Aspose::Words::Fields::FieldBarcode class
Contents
[
Hide
]FieldBarcode class
Implements the BARCODE field. To learn more, visit the Working with Fields documentation article.
class FieldBarcode : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
Method | Description |
---|---|
get_DisplayResult() | Gets the text that represents the displayed field result. |
get_End() const | Gets the node that represents the field end. |
get_FacingIdentificationMark() | Gets or sets the type of a Facing Identification Mark (FIM) to insert. |
get_FieldEnd() const | Gets the node that represents the field end. |
get_FieldStart() const | Gets the node that represents the start of the field. |
get_Format() | Gets a FieldFormat object that provides typed access to field’s formatting. |
get_IsBookmark() | Gets or sets whether PostalAddress is the name of a bookmark. |
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_IsUSPostalAddress() | Gets or sets whether PostalAddress is a U.S. postal address. |
get_LocaleId() | Gets or sets the LCID of the field. |
get_PostalAddress() | Gets or sets the postal address used for generating a barcode or the name of the bookmark that refers to it. |
get_Result() | Gets or sets text that is between the field separator and field end. |
get_Separator() | Gets the node that represents the field separator. Can be null. |
get_Start() const | Gets the node that represents the start of the field. |
virtual get_Type() const | Gets 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_FacingIdentificationMark(const System::String&) | Setter for Aspose::Words::Fields::FieldBarcode::get_FacingIdentificationMark. |
set_IsBookmark(bool) | Setter for Aspose::Words::Fields::FieldBarcode::get_IsBookmark. |
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_IsUSPostalAddress(bool) | Setter for Aspose::Words::Fields::FieldBarcode::get_IsUSPostalAddress. |
set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
set_PostalAddress(const System::String&) | Setter for Aspose::Words::Fields::FieldBarcode::get_PostalAddress. |
set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
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. |
Examples
Shows how to use the BARCODE field to display U.S. ZIP codes in the form of a barcode.
auto doc = MakeObject<Document>();
auto builder = MakeObject<DocumentBuilder>(doc);
builder->Writeln();
// Below are two ways of using BARCODE fields to display custom values as barcodes.
// 1 - Store the value that the barcode will display in the PostalAddress property:
auto field = System::ExplicitCast<FieldBarcode>(builder->InsertField(FieldType::FieldBarcode, true));
// This value needs to be a valid ZIP code.
field->set_PostalAddress(u"96801");
field->set_IsUSPostalAddress(true);
field->set_FacingIdentificationMark(u"C");
ASSERT_EQ(u" BARCODE 96801 \\u \\f C", field->GetFieldCode());
builder->InsertBreak(BreakType::LineBreak);
// 2 - Reference a bookmark that stores the value that this barcode will display:
field = System::ExplicitCast<FieldBarcode>(builder->InsertField(FieldType::FieldBarcode, true));
field->set_PostalAddress(u"BarcodeBookmark");
field->set_IsBookmark(true);
ASSERT_EQ(u" BARCODE BarcodeBookmark \\b", field->GetFieldCode());
// The bookmark that the BARCODE field references in its PostalAddress property
// need to contain nothing besides the valid ZIP code.
builder->InsertBreak(BreakType::PageBreak);
builder->StartBookmark(u"BarcodeBookmark");
builder->Writeln(u"968877");
builder->EndBookmark(u"BarcodeBookmark");
doc->Save(ArtifactsDir + u"Field.BARCODE.docx");
See Also
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++