com.aspose.words
Class FieldType

java.lang.Object
    extended by com.aspose.words.FieldType

public class FieldType 
extends java.lang.Object

Utility class containing constants. Enumeration that identifies all different types of Word fields.

Field Summary
static final intFIELD_NONE
           Field type is not specified or unknown.
static final intFIELD_CANNOT_PARSE
           Specifies that the field was unable to be parsed.
static final intFIELD_ADDIN
           Specifies that the field contains data created by an add-in.
static final intFIELD_ADDRESS_BLOCK
           Inserts an address block.
static final intFIELD_ADVANCE
           Offset subsequent text within a line to the left, right, up or down.
static final intFIELD_ASK
           Prompt the user for text to assign to a bookmark.
static final intFIELD_AUTHOR
           The name of the document's author from Summary Info.
static final intFIELD_AUTO_NUM
           Insert an automatic number.
static final intFIELD_AUTO_NUM_LEGAL
           Insert an automatic number in legal format.
static final intFIELD_AUTO_NUM_OUTLINE
           Insert an automatic number in outline format.
static final intFIELD_AUTO_TEXT
           Insert an AutoText entry.
static final intFIELD_AUTO_TEXT_LIST
           Insert text based on style.
static final intFIELD_BAR_CODE
           Insert a delivery point barcode.
static final intFIELD_BIDI_OUTLINE
           Specified in [ECMA-376] part 4, section 2.16.5.12
static final intFIELD_COMMENTS
           The comments from Summary Info.
static final intFIELD_COMPARE
           Compares two values.
static final intFIELD_CREATE_DATE
           The date the document was created.
static final intFIELD_DATA
           Specifies that this field should redirect the mail merge data and header files to the ones specified.
static final intFIELD_DATABASE
           Insert data from an external database.
static final intFIELD_DATE
           Today's date.
static final intFIELD_DDE
           Undocumented.
static final intFIELD_DDE_AUTO
           Undocumented.
static final intFIELD_DOC_PROPERTY
           Insert the value of the property.
static final intFIELD_DOC_VARIABLE
           Insert the value of the document variable.
static final intFIELD_EDIT_TIME
           The total document editing time.
static final intFIELD_EMBED
           OLE2 embedded object. Might occur only in files. In the document object, represented by a single shape node.
static final intFIELD_EQUATION
           Create a scientific equation.
static final intFIELD_FILE_NAME
           The document's name and location.
static final intFIELD_FILE_SIZE
           The size on disk of the active document.
static final intFIELD_FILL_IN
           Prompt the user for text to insert in the document.
static final intFIELD_FOOTNOTE_REF
           This field is identical to NOTEREF specified in [ECMA-376] part 4, section 2.16.5.47.
static final intFIELD_FORM_CHECK_BOX
           Check box control.
static final intFIELD_FORM_DROP_DOWN
           Drop down control.
static final intFIELD_FORM_TEXT_INPUT
           Text control.
static final intFIELD_FORMULA
           Calculates the result of an expression.
static final intFIELD_GREETING_LINE
           Specified in [ECMA-376] part 4, section 2.16.5.30
static final intFIELD_GLOSSARY
           This field is identical to AUTOTEXT specified in [ECMA-376] part 4, section 2.16.5.8
static final intFIELD_GO_TO_BUTTON
           Move the insertion point to a new location.
static final intFIELD_HTML_ACTIVE_X
           Specifies the field represents an HTML control.
static final intFIELD_HYPERLINK
           Open and jump to the specified file.
static final intFIELD_IF
           Evaluate arguments conditionally.
static final intFIELD_INCLUDE
           This field is identical to INCLUDETEXT specified in [ECMA-376] part 4, section 2.16.5.34
static final intFIELD_INCLUDE_PICTURE
           "INCLUDEPICTURE", Insert a picture from a file. Might occur only in files. In the document object, represented by a single shape node.
static final intFIELD_INCLUDE_TEXT
           Insert text from a file.
static final intFIELD_INDEX
           Create an index.
static final intFIELD_INDEX_ENTRY
           Mark an index entry.
static final intFIELD_INFO
           Data from Summary Info.
static final intFIELD_IMPORT
           Specified in [ECMA-376] part 4, section 2.16.5.33
static final intFIELD_KEYWORD
           The keywords from Summary Info.
static final intFIELD_LAST_SAVED_BY
           Name of user who last saved the document.
static final intFIELD_LINK
          

Linked OLE2 object.

The LINK field in the file can be with an image or without. Aspose.Words represents a LINK field with an image and without differently in the model. A LINK field with an image will be represented by a Shape object and no field. A LINK field without an image will be represeted as a normal field.

static final intFIELD_LIST_NUM
           Insert an element in a list.
static final intFIELD_MACRO_BUTTON
           Run a macro.
static final intFIELD_MERGE_FIELD
           Insert a mail merge field.
