is_us_postal_address property

FieldBarcode.is_us_postal_address property

Gets or sets whether FieldBarcode.postal_address is a U.S. postal address.

@property
def is_us_postal_address(self) -> bool:
    ...

@is_us_postal_address.setter
def is_us_postal_address(self, value: bool):
    ...

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)

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 postal_address property:
field = builder.insert_field(aw.fields.FieldType.FIELD_BARCODE, 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(aw.fields.FieldType.FIELD_BARCODE, 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 "postal_address" 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(ARTIFACTS_DIR + "Field.field_barcode.docx")

See Also

FieldBarcode.is_bookmark property FieldBarcode.postal_address property