FieldBarcode class
FieldBarcode class
Implements the BARCODE field. To learn more, visit the Working with Fields documentation article.
Remarks
Inserts a postal barcode in a machine-readable form of address used by the U.S. Postal Service.
Inheritance: FieldBarcode → Field
Constructors
| Name | Description |
|---|---|
| FieldBarcode() | The default constructor. |
Properties
| Name | Description |
|---|---|
| display_result | Gets the text that represents the displayed field result. (Inherited from Field) |
| end | Gets the node that represents the field end. (Inherited from Field) |
| facing_identification_mark | Gets or sets the type of a Facing Identification Mark (FIM) to insert. |
| format | Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field) |
| is_bookmark | Gets or sets whether FieldBarcode.postal_address is the name of a bookmark. |
| is_dirty | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. (Inherited from Field) |
| is_locked | Gets or sets whether the field is locked (should not recalculate its result). (Inherited from Field) |
| is_us_postal_address | Gets or sets whether FieldBarcode.postal_address is a U.S. postal address. |
| locale_id | Gets or sets the LCID of the field. (Inherited from Field) |
| postal_address | Gets or sets the postal address used for generating a barcode or the name of the bookmark that refers to it. |
| result | Gets or sets text that is between the field separator and field end. (Inherited from Field) |
| separator | Gets the node that represents the field separator. Can be None.(Inherited from Field) |
| start | Gets the node that represents the start of the field. (Inherited from Field) |
| type | Gets the Microsoft Word field type. (Inherited from Field) |
Methods
| Name | Description |
|---|---|
| get_field_code() | 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. (Inherited from Field) |
| get_field_code(include_child_field_codes) | Returns text between field start and field separator (or field end if there is no separator). (Inherited from Field) |
| 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 None.(Inherited from Field) |
| unlink() | Performs the field unlink. (Inherited from Field) |
| update() | Performs the field update. Throws if the field is being updated already. (Inherited from Field) |
| update(ignore_merge_format) | Performs a field update. Throws if the field is being updated already. (Inherited from Field) |
Examples
Shows how to use the BARCODE field to display U.S. ZIP codes in the form of a barcode.
doc = aw.Document()
builder = aw.DocumentBuilder(doc=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:
field = builder.insert_field(field_type=aw.fields.FieldType.FIELD_BARCODE, update_field=True).as_field_barcode()
# This value needs to be a valid ZIP code.
field.postal_address = '96801'
field.is_us_postal_address = True
field.facing_identification_mark = 'C'
self.assertEqual(' BARCODE 96801 \\u \\f C', field.get_field_code())
builder.insert_break(aw.BreakType.LINE_BREAK)
# 2 - Reference a bookmark that stores the value that this barcode will display:
field = builder.insert_field(field_type=aw.fields.FieldType.FIELD_BARCODE, update_field=True).as_field_barcode()
field.postal_address = 'BarcodeBookmark'
field.is_bookmark = True
self.assertEqual(' BARCODE BarcodeBookmark \\b', field.get_field_code())
# The bookmark that the BARCODE field references in its PostalAddress property
# need to contain nothing besides the valid ZIP code.
builder.insert_break(aw.BreakType.PAGE_BREAK)
builder.start_bookmark('BarcodeBookmark')
builder.writeln('968877')
builder.end_bookmark('BarcodeBookmark')
doc.save(file_name=ARTIFACTS_DIR + 'Field.BARCODE.docx')
See Also
- module aspose.words.fields
- class Field