Aspose::Words::Fields::FieldTA class

FieldTA class

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

class FieldTA : public Field,
                public IFieldCodeTokenInfoProvider

Methods

MethodDescription
get_EntryCategory()Gets or sets the integral entry category, which is a number that corresponds to the order of categories.
get_IsBold()Gets whether to apply bold formatting to the page number for the entry.
get_IsItalic()Gets whether to apply italic formatting to the page number for the entry.
get_LongCitation()Gets the long citation for the entry.
get_PageRangeBookmarkName()Gets the name of the bookmark that marks a range of pages that is inserted as the entry’s page number.
get_ShortCitation()Gets the short citation for the entry.
set_EntryCategory(const System::String &)Sets the integral entry category, which is a number that corresponds to the order of categories.
set_IsBold(bool)Sets whether to apply bold formatting to the page number for the entry.
set_IsItalic(bool)Sets whether to apply italic formatting to the page number for the entry.
set_LongCitation(const System::String &)Sets the long citation for the entry.
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_ShortCitation(const System::String &)Sets the short citation for the 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).
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

Defines the text and page number for a table of authorities entry, which is used by a TOA field.

See Also