FieldFormatOptions Class

Represents options used to format field results.

Inheritance

object

BaseFieldOptions

FieldFormatOptions

SectionPagesFieldOptions

SeqFieldOptions

TimeFormatOptions

Implements

IFieldOptions

Namespace: GrapeCity.Documents.Word.Fields

Assembly: DS.Documents.Word.dll

Syntax

public class FieldFormatOptions : BaseFieldOptions, IFieldOptions

Public Class FieldFormatOptions
    Inherits BaseFieldOptions
    Implements IFieldOptions

Properties

Name	Description
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.
NumberStyle	Gets or sets the number formatting style. Default value is None.
ResultFormat	Gets or sets the result formatting rule. Default value is None.
StringStyle	Gets or sets the string formatting style. Default value is None.

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