search/mag_sel search/close
Aspose::Words::Fields::FieldMergeBarcode Class Reference

Implements the MERGEBARCODE field.

#include <Aspose.Words.Cpp/Fields/FieldMergeBarcode.h>

+ Inheritance diagram for Aspose::Words::Fields::FieldMergeBarcode:

Public Member Functions

bool CanWorkAsMergeField () override
 
bool get_AddStartStopChar ()
 Gets whether to add Start/Stop characters for barcode types NW7 and CODE39. More...
 
String get_BackgroundColor ()
 Gets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]. More...
 
String get_BarcodeType ()
 Gets the barcode type (QR, etc.) More...
 
String get_BarcodeValue ()
 Gets the barcode value. More...
 
String get_CaseCodeStyle ()
 Gets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]. More...
 
bool get_DisplayText ()
 Gets whether to display barcode data (text) along with image. More...
 
SharedPtr< FieldEndget_End () override
 Gets the node that represents the field end. More...
 
String get_ErrorCorrectionLevel ()
 Gets an error correction level of QR Code. Valid values are [0, 3]. More...
 
bool get_FixCheckDigit ()
 Gets whether to fix the check digit if it’s invalid. More...
 
String get_ForegroundColor ()
 Gets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]. More...
 
String get_PosCodeStyle ()
 Gets 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 a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]. More...
 
SharedPtr< FieldSeparatorget_Separator () override
 Gets the node that represents the field separator. Can be null. More...
 
SharedPtr< FieldStartget_Start () override
 Gets the node that represents the start of the field. More...
 
String get_SymbolHeight ()
 Gets the height of the symbol. The units are in TWIPS (1/1440 inch). More...
 
String get_SymbolRotation ()
 Gets the rotation of the barcode symbol. Valid values are [0, 3]. More...
 
String GetMergeFieldName () override
 
FieldSwitchType GetSwitchType (String switchName) override
 
virtual const TypeInfoGetType () const override
 
virtual bool Is (const TypeInfo &target) const override
 
bool IsMergeValueRequired () override
 
void set_AddStartStopChar (bool value)
 Sets whether to add Start/Stop characters for barcode types NW7 and CODE39. More...
 
void set_BackgroundColor (String value)
 Sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]. More...
 
void set_BarcodeType (String value)
 Sets the barcode type (QR, etc.) More...
 
void set_BarcodeValue (String value)
 Sets the barcode value. More...
 
void set_CaseCodeStyle (String value)
 Sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD]. More...
 
void set_DisplayText (bool value)
 Sets whether to display barcode data (text) along with image. More...
 
void set_ErrorCorrectionLevel (String value)
 Sets an error correction level of QR Code. Valid values are [0, 3]. More...
 
void set_FixCheckDigit (bool value)
 Sets whether to fix the check digit if it’s invalid. More...
 
void set_ForegroundColor (String value)
 Sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF]. More...
 
void set_PosCodeStyle (String value)
 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...
 
void set_ScalingFactor (String value)
 Sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000]. More...
 
void set_SymbolHeight (String value)
 Sets the height of the symbol. The units are in TWIPS (1/1440 inch). More...
 
void set_SymbolRotation (String value)
 Sets the rotation of the barcode symbol. Valid values are [0, 3]. More...
 
- Public Member Functions inherited from Field
String get_DisplayResult ()
 Gets the text that represents the displayed field result. More...
 
SharedPtr< FieldEndget_End () const
 Gets the node that represents the field end. More...
 
SharedPtr< FieldEndget_FieldEnd () const
 Gets the node that represents the field end. More...
 
SharedPtr< FieldStartget_FieldStart () const
 Gets the node that represents the start of the field. More...
 
SharedPtr< FieldFormatget_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< FieldSeparatorget_Separator ()
 Gets the node that represents the field separator. Can be null. More...
 
SharedPtr< FieldStartget_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< NodeRemove ()
 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 TypeInfoType ()
 
- Static Public Member Functions inherited from Field
static const TypeInfoType ()
 

Member Function Documentation

◆ CanWorkAsMergeField()

bool Aspose::Words::Fields::FieldMergeBarcode::CanWorkAsMergeField ( )
override

◆ get_AddStartStopChar()

bool Aspose::Words::Fields::FieldMergeBarcode::get_AddStartStopChar ( )

Gets whether to add Start/Stop characters for barcode types NW7 and CODE39.

◆ get_BackgroundColor()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_BackgroundColor ( )

Gets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].

◆ get_BarcodeType()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_BarcodeType ( )

Gets the barcode type (QR, etc.)

◆ get_BarcodeValue()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_BarcodeValue ( )

Gets the barcode value.

◆ get_CaseCodeStyle()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_CaseCodeStyle ( )

Gets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD].

◆ get_DisplayText()

bool Aspose::Words::Fields::FieldMergeBarcode::get_DisplayText ( )

Gets whether to display barcode data (text) along with image.

◆ get_End()

System::SharedPtr<Aspose::Words::Fields::FieldEnd> Aspose::Words::Fields::FieldMergeBarcode::get_End ( )
override

Gets the node that represents the field end.

