Skip to content

Commit 64efd16

Browse files
AsposeAGAsposeAG
committed
Barcode for NET 26.6 API reference
1 parent 02e5be2 commit 64efd16

50 files changed

Lines changed: 217 additions & 80 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎english/net/aspose.barcode.generation/_index.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,7 @@ The **Aspose.BarCode.Generation** containing general classes for the implementat
9393
| [QREncodeMode](./qrencodemode/) | Encoding mode for QR barcodes. |
9494
| [QREncodeType](./qrencodetype/) | QR / MicroQR selector mode. Select ForceQR for standard QR symbols, Auto for MicroQR. ForceMicroQR is used for strongly MicroQR symbol generation if it is possible. |
9595
| [QRErrorLevel](./qrerrorlevel/) | Level of Reed-Solomon error correction. From low to high: LevelL, LevelM, LevelQ, LevelH. |
96+
| [QrExtCompactionMode](./qrextcompactionmode/) | Specifies QR compaction mode for codetext added by QrExtCodetextBuilder. |
9697
| [QRVersion](./qrversion/) | Version of QR Code. From Version1 to Version40 for QR code and from M1 to M4 for MicroQr. |
9798
| [RectMicroQRVersion](./rectmicroqrversion/) | Version of RectMicroQR Code. From version R7x43 to version R17x139. |
9899
| [SvgColorMode](./svgcolormode/) | Possible modes for filling color in svg file, RGB is default and supported by SVG 1.1. RGBA, HSL, HSLA is allowed in SVG 2.0 standard. Even in RGB opacity will be set through "fill-opacity" parameter |

