FieldToa
Overview
FieldToa is a class in Aspose.Words FOSS for .NET.
Inherits from: Field, IFieldCodeTokenInfoProvider.
Implements the TOA field.
This class provides 4 methods for working with FieldToa objects in .NET programs.
Available methods include: GetFieldCode, Remove, Unlink, Update.
All public members are accessible to any .NET application after installing the Aspose.Words FOSS for .NET package.
Properties: BookmarkName, DisplayResult, End, EntryCategory, EntrySeparator, Format, and 14 more.
Properties
| Name | Type | Access | Description |
|---|---|---|---|
BookmarkName | string | Read/Write | Gets or sets the name of the bookmark that marks the portion of the document used to build the table. |
EntryCategory | string | Read/Write | Gets or sets the integral category for entries included in the table. |
SequenceSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate sequence numbers and page numbers. |
EntrySeparator | string | Read/Write | Gets or sets the character sequence that is used to separate a table of authorities entry and its page number. |
RemoveEntryFormatting | bool | Read/Write | Gets or sets whether to remove the formatting of the entry text in the document from the entry in the table of authorities. |
PageRangeSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate the start and end of a page range. |
UseHeading | bool | Read/Write | Gets or sets whether to include the category heading for the entries in a table of authorities. |
PageNumberListSeparator | string | Read/Write | Gets or sets the character sequence that is used to separate two page numbers in a page number list. |
UsePassim | bool | Read/Write | Gets or 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. |
SequenceName | string | Read/Write | Gets or sets the name of a sequence whose number is included with the page number. |
Start | FieldStart | Read | Gets the node that represents the start of the field. |
Separator | FieldSeparator | Read | Gets the node that represents the field separator. |
End | FieldEnd | Read | Gets the node that represents the field end. |
Type | FieldType | Read | Gets the Microsoft Word field type. |
Result | string | Read/Write | Gets or sets text that is between the field separator and field end. |
DisplayResult | string | Read | Gets the text that represents the displayed field result. |
IsLocked | bool | Read/Write | Gets or sets whether the field is locked (should not recalculate its result). |
IsDirty | bool | Read/Write | Gets or sets whether the current result of the field is no longer correct (stale) due to other modifications made to the document. |
Format | FieldFormat | Read | Gets a FieldFormat object that provides typed access to field’s formatting. |
LocaleId | int | Read/Write | Gets or sets the LCID of the field. |
Methods
| Signature | Description |
|---|---|
GetFieldCode() | Returns text between field start and field separator (or field end if there is no separator). |
Remove() | Removes the field from the document. |
Update() | Performs the field update. |
Unlink() | Performs the field unlink. |