Skip to content

Commit 83d735e

Browse files
author
agent-aspose-barcode-examples
committed
docs: bootstrap auto-generated agents.md and index.json
1 parent e7752d7 commit 83d735e

2 files changed

Lines changed: 24 additions & 1844 deletions

File tree

agents.md

Lines changed: 18 additions & 269 deletions
Original file line numberDiff line numberDiff line change
@@ -21,313 +21,87 @@ When working in this repository:
2121

2222
## Repository Overview
2323

24-
This repository contains **1124** working code examples demonstrating Aspose.BarCode for .NET capabilities.
24+
This repository contains **0** working code examples demonstrating Aspose.BarCode for .NET capabilities.
2525

26-
**Statistics** (as of 2026-04-27):
27-
- Total Examples: 1124
28-
- Categories: 21
26+
**Statistics** (as of 2026-04-28):
27+
- Total Examples: 0
28+
- Categories: 0
2929
- Overall Pass Rate: 100.0%
3030

3131
## Category Details
3232

33-
### barcode-appearance-customization
34-
- Examples: 30
35-
- Guide: [agents.md](./barcode-appearance-customization/agents.md)
36-
37-
### barcode-checksum-control
38-
- Examples: 30
39-
- Guide: [agents.md](./barcode-checksum-control/agents.md)
40-
41-
### barcode-color-customization
42-
- Examples: 28
43-
- Guide: [agents.md](./barcode-color-customization/agents.md)
44-
45-
### barcode-configuration-serialization
46-
- Examples: 30
47-
- Guide: [agents.md](./barcode-configuration-serialization/agents.md)
48-
49-
### barcode-reading-properties
50-
- Examples: 50
51-
- Guide: [agents.md](./barcode-reading-properties/agents.md)
52-
53-
### barcode-recognition-basics
54-
- Examples: 75
55-
- Guide: [agents.md](./barcode-recognition-basics/agents.md)
56-
57-
### barcode-recognition-performance
58-
- Examples: 81
59-
- Guide: [agents.md](./barcode-recognition-performance/agents.md)
60-
61-
### barcode-recognition-xml-serialization
62-
- Examples: 35
63-
- Guide: [agents.md](./barcode-recognition-xml-serialization/agents.md)
64-
65-
### barcode-saving-and-export
66-
- Examples: 30
67-
- Guide: [agents.md](./barcode-saving-and-export/agents.md)
68-
69-
### barcode-size-and-resolution
70-
- Examples: 34
71-
- Guide: [agents.md](./barcode-size-and-resolution/agents.md)
72-
73-
### barcode-text-customization
74-
- Examples: 29
75-
- Guide: [agents.md](./barcode-text-customization/agents.md)
76-
77-
### gs1-barcode-types
78-
- Examples: 34
79-
- Guide: [agents.md](./gs1-barcode-types/agents.md)
80-
81-
### hibc-lic-barcode
82-
- Examples: 35
83-
- Guide: [agents.md](./hibc-lic-barcode/agents.md)
84-
85-
### mailmark-four-state-barcode
86-
- Examples: 29
87-
- Guide: [agents.md](./mailmark-four-state-barcode/agents.md)
88-
89-
### mailmark-two-dimensional-barcode
90-
- Examples: 34
91-
- Guide: [agents.md](./mailmark-two-dimensional-barcode/agents.md)
92-
93-
### maxicode-barcode
94-
- Examples: 34
95-
- Guide: [agents.md](./maxicode-barcode/agents.md)
96-
97-
### one-dimensional-barcode-types
98-
- Examples: 126
99-
- Guide: [agents.md](./one-dimensional-barcode-types/agents.md)
100-
101-
### postal-barcode-types
102-
- Examples: 90
103-
- Guide: [agents.md](./postal-barcode-types/agents.md)
104-
105-
### special-barcode-recognition-settings
106-
- Examples: 48
107-
- Guide: [agents.md](./special-barcode-recognition-settings/agents.md)
108-
109-
### swiss-qr-code
110-
- Examples: 28
111-
- Guide: [agents.md](./swiss-qr-code/agents.md)
112-
113-
### two-dimensional-barcode-types
114-
- Examples: 214
115-
- Guide: [agents.md](./two-dimensional-barcode-types/agents.md)
116-
11733
## Boundaries
11834

11935
### Always
12036

121-
These rules are mandatory for every example.
122-
12337
#### Use `using` blocks for IDisposable objects
12438
```csharp
125-
// CORRECT
12639
using (BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.Code128, "12345"))
12740
{
12841
generator.Save("barcode.png");
12942
}
130-
131-
// WRONG - memory leak, file lock not released
132-
// BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.Code128, "12345");
133-
// generator.Save("barcode.png");
13443
```
13544