‎english/net/aspose.barcode.generation/eciencodings/_index.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,14 +63,14 @@ using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode
6363
{
6464
generator.CodeText = "12345TEXT";
6565
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.ECIEncoding;
66-
generator.Parameters.Barcode.QR.QrECIEncoding = ECIEncodings.UTF8;
66+
generator.Parameters.Barcode.QR.ECIEncoding = ECIEncodings.UTF8;
6767
generator.Save("test.png");
6868
}
6969
[VB.NET]
7070
Using generator As New Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR)
7171
generator.CodeText = "12345TEXT"
7272
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.ECIEncoding
73-
generator.Parameters.Barcode.QR.QrECIEncoding = ECIEncodings.UTF8
73+
generator.Parameters.Barcode.QR.ECIEncoding = ECIEncodings.UTF8
7474
generator.Save("test.png")
7575
End Using
7676
```

‎english/net/aspose.barcode.generation/qrencodemode/_index.md‎

Lines changed: 27 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -53,18 +53,25 @@ End Using
5353

5454
//This sample shows how to use FNC1 first position in Extended Mode.
5555
56-
//Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes.
57-
//It is better to use QrExtCodetextBuilder for extended codetext generation.
58-
//Use Display2DText property to set visible text to removing managing characters.
59-
//Encoding Principles:
60-
//All symbols "\" must be doubled "\\" in the codetext.
61-
//FNC1 in first position is set in codetext as as "<FNC1>"
62-
//FNC1 in second position is set in codetext as as "<FNC1(value)>". The value must be single symbols (a-z, A-Z) or digits from 0 to 99.
63-
//Group Separator for FNC1 modes is set as 0x1D character '\\u001D'
64-
//If you need to insert "<FNC1>" string into barcode write it as "<\FNC1>"
65-
//ECI identifiers are set as single slash and six digits identifier "\000026" - UTF8 ECI identifier
66-
//To disable current ECI mode and convert to default JIS8 mode zero mode ECI indetifier is set. "\000000"
67-
//All unicode characters after ECI identifier are automatically encoded into correct character codeset.
56+
Extended Channel mode which supports FNC1 first position, FNC1 second position and multi ECI modes.
57+
It is better to use QrExtCodetextBuilder for extended codetext generation.
58+
Use Display2DText property to set visible text by removing managing characters.
59+
Encoding Principles:
60+
All symbols "\" must be doubled "\\" in the codetext.
61+
FNC1 in first position is set in codetext as "<FNC1>".
62+
FNC1 in second position is set in codetext as "<FNC1(value)>". The value must be a single character from a-z or A-Z, or a two-digit number from 00 to 99.
63+
Group Separator for FNC1 modes is set as 0x1D character '\u001D'.
64+
If you need to insert "<FNC1>" string into barcode write it as "<\FNC1>".
65+
ECI identifiers are set as single slash and six digits identifier, for example "\000026" for UTF8 ECI identifier.
66+
The default ECI mode is ISO/IEC 8859-1 ECI identifier "\000003". It does not need to be encoded at the beginning of the codetext.
67+
To switch from another ECI mode to the default ECI mode, use "\000003".
68+
All unicode characters after ECI identifier are automatically encoded into correct character codeset.
69+
QR compaction mode selectors are set as single slash and mode name: "\auto", "\num", "\alnum", "\byte", "\kanji".
70+
"\auto" sets automatic compaction mode, "\num" sets Numeric mode, "\alnum" sets AlphaNumeric mode, "\byte" sets Bytes mode, and "\kanji" sets Kanji mode.
71+
The default compaction mode is "\auto".
72+
Compaction mode selectors define the encoding mode for the following data until the next compaction mode selector or ECI identifier is found.
73+
If the data cannot be encoded in the selected compaction mode, an ArgumentException is thrown.
74+
This mode is not supported by MicroQR barcodes.
6875

6976
[C#]
7077
//create codetext
@@ -132,12 +139,15 @@ QrExtCodetextBuilder textBuilder = new QrExtCodetextBuilder();
132139
textBuilder.AddECICodetext(ECIEncodings.Win1251, "Will");
133140
textBuilder.AddECICodetext(ECIEncodings.UTF8, "Right");
134141
textBuilder.AddECICodetext(ECIEncodings.UTF16BE, "Power");
135-
textBuilder.AddPlainCodetext(@"t\e\\st");
142+
textBuilder.AddPlainCodetext(@"t\e\\st");
143+
textBuilder.AddAlphaNumericCodetext(@"ASPOSE2001");
144+
textBuilder.AddNumericCodetext(@"20012026");
145+
136146
//generate barcode
137147
using (Aspose.BarCode.Generation.BarcodeGenerator generator = new Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR))
138148
{
139149
generator.CodeText = textBuilder.GetExtendedCodetext();
140-
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.Extendedt;
150+
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.Extended;
141151
generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text";
142152
generator.Save(@"d:\test.png");
143153
}
@@ -148,6 +158,9 @@ textBuilder.AddECICodetext(ECIEncodings.Win1251, "Will")
148158
textBuilder.AddECICodetext(ECIEncodings.UTF8, "Right")
149159
textBuilder.AddECICodetext(ECIEncodings.UTF16BE, "Power")
150160
textBuilder.AddPlainCodetext(@"t\e\\st")
161+
textBuilder.AddCodetextWithCompactionMode(QrExtCompactionMode.AlphaNumeric, @"ASPOSE2001");
162+
textBuilder.AddCodetextWithCompactionMode(QrExtCompactionMode.Numeric, @"20012026");
163+
151164
'generate barcode
152165
Using generator As New Aspose.BarCode.Generation.BarcodeGenerator(EncodeTypes.QR)
153166
generator.CodeText = textBuilder.GetExtendedCodetext()

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/_index.md‎

Lines changed: 20 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -26,12 +26,13 @@ public class QrExtCodetextBuilder : ExtCodetextBuilder
2626

2727
| Name | Description |
2828
| --- | --- |
29+
| [AddCodetextWithCompactionMode](../../aspose.barcode.generation/qrextcodetextbuilder/addcodetextwithcompactionmode/)(QrExtCompactionMode, string) | Adds codetext with the specified QR compaction mode to the extended codetext items. |
2930
| [AddECICodetext](../../aspose.barcode.generation/extcodetextbuilder/addecicodetext/)(ECIEncodings, string) | Adds codetext with Extended Channel Identifier |
30-
| [AddFNC1FirstPosition](../../aspose.barcode.generation/qrextcodetextbuilder/addfnc1firstposition/)() | Adds FNC1 in first position to the extended codetext items |
31+
| [AddFNC1FirstPosition](../../aspose.barcode.generation/qrextcodetextbuilder/addfnc1firstposition/)() | Sets FNC1 in first position. If another FNC1 mode was set before, it is replaced. |
3132
| [AddFNC1GroupSeparator](../../aspose.barcode.generation/qrextcodetextbuilder/addfnc1groupseparator/)() | Adds Group Separator (GS - '\\u001D') to the extended codetext items |
32-
| [AddFNC1SecondPosition](../../aspose.barcode.generation/qrextcodetextbuilder/addfnc1secondposition/)(string) | Adds FNC1 in second position to the extended codetext items |
33+
| [AddFNC1SecondPosition](../../aspose.barcode.generation/qrextcodetextbuilder/addfnc1secondposition/)(string) | Sets FNC1 in second position. If another FNC1 mode was set before, it is replaced. |
3334
| [AddPlainCodetext](../../aspose.barcode.generation/extcodetextbuilder/addplaincodetext/)(string) | Adds plain codetext to the extended codetext items |
34-
| virtual [Clear](../../aspose.barcode.generation/extcodetextbuilder/clear/)() | Clears extended codetext items |
35+
| override [Clear](../../aspose.barcode.generation/qrextcodetextbuilder/clear/)() | Clears extended codetext items |
3536
| override [GetExtendedCodetext](../../aspose.barcode.generation/qrextcodetextbuilder/getextendedcodetext/)() | Generates Extended codetext from the extended codetext list. |
3637

3738
## Examples
@@ -41,21 +42,21 @@ This sample shows how to use FNC1 first position in Extended Mode.
4142
```csharp
4243
[C#]
4344
//create codetext
44-
QrExtCodetextBuilder lTextBuilder = new QrExtCodetextBuilder();
45-
lTextBuilder.AddFNC1FirstPosition();
46-
lTextBuilder.AddPlainCodetext("000%89%%0");
47-
lTextBuilder.AddFNC1GroupSeparator();
48-
lTextBuilder.AddPlainCodetext("12345<FNC1>");
45+
QrExtCodetextBuilder TextBuilder = new QrExtCodetextBuilder();
46+
TextBuilder.AddFNC1FirstPosition();
47+
TextBuilder.AddPlainCodetext("000%89%%0");
48+
TextBuilder.AddFNC1GroupSeparator();
49+
TextBuilder.AddPlainCodetext("12345<FNC1>");
4950

5051
//generate codetext
51-
string lCodetext = lTextBuilder.GetExtendedCodetext();
52+
string codetext = TextBuilder.GetExtendedCodetext();
5253

5354
//generate
5455
using(BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR))
5556
{
5657
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.ExtendedCodetext;
5758
generator.Parameters.Barcode.QR.ErrorLevel = QRErrorLevel.LevelL;
58-
generator.CodeText = lCodetext;
59+
generator.CodeText = codetext;
5960
generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text";
6061
generator.Save("test.bmp");
6162
}
@@ -66,19 +67,19 @@ This sample shows how to use FNC1 second position in Extended Mode.
6667
```csharp
6768
[C#]
6869
//create codetext
69-
QrExtCodetextBuilder lTextBuilder = new QrExtCodetextBuilder();
70+
QrExtCodetextBuilder TextBuilder = new QrExtCodetextBuilder();
7071
TextBuilder.AddFNC1SecondPosition("12");
7172
TextBuilder.AddPlainCodetext("TRUE3456");
7273

7374
//generate codetext
74-
string lCodetext = lTextBuilder.GetExtendedCodetext();
75+
string codetext = TextBuilder.GetExtendedCodetext();
7576

7677
//generate
7778
using(BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR))
7879
{
7980
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.ExtendedCodetext;
8081
generator.Parameters.Barcode.QR.ErrorLevel = QRErrorLevel.LevelL;
81-
generator.CodeText = lCodetext;
82+
generator.CodeText = codetext;
8283
generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text";
8384
generator.Save("test.bmp");
8485
}
@@ -89,21 +90,23 @@ This sample shows how to use multi ECI mode in Extended Mode.
8990
```csharp
9091
[C#]
9192
//create codetext
92-
QrExtCodetextBuilder lTextBuilder = new QrExtCodetextBuilder();
93+
QrExtCodetextBuilder TextBuilder = new QrExtCodetextBuilder();
9394
TextBuilder.AddECICodetext(ECIEncodings.Win1251, "Will");
9495
TextBuilder.AddECICodetext(ECIEncodings.UTF8, "Right");
9596
TextBuilder.AddECICodetext(ECIEncodings.UTF16BE, "Power");
96-
TextBuilder.AddPlainCodetext(@"t\e\\st");
97+
TextBuilder.AddPlainCodetext(@"t\e\\st");
98+
TextBuilder.AddCodetextWithCompactionMode(QrExtCompactionMode.AlphaNumeric, @"ASPOSE2001");
99+
TextBuilder.AddCodetextWithCompactionMode(QrExtCompactionMode.Numeric, @"20012026");
97100

98101
//generate codetext
99-
string lCodetext = lTextBuilder.GetExtendedCodetext();
102+
string codetext = TextBuilder.GetExtendedCodetext();
100103

101104
//generate
102105
using(BarcodeGenerator generator = new BarcodeGenerator(EncodeTypes.QR))
103106
{
104107
generator.Parameters.Barcode.QR.EncodeMode = QREncodeMode.ExtendedCodetext;
105108
generator.Parameters.Barcode.QR.ErrorLevel = QRErrorLevel.LevelL;
106-
generator.CodeText = lCodetext;
109+
generator.CodeText = codetext;
107110
generator.Parameters.Barcode.CodeTextParameters.TwoDDisplayText = "My Text";
108111
generator.Save("test.bmp");
109112
}

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/addcodetextwithcompactionmode/_index.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: QrExtCodetextBuilder.AddCodetextWithCompactionMode
3+
second_title: Aspose.BarCode for .NET API Reference
4+
description: QrExtCodetextBuilder method. Adds codetext with the specified QR compaction mode to the extended codetext items
5+
type: docs
6+
weight: 20
7+
url: /net/aspose.barcode.generation/qrextcodetextbuilder/addcodetextwithcompactionmode/
8+
---
9+
## QrExtCodetextBuilder.AddCodetextWithCompactionMode method
10+
11+
Adds codetext with the specified QR compaction mode to the extended codetext items.
12+
13+
```csharp
14+
public void AddCodetextWithCompactionMode(QrExtCompactionMode mode, string codetext)
15+
```
16+
17+
| Parameter | Type | Description |
18+
| --- | --- | --- |
19+
| mode | QrExtCompactionMode | QR compaction mode for the codetext. |
20+
| codetext | String | Codetext in Unicode to add as an extended codetext item. |
21+
22+
### Exceptions
23+
24+
| exception | condition |
25+
| --- | --- |
26+
| ArgumentException | The specified codetext cannot be encoded in the selected QR compaction mode. |
27+
28+
### See Also
29+
30+
* enum [QrExtCompactionMode](../../qrextcompactionmode/)
31+
* class [QrExtCodetextBuilder](../)
32+
* namespace [Aspose.BarCode.Generation](../../../aspose.barcode.generation/)
33+
* assembly [Aspose.BarCode](../../../)
34+
35+

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/addfnc1firstposition/_index.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
22
title: QrExtCodetextBuilder.AddFNC1FirstPosition
33
second_title: Aspose.BarCode for .NET API Reference
4-
description: QrExtCodetextBuilder method. Adds FNC1 in first position to the extended codetext items
4+
description: QrExtCodetextBuilder method. Sets FNC1 in first position. If another FNC1 mode was set before it is replaced
55
type: docs
6-
weight: 20
6+
weight: 30
77
url: /net/aspose.barcode.generation/qrextcodetextbuilder/addfnc1firstposition/
88
---
99
## QrExtCodetextBuilder.AddFNC1FirstPosition method
1010

11-
Adds FNC1 in first position to the extended codetext items
11+
Sets FNC1 in first position. If another FNC1 mode was set before, it is replaced.
1212

1313
```csharp
1414
public void AddFNC1FirstPosition()

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/addfnc1groupseparator/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: QrExtCodetextBuilder.AddFNC1GroupSeparator
33
second_title: Aspose.BarCode for .NET API Reference
44
description: QrExtCodetextBuilder method. Adds Group Separator GS u001D to the extended codetext items
55
type: docs
6-
weight: 30
6+
weight: 40
77
url: /net/aspose.barcode.generation/qrextcodetextbuilder/addfnc1groupseparator/
88
---
99
## QrExtCodetextBuilder.AddFNC1GroupSeparator method

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/addfnc1secondposition/_index.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
22
title: QrExtCodetextBuilder.AddFNC1SecondPosition
33
second_title: Aspose.BarCode for .NET API Reference
4-
description: QrExtCodetextBuilder method. Adds FNC1 in second position to the extended codetext items
4+
description: QrExtCodetextBuilder method. Sets FNC1 in second position. If another FNC1 mode was set before it is replaced
55
type: docs
6-
weight: 40
6+
weight: 50
77
url: /net/aspose.barcode.generation/qrextcodetextbuilder/addfnc1secondposition/
88
---
99
## QrExtCodetextBuilder.AddFNC1SecondPosition method
1010

11-
Adds FNC1 in second position to the extended codetext items
11+
Sets FNC1 in second position. If another FNC1 mode was set before, it is replaced.
1212

1313
```csharp
1414
public void AddFNC1SecondPosition(string codetext)
1515
```
1616

1717
| Parameter | Type | Description |
1818
| --- | --- | --- |
19-
| codetext | String | Value of the FNC1 in the second position |
19+
| codetext | String | Value of the FNC1 in the second position. The value must be a single letter from a-z or A-Z, or a two-digit number from 00 to 99. |
2020

2121
### See Also
2222

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/clear/_index.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: QrExtCodetextBuilder.Clear
3+
second_title: Aspose.BarCode for .NET API Reference
4+
description: QrExtCodetextBuilder method. Clears extended codetext items
5+
type: docs
6+
weight: 60
7+
url: /net/aspose.barcode.generation/qrextcodetextbuilder/clear/
8+
---
9+
## QrExtCodetextBuilder.Clear method
10+
11+
Clears extended codetext items
12+
13+
```csharp
14+
public override void Clear()
15+
```
16+
17+
### See Also
18+
19+
* class [QrExtCodetextBuilder](../)
20+
* namespace [Aspose.BarCode.Generation](../../../aspose.barcode.generation/)
21+
* assembly [Aspose.BarCode](../../../)
22+
23+

‎english/net/aspose.barcode.generation/qrextcodetextbuilder/getextendedcodetext/_index.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: QrExtCodetextBuilder.GetExtendedCodetext
33
second_title: Aspose.BarCode for .NET API Reference
44
description: QrExtCodetextBuilder method. Generates Extended codetext from the extended codetext list
55
type: docs
6-
weight: 50
6+
weight: 70
77
url: /net/aspose.barcode.generation/qrextcodetextbuilder/getextendedcodetext/
88
---
99
## QrExtCodetextBuilder.GetExtendedCodetext method

0 commit comments

Comments
 (0)