Aspose::Words::Fields::FieldMergeBarcode class

FieldMergeBarcode class

Implements the MERGEBARCODE field. To learn more, visit the Working with Fields documentation article.

class FieldMergeBarcode : public Aspose::Words::Fields::Field,
                          public Aspose::Words::Fields::IFieldCodeTokenInfoProvider,
                          public Aspose::Words::Fields::IMergeFieldSurrogate

Methods

MethodDescription
get_AddStartStopChar()Gets whether to add Start/Stop characters for barcode types NW7 and CODE39.
get_BackgroundColor()Gets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].
get_BarcodeType()Gets the barcode type (QR, etc.)
get_BarcodeValue()Gets the barcode value.
get_CaseCodeStyle()Gets the style of a Case Code for barcode type ITF14. The valid values are [STD
get_DisplayResult()Gets the text that represents the displayed field result.
get_DisplayText()Gets whether to display barcode data (text) along with image.
get_End() overrideGets the node that represents the field end.
get_End() constGets the node that represents the field end.
get_ErrorCorrectionLevel()Gets an error correction level of QR Code. Valid values are [0, 3].
get_FieldEnd() constGets the node that represents the field end.
get_FieldStart() constGets the node that represents the start of the field.
get_FixCheckDigit()Gets whether to fix the check digit if it’s invalid.
get_ForegroundColor()Gets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].
get_Format()Gets a FieldFormat object that provides typed access to field’s formatting.
get_IsDirty()Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsLocked()Gets or sets whether the field is locked (should not recalculate its result).
get_LocaleId()Gets or sets the LCID of the field.
get_PosCodeStyle()Gets the style of a Point of Sale barcode (barcode types UPCA
get_Result()Gets or sets text that is between the field separator and field end.
get_ScalingFactor()Gets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].
get_Separator() overrideGets the node that represents the field separator. Can be null.
get_Start() overrideGets the node that represents the start of the field.
get_Start() constGets the node that represents the start of the field.
get_SymbolHeight()Gets the height of the symbol. The units are in TWIPS (1/1440 inch).
get_SymbolRotation()Gets the rotation of the barcode symbol. Valid values are [0, 3].
virtual get_Type() constGets the Microsoft Word field type.
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.
GetFieldCode(bool)Returns text between field start and field separator (or field end if there is no separator).
GetType() const override
Is(const System::TypeInfo&) const override
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.
set_AddStartStopChar(bool)Sets whether to add Start/Stop characters for barcode types NW7 and CODE39.
set_BackgroundColor(const System::String&)Sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].
set_BarcodeType(const System::String&)Sets the barcode type (QR, etc.)
set_BarcodeValue(const System::String&)Sets the barcode value.
set_CaseCodeStyle(const System::String&)Sets the style of a Case Code for barcode type ITF14. The valid values are [STD
set_DisplayText(bool)Sets whether to display barcode data (text) along with image.
set_ErrorCorrectionLevel(const System::String&)Sets an error correction level of QR Code. Valid values are [0, 3].
set_FixCheckDigit(bool)Sets whether to fix the check digit if it’s invalid.
set_ForegroundColor(const System::String&)Sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].
set_IsDirty(bool)Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
set_IsLocked(bool)Setter for Aspose::Words::Fields::Field::get_IsLocked.
set_LocaleId(int32_t)Setter for Aspose::Words::Fields::Field::get_LocaleId.
set_PosCodeStyle(const System::String&)Sets the style of a Point of Sale barcode (barcode types UPCA
set_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
set_ScalingFactor(const System::String&)Sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].
set_SymbolHeight(const System::String&)Sets the height of the symbol. The units are in TWIPS (1/1440 inch).
set_SymbolRotation(const System::String&)Sets the rotation of the barcode symbol. Valid values are [0, 3].
static Type()
Unlink()Performs the field unlink.
Update()Performs the field update. Throws if the field is being updated already.
Update(bool)Performs a field update. Throws if the field is being updated already.

See Also