DS.Documents.Word Assembly

GrapeCity.Documents.Word.Fields.ListNumFieldOptions

ListNumFieldOptions Class

Represents options for the LISTNUM field.

The LISTNUM field inserts the next number from a specified level of a numbering definition, or a specific number from that level.

Inheritance

object

BaseFieldOptions

ListNumFieldOptions

Implements

IFieldOptions

Namespace: GrapeCity.Documents.Word.Fields

Assembly: DS.Documents.Word.dll

Syntax

public class ListNumFieldOptions : BaseFieldOptions, IFieldOptions

Public Class ListNumFieldOptions
    Inherits BaseFieldOptions
    Implements IFieldOptions

Constructors

Name	Description
ListNumFieldOptions(ComplexField)	Initializes a new instance of the ListNumFieldOptions class.
ListNumFieldOptions(DocumentBase)	Initializes a new instance of the ListNumFieldOptions class.
ListNumFieldOptions(SimpleField)	Initializes a new instance of the ListNumFieldOptions class.

Properties

Name Description

Name	Description
Level	Gets or sets the list level, overriding the default behavior of the field. Allowed values are null or from `1` to `9`, inclusive. If the value is null, the default level for a new series is `1`; otherwise, the current level is continued. The default value is null.
Name	Gets or sets the name of the ListTemplate defined in the document. If the value is one of the built-in names `NumberDefault`, `LegalDefault`, or `OutlineDefault`, all fields with the same value belong to a single numbering instance. The built-in names correspond to the following list templates: `NumberDefault` - OutlineNumbers `LegalDefault` - OutlineLegal `OutlineDefault` - OutlineHeadingsNumbers If the value is null, the field belongs to the same numbering instance as the most recent LISTNUM field or numbered paragraph in the document. The default value is null.
StartAt	Gets or sets the starting value for this field. Allowed values are null or a positive integer. If the value is null, the default value for a new series is `1`; otherwise, the current series numbering is continued. The default value is null.

Level

Gets or sets the list level, overriding the default behavior of the field.

Allowed values are null or from 1 to 9, inclusive.

If the value is null, the default level for a new series is 1; otherwise, the current level is continued.

The default value is null.

Name

Gets or sets the name of the ListTemplate defined in the document.

If the value is one of the built-in names NumberDefault, LegalDefault, or OutlineDefault, all fields with the same value belong to a single numbering instance.

The built-in names correspond to the following list templates:

NumberDefault - OutlineNumbers
LegalDefault - OutlineLegal
OutlineDefault - OutlineHeadingsNumbers

If the value is null, the field belongs to the same numbering instance as the most recent LISTNUM field or numbered paragraph in the document.

The default value is null.

StartAt

Gets or sets the starting value for this field.

Allowed values are null or a positive integer.

If the value is null, the default value for a new series is 1; otherwise, the current series numbering is continued.

The default value is null.

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