visit_field_start method

visit_field_start(field_start)

Called when a field starts in the document.

def visit_field_start(self, field_start: aspose.words.fields.FieldStart):
    ...
ParameterTypeDescription
field_startFieldStartThe object that is being visited.

Remarks

A field in a Word document consists of a field code and field value.

For example, a field that displays a page number can be represented as follows:

[FieldStart]PAGE[FieldSeparator]98[FieldEnd]

The field separator separates field code from field value in the document. Note that some fields have only field code and do not have field separator and field value.

Fields can be nested.

Returns

A VisitorAction value that specifies how to continue the enumeration.

See Also