[]
        
(Showing Draft Content)

GrapeCity.Documents.Word.Fields.StyleRefFieldOptions

StyleRefFieldOptions Class

Represents STYLEREF field options.

A STYLEREF field Inserts the nearest piece of text prior to this field that is formatted by the specified style name.

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

Constructors

Name Description
StyleRefFieldOptions(ComplexField)

Initializes a new instance of the StyleRefFieldOptions class.

StyleRefFieldOptions(DocumentBase, string)

Initializes a new instance of the StyleRefFieldOptions class.

StyleRefFieldOptions(SimpleField)

Initializes a new instance of the StyleRefFieldOptions class.

Properties

Name Description
DisplayListNumber
DisplayRelative
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.

SearchFromBottomOfPage

Gets or sets a value indicating whether to search from the bottom of the current page, rather from the top.

The default value is false.

This property has effect when the field is placed in a header or footer.

StringStyle

Gets or sets the string formatting style.

Default value is None.

Style

Gets or sets the style name to search in the document.

SuppressListNumberText

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