13645
#### Use Aspose.Drawing instead of System.Drawing
13746
```csharp
138-
// CORRECT
13947
using Aspose.Drawing;
14048
using Aspose.Drawing.Imaging;
141-
142-
// WRONG - System.Drawing is not available in this environment
143-
// using System.Drawing;
49+
// WRONG: using System.Drawing;
14450
```
14551

14652
#### Never use EncodeTypes as a variable or parameter type
14753
```csharp
148-
// CORRECT
14954
BaseEncodeType barcodeType = EncodeTypes.Code128;
150-
void Generate(BaseEncodeType type, string codeText) { }
151-
152-
// WRONG - EncodeTypes is a static class, not a type
153-
// EncodeTypes barcodeType = EncodeTypes.Code128;
154-
// void Generate(EncodeTypes type, string codeText) { }
55+
// WRONG: EncodeTypes barcodeType = EncodeTypes.Code128;
15556
```
15657

15758
#### Always use the Barcode sub-object for barcode-specific parameters
15859
```csharp
159-
// CORRECT
160-
generator.Parameters.Barcode.BarColor = Aspose.Drawing.Color.Black;
16160
generator.Parameters.Barcode.XDimension.Pixels = 2f;
16261
generator.Parameters.Barcode.BarHeight.Pixels = 50f;
16362
generator.Parameters.Barcode.Padding.Left.Point = 5f;
164-
165-
// WRONG
166-
// generator.Parameters.BarColor = Color.Black;
167-
// generator.Parameters.XDimension.Pixels = 2f;
168-
```
169-
170-
#### Use unit members for unit-based properties
171-
```csharp
172-
// CORRECT
173-
generator.Parameters.Barcode.XDimension.Pixels = 2f;
174-
generator.Parameters.Barcode.BarHeight.Point = 50f;
175-
generator.Parameters.ImageWidth.Millimeters = 50f;
176-
177-
// WRONG
178-
// generator.Parameters.Barcode.XDimension = 2f;
179-
// generator.Parameters.Barcode.BarHeight = Unit.Pixels(50);
63+
// WRONG: generator.Parameters.XDimension.Pixels = 2f;
18064
```
18165

18266
#### Use correct path for border properties
18367
```csharp
184-
// CORRECT
18568
generator.Parameters.Border.Color = Aspose.Drawing.Color.Black;
18669
generator.Parameters.Border.Width.Pixels = 2f;
187-
188-
// WRONG
189-
// generator.Parameters.BorderColor = Color.Black;
190-
// generator.Parameters.BorderWidth = 2;
70+
// WRONG: generator.Parameters.BorderColor = Color.Black;
19171
```
19272

193-
### Ask First
194-
195-
Check with a human before doing any of these:
196-
- **Creating multi-file projects** - each example must be a single `.cs` file
197-
- **Using deprecated APIs** - check the Aspose.BarCode changelog for the current API surface
198-
- **Adding NuGet packages** beyond `Aspose.BarCode` - the `.csproj` template only includes Aspose.BarCode
199-
- **Modifying shared infrastructure** - `.csproj` templates, `agents.md` files
200-
20173
### Never
20274