static final intFIELD_MERGE_REC
           The number of the current merge record.
static final intFIELD_MERGE_SEQ
           Merge record sequence number.
static final intFIELD_NEXT
           Go to the next record in a mail merge.
static final intFIELD_NEXT_IF
           Conditionally go to the next record in a mail merge.
static final intFIELD_NOTE_REF
           Insert the number of a footnote or endnote.
static final intFIELD_NUM_CHARS
           The number of characters in the document.
static final intFIELD_NUM_PAGES
           The number of pages in the document.
static final intFIELD_NUM_WORDS
           The number of words in the document.
static final intFIELD_OCX
          

Represents an ActiveX control such as a command button etc.

Normally, Aspose.Words will represent an ActiveX control as a Shape object, but for some documents, where a control does not have data and/or seems to be invalid, it will be represented as a field.

static final intFIELD_PAGE
           Insert the number of the current page.
static final intFIELD_PAGE_REF
           Insert the number of the page containing the specified bookmark.
static final intFIELD_PRINT
           Download commands to a printer.
static final intFIELD_PRINT_DATE
           The date the document was last printed.
static final intFIELD_PRIVATE
           Stores data for documents converted from other file formats. Microsoft Word inserts a PRIVATE field when converting file formats; the field contains data needed for converting a document back to its original file format. A PRIVATE field is formatted as hidden text and doesn't affect the document layout.
static final intFIELD_QUOTE
           Insert literal text.
static final intFIELD_REF
           Insert the text marked by a bookmark.
static final intFIELD_REF_NO_KEYWORD
           Specifies that the field represents a REF field where the keyword has been omitted.
static final intFIELD_REF_DOC
           Create an index, table of contents, table of figures, and/or table of authorities by using multiple documents.
static final intFIELD_REVISION_NUM
           Insert the number of times the document has been saved.
static final intFIELD_SAVE_DATE
           The date the document was last saved.
static final intFIELD_SECTION
           Insert the number of the current section.
static final intFIELD_SECTION_PAGES
           Insert the total number of pages in the section.
static final intFIELD_SEQUENCE
           Insert an automatic sequence number.
static final intFIELD_SET
           Assign new text to a bookmark.
static final intFIELD_SHAPE
           Represents an inline shape in the document. Might occur only in files. In the document object, represented by a single shape node.
static final intFIELD_SKIP_IF
           Conditionally skip a record in a mail merge.
static final intFIELD_STYLE_REF
           Insert the text from a like-style paragraph.
static final intFIELD_SUBJECT
           The document's subject from Summary Info.
static final intFIELD_SYMBOL
           Insert a special character.
static final intFIELD_TEMPLATE
           The name of the template attached to the document.
static final intFIELD_TIME
           The current time.
static final intFIELD_TITLE
           The document's title from Summary Info.
static final intFIELD_TOA
           Create a table of authorities.
static final intFIELD_TOA_ENTRY
           Make a table of authorities entry.
static final intFIELD_TOC
           Create a table of contents.
static final intFIELD_TOC_ENTRY
           Make a table of contents entry.
static final intFIELD_USER_ADDRESS
           Address from Tools Options User Info.
static final intFIELD_USER_INITIALS
           Initials form Tools Options User Info.
static final intFIELD_USER_NAME
           Name from Tools Options User Info.
 

Field Detail

FIELD_NONE

public static final int FIELD_NONE
Field type is not specified or unknown.

FIELD_CANNOT_PARSE

public static final int FIELD_CANNOT_PARSE
Specifies that the field was unable to be parsed.

FIELD_ADDIN

public static final int FIELD_ADDIN
Specifies that the field contains data created by an add-in.

FIELD_ADDRESS_BLOCK

public static final int FIELD_ADDRESS_BLOCK
Inserts an address block.

FIELD_ADVANCE

public static final int FIELD_ADVANCE
Offset subsequent text within a line to the left, right, up or down.

FIELD_ASK

public static final int FIELD_ASK
Prompt the user for text to assign to a bookmark.

FIELD_AUTHOR

public static final int FIELD_AUTHOR
The name of the document's author from Summary Info.

FIELD_AUTO_NUM

public static final int FIELD_AUTO_NUM
Insert an automatic number.

FIELD_AUTO_NUM_LEGAL

public static final int FIELD_AUTO_NUM_LEGAL
Insert an automatic number in legal format.

FIELD_AUTO_NUM_OUTLINE

public static final int FIELD_AUTO_NUM_OUTLINE
Insert an automatic number in outline format.

FIELD_AUTO_TEXT

public static final int FIELD_AUTO_TEXT
Insert an AutoText entry.

FIELD_AUTO_TEXT_LIST

public static final int FIELD_AUTO_TEXT_LIST
Insert text based on style.

FIELD_BAR_CODE