◆ get_ErrorCorrectionLevel()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_ErrorCorrectionLevel ( )

Gets an error correction level of QR Code. Valid values are [0, 3].

◆ get_FixCheckDigit()

bool Aspose::Words::Fields::FieldMergeBarcode::get_FixCheckDigit ( )

Gets whether to fix the check digit if it’s invalid.

◆ get_ForegroundColor()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_ForegroundColor ( )

Gets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].

◆ get_PosCodeStyle()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_PosCodeStyle ( )

Gets the style of a Point of Sale barcode (barcode types UPCA|UPCE|EAN13|EAN8). The valid values (case insensitive) are [STD|SUP2|SUP5|CASE].

◆ get_ScalingFactor()

System::String Aspose::Words::Fields::FieldMergeBarcode::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()

System::SharedPtr<Aspose::Words::Fields::FieldSeparator> Aspose::Words::Fields::FieldMergeBarcode::get_Separator ( )
override

Gets the node that represents the field separator. Can be null.

◆ get_Start()

System::SharedPtr<Aspose::Words::Fields::FieldStart> Aspose::Words::Fields::FieldMergeBarcode::get_Start ( )
override

Gets the node that represents the start of the field.

◆ get_SymbolHeight()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_SymbolHeight ( )

Gets the height of the symbol. The units are in TWIPS (1/1440 inch).

◆ get_SymbolRotation()

System::String Aspose::Words::Fields::FieldMergeBarcode::get_SymbolRotation ( )

Gets the rotation of the barcode symbol. Valid values are [0, 3].

◆ GetMergeFieldName()

System::String Aspose::Words::Fields::FieldMergeBarcode::GetMergeFieldName ( )
override

◆ GetSwitchType()

Aspose::Words::Fields::FieldSwitchType Aspose::Words::Fields::FieldMergeBarcode::GetSwitchType ( System::String  switchName)
override

◆ GetType()

virtual const System::TypeInfo& Aspose::Words::Fields::FieldMergeBarcode::GetType ( ) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ Is()

virtual bool Aspose::Words::Fields::FieldMergeBarcode::Is ( const System::TypeInfo target) const
overridevirtual

Reimplemented from Aspose::Words::Fields::Field.

◆ IsMergeValueRequired()

bool Aspose::Words::Fields::FieldMergeBarcode::IsMergeValueRequired ( )
override

◆ set_AddStartStopChar()

void Aspose::Words::Fields::FieldMergeBarcode::set_AddStartStopChar ( bool  value)

Sets whether to add Start/Stop characters for barcode types NW7 and CODE39.

◆ set_BackgroundColor()

void Aspose::Words::Fields::FieldMergeBarcode::set_BackgroundColor ( System::String  value)

Sets the background color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].

◆ set_BarcodeType()

void Aspose::Words::Fields::FieldMergeBarcode::set_BarcodeType ( System::String  value)

Sets the barcode type (QR, etc.)

◆ set_BarcodeValue()

void Aspose::Words::Fields::FieldMergeBarcode::set_BarcodeValue ( System::String  value)

Sets the barcode value.

◆ set_CaseCodeStyle()

void Aspose::Words::Fields::FieldMergeBarcode::set_CaseCodeStyle ( System::String  value)

Sets the style of a Case Code for barcode type ITF14. The valid values are [STD|EXT|ADD].

◆ set_DisplayText()

void Aspose::Words::Fields::FieldMergeBarcode::set_DisplayText ( bool  value)

Sets whether to display barcode data (text) along with image.

◆ set_ErrorCorrectionLevel()

void Aspose::Words::Fields::FieldMergeBarcode::set_ErrorCorrectionLevel ( System::String  value)

Sets an error correction level of QR Code. Valid values are [0, 3].

◆ set_FixCheckDigit()

void Aspose::Words::Fields::FieldMergeBarcode::set_FixCheckDigit ( bool  value)

Sets whether to fix the check digit if it’s invalid.

◆ set_ForegroundColor()

void Aspose::Words::Fields::FieldMergeBarcode::set_ForegroundColor ( System::String  value)

Sets the foreground color of the barcode symbol. Valid values are in the range [0, 0xFFFFFF].

◆ set_PosCodeStyle()

void Aspose::Words::Fields::FieldMergeBarcode::set_PosCodeStyle ( System::String  value)

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].

◆ set_ScalingFactor()

void Aspose::Words::Fields::FieldMergeBarcode::set_ScalingFactor ( System::String  value)

Sets a scaling factor for the symbol. The value is in whole percentage points and the valid values are [10, 1000].

◆ set_SymbolHeight()

void Aspose::Words::Fields::FieldMergeBarcode::set_SymbolHeight ( System::String  value)

Sets the height of the symbol. The units are in TWIPS (1/1440 inch).

◆ set_SymbolRotation()

void Aspose::Words::Fields::FieldMergeBarcode::set_SymbolRotation ( System::String  value)

Sets the rotation of the barcode symbol. Valid values are [0, 3].

◆ Type()

static const System::TypeInfo& Aspose::Words::Fields::FieldMergeBarcode::Type ( )
static