20375
- Never use `System.Drawing` — always use `Aspose.Drawing`
20476
- Never use `EncodeTypes` as a variable, field, or parameter type — use `BaseEncodeType`
20577
- Never call `Environment.Exit(1)` — use `Console.WriteLine` for failure reporting
206-
- Never use `generator.Parameters.BorderColor` or `generator.Parameters.BorderWidth` — use `generator.Parameters.Border.Color` and `generator.Parameters.Border.Width.Pixels`
78+
- Never use `generator.Parameters.BorderColor` or `generator.Parameters.BorderWidth`
20779
- Never use `generator.Parameters.Padding.*` — use `generator.Parameters.Barcode.Padding.*`
20880
- Never use `generator.Parameters.XDimension` — use `generator.Parameters.Barcode.XDimension`
20981
- Never use `reader.BarcodeSettings.QualitySettings` — use `reader.QualitySettings` directly
21082
- Never use `result.IsCodeTextValid` — it does not exist on `BarCodeResult`
21183
- Never use `DeconvolutionMode.Disabled` — use `DeconvolutionMode.Fast`
212-
- Never forget to dispose objects — always use `using` blocks for IDisposable types
213-
- Never use `using (var doc = new Document())` or `using (var builder = new DocumentBuilder(doc))` — these types are not IDisposable
214-
215-
## Common Mistakes (Anti-Patterns)
216-
217-
### Using System.Drawing instead of Aspose.Drawing
218-
```csharp
219-
// WRONG - CS0246: System.Drawing not available
220-
using System.Drawing;
221-
Color c = Color.Red;
222-
```
223-
```csharp
224-
// CORRECT
225-
using Aspose.Drawing;
226-
Aspose.Drawing.Color c = Aspose.Drawing.Color.Red;
227-
```
228-
229-
### Wrong border property paths
230-
```csharp
231-
// WRONG - CS1061: member does not exist
232-
generator.Parameters.BorderColor = Color.Black;
233-
generator.Parameters.BorderWidth = 2;
234-
```
235-
```csharp
236-
// CORRECT
237-
generator.Parameters.Border.Color = Aspose.Drawing.Color.Black;
238-
generator.Parameters.Border.Width.Pixels = 2f;
239-
```
240-
241-
### Wrong padding / XDimension paths
242-
```csharp
243-
// WRONG
244-
generator.Parameters.Padding.Left.Pixels = 5f;
245-
generator.Parameters.XDimension.Pixels = 2f;
246-
```
247-
```csharp
248-
// CORRECT
249-
generator.Parameters.Barcode.Padding.Left.Pixels = 5f;
250-
generator.Parameters.Barcode.XDimension.Pixels = 2f;
251-
```
252-
253-
### Using EncodeTypes as a type
254-
```csharp
255-
// WRONG - CS0721: static type cannot be used as parameter type
256-
void Generate(EncodeTypes type) { }
257-
```
258-
```csharp
259-
// CORRECT
260-
void Generate(BaseEncodeType type) { }
261-
```
26284

26385
## Repository Structure
26486

26587
```
26688
agents.md
267-
README.md
268-
+-- barcode-appearance-customization/
269-
+-- barcode-checksum-control/
270-
+-- barcode-color-customization/
271-
+-- barcode-configuration-serialization/
272-
+-- barcode-reading-properties/
273-
+-- barcode-recognition-basics/
274-
+-- barcode-recognition-performance/
275-
+-- barcode-recognition-xml-serialization/
276-
+-- barcode-saving-and-export/
277-
+-- barcode-size-and-resolution/
278-
+-- barcode-text-customization/
279-
+-- gs1-barcode-types/
280-
+-- hibc-lic-barcode/
281-
+-- mailmark-four-state-barcode/
282-
+-- mailmark-two-dimensional-barcode/
283-
+-- maxicode-barcode/
284-
+-- one-dimensional-barcode-types/
285-
+-- postal-barcode-types/
286-
+-- special-barcode-recognition-settings/
287-
+-- swiss-qr-code/
288-
+-- two-dimensional-barcode-types/
89+
index.json
90+
28991
```
29092

29193
## Category Index
29294

29395
| Category | Examples | Pass Rate | Details |
29496
|----------|----------|-----------|---------|
295-
| [Barcode Appearance Customization](./barcode-appearance-customization/) | 30 | 100.0% | [agents.md](./barcode-appearance-customization/agents.md) |
296-
| [Barcode Checksum Control](./barcode-checksum-control/) | 30 | 100.0% | [agents.md](./barcode-checksum-control/agents.md) |
297-
| [Barcode Color Customization](./barcode-color-customization/) | 28 | 100.0% | [agents.md](./barcode-color-customization/agents.md) |
298-
| [Barcode Configuration Serialization](./barcode-configuration-serialization/) | 30 | 100.0% | [agents.md](./barcode-configuration-serialization/agents.md) |
299-
| [Barcode Reading Properties](./barcode-reading-properties/) | 50 | 100.0% | [agents.md](./barcode-reading-properties/agents.md) |
300-
| [Barcode Recognition Basics](./barcode-recognition-basics/) | 75 | 100.0% | [agents.md](./barcode-recognition-basics/agents.md) |
301-
| [Barcode Recognition Performance](./barcode-recognition-performance/) | 81 | 100.0% | [agents.md](./barcode-recognition-performance/agents.md) |
302-
| [Barcode Recognition XML Serialization](./barcode-recognition-xml-serialization/) | 35 | 100.0% | [agents.md](./barcode-recognition-xml-serialization/agents.md) |
303-
| [Barcode Saving And Export](./barcode-saving-and-export/) | 30 | 100.0% | [agents.md](./barcode-saving-and-export/agents.md) |
304-
| [Barcode Size And Resolution](./barcode-size-and-resolution/) | 34 | 100.0% | [agents.md](./barcode-size-and-resolution/agents.md) |
305-
| [Barcode Text Customization](./barcode-text-customization/) | 29 | 100.0% | [agents.md](./barcode-text-customization/agents.md) |
306-
| [GS1 Barcode Types](./gs1-barcode-types/) | 34 | 100.0% | [agents.md](./gs1-barcode-types/agents.md) |
307-
| [HIBC LIC Barcode](./hibc-lic-barcode/) | 35 | 100.0% | [agents.md](./hibc-lic-barcode/agents.md) |
308-
| [Mailmark Four State Barcode](./mailmark-four-state-barcode/) | 29 | 100.0% | [agents.md](./mailmark-four-state-barcode/agents.md) |
309-
| [Mailmark Two Dimensional Barcode](./mailmark-two-dimensional-barcode/) | 34 | 100.0% | [agents.md](./mailmark-two-dimensional-barcode/agents.md) |
310-
| [MaxiCode Barcode](./maxicode-barcode/) | 34 | 100.0% | [agents.md](./maxicode-barcode/agents.md) |
311-
| [One Dimensional Barcode Types](./one-dimensional-barcode-types/) | 126 | 100.0% | [agents.md](./one-dimensional-barcode-types/agents.md) |
312-
| [Postal Barcode Types](./postal-barcode-types/) | 90 | 100.0% | [agents.md](./postal-barcode-types/agents.md) |
313-
| [Special Barcode Recognition Settings](./special-barcode-recognition-settings/) | 48 | 100.0% | [agents.md](./special-barcode-recognition-settings/agents.md) |
314-
| [Swiss QR Code](./swiss-qr-code/) | 28 | 100.0% | [agents.md](./swiss-qr-code/agents.md) |
315-
| [Two Dimensional Barcode Types](./two-dimensional-barcode-types/) | 214 | 100.0% | [agents.md](./two-dimensional-barcode-types/agents.md) |
97+
31698

