FieldBuilder constructor

FieldBuilder(field_type)

Initializes an instance of the FieldBuilder class.

def __init__(self, field_type: aspose.words.fields.FieldType):
    ...
ParameterTypeDescription
field_typeFieldTypeThe type of the field to build.

Examples

Shows how to create and insert a field using a field builder.

doc = aw.Document()

# A convenient way of adding text content to a document is with a document builder.
builder = aw.DocumentBuilder(doc)
builder.write(" Hello world! This text is one Run, which is an inline node.")

# Fields have their builder, which we can use to construct a field code piece by piece.
# In this case, we will construct a BARCODE field representing a US postal code,
# and then insert it in front of a Run.
field_builder = aw.fields.FieldBuilder(aw.fields.FieldType.FIELD_BARCODE)
field_builder.add_argument("90210")
field_builder.add_switch("\\f", "A")
field_builder.add_switch("\\u")

field_builder.build_and_insert(doc.first_section.body.first_paragraph.runs[0])

doc.update_fields()
doc.save(ARTIFACTS_DIR + "Field.create_with_field_builder.docx")

See Also

FieldBuilder.add_argument method