[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.Fields.XeFieldOptions

XeFieldOptions Class

Represents XE field options.

The XE field defines options used for entires in an INDEX field (see IndexFieldOptions).

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

Constructors

Name Description
XeFieldOptions(ComplexField)

Initializes a new instance of the XeFieldOptions class.

XeFieldOptions(DocumentBase)

Initializes a new instance of the XeFieldOptions class.

XeFieldOptions(SimpleField)

Initializes a new instance of the XeFieldOptions class.

Properties

Name Description
Behavior

Gets or sets the field behavior.

Default value is Page.

Bold

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

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

This property does not have effect if the Behavior property is CrossReference.

Default value is false.

Entry

Gets the index entry.

Italic

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

However, if the index style for that entry is already italic, the true removes that formatting for that entry.

This property does not have effect if the Behavior property is CrossReference.

Default value is false.

PageRangeBookmark

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

This property has effect only if Behavior is PageRange.

Default value is Empty.

Reference

Gets the formatted content which is used in place of a page number.

This property has effect only if Behavior is CrossReference.

Type

Gets or sets the type of the entry. Provides a way to associate the entry with a specific index, see EntriesType for details.

Default value is null.

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()