Aspose::Words::Fields::FieldMergeSeq class

FieldMergeSeq class

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

class FieldMergeSeq : public Field

Methods

MethodDescription
GetFieldCode()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.
GetFieldCode(bool)Returns text between field start and field separator (or field end if there is no separator).
virtual 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 null.
Unlink()Performs the field unlink.
Update()Performs the field update. Throws if the field is being updated already.
Update(bool)Performs a field update. Throws if the field is being updated already.
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_Format()Gets a FieldFormat object that provides typed access to field’s formatting.
get_IsDirty()Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsLocked()Gets or sets whether the field is locked (should not recalculate its result).
get_LocaleId()Gets or sets the LCID of the field.
get_Result()Gets or sets text that is between the field separator and field end.
get_Separator()Gets the node that represents the field separator. Can be null.
get_Start() constGets the node that represents the start of the field.
virtual get_Type() constGets the Microsoft Word field type.
set_IsDirty(bool)Sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
set_IsLocked(bool)Sets whether the field is locked (should not recalculate its result).
set_LocaleId(int32_t)Sets the LCID of the field.
set_Result(const System::String &)Sets text that is between the field separator and field end.

Remarks

At the moment the MERGEREC and MERGESEQ fields implement the same functionality because we don’t know for sure how to skip records in Aspose.Words mail merge.

See Also