31799
## Command Reference
318100

319-
### Build and Run
320101
```bash
321-
# Create a new project (if needed)
322102
dotnet new console -n ExampleProject --framework net9.0
323-
324-
# Add Aspose.BarCode NuGet package
325103
dotnet add package Aspose.BarCode
326-
327-
# Build
328104
dotnet build --configuration Release --verbosity minimal
329-
330-
# Run
331105
dotnet run
332106
```
333107

@@ -339,48 +113,23 @@ dotnet run
339113
<TargetFramework>net9.0</TargetFramework>
340114
</PropertyGroup>
341115
<ItemGroup>
342-
<PackageReference Include="Aspose.BarCode" Version="26.4.0" />
116+
<PackageReference Include="Aspose.BarCode" Version="26.3.0" />
343117
</ItemGroup>
344118
</Project>
345119
```
346120

347-
## Testing Guide
348-
349-
Every example must pass these verification steps.
121+
## Common Error Codes
350122

351-
### Build Verification
352-
```bash
353-
dotnet build --configuration Release --verbosity minimal
354-
```
355-
- **Success**: Exit code 0, no `CS` error codes in output
356-
- **Failure**: Any `error CS####` line indicates a build failure
357-
358-
### Common Error Codes
359123
| Code | Meaning | Fix |
360124
|------|---------|-----|
361125
| `CS0721` | Static type used as parameter | Use `BaseEncodeType` instead of `EncodeTypes` |
362-
| `CS1061` | Member does not exist on type | Check Aspose.BarCode API docs; verify property path |
363-
| `CS0246` | Type or namespace not found | Add missing `using` directive; use `Aspose.Drawing` not `System.Drawing` |
126+
| `CS1061` | Member does not exist on type | Verify property path; check Aspose.BarCode docs |
127+
| `CS0246` | Type or namespace not found | Add missing `using`; use `Aspose.Drawing` not `System.Drawing` |
364128
| `CS1674` | Type not IDisposable | Remove `using` from non-disposable types |
365-
| `CS0029` | Cannot convert type | Cast explicitly or use correct type |
366-
367-
## How to Use These Examples
368-
369-
### Prerequisites
370-
- .NET SDK (net9.0)
371-
- Aspose.BarCode for .NET 26.4 (via NuGet)
372-
373-
### Running an Example
374-
1. Navigate to any category folder
375-
2. Each .cs file is a standalone Console Application
376-
3. Compile and run:
377-
```bash
378-
dotnet run <example-file.cs>
379-
```
380129

381130
<!-- AUTOGENERATED:START -->
382-
Updated: 2026-04-27 | Run: `20260427` | Examples: 1124 | Categories: 21
131+
Updated: 2026-04-28 | Run: `20260428_042136` | Examples: 0 | Categories: 0
383132
<!-- AUTOGENERATED:END -->
384133

385134
---
386-
*This repository is maintained by automated code generation. Last updated: 2026-04-27 | Total examples: 1124*
135+
*This repository is maintained by automated code generation. Last updated: 2026-04-28 | Total examples: 0*

0 commit comments

Comments
 (0)