GemBox.Document
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    FieldType Enum

    Namespace:
    GemBox.Document
    Assembly:
    GemBox.Document.dll

    Represents a field type that is used in defining Fields.

    • C#
    • VB.NET
    public enum FieldType
    Public Enum FieldType

    Fields

    AddressBlock

    Inserts a mail merge address block.

    Advance

    Moves the starting point of text that follows the field to the right or left, up or down, or to a specific horizontal or vertical position.

    Ask

    Prompts the user to enter information and assigns the bookmark designated by first field argument to represent the user's response. Second field argument specifies the prompt text, which is displayed in a dialog box.

    Author

    Retrieves, and optionally sets, the document author's name.

    AutoNum

    In paragraphs formatted with one of the nine built-in heading styles, paragraph numbering restarts at 1 in each successive heading level. If headings that contain AUTONUM fields are followed by body text paragraphs that also contain AUTONUM fields, the paragraph numbering of the body text is restarted at 1 after each heading. If the headings don't contain AUTONUM fields, body text paragraphs that contain AUTONUM fields are numbered in a continuous, sequential series throughout the document. This field is supported for legacy reasons, it is recommended that ListNum be used instead.

    AutoNumLgl

    For legal and technical publications, use the nine built-in heading styles to format headings in the document, and then insert an AUTONUMLGL field at the beginning of each heading paragraph. This field is supported for legacy reasons, it is recommended that ListNum be used instead.

    AutoNumOut

    Use the nine built-in heading styles to format headings in the document, and then insert an AUTONUMOUT field at the beginning of each heading paragraph. This field is supported for legacy reasons, it is recommended that ListNum be used instead.

    AutoText

    Inserts the AutoText entry whose name is specified by field argument.

    AutoTextList

    Creates a shortcut menu based on AutoText entries in the active template. The list can vary based on the styles applied to the AutoText entries. Field argument is inserted into the document.

    BarCode

    Produces a postal bar code that is a machine-readable form of address used by the U.S. Postal Service.

    Bibliography

    Retrieves and displays the formatted bibliographic data for all sources in the current document.

    Citation

    Displays the formatted contents of the bibliography entry for a source or reference work with a tag name of a source matching field argument.

    Comments

    Retrieves, and optionally sets, the comments relating to the current document.

    Compare

    Compares the values designated by two expressions using the designated operator. Field value is 1 if the comparison is true, or 0 if the comparison is false.

    CreateDate

    Retrieves the date and time at which the document was created.

    Database

    Inserts the results of a database query into a Table.

    Date

    Retrieves the current date and time.

    DisplayBarcode

    Renders a generated barcode symbol using the data in this display field.

    DocProperty

    Retrieves the document information indicated by document property category field argument.

    DocVariable

    Inserts the string assigned to the document variable designated by field argument.

    EditTime

    Retrieves the total editing time, in minutes, since the document was created.

    Eq

    Computes the specified mathematical equation.

    FileName

    Retrieves the name of the current document as stored on disk.

    FileSize

    Retrieves the size of the current document in bytes.

    FillIn

    Prompts the user to enter text. Field argument contains the prompt.

    FormCheckBox

    Inserts a check box style form field which, when the editing of form fields is enabled, can be checked and unchecked.

    FormDropDown

    Inserts a drop-down list style form field which, when the editing of form fields is enabled, can be used to select an entry in the list.

    FormText

    Inserts a text box style form field which, when the editing of form fields is enabled, can be typed into.

    Formula

    Represents an arbitrary complex arithmetic expression involving constants, bookmarks that refer to expressions, arithmetic and logical operators, functions, values of cells in a table, and fields that result in a single value. Expression can contain grouping parentheses to document the default precedence or to override it.

    GoToButton

    Inserts a jump command, such that when it is activated, the insertion point of the document is moved to the location specified by field argument. First field argument can be a bookmark, a page number, or some other item. Second field argument is the text or graphic "button" that appears in the document, such that it can be selected to activate the jump.

    GreetingLine

    Inserts a mail merge greeting line.

    Hyperlink

    When selected, causes control to jump to the location specified by field argument. That location can be a bookmark or a URL.

    If

    Compares the values designated by two expressions using the designated operator. Field value is first field argument if the comparison is true; otherwise, second field argument.

    IncludePicture

    Retrieves the picture contained in the document named by field argument.

    IncludeText

    Inserts all or part of the text and graphics contained in the document named by first field argument.

    Index

    Builds an index using the index entries specified by XE fields, and inserts that index at this place in the document.

    Info

    A field of this kind is treated as if INFO was omitted and info category field argument was a field-type name.

    Keywords

    Retrieves, and optionally sets, the document's keywords.

    LastSavedBy

    Retrieves the name of the user who last modified and saved the current document.

    Link

    For information copied from another application, this field links that information to its original source file using OLE.

    ListNum

    Computes the next integral number from the current or a specific series, or a specific number from the next or specific series.

    MacroButton

    Allows the macro or command designated by first field argument to be run. Second field argument designates the text or graphic to appear as the "button" that is selected to run the macro or command.

    MergeBarcode

    This field is analogous to the field code, MergeField. The main difference is that MergeBarcode generates a DisplayBarcode field based on the merge result instead of showing it directly. The syntax of field instruction and supported switches is also different.

    MergeField

    Retrieves the name of a data field designated by field argument within the merge characters in a mail merge main document. When the main document is merged with the selected data source, information from the specified data field is inserted in place of the merge field.

    MergeRec

    Use this in a mail merge to print the number of the corresponding merged data record in each resulting merged document.

    MergeSeq

    The number of data records that were successfully merged with the main document.

    Next

    Merges the next data record into the current resulting merged document, rather than starting a new merged document.

    NextIf

    Compares the values designated by two expressions using the designated operator. If the comparison is true, the next data record is merged into the current merge document. Merge fields that follow the NEXTIF in the main document are replaced by values from the next data record rather than the current data record. If the comparison is false, the next data record is merged into a new merge document.

    NoteRef

    Inserts the mark of the footnote or endnote that is marked by the bookmark specified by field argument.

    NumChars

    Retrieves the number of characters in the current document.

    NumPages

    Retrieves the number of pages in the current document.

    NumWords

    Retrieves the number of words in the current document.

    Page

    Retrieves the number of the current page.

    PageRef

    Inserts the number of the page containing the bookmark specified by field argument for a cross-reference.

    Print

    Sends the printer-specific control code characters specified by field argument to the selected printer.

    PrintDate

    Retrieves the date and time on which the document was last printed.

    Quote

    Retrieves the text specified by field argument.

    RD

    Field argument identifies a file to include when creating a table of contents, a table of authorities, or an index using a TOC, TOA, or Index field.

    Ref

    Inserts the text or graphics represented by the bookmark specified by field argument.

    RevNum

    Retrieves the document's revision number (which indicates the number of times the document has been saved).

    SaveDate

    Retrieves the date and time on which the document was last saved.

    Section

    Retrieves the number of the current section.

    SectionPages

    Retrieves the number of the current page within the current section.

    Seq

    Sequentially numbers chapters, tables, figures, and other user-defined lists of items in a document.

    Set

    Defines the bookmark name specified by first field argument to represent the information specified by second field argument.

    SkipIf

    Compares the values designated by two expressions using the designated operator. If the comparison is true, SKIPIF cancels the current merge document, moves to the next in the data source, and starts a new merge document. If the comparison is false, the current merge document is continued.

    StyleRef

    Inserts the nearest piece of text prior to this field that is formatted by the style whose name is specified by field argument. The style can be a paragraph style or a character style.

    Subject

    Retrieves, and optionally sets, the document's subject.

    Symbol

    Retrieves the character whose code point value is specified in decimal or hexadecimal (by using a leading 0x or 0X) in field argument.

    TA

    Defines the text and page number for a table of authorities entry, which is used by a TOA field.

    TC

    Defines the text and page number for a table of contents (including a table of figures) entry, which is used by a TOC field. The text of the entry is field argument.

    Template

    Retrieves the disk file name of the template used by the current document.

    Time

    Retrieves the current date and time.

    Title

    Retrieves, and optionally sets, the document's title.

    TOA

    Builds a table of authorities (that is, a list of the references in a legal document, such as references to cases, statutes, and rules, along with the numbers of the pages on which the references appear) using the entries specified by TA fields.

    TOC

    Builds a table of contents (which can also be a table of figures) using the entries specified by TC fields, their heading levels, and specified styles, and inserts that table at this place in the document.

    Unknown

    Field type cannot be resolved because InstructionElements does not start with Runs that specify valid field code.

    UserAddress

    Retrieves the current user's postal address or, if field argument is present, the address specified by field argument. Specifying a field argument shall not change the address of the current user.

    UserInitials

    Retrieves the current user's initials or, if field argument is present, the initials specified by field argument. Specifying a field argument shall not change the initials of the current user.

    UserName

    Retrieves the current user's name or, if field argument is present, the name specified by field argument. Specifying a field argument shall not change the name of the current user.

    XE

    Defines the text and page number for an index entry, which is used by an Index field. The text of the entry is field argument.

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.