Aspose::Words::Fields::FieldXE class

FieldXE class

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

class FieldXE : public Aspose::Words::Fields::Field,
                public Aspose::Words::Fields::IFieldCodeTokenInfoProvider

Methods

MethodDescription
get_DisplayResult()Gets the text that represents the displayed field result.
get_End() constGets the node that represents the field end.
get_EntryType()Gets an index entry type.
get_FieldEnd() constGets the node that represents the field end.
get_FieldStart() constGets the node that represents the start of the field.
get_Format()Gets a FieldFormat object that provides typed access to field’s formatting.
get_IsBold()Gets whether to apply bold formatting to the entry’s page number.
get_IsDirty()Gets whether the current result of the field is no longer correct (stale) due to other modifications made to the document.
get_IsItalic()Gets whether to apply italic formatting to the entry’s page number.
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_PageNumberReplacement()Gets text used in place of a page number.
get_PageRangeBookmarkName()Gets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number.
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.
get_Text()Gets the text of the entry.
virtual get_Type() constGets the Microsoft Word field type.
get_Yomi()Gets the yomi (first phonetic character for sorting indexes) for the index entry.
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).
GetType() const override
Is(const System::TypeInfo&) const override
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.
set_EntryType(const System::String&)Sets an index entry type.
set_IsBold(bool)Sets whether to apply bold formatting to the entry’s page number.
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_IsItalic(bool)Sets whether to apply italic formatting to the entry’s page number.
set_IsLocked(bool)Setter for Aspose::Words::Fields::Field::get_IsLocked.
set_LocaleId(int32_t)Setter for Aspose::Words::Fields::Field::get_LocaleId.
set_PageNumberReplacement(const System::String&)Sets text used in place of a page number.
set_PageRangeBookmarkName(const System::String&)Sets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number.
set_Result(const System::String&)Setter for Aspose::Words::Fields::Field::get_Result.
set_Text(const System::String&)Sets the text of the entry.
set_Yomi(const System::String&)Sets the yomi (first phonetic character for sorting indexes) for the index entry.
static Type()
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.

See Also