public static final int FIELD_BAR_CODE
Insert a delivery point barcode.

FIELD_BIDI_OUTLINE

public static final int FIELD_BIDI_OUTLINE
Specified in [ECMA-376] part 4, section 2.16.5.12

FIELD_COMMENTS

public static final int FIELD_COMMENTS
The comments from Summary Info.

FIELD_COMPARE

public static final int FIELD_COMPARE
Compares two values.

FIELD_CREATE_DATE

public static final int FIELD_CREATE_DATE
The date the document was created.

FIELD_DATA

public static final int FIELD_DATA
Specifies that this field should redirect the mail merge data and header files to the ones specified.

FIELD_DATABASE

public static final int FIELD_DATABASE
Insert data from an external database.

FIELD_DATE

public static final int FIELD_DATE
Today's date.

FIELD_DDE

public static final int FIELD_DDE
Undocumented.

FIELD_DDE_AUTO

public static final int FIELD_DDE_AUTO
Undocumented.

FIELD_DOC_PROPERTY

public static final int FIELD_DOC_PROPERTY
Insert the value of the property.

FIELD_DOC_VARIABLE

public static final int FIELD_DOC_VARIABLE
Insert the value of the document variable.

FIELD_EDIT_TIME

public static final int FIELD_EDIT_TIME
The total document editing time.

FIELD_EMBED

public static final int FIELD_EMBED
OLE2 embedded object. Might occur only in files. In the document object, represented by a single shape node.

FIELD_EQUATION

public static final int FIELD_EQUATION
Create a scientific equation.

FIELD_FILE_NAME

public static final int FIELD_FILE_NAME
The document's name and location.

FIELD_FILE_SIZE

public static final int FIELD_FILE_SIZE
The size on disk of the active document.

FIELD_FILL_IN

public static final int FIELD_FILL_IN
Prompt the user for text to insert in the document.

FIELD_FOOTNOTE_REF

public static final int FIELD_FOOTNOTE_REF
This field is identical to NOTEREF specified in [ECMA-376] part 4, section 2.16.5.47.

FIELD_FORM_CHECK_BOX

public static final int FIELD_FORM_CHECK_BOX
Check box control.

FIELD_FORM_DROP_DOWN

public static final int FIELD_FORM_DROP_DOWN
Drop down control.

FIELD_FORM_TEXT_INPUT

public static final int FIELD_FORM_TEXT_INPUT
Text control.

FIELD_FORMULA

public static final int FIELD_FORMULA
Calculates the result of an expression.

FIELD_GREETING_LINE

public static final int FIELD_GREETING_LINE
Specified in [ECMA-376] part 4, section 2.16.5.30

FIELD_GLOSSARY

public static final int FIELD_GLOSSARY
This field is identical to AUTOTEXT specified in [ECMA-376] part 4, section 2.16.5.8

FIELD_GO_TO_BUTTON

public static final int FIELD_GO_TO_BUTTON
Move the insertion point to a new location.

FIELD_HTML_ACTIVE_X

public static final int FIELD_HTML_ACTIVE_X
Specifies the field represents an HTML control.

FIELD_HYPERLINK

public static final int FIELD_HYPERLINK
Open and jump to the specified file.

FIELD_IF

public static final int FIELD_IF
Evaluate arguments conditionally.

FIELD_INCLUDE

public static final int FIELD_INCLUDE
This field is identical to INCLUDETEXT specified in [ECMA-376] part 4, section 2.16.5.34

FIELD_INCLUDE_PICTURE

public static final int FIELD_INCLUDE_PICTURE
"INCLUDEPICTURE", Insert a picture from a file. Might occur only in files. In the document object, represented by a single shape node.

FIELD_INCLUDE_TEXT

public static final int FIELD_INCLUDE_TEXT
Insert text from a file.

FIELD_INDEX

public static final int FIELD_INDEX
Create an index.

FIELD_INDEX_ENTRY

public static final int FIELD_INDEX_ENTRY
Mark an index entry.

FIELD_INFO

public static final int FIELD_INFO
Data from Summary Info.

FIELD_IMPORT

public static final int FIELD_IMPORT
Specified in [ECMA-376] part 4, section 2.16.5.33

FIELD_KEYWORD

public static final int FIELD_KEYWORD
The keywords from Summary Info.

FIELD_LAST_SAVED_BY

public static final int FIELD_LAST_SAVED_BY
Name of user who last saved the document.

FIELD_LINK

public static final int FIELD_LINK

Linked OLE2 object.

The LINK field in the file can be with an image or without. Aspose.Words represents a LINK field with an image and without differently in the model. A LINK field with an image will be represented by a Shape object and no field. A LINK field without an image will be represeted as a normal field.


FIELD_LIST_NUM

public static final int FIELD_LIST_NUM
Insert an element in a list.

FIELD_MACRO_BUTTON

