Click or drag to resize
FieldType Enumeration
Represents a field type that is used in defining Fields.

Namespace: GemBox.Document
Assembly: GemBox.Document (in GemBox.Document.dll) Version: 25.3.30.1231
Syntax
public enum FieldType
Members
  Member nameValueDescription
Unknown0 Field type cannot be resolved because InstructionInlines does not start with Runs that specify valid field code.
CreateDate1 Retrieves the date and time at which the document was created.
Date2 Retrieves the current date and time.
EditTime3 Retrieves the total editing time, in minutes, since the document was created.
PrintDate4 Retrieves the date and time on which the document was last printed.
SaveDate5 Retrieves the date and time on which the document was last saved.
Time6 Retrieves the current date and time.
Compare7 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.
DocVariable8 Inserts the string assigned to the document variable designated by field argument.
GoToButton9 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.
If10 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.
MacroButton11 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.
Print12 Sends the printer-specific control code characters specified by field argument to the selected printer.
Author13 Retrieves, and optionally sets, the document author's name.
Comments14 Retrieves, and optionally sets, the comments relating to the current document.
DocProperty15 Retrieves the document information indicated by document property category field argument.
FileName16 Retrieves the name of the current document as stored on disk.
FileSize17 Retrieves the size of the current document in bytes.
Info18 A field of this kind is treated as if INFO was omitted and info category field argument was a field-type name.
Keywords19 Retrieves, and optionally sets, the document's keywords.
LastSavedBy20 Retrieves the name of the user who last modified and saved the current document.
NumChars21 Retrieves the number of characters in the current document.
NumPages22 Retrieves the number of pages in the current document.
NumWords23 Retrieves the number of words in the current document.
Subject24 Retrieves, and optionally sets, the document's subject.
Template25 Retrieves the disk file name of the template used by the current document.
Title26 Retrieves, and optionally sets, the document's title.
Formula27 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.
Advance28 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.
Eq29 Computes the specified mathematical equation.
Symbol30 Retrieves the character whose code point value is specified in decimal or hexadecimal (by using a leading 0x or 0X) in field argument.
Index31 Builds an index using the index entries specified by XE fields, and inserts that index at this place in the document.
RD32 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.
TA33 Defines the text and page number for a table of authorities entry, which is used by a TOA field.
TC34 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.
TOA35 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.
TOC36 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.
XE37 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.
AutoText38 Inserts the AutoText entry whose name is specified by field argument.
AutoTextList39 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.
Bibliography40 Retrieves and displays the formatted bibliographic data for all sources in the current document.
Citation41 Displays the formatted contents of the bibliography entry for a source or reference work with a tag name of a source matching field argument.
Hyperlink42 When selected, causes control to jump to the location specified by field argument. That location can be a bookmark or a URL.
IncludePicture43 Retrieves the picture contained in the document named by field argument.
IncludeText44 Inserts all or part of the text and graphics contained in the document named by first field argument.
Link45 For information copied from another application, this field links that information to its original source file using OLE.
NoteRef46 Inserts the mark of the footnote or endnote that is marked by the bookmark specified by field argument.
PageRef47 Inserts the number of the page containing the bookmark specified by field argument for a cross-reference.
Quote48 Retrieves the text specified by field argument.
Ref49 Inserts the text or graphics represented by the bookmark specified by field argument.
StyleRef50 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.
AddressBlock51 Inserts a mail merge address block.
Ask52 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.
Database53 Inserts the results of a database query into a Table.
FillIn54 Prompts the user to enter text. Field argument contains the prompt.
GreetingLine55 Inserts a mail merge greeting line.
MergeField56 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.
MergeRec57 Use this in a mail merge to print the number of the corresponding merged data record in each resulting merged document.
MergeSeq58 The number of data records that were successfully merged with the main document.
Next59 Merges the next data record into the current resulting merged document, rather than starting a new merged document.
NextIf60 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.
Set61 Defines the bookmark name specified by first field argument to represent the information specified by second field argument.
SkipIf62 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.
AutoNum63 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.
AutoNumLgl64 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.
AutoNumOut65 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.
BarCode66 Produces a postal bar code that is a machine-readable form of address used by the U.S. Postal Service.
ListNum67 Computes the next integral number from the current or a specific series, or a specific number from the next or specific series.
Page68 Retrieves the number of the current page.
RevNum69 Retrieves the document's revision number (which indicates the number of times the document has been saved).
Section70 Retrieves the number of the current section.
SectionPages71 Retrieves the number of the current page within the current section.
Seq72 Sequentially numbers chapters, tables, figures, and other user-defined lists of items in a document.
UserAddress73 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.
UserInitials74 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.
UserName75 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.
FormCheckBox76 Inserts a check box style form field which, when the editing of form fields is enabled, can be checked and unchecked.
FormDropDown77 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.
FormText78 Inserts a text box style form field which, when the editing of form fields is enabled, can be typed into.
See Also