|
Aspose::Words::Fields::FieldDisplayBarcode Class Reference
Implements the DISPLAYBARCODE field.
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
#include <Aspose.Words.Cpp/Fields/FieldDisplayBarcode.h>
Inheritance diagram for Aspose::Words::Fields::FieldDisplayBarcode:
Public Member Functions | |
| bool | get_AddStartStopChar () |
| Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39. More... | |
| String | get_BackgroundColor () |
| Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]. More... | |
| String | get_BarcodeType () |
| Gets or sets the barcode type (QR, etc.) More... | |
| String | get_BarcodeValue () |
| Gets or sets the barcode value. More... | |
| String | get_CaseCodeStyle () |
| Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]. More... | |
| bool | get_DisplayText () |
| Gets or sets whether to display barcode data (text) along with image. More... | |
| String | get_ErrorCorrectionLevel () |
| Gets or sets an error correction level of QR Code. Valid values are [0, 3]. More... | |
| bool | get_FixCheckDigit () |
| Gets or sets whether to fix the check digit if it’s invalid. More... | |
| String | get_ForegroundColor () |
| Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]. More... | |
| String | get_PosCodeStyle () |
| Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE]. More... | |
| String | get_ScalingFactor () |
| Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]. More... | |
| String | get_SymbolHeight () |
| Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch). More... | |
| String | get_SymbolRotation () |
| Gets or sets the rotation of the barcode symbol. Valid values are [0, 3]. More... | |
| FieldSwitchType | GetSwitchType (String switchName) override |
| virtual const TypeInfo & | GetType () const override |
| virtual bool | Is (const TypeInfo &target) const override |
| void | set_AddStartStopChar (bool value) |
| Setter for get_AddStartStopChar. More... | |
| void | set_BackgroundColor (String value) |
| Setter for get_BackgroundColor. More... | |
| void | set_BarcodeType (String value) |
| Setter for get_BarcodeType. More... | |
| void | set_BarcodeValue (String value) |
| Setter for get_BarcodeValue. More... | |
| void | set_CaseCodeStyle (String value) |
| Setter for get_CaseCodeStyle. More... | |
| void | set_DisplayText (bool value) |
| Setter for get_DisplayText. More... | |
| void | set_ErrorCorrectionLevel (String value) |
| Setter for get_ErrorCorrectionLevel. More... | |
| void | set_FixCheckDigit (bool value) |
| Setter for get_FixCheckDigit. More... | |
| void | set_ForegroundColor (String value) |
| Setter for get_ForegroundColor. More... | |
| void | set_PosCodeStyle (String value) |
| Setter for get_PosCodeStyle. More... | |
| void | set_ScalingFactor (String value) |
| Setter for get_ScalingFactor. More... | |
| void | set_SymbolHeight (String value) |
| Setter for get_SymbolHeight. More... | |
| void | set_SymbolRotation (String value) |
| Setter for get_SymbolRotation. More... | |
| Public Member Functions inherited from Field | |
| String | get_DisplayResult () |
| Gets the text that represents the displayed field result. More... | |
| SharedPtr< FieldEnd > | get_End () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldEnd > | get_FieldEnd () const |
| Gets the node that represents the field end. More... | |
| SharedPtr< FieldStart > | get_FieldStart () const |
| Gets the node that represents the start of the field. More... | |
| SharedPtr< FieldFormat > | get_Format () |
| Gets a FieldFormat object that provides typed access to field's formatting. More... | |
| bool | get_IsDirty () |
| Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. More... | |
| bool | get_IsLocked () |
| Gets or sets whether the field is locked (should not recalculate its result). More... | |
| int32_t | get_LocaleId () |
| Gets or sets the LCID of the field. More... | |
| String | get_Result () |
| Gets or sets text that is between the field separator and field end. More... | |
| SharedPtr< FieldSeparator > | get_Separator () |
| Gets the node that represents the field separator. Can be null. More... | |
| SharedPtr< FieldStart > | get_Start () const |
| Gets the node that represents the start of the field. More... | |
| virtual FieldType | get_Type () |
| Gets the Microsoft Word field type. More... | |
| String | GetFieldCode () |
| Returns text between field start and field separator (or field end if there is no separator). Both field code and field result of child fields are included. More... | |
| String | GetFieldCode (bool includeChildFieldCodes) |
| Returns text between field start and field separator (or field end if there is no separator). More... | |
| SharedPtr< Node > | Remove () |
| Removes the field from the document. Returns a node right after the field. If the field's end is the last child of its parent node, returns its parent paragraph. If the field is already removed, returns null. More... | |
| void | set_IsDirty (bool value) |
| Setter for get_IsDirty. More... | |
| void | set_IsLocked (bool value) |
| Setter for get_IsLocked. More... | |
| void | set_LocaleId (int32_t value) |
| Setter for get_LocaleId. More... | |
| void | set_Result (String value) |
| Setter for get_Result. More... | |
| bool | Unlink () |
| Performs the field unlink. More... | |
| void | Update () |
| Performs the field update. Throws if the field is being updated already. More... | |
| void | Update (bool ignoreMergeFormat) |
| Performs a field update. Throws if the field is being updated already. More... | |
Static Public Member Functions | |
| static const TypeInfo & | Type () |
| Static Public Member Functions inherited from Field | |
| static const TypeInfo & | Type () |
Member Function Documentation
◆ get_AddStartStopChar()
| bool Aspose::Words::Fields::FieldDisplayBarcode::get_AddStartStopChar | ( | ) |
Gets or sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_BackgroundColor()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_BackgroundColor | ( | ) |
Gets or sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_BarcodeType()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_BarcodeType | ( | ) |
Gets or sets the barcode type (QR, etc.)
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_BarcodeValue()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_BarcodeValue | ( | ) |
Gets or sets the barcode value.
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_CaseCodeStyle()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_CaseCodeStyle | ( | ) |
Gets or sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_DisplayText()
| bool Aspose::Words::Fields::FieldDisplayBarcode::get_DisplayText | ( | ) |
Gets or sets whether to display barcode data (text) along with image.
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_ErrorCorrectionLevel()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_ErrorCorrectionLevel | ( | ) |
Gets or sets an error correction level of QR Code. Valid values are [0, 3].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_FixCheckDigit()
| bool Aspose::Words::Fields::FieldDisplayBarcode::get_FixCheckDigit | ( | ) |
Gets or sets whether to fix the check digit if it’s invalid.
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_ForegroundColor()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_ForegroundColor | ( | ) |
Gets or sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_PosCodeStyle()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_PosCodeStyle | ( | ) |
Gets or sets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_ScalingFactor()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_ScalingFactor | ( | ) |
Gets or sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_SymbolHeight()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_SymbolHeight | ( | ) |
Gets or sets the height of the symbol. The units are in TWIPS (1/1440 inch).
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ get_SymbolRotation()
| System::String Aspose::Words::Fields::FieldDisplayBarcode::get_SymbolRotation | ( | ) |
Gets or sets the rotation of the barcode symbol. Valid values are [0, 3].
- Examples
Shows how to insert a DISPLAYBARCODE field, and set its properties.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
auto field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
// Below are four types of barcodes, decorated in various ways, that the DISPLAYBARCODE field can display.
// 1 - QR code with custom colors:
field->set_BarcodeType(u"QR");
field->set_BarcodeValue(u"ABC123");
field->set_BackgroundColor(u"0xF8BD69");
field->set_ForegroundColor(u"0xB5413B");
field->set_ErrorCorrectionLevel(u"3");
field->set_ScalingFactor(u"250");
field->set_SymbolHeight(u"1000");
field->set_SymbolRotation(u"0");
ASSERT_EQ(u" DISPLAYBARCODE ABC123 QR \\b 0xF8BD69 \\f 0xB5413B \\q 3 \\s 250 \\h 1000 \\r 0", field->GetFieldCode());
builder->Writeln();
// 2 - EAN13 barcode, with the digits displayed below the bars:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"EAN13");
field->set_BarcodeValue(u"501234567890");
field->set_DisplayText(true);
field->set_PosCodeStyle(u"CASE");
field->set_FixCheckDigit(true);
ASSERT_EQ(u" DISPLAYBARCODE 501234567890 EAN13 \\t \\p CASE \\x", field->GetFieldCode());
builder->Writeln();
// 3 - CODE39 barcode:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"CODE39");
field->set_BarcodeValue(u"12345ABCDE");
field->set_AddStartStopChar(true);
ASSERT_EQ(u" DISPLAYBARCODE 12345ABCDE CODE39 \\d", field->GetFieldCode());
builder->Writeln();
// 4 - ITF4 barcode, with a specified case code:
field = System::DynamicCast<FieldDisplayBarcode>(builder->InsertField(FieldType::FieldDisplayBarcode, true));
field->set_BarcodeType(u"ITF14");
field->set_BarcodeValue(u"09312345678907");
field->set_CaseCodeStyle(u"STD");
ASSERT_EQ(u" DISPLAYBARCODE 09312345678907 ITF14 \\c STD", field->GetFieldCode());
doc->Save(ArtifactsDir + u"Field.DISPLAYBARCODE.docx");
◆ GetSwitchType()
|
override |
◆ GetType()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ Is()
|
overridevirtual |
Reimplemented from Aspose::Words::Fields::Field.
◆ set_AddStartStopChar()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_AddStartStopChar | ( | bool | value | ) |
◆ set_BackgroundColor()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_BackgroundColor | ( | System::String | value | ) |
◆ set_BarcodeType()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_BarcodeType | ( | System::String | value | ) |
◆ set_BarcodeValue()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_BarcodeValue | ( | System::String | value | ) |
◆ set_CaseCodeStyle()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_CaseCodeStyle | ( | System::String | value | ) |
◆ set_DisplayText()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_DisplayText | ( | bool | value | ) |
◆ set_ErrorCorrectionLevel()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_ErrorCorrectionLevel | ( | System::String | value | ) |
◆ set_FixCheckDigit()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_FixCheckDigit | ( | bool | value | ) |
◆ set_ForegroundColor()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_ForegroundColor | ( | System::String | value | ) |
◆ set_PosCodeStyle()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_PosCodeStyle | ( | System::String | value | ) |
◆ set_ScalingFactor()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_ScalingFactor | ( | System::String | value | ) |
◆ set_SymbolHeight()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_SymbolHeight | ( | System::String | value | ) |
◆ set_SymbolRotation()
| void Aspose::Words::Fields::FieldDisplayBarcode::set_SymbolRotation | ( | System::String | value | ) |
◆ Type()
|
static |