public static final int FIELD_MACRO_BUTTON
Run a macro.

FIELD_MERGE_FIELD

public static final int FIELD_MERGE_FIELD
Insert a mail merge field.

FIELD_MERGE_REC

public static final int FIELD_MERGE_REC
The number of the current merge record.

FIELD_MERGE_SEQ

public static final int FIELD_MERGE_SEQ
Merge record sequence number.

FIELD_NEXT

public static final int FIELD_NEXT
Go to the next record in a mail merge.

FIELD_NEXT_IF

public static final int FIELD_NEXT_IF
Conditionally go to the next record in a mail merge.

FIELD_NOTE_REF

public static final int FIELD_NOTE_REF
Insert the number of a footnote or endnote.

FIELD_NUM_CHARS

public static final int FIELD_NUM_CHARS
The number of characters in the document.

FIELD_NUM_PAGES

public static final int FIELD_NUM_PAGES
The number of pages in the document.

FIELD_NUM_WORDS

public static final int FIELD_NUM_WORDS
The number of words in the document.

FIELD_OCX

public static final int FIELD_OCX

Represents an ActiveX control such as a command button etc.

Normally, Aspose.Words will represent an ActiveX control as a Shape object, but for some documents, where a control does not have data and/or seems to be invalid, it will be represented as a field.


FIELD_PAGE

public static final int FIELD_PAGE
Insert the number of the current page.

FIELD_PAGE_REF

public static final int FIELD_PAGE_REF
Insert the number of the page containing the specified bookmark.

FIELD_PRINT

public static final int FIELD_PRINT
Download commands to a printer.

FIELD_PRINT_DATE

public static final int FIELD_PRINT_DATE
The date the document was last printed.

FIELD_PRIVATE

public static final int FIELD_PRIVATE
Stores data for documents converted from other file formats. Microsoft Word inserts a PRIVATE field when converting file formats; the field contains data needed for converting a document back to its original file format. A PRIVATE field is formatted as hidden text and doesn't affect the document layout.

FIELD_QUOTE

public static final int FIELD_QUOTE
Insert literal text.

FIELD_REF

public static final int FIELD_REF
Insert the text marked by a bookmark.

FIELD_REF_NO_KEYWORD

public static final int FIELD_REF_NO_KEYWORD
Specifies that the field represents a REF field where the keyword has been omitted.

FIELD_REF_DOC

public static final int FIELD_REF_DOC
Create an index, table of contents, table of figures, and/or table of authorities by using multiple documents.

FIELD_REVISION_NUM

public static final int FIELD_REVISION_NUM
Insert the number of times the document has been saved.

FIELD_SAVE_DATE

public static final int FIELD_SAVE_DATE
The date the document was last saved.

FIELD_SECTION

public static final int FIELD_SECTION
Insert the number of the current section.

FIELD_SECTION_PAGES

public static final int FIELD_SECTION_PAGES
Insert the total number of pages in the section.

FIELD_SEQUENCE

public static final int FIELD_SEQUENCE
Insert an automatic sequence number.

FIELD_SET

public static final int FIELD_SET
Assign new text to a bookmark.

FIELD_SHAPE

public static final int FIELD_SHAPE
Represents an inline shape in the document. Might occur only in files. In the document object, represented by a single shape node.

FIELD_SKIP_IF

public static final int FIELD_SKIP_IF
Conditionally skip a record in a mail merge.

FIELD_STYLE_REF

public static final int FIELD_STYLE_REF
Insert the text from a like-style paragraph.

FIELD_SUBJECT

public static final int FIELD_SUBJECT
The document's subject from Summary Info.

FIELD_SYMBOL

public static final int FIELD_SYMBOL
Insert a special character.

FIELD_TEMPLATE

public static final int FIELD_TEMPLATE
The name of the template attached to the document.

FIELD_TIME

public static final int FIELD_TIME
The current time.

FIELD_TITLE

public static final int FIELD_TITLE
The document's title from Summary Info.

FIELD_TOA

public static final int FIELD_TOA
Create a table of authorities.

FIELD_TOA_ENTRY

public static final int FIELD_TOA_ENTRY
Make a table of authorities entry.

FIELD_TOC

public static final int FIELD_TOC
Create a table of contents.

FIELD_TOC_ENTRY

public static final int FIELD_TOC_ENTRY
Make a table of contents entry.

FIELD_USER_ADDRESS

public static final int FIELD_USER_ADDRESS
Address from Tools Options User Info.

FIELD_USER_INITIALS

public static final int FIELD_USER_INITIALS
Initials form Tools Options User Info.

FIELD_USER_NAME

public static final int FIELD_USER_NAME
Name from Tools Options User Info.

See Also:
          Aspose.Words Documentation - the home page for the Aspose.Words Product Documentation.
          Aspose.Words Support Forum - our preferred method of support.