GrapeCity.Documents.Word.Fields.SeqFieldOptions

Class SeqFieldOptions

Namespace

GrapeCity.Documents.Word.Fields

Assembly

GcDocs.Word.dll

Represents SEQ field options.

A SEQ field sequentially numbers chapters, tables, figures, and other user-defined lists of items in a document.

public class SeqFieldOptions : FieldFormatOptions, IFieldOptions

Inheritance

object

BaseFieldOptions

FieldFormatOptions

SeqFieldOptions

Implements

IFieldOptions

Inherited Members

FieldFormatOptions.Load(SimpleField)

FieldFormatOptions.Load(ComplexField)

FieldFormatOptions.ToString()

FieldFormatOptions.NumberFormat

FieldFormatOptions.NumberStyle

FieldFormatOptions.StringStyle

FieldFormatOptions.ResultFormat

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Constructors

SeqFieldOptions(ComplexField)

Initializes a new instance of the SeqFieldOptions class.

public SeqFieldOptions(ComplexField field)

Parameters

field ComplexField

The ComplexField from which to load the options.

SeqFieldOptions(DocumentBase, string)

Initializes a new instance of the SeqFieldOptions class.

public SeqFieldOptions(DocumentBase doc, string id)

Parameters

doc DocumentBase

The document whose resources to use in this instance.

id string

The name assigned to the series of items that are to be numbered.

SeqFieldOptions(SimpleField)

Initializes a new instance of the SeqFieldOptions class.

public SeqFieldOptions(SimpleField field)

Parameters

field SimpleField

The SimpleField from which to load the options.

Properties

Behavior

Gets or sets the field behavior.

Default value is Next.

If Bookmark property value is not null the value is Bookmark.

public SeqFieldBehavior Behavior { get; set; }

Property Value

SeqFieldBehavior

Exceptions

PropertyNullOrWhiteSpaceException

Thrown when trying to set Bookmark and property Bookmark is null or empty string.

Bookmark

Gets or sets the bookmark name that refers to an item elsewhere in the document rather than in the current location.

Default value is null.

public string Bookmark { get; set; }

Property Value

string

Hidden

Gets or sets whether to hide the field result.

Default value is false.

If formating options NumberFormat, NumberStyle and StringStyle are not default the property value is true.

public bool Hidden { get; set; }

Property Value

bool

Id

Gets or sets the name assigned to the series of items that are to be numbered.

public string Id { get; set; }

Property Value

string

Exceptions

PropertyNullOrWhiteSpaceException

Thrown when trying to set null or empty string.

ResetAt

Gets or sets the built-in heading style OutlineLevel at which to reset the sequence if the Behavior property is ResetAt.

Default value is Level1.

public OutlineLevel ResetAt { get; set; }

Property Value

OutlineLevel

Exceptions

ArgumentOutOfRangeException

Thrown when trying to set BodyText.

ResetTo

Gets or sets the value to reset the sequence if the Behavior property is ResetTo.

Default value is 0.

public int ResetTo { get; set; }

Property Value

int

Exceptions

ArgumentOutOfRangeException

Thrown when trying to set value less than 0.

Methods

Save(ComplexField)

Saves options to a ComplexField.

public override void Save(ComplexField field)

Parameters

field ComplexField

The ComplexField where to save the options.

Exceptions

PropertyNullOrWhiteSpaceException

Thrown when the Id property is null or empty string.

Save(SimpleField)

Saves options to a SimpleField.

public override void Save(SimpleField field)

Parameters

field SimpleField

The SimpleField where to save the options.

Exceptions

PropertyNullOrWhiteSpaceException

Thrown when the Id property is null or empty string.