Skip to content

Commit 7789c39

Browse files
AsposeAGAsposeAG
committed
Merge remote-tracking branch 'remotes/origin/main' into production
2 parents 55c9cbc + 07fa517 commit 7789c39

File tree

13 files changed

+108
-27
lines changed

13 files changed

+108
-27
lines changed

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ public enum AztecEncodeMode
1919
| Name | Value | Description |
2020
| --- | --- | --- |
2121
| Auto | `0` | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
22-
| Bytes | `1` | Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
23-
| ExtendedCodetext | `2` | Extended mode which supports multi ECI modes. |
22+
| Bytes | `1` | *This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method to convert the message to byte array with specified encoding.* Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
23+
| ExtendedCodetext | `2` | *This property is obsolete and will be removed in future releases. Instead, use the 'Extended' encode mode.* Extended mode which supports multi ECI modes. |
2424
| Extended | `3` | Extended mode which supports multi ECI modes. |
2525
| Binary | `4` | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
2626
| ECI | `5` | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |

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

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,8 @@ public sealed class BarcodeGenerator : Component
4545
| [Save](../../aspose.barcode.generation/barcodegenerator/save/#save)(Stream, BarCodeImageFormat) | Save barcode image to stream in specific format. |
4646
| [Save](../../aspose.barcode.generation/barcodegenerator/save/#save_2)(string, BarCodeImageFormat) | Save barcode image to specific file in specific format. |
4747
| [SetCodeText](../../aspose.barcode.generation/barcodegenerator/setcodetext/#setcodetext)(byte[]) | Set codetext as sequence of bytes. |
48-
| [SetCodeText](../../aspose.barcode.generation/barcodegenerator/setcodetext/#setcodetext_1)(string, Encoding) | Encodes codetext with byte order mark (BOM) using specified encoding. |
48+
| [SetCodeText](../../aspose.barcode.generation/barcodegenerator/setcodetext/#setcodetext_1)(string, Encoding) | Encodes codetext with byte order mark (BOM), using specified encoding: like UTF8, UTF16, UTF32, e.t.c.. 1D barcodes should use Encoding.ASCII or ISO/IEC 8859-1 - Encoding.GetEncoding(28591). 2D barcodes should use Encoding.UTF8. |
49+
| [SetCodeText](../../aspose.barcode.generation/barcodegenerator/setcodetext/#setcodetext_2)(string, Encoding, bool) | Encodes codetext with optional byte order mark (BOM) insertion, using specified encoding: like UTF8, UTF16, UTF32, e.t.c.. 1D barcodes should use Encoding.ASCII or ISO/IEC 8859-1 - Encoding.GetEncoding(28591). 2D barcodes should use Encoding.UTF8. |
4950

5051
## Examples
5152

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

Lines changed: 81 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ public void SetCodeText(byte[] codeBytes)
2828

2929
## SetCodeText(string, Encoding) {#setcodetext_1}
3030

31-
Encodes codetext with byte order mark (BOM) using specified encoding.
31+
Encodes codetext with byte order mark (BOM), using specified encoding: like UTF8, UTF16, UTF32, e.t.c.. 1D barcodes should use Encoding.ASCII or ISO/IEC 8859-1 - Encoding.GetEncoding(28591). 2D barcodes should use Encoding.UTF8.
3232

3333
```csharp
3434
public void SetCodeText(string codeText, Encoding encoding)
@@ -39,6 +39,86 @@ public void SetCodeText(string codeText, Encoding encoding)
3939
| codeText | String | CodeText string |
4040
| encoding | Encoding | Applied encoding |
4141

42+
## Examples
43+
44+
This sample shows how to use SetCodeText with 1D and 2D barcodes
45+
46+
```csharp
47+
[C#]
48+
//Encode codetext of 1D barcodes with 7-bit ASCII encoding, byte order mark (BOM) is absent
49+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
50+
{
51+
gen.SetCodeText("123ABCD", Encoding.ASCII);
52+
gen.Save("barcode.png", BarCodeImageFormat.Png);
53+
}
54+
//Encode codetext of 1D barcodes with 8-bit ISO/IEC 8859-1 encoding, byte order mark (BOM) is absent
55+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
56+
{
57+
gen.SetCodeText("123ABCD", Encoding.GetEncoding(28591));
58+
gen.Save("barcode.png", BarCodeImageFormat.Png);
59+
}
60+
//Encode codetext of 2D barcodes with UTF8 encoding with byte order mark (BOM)
61+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
62+
{
63+
gen.SetCodeText("123ABCD", Encoding.UTF8);
64+
gen.Save("barcode.png", BarCodeImageFormat.Png);
65+
}
66+
```
67+
68+
### See Also
69+
70+
* class [BarcodeGenerator](../)
71+
* namespace [Aspose.BarCode.Generation](../../../aspose.barcode.generation/)
72+
* assembly [Aspose.BarCode](../../../)
73+
74+
---
75+
76+
## SetCodeText(string, Encoding, bool) {#setcodetext_2}
77+
78+
Encodes codetext with optional byte order mark (BOM) insertion, using specified encoding: like UTF8, UTF16, UTF32, e.t.c.. 1D barcodes should use Encoding.ASCII or ISO/IEC 8859-1 - Encoding.GetEncoding(28591). 2D barcodes should use Encoding.UTF8.
79+
80+
```csharp
81+
public void SetCodeText(string codeText, Encoding encoding, bool insertBOM)
82+
```
83+
84+
| Parameter | Type | Description |
85+
| --- | --- | --- |
86+
| codeText | String | CodeText string |
87+
| encoding | Encoding | Applied encoding |
88+
| insertBOM | Boolean | flag indicates insertion of the Encoding byte order mark (BOM). In case, the Encoding requires byte order mark (BOM) insertion: like UTF8, UTF16, UTF32, e.t.c. and flag is set to true, the BOM is added, in case of setting flag to false, the BOM insertion is ignored. |
89+
90+
## Examples
91+
92+
This sample shows how to use SetCodeText with 1D and 2D barcodes
93+
94+
```csharp
95+
[C#]
96+
//Encode codetext of 1D barcodes with 7-bit ASCII encoding, byte order mark (BOM) is absent
97+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
98+
{
99+
gen.SetCodeText("123ABCD", Encoding.ASCII, true);
100+
gen.Save("barcode.png", BarCodeImageFormat.Png);
101+
}
102+
//Encode codetext of 1D barcodes with 8-bit ISO/IEC 8859-1 encoding, byte order mark (BOM) is absent
103+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
104+
{
105+
gen.SetCodeText("123ABCD", Encoding.GetEncoding(28591), true);
106+
gen.Save("barcode.png", BarCodeImageFormat.Png);
107+
}
108+
//Encode codetext of 2D barcodes with UTF8 encoding with byte order mark (BOM)
109+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
110+
{
111+
gen.SetCodeText("123ABCD", Encoding.UTF8, true);
112+
gen.Save("barcode.png", BarCodeImageFormat.Png);
113+
}
114+
//Encode codetext of 2D barcodes with UTF8 encoding without byte order mark (BOM)
115+
using (BarcodeGenerator gen = new BarcodeGenerator(EncodeTypes.Code128))
116+
{
117+
gen.SetCodeText("123ABCD", Encoding.UTF8, false);
118+
gen.Save("barcode.png", BarCodeImageFormat.Png);
119+
}
120+
```
121+
42122
### See Also
43123

44124
* class [BarcodeGenerator](../)

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,12 @@ public enum DataMatrixEncodeMode
2020
| --- | --- | --- |
2121
| Auto | `0` | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
2222
| ASCII | `1` | Encodes one alphanumeric or two numeric characters per byte |
23-
| Bytes | `6` | Encode 8 bit values |
23+
| Bytes | `6` | *This property is obsolete and will be removed in future releases. Instead, use Base256 option.* Encode 8 bit values |
2424
| C40 | `8` | Uses C40 encoding. Encodes Upper-case alphanumeric, Lower case and special characters |
2525
| Text | `9` | Uses Text encoding. Encodes Lower-case alphanumeric, Upper case and special characters |
2626
| EDIFACT | `10` | Uses EDIFACT encoding. Uses six bits per character, encodes digits, upper-case letters, and many punctuation marks, but has no support for lower-case letters. |
2727
| ANSIX12 | `11` | Uses ANSI X12 encoding. |
28-
| ExtendedCodetext | `12` | ExtendedCodetext mode allows to manually switch encodation schemes and ECI encodings in codetext. |
28+
| ExtendedCodetext | `12` | *This property is obsolete and will be removed in future releases. Instead, use the 'Extended' encode mode.* ExtendedCodetext mode allows to manually switch encodation schemes and ECI encodings in codetext. |
2929
| Extended | `13` | ExtendedCodetext mode allows to manually switch encodation schemes and ECI encodings in codetext. |
3030
| Base256 | `14` | Encode 8 bit values |
3131
| Binary | `15` | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public int Columns { get; set; }
1818
### See Also
1919

2020
* class [DataMatrixParameters](../)
21-
* namespace [Aspose.BarCode.Generation](../../datamatrixparameters/)
21+
* namespace [Aspose.BarCode.Generation](../../../aspose.barcode.generation/)
2222
* assembly [Aspose.BarCode](../../../)
2323

2424

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public int Rows { get; set; }
1818
### See Also
1919

2020
* class [DataMatrixParameters](../)
21-
* namespace [Aspose.BarCode.Generation](../../datamatrixparameters/)
21+
* namespace [Aspose.BarCode.Generation](../../../aspose.barcode.generation/)
2222
* assembly [Aspose.BarCode](../../../)
2323

2424

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ public enum DotCodeEncodeMode
1919
| Name | Value | Description |
2020
| --- | --- | --- |
2121
| Auto | `0` | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
22-
| Bytes | `1` | Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
23-
| ExtendedCodetext | `2` | Extended mode which supports multi ECI modes. |
22+
| Bytes | `1` | *This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method to convert the message to byte array with specified encoding.* Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
23+
| ExtendedCodetext | `2` | *This property is obsolete and will be removed in future releases. Instead, use the 'Extended' encode mode.* Extended mode which supports multi ECI modes. |
2424
| Binary | `3` | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
2525
| ECI | `4` | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |
2626
| Extended | `5` | Extended mode which supports multi ECI modes. |

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,8 @@ public enum MaxiCodeEncodeMode
1919
| Name | Value | Description |
2020
| --- | --- | --- |
2121
| Auto | `0` | In Auto mode, the CodeText is encoded with maximum data compactness. Unicode characters are re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. |
22-
| Bytes | `1` | Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
23-
| ExtendedCodetext | `2` | Extended mode which supports multi ECI modes. |
22+
| Bytes | `1` | *This property is obsolete and will be removed in future releases. Instead, use the 'SetCodeText' method to convert the message to byte array with specified encoding.* Encode codetext as plain bytes. If it detects any Unicode character, the character will be encoded as two bytes, lower byte first. |
23+
| ExtendedCodetext | `2` | *This property is obsolete and will be removed in future releases. Instead, use the 'Extended' encode mode.* Extended mode which supports multi ECI modes. |
2424
| Extended | `3` | Extended mode which supports multi ECI modes. |
2525
| Binary | `4` | In Binary mode, the CodeText is encoded with maximum data compactness. If a Unicode character is found, an exception is thrown. |
2626
| ECI | `5` | In ECI mode, the entire message is re-encoded in the ECIEncoding specified encoding with the insertion of an ECI identifier. If a character is found that is not supported by the selected ECI encoding, an exception is thrown. Please note that some old (pre 2006) scanners may not support this mode. |

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ public enum Pdf417CompactionMode
1919

2020
| Name | Value | Description |
2121
| --- | --- | --- |
22-
| Auto | `0` | auto detect compaction mode |
23-
| Text | `1` | text compaction |
24-
| Numeric | `2` | numeric compaction mode |
25-
| Binary | `3` | binary compaction mode |
22+
| Auto | `0` | *This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode.Auto property.* auto detect compaction mode |
23+
| Text | `1` | *This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode.Auto property for maximum data compactness.* text compaction |
24+
| Numeric | `2` | *This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode.Auto property for maximum data compactness.* numeric compaction mode |
25+
| Binary | `3` | *This property is obsolete and will be removed in future releases. Instead, use the Pdf417EncodeMode.Binary property.* binary compaction mode |
2626

2727
### See Also
2828

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ public Pdf417CompactionMode Pdf417CompactionMode { get; set; }
1919

2020
* enum [Pdf417CompactionMode](../../pdf417compactionmode/)
2121
* class [Pdf417Parameters](../)
22-
* namespace [Aspose.BarCode.Generation](../../pdf417parameters/)
22+
* namespace [Aspose.BarCode.Generation](../../../aspose.barcode.generation/)
2323
* assembly [Aspose.BarCode](../../../)
2424

2525

0 commit comments

Comments
 (0)