GrapeCity.Documents.Word.Fields.FieldFormatOptions

Class FieldFormatOptions

Namespace

GrapeCity.Documents.Word.Fields

Assembly

GcDocs.Word.dll

Represents options used to format field results.

public class FieldFormatOptions : BaseFieldOptions, IFieldOptions

Inheritance

object

BaseFieldOptions

FieldFormatOptions

Implements

IFieldOptions

Derived

NumPagesFieldOptions

PageFieldOptions

PageRefFieldOptions

SectionFieldOptions

SectionPagesFieldOptions

SeqFieldOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Properties

NumberFormat

Gets or sets the number format.

• 0Specifies the requisite numeric positions to display in the result. If the result does not include a digit in that position, 0 is displayed.
• #Specifies the requisite numeric positions to display in the result. If the result does not include a digit in that position, a space is displayed.
• xDrops digits to the left of the x placeholder. If the placeholder is to the right of the decimal point, the result is rounded to that place.
• .Indicates the radix-point position.
• ,Separates groups of three digits.
• -Prepends a minus sign to a negative result, or prepends a space if the result is positive or 0.
• +Prepends a plus sign to a positive result, a minus sign to a negative result, or a space if the result is 0.
• Other characterIncludes the specified character in the result at that position.
• 'text'Includes text in the result.
• `numbered-item`Includes, in Arabic numerals, the number of the preceding item numbered as a caption or resulting from a SEQ field. Numbered-item shall be the same name as identifier in that SEQ field.
• positive-result ; negative-resultSpecifies different sets of picture items for positive and negative results. A zero value uses the positive picture.
• positive-result ; negative-result ; zero-resultSpecifies different sets of picture items for positive, negative, and zero results.

The default value is null.

public string NumberFormat { get; set; }

Property Value

string

NumberStyle

Gets or sets the number formatting style.

Default value is None.

public NumberStyle NumberStyle { get; set; }

Property Value

NumberStyle

Exceptions

BulletListPropertyException

Thrown when trying to set Bullet value.

ResultFormat

Gets or sets the result formatting rule.

Default value is None.

public ResultFormat ResultFormat { get; set; }

Property Value

ResultFormat

StringStyle

Gets or sets the string formatting style.

Default value is None.

public StringStyle StringStyle { get; set; }

Property Value

StringStyle

Methods

Load(ComplexField)

Loads options from a ComplexField.

public void Load(ComplexField field)

Parameters

field ComplexField

The ComplexField from which to load the options.

Load(SimpleField)

Loads options from a SimpleField.

public void Load(SimpleField field)

Parameters

field SimpleField

The SimpleField from which to load the options.

Save(ComplexField)

Saves options to a ComplexField.

public virtual void Save(ComplexField field)

Parameters

field ComplexField

The ComplexField where to save the options.

Save(SimpleField)

Saves options to a SimpleField.

public virtual void Save(SimpleField field)

Parameters

field SimpleField

The SimpleField where to save the options.

ToString()

public override string ToString()

Returns

string