Aspose::Words::Fields::FieldToa class
Contents
[
Hide
]FieldToa class
Implements the TOA field. To learn more, visit the Working with Fields documentation article.
class FieldToa : public Aspose::Words::Fields::Field,
public Aspose::Words::Fields::IFieldCodeTokenInfoProvider
Methods
| Method | Description |
|---|---|
| get_BookmarkName() | Gets the name of the bookmark that marks the portion of the document used to build the table. |
| get_DisplayResult() | Gets the text that represents the displayed field result. |
| get_End() const | Gets the node that represents the field end. |
| get_EntryCategory() | Gets the integral category for entries included in the table. |
| get_EntrySeparator() | Gets the character sequence that is used to separate a table of authorities entry and its page number. |
| get_FieldEnd() const | Gets the node that represents the field end. |
| get_FieldStart() const | Gets the node that represents the start of the field. |
| 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_PageNumberListSeparator() | Gets the character sequence that is used to separate two page numbers in a page number list. |
| get_PageRangeSeparator() | Gets the character sequence that is used to separate the start and end of a page range. |
| get_RemoveEntryFormatting() | Gets whether to remove the formatting of the entry text in the document from the entry in the table of authorities. |
| 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_SequenceName() | Gets the name of a sequence whose number is included with the page number. |
| get_SequenceSeparator() | Gets the character sequence that is used to separate sequence numbers and page numbers. |
| get_Start() const | Gets the node that represents the start of the field. |
| virtual get_Type() const | Gets the Microsoft Word field type. |
| get_UseHeading() | Gets whether to include the category heading for the entries in a table of authorities. |
| get_UsePassim() | Gets whether to replace five or more different page references to the same authority with “passim”, which is used to indicate that a word or passage occurs frequently in the work cited. |
| 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_BookmarkName(const System::String&) | Sets the name of the bookmark that marks the portion of the document used to build the table. |
| set_EntryCategory(const System::String&) | Sets the integral category for entries included in the table. |
| set_EntrySeparator(const System::String&) | Sets the character sequence that is used to separate a table of authorities entry and its page number. |
| set_IsDirty(bool) | Setter for Aspose::Words::Fields::Field::get_IsDirty. |
| set_IsLocked(bool) | Setter for Aspose::Words::Fields::Field::get_IsLocked. |
| set_LocaleId(int32_t) | Setter for Aspose::Words::Fields::Field::get_LocaleId. |
| set_PageNumberListSeparator(const System::String&) | Sets the character sequence that is used to separate two page numbers in a page number list. |
| set_PageRangeSeparator(const System::String&) | Sets the character sequence that is used to separate the start and end of a page range. |
| set_RemoveEntryFormatting(bool) | Sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities. |
| set_Result(const System::String&) | Setter for Aspose::Words::Fields::Field::get_Result. |
| set_SequenceName(const System::String&) | Sets the name of a sequence whose number is included with the page number. |
| set_SequenceSeparator(const System::String&) | Sets the character sequence that is used to separate sequence numbers and page numbers. |
| set_UseHeading(bool) | Sets whether to include the category heading for the entries in a table of authorities. |
| set_UsePassim(bool) | Sets whether to replace five or more different page references to the same authority with “passim”, which is used to indicate that a word or passage occurs frequently in the work cited. |
| 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
- Class Field
- Namespace Aspose::Words::Fields
- Library Aspose.Words for C++