FieldSkipIf class

Implements the SKIPIF field. To learn more, visit the Working with Fields documentation article.

Remarks

Compares the values designated by the expressions FieldSkipIf.left_expression and FieldSkipIf.right_expression in comparison using the operator designated by FieldSkipIf.comparison_operator. If the comparison is true, SKIPIF cancels the current merge document, moves to the next data record in the data source, and starts a new merge document. If the comparison is false, the current merge document is continued.

Inheritance: FieldSkipIf → Field

Constructors

Name	Description
FieldSkipIf()	The default constructor.

Properties

Name	Description
comparison_operator	Gets or sets the comparison operator.
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)
format	Gets a FieldFormat object that provides typed access to field’s formatting. (Inherited from Field)
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)
left_expression	Gets or sets the left part of the comparison expression.
locale_id	Gets or sets the LCID of the field. (Inherited from Field)
result	Gets or sets text that is between the field separator and field end. (Inherited from Field)
right_expression	Gets or sets the right part of the comparison expression.
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)

FieldSkipIf class