[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.Fields.TaFieldOptions

TaFieldOptions Class

Represents options for configuring a TA (Table of Authorities) field.

Inheritance
TaFieldOptions
Implements
Namespace: GrapeCity.Documents.Word.Fields
Assembly: DS.Documents.Word.dll
Syntax
public class TaFieldOptions : BaseFieldOptions, IFieldOptions
Public Class TaFieldOptions
    Inherits BaseFieldOptions
    Implements IFieldOptions
Remarks

A TA field defines the text and page number for a Table of Authorities entry, which is used by a TOA field to generate the final table.

Constructors

Name Description
TaFieldOptions(ComplexField)

Initializes a new instance of the TaFieldOptions class.

TaFieldOptions(DocumentBase)

Initializes a new instance of the TaFieldOptions class.

TaFieldOptions(SimpleField)

Initializes a new instance of the TaFieldOptions class.

Properties

Name Description
Bold

Gets or sets whether to apply bold formatting to the entry's page number.

However, if the table of authorities style for that entry is already bold, the true value removes that formatting for that entry.

Default value is false.

Category

Gets or sets the numeric category assigned to the entry in a Table of Authorities (TA) field.

Italic

Gets or sets whether to apply italic formatting to the entry's page number.

However, if the table of authorities style for that entry is already italic, the true value removes that formatting for that entry.

Default value is false.

LongCitation

Gets the entry long citation formatted text that is used as item text in the TOA field.

PageRangeBookmark

Gets or sets the name of bookmark which is used as range of pages marked by the bookmark instead of the field page number.

Default value is Empty.

ShortCitation

Gets or sets the short citation text that is used to group entries in the TOA field that don't have LongCitation.

Default value is Empty.

Methods

Name Description
Load(ComplexField)

Loads options from the specified ComplexField.

Load(SimpleField)

Loads options from the specified SimpleField.

Save(ComplexField)

Saves the current options to the specified ComplexField.

Save(SimpleField)

Saves the current options to the specified SimpleField.

ToString()

See Also