public class FieldType
extends java.lang.Object
Examples:
Shows how to insert a field into a document using a field code.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
Field dateField = builder.insertField("DATE \\* MERGEFORMAT");
Assert.assertEquals(FieldType.FIELD_DATE, dateField.getType());
Assert.assertEquals("DATE \\* MERGEFORMAT", dateField.getFieldCode());
Shows how to work with a FieldStart node.
Document doc = new Document();
DocumentBuilder builder = new DocumentBuilder(doc);
FieldDate field = (FieldDate) builder.insertField(FieldType.FIELD_DATE, true);
field.getFormat().setDateTimeFormat("dddd, MMMM dd, yyyy");
field.update();
FieldChar fieldStart = field.getStart();
Assert.assertEquals(FieldType.FIELD_DATE, fieldStart.getFieldType());
Assert.assertEquals(false, fieldStart.isDirty());
Assert.assertEquals(false, fieldStart.isLocked());
// Retrieve the facade object which represents the field in the document.
field = (FieldDate) fieldStart.getField();
Assert.assertEquals(false, field.isLocked());
Assert.assertEquals(" DATE \\@ \"dddd, MMMM dd, yyyy\"", field.getFieldCode());
// Update the field to show the current date.
field.update();
| Modifier and Type | Field and Description |
|---|---|
static int |
FIELD_ADDIN
Specifies the ADDIN field.
|
static int |
FIELD_ADDRESS_BLOCK
Specifies the ADDRESSBLOCK field.
|
static int |
FIELD_ADVANCE
Specifies the ADVANCE field.
|
static int |
FIELD_ASK
Specifies the ASK field.
|
static int |
FIELD_AUTHOR
Specifies the AUTHOR field.
|
static int |
FIELD_AUTO_NUM
Specifies the AUTONUM field.
|
static int |
FIELD_AUTO_NUM_LEGAL
Specifies the AUTONUMLGL field.
|
static int |
FIELD_AUTO_NUM_OUTLINE
Specifies the AUTONUMOUT field.
|
static int |
FIELD_AUTO_TEXT
Specifies the AUTOTEXT field.
|
static int |
FIELD_AUTO_TEXT_LIST
Specifies the AUTOTEXTLIST field.
|
static int |
FIELD_BARCODE
Specifies the BARCODE field.
|
static int |
FIELD_BIBLIOGRAPHY
Specifies the BIBLIOGRAPHY field.
|
static int |
FIELD_BIDI_OUTLINE
Specifies the BIDIOUTLINE field.
|
static int |
FIELD_CANNOT_PARSE
Specifies that the field was unable to be parsed.
|
static int |
FIELD_CITATION
Specifies the CITATION field.
|
static int |
FIELD_COMMENTS
Specifies the COMMENTS field.
|
static int |
FIELD_COMPARE
Specifies the COMPARE field.
|
static int |
FIELD_CREATE_DATE
Specifies the CREATEDATE field.
|
static int |
FIELD_DATA
Specifies the DATA field.
|
static int |
FIELD_DATABASE
Specifies the DATABASE field.
|
static int |
FIELD_DATE
Specifies the DATE field.
|
static int |
FIELD_DDE
Specifies the DDE field.
|
static int |
FIELD_DDE_AUTO
Specifies the DDEAUTO field.
|
static int |
FIELD_DISPLAY_BARCODE
Specifies the DISPLAYBARCODE field.
|
static int |
FIELD_DOC_PROPERTY
Specifies the DOCPROPERTY field.
|
static int |
FIELD_DOC_VARIABLE
Specifies the DOCVARIABLE field.
|
static int |
FIELD_EDIT_TIME
Specifies the EDITTIME field.
|
static int |
FIELD_EMBED
Specifies the EMBED field.
|
static int |
FIELD_EQUATION
Specifies the EQ field.
|
static int |
FIELD_FILE_NAME
Specifies the FILENAME field.
|
static int |
FIELD_FILE_SIZE
Specifies the FILESIZE field.
|
static int |
FIELD_FILL_IN
Specifies the FILLIN field.
|
static int |
FIELD_FOOTNOTE_REF
Specifies the FOOTNOTEREF field.
|
static int |
FIELD_FORM_CHECK_BOX
Specifies the FORMCHECKBOX field.
|
static int |
FIELD_FORM_DROP_DOWN
Specifies the FORMDROPDOWN field.
|
static int |
FIELD_FORM_TEXT_INPUT
Specifies the FORMTEXT field.
|
static int |
FIELD_FORMULA
Specifies the = (formula) field.
|
static int |
FIELD_GLOSSARY
Specifies the GLOSSARY field.
|
static int |
FIELD_GO_TO_BUTTON
Specifies the GOTOBUTTON field.
|
static int |
FIELD_GREETING_LINE
Specifies the GREETINGLINE field.
|
static int |
FIELD_HTML_ACTIVE_X
Specifies the field that represents an HTML control.
|
static int |
FIELD_HYPERLINK
Specifies the HYPERLINK field.
|
static int |
FIELD_IF
Specifies the IF field.
|
static int |
FIELD_IMPORT
Specifies the IMPORT field.
|
static int |
FIELD_INCLUDE
Specifies the INCLUDE field.
|
static int |
FIELD_INCLUDE_PICTURE
Specifies the INCLUDEPICTURE field.
|
static int |
FIELD_INCLUDE_TEXT
Specifies the INCLUDETEXT field.
|
static int |
FIELD_INDEX
Specifies the INDEX field.
|
static int |
FIELD_INDEX_ENTRY
Specifies the XE field.
|
static int |
FIELD_INFO
Specifies the INFO field.
|
static int |
FIELD_KEYWORD
Specifies the KEYWORDS field.
|
static int |
FIELD_LAST_SAVED_BY
Specifies the LASTSAVEDBY field.
|
static int |
FIELD_LINK
Specifies the LINK field.
|
static int |
FIELD_LIST_NUM
Specifies the LISTNUM field.
|
static int |
FIELD_MACRO_BUTTON
Specifies the MACROBUTTON field.
|
static int |
FIELD_MERGE_BARCODE
Specifies the MERGEBARCODE field.
|
static int |
FIELD_MERGE_FIELD
Specifies the MERGEFIELD field.
|
static int |
FIELD_MERGE_REC
Specifies the MERGEREC field.
|
static int |
FIELD_MERGE_SEQ
Specifies the MERGESEQ field.
|
static int |
FIELD_NEXT
Specifies the NEXT field.
|
static int |
FIELD_NEXT_IF
Specifies the NEXTIF field.
|
static int |
FIELD_NONE
Field type is not specified or unknown.
|
static int |
FIELD_NOTE_REF
Specifies the NOTEREF field.
|
static int |
FIELD_NUM_CHARS
Specifies the NUMCHARS field.
|
static int |
FIELD_NUM_PAGES
Specifies the NUMPAGES field.
|
static int |
FIELD_NUM_WORDS
Specifies the NUMWORDS field.
|
static int |
FIELD_OCX
Specifies the OCX field.
|
static int |
FIELD_PAGE
Specifies the PAGE field.
|
static int |
FIELD_PAGE_REF
Specifies the PAGEREF field.
|
static int |
FIELD_PRINT
Specifies the PRINT field.
|
static int |
FIELD_PRINT_DATE
Specifies the PRINTDATE field.
|
static int |
FIELD_PRIVATE
Specifies the PRIVATE field.
|
static int |
FIELD_QUOTE
Specifies the QUOTE field.
|
static int |
FIELD_REF
Specifies the REF field.
|
static int |
FIELD_REF_DOC
Specifies the RD field.
|
static int |
FIELD_REF_NO_KEYWORD
Specifies that the field represents a REF field where the keyword has been omitted.
|
static int |
FIELD_REVISION_NUM
Specifies the REVNUM field.
|
static int |
FIELD_SAVE_DATE
Specifies the SAVEDATE field.
|
static int |
FIELD_SECTION
Specifies the SECTION field.
|
static int |
FIELD_SECTION_PAGES
Specifies the SECTIONPAGES field.
|
static int |
FIELD_SEQUENCE
Specifies the SEQ field.
|
static int |
FIELD_SET
Specifies the SET field.
|
static int |
FIELD_SHAPE
Specifies the SHAPE field.
|
static int |
FIELD_SKIP_IF
Specifies the SKIPIF field.
|
static int |
FIELD_STYLE_REF
Specifies the STYLEREF field.
|
static int |
FIELD_SUBJECT
Specifies the SUBJECT field.
|
static int |
FIELD_SYMBOL
Specifies the SYMBOL field.
|
static int |
FIELD_TEMPLATE
Specifies the TEMPLATE field.
|
static int |
FIELD_TIME
Specifies the TIME field.
|
static int |
FIELD_TITLE
Specifies the TITLE field.
|
static int |
FIELD_TOA
Specifies the TOA field.
|
static int |
FIELD_TOA_ENTRY
Specifies the TA field.
|
static int |
FIELD_TOC
Specifies the TOC field.
|
static int |
FIELD_TOC_ENTRY
Specifies the TC field.
|
static int |
FIELD_USER_ADDRESS
Specifies the USERADDRESS field.
|
static int |
FIELD_USER_INITIALS
Specifies the USERINITIALS field.
|
static int |
FIELD_USER_NAME
Specifies the USERNAME field.
|
static int |
length |
| Modifier and Type | Method and Description |
|---|---|
static int |
fromName(java.lang.String fieldTypeName) |
static java.lang.String |
getName(int fieldType) |
static int[] |
getValues() |
static java.lang.String |
toString(int fieldType) |
public static int FIELD_NONE
public static int FIELD_CANNOT_PARSE
public static int FIELD_ADDIN
public static int FIELD_ADDRESS_BLOCK
public static int FIELD_ADVANCE
public static int FIELD_ASK
public static int FIELD_AUTHOR
public static int FIELD_AUTO_NUM
public static int FIELD_AUTO_NUM_LEGAL
public static int FIELD_AUTO_NUM_OUTLINE
public static int FIELD_AUTO_TEXT
public static int FIELD_AUTO_TEXT_LIST
public static int FIELD_BARCODE
public static int FIELD_BIBLIOGRAPHY
public static int FIELD_BIDI_OUTLINE
public static int FIELD_CITATION
public static int FIELD_COMMENTS
public static int FIELD_COMPARE
public static int FIELD_CREATE_DATE
public static int FIELD_DATA
public static int FIELD_DATABASE
public static int FIELD_DATE
public static int FIELD_DDE
public static int FIELD_DISPLAY_BARCODE
public static int FIELD_MERGE_BARCODE
public static int FIELD_DDE_AUTO
public static int FIELD_DOC_PROPERTY
public static int FIELD_DOC_VARIABLE
public static int FIELD_EDIT_TIME
public static int FIELD_EMBED
public static int FIELD_EQUATION
public static int FIELD_FILE_NAME
public static int FIELD_FILE_SIZE
public static int FIELD_FILL_IN
public static int FIELD_FOOTNOTE_REF
public static int FIELD_FORM_CHECK_BOX
public static int FIELD_FORM_DROP_DOWN
public static int FIELD_FORM_TEXT_INPUT
public static int FIELD_FORMULA
public static int FIELD_GREETING_LINE
public static int FIELD_GLOSSARY
public static int FIELD_GO_TO_BUTTON
public static int FIELD_HTML_ACTIVE_X
public static int FIELD_HYPERLINK
public static int FIELD_IF
public static int FIELD_INCLUDE
public static int FIELD_INCLUDE_PICTURE
public static int FIELD_INCLUDE_TEXT
public static int FIELD_INDEX
public static int FIELD_INDEX_ENTRY
public static int FIELD_INFO
public static int FIELD_IMPORT
public static int FIELD_KEYWORD
public static int FIELD_LAST_SAVED_BY
public static int FIELD_LINK
public static int FIELD_LIST_NUM
public static int FIELD_MACRO_BUTTON
public static int FIELD_MERGE_FIELD
public static int FIELD_MERGE_REC
public static int FIELD_MERGE_SEQ
public static int FIELD_NEXT
public static int FIELD_NEXT_IF
public static int FIELD_NOTE_REF
public static int FIELD_NUM_CHARS
public static int FIELD_NUM_PAGES
public static int FIELD_NUM_WORDS
public static int FIELD_OCX
Specifies the OCX field.
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.
public static int FIELD_PAGE
public static int FIELD_PAGE_REF
public static int FIELD_PRINT
public static int FIELD_PRINT_DATE
public static int FIELD_PRIVATE
public static int FIELD_QUOTE
public static int FIELD_REF
public static int FIELD_REF_NO_KEYWORD
public static int FIELD_REF_DOC
public static int FIELD_REVISION_NUM
public static int FIELD_SAVE_DATE
public static int FIELD_SECTION
public static int FIELD_SECTION_PAGES
public static int FIELD_SEQUENCE
public static int FIELD_SET
public static int FIELD_SHAPE
public static int FIELD_SKIP_IF
public static int FIELD_STYLE_REF
public static int FIELD_SUBJECT
public static int FIELD_SYMBOL
public static int FIELD_TEMPLATE
public static int FIELD_TIME
public static int FIELD_TITLE
public static int FIELD_TOA
public static int FIELD_TOA_ENTRY
public static int FIELD_TOC
public static int FIELD_TOC_ENTRY
public static int FIELD_USER_ADDRESS
public static int FIELD_USER_INITIALS
public static int FIELD_USER_NAME
public static int length