insert_field method

insert_field(field_type, update_field, ref_node, is_after)

Inserts a field into this paragraph.

def insert_field(self, field_type: aspose.words.fields.FieldType, update_field: bool, ref_node: aspose.words.Node, is_after: bool):
    ...

Parameter	Type	Description
field_type	FieldType	The type of the field to insert.
update_field	bool	Specifies whether to update the field immediately.
ref_node	Node	Reference node inside this paragraph (if refNode isNone, then appends to the end of the paragraph).
is_after	bool	Whether to insert the field after or before reference node.

Returns

A Field object that represents the inserted field.

insert_field(field_code, ref_node, is_after)

Inserts a field into this paragraph.

def insert_field(self, field_code: str, ref_node: aspose.words.Node, is_after: bool):
    ...

Parameter	Type	Description
field_code	str	The field code to insert (without curly braces).
ref_node	Node	Reference node inside this paragraph (if refNode isNone, then appends to the end of the paragraph).
is_after	bool	Whether to insert the field after or before reference node.

Returns

A Field object that represents the inserted field.

insert_field(field_code, field_value, ref_node, is_after)

Inserts a field into this paragraph.

def insert_field(self, field_code: str, field_value: str, ref_node: aspose.words.Node, is_after: bool):
    ...

Parameter	Type	Description
field_code	str	The field code to insert (without curly braces).
field_value	str	The field value to insert. Pass None for fields that do not have a value.
ref_node	Node	Reference node inside this paragraph (if refNode isNone, then appends to the end of the paragraph).
is_after	bool	Whether to insert the field after or before reference node.

Returns

A Field object that represents the inserted field.

Examples

Shows various ways of adding fields to a paragraph.

doc = aw.Document()
para = doc.first_section.body.first_paragraph

# Below are three ways of inserting a field into a paragraph.
# 1 -  Insert an AUTHOR field into a paragraph after one of the paragraph's child nodes:
run = aw.Run(doc)
run.text = "This run was written by "
para.append_child(run)

doc.built_in_document_properties.get_by_name("Author").value = "John Doe"
para.insert_field(aw.fields.FieldType.FIELD_AUTHOR, True, run, True)

# 2 -  Insert a QUOTE field after one of the paragraph's child nodes:
run = aw.Run(doc)
run.text = "."
para.append_child(run)

field = para.insert_field(" QUOTE \" Real value\" ", run, True)

# 3 -  Insert a QUOTE field before one of the paragraph's child nodes,
# and get it to display a placeholder value:
para.insert_field(" QUOTE \" Real value.\"", " Placeholder value.", field.start, False)

self.assertEqual(" Placeholder value.", doc.range.fields[1].result)

# This field will display its placeholder value until we update it.
doc.update_fields()

self.assertEqual(" Real value.", doc.range.fields[1].result)

doc.save(ARTIFACTS_DIR + "Paragraph.insert_field.docx")

See Also

• module aspose.words
• class Paragraph