DS.Documents.Word Assembly

GrapeCity.Documents.Word.Fields.IndexFieldOptions

IndexFieldOptions Class

Represents INDEX field options.

The INDEX field builds an index using the index entries specified by XE fields (see XeFieldOptions), and inserts that index at its place in the document.

Inheritance

object

BaseFieldOptions

IndexFieldOptions

Implements

IFieldOptions

Namespace: GrapeCity.Documents.Word.Fields

Assembly: DS.Documents.Word.dll

Syntax

public class IndexFieldOptions : BaseFieldOptions, IFieldOptions

Public Class IndexFieldOptions
    Inherits BaseFieldOptions
    Implements IFieldOptions

Constructors

Name	Description
IndexFieldOptions(ComplexField)	Initializes a new instance of the IndexFieldOptions class.
IndexFieldOptions(DocumentBase)	Initializes a new instance of the IndexFieldOptions class. The document whose resources to use in this instance.
IndexFieldOptions(SimpleField)	Initializes a new instance of the IndexFieldOptions class.

Properties

Name	Description
Bookmark	Gets or sets the name of a bookmark which allows including entries only from the portion of the document marked by this bookmark. Default value is null.
CharacterRange	Gets the range of characters, only entries with first letters within that range will be included in the index. Default value is IsAll, which includes all entries.
Columns	Gets or sets the number of columns per page. Allowed values are from 1 to 4, inclusive. If the value is null the index result does not change the current number of columns. Default value is null.
Culture	Gets or sets the CultureInfo that is used to sort the index entries. If null, the culture specified when updating the field (see Culture) is used. Default value is null.
EntriesType	Gets or sets a value specifying what type of XE fields to collect. If not null, only XE entries with Type equal to the value of this property will be included in the index. Default value is null.
FlatList	Gets or sets a value indicating whether subentries run in the same line as the main entry. If true, colons (':') separate main entries from subentries, while semicolons (';') separate subentries. Default value is false.
Heading	Gets or sets a heading text which appears at the start of each set of entries for any given letter. If the first letter in the text is A or a, that letter will be replaced with the corresponding letter for each letter set. Default value is Empty (no headings).
PageNumbers	Gets the options used to show page numbers in the index.
UseYomi	Gets or sets a value indicating whether to use Yomi to sort the index entries. Default value is false.

Methods

Name	Description
Load(ComplexField)	Loads options from a ComplexField.
Load(SimpleField)	Loads options from a SimpleField.
Save(ComplexField)	Saves options to a ComplexField.
Save(SimpleField)	Saves options to a SimpleField.
ToString()