Word.Interfaces.FieldData interface
An interface describing the data returned by calling field.toJSON().
Properties
| code | Specifies the field's code instruction. |
| data | Specifies data in a field of |
| kind | Gets the field's kind. |
| locked | Specifies whether the field is locked. |
| result | Gets the field's result data. |
| show |
Specifies whether the field codes are displayed for the specified field. |
| type | Gets the field's type. |
Property Details
code
Specifies the field's code instruction.
code?: string;Property Value
string
Remarks
Note: The ability to set the code was introduced in WordApi 1.5.
data
Specifies data in a field of addin type. If the field isn't an addin type, it's null and it will throw a general exception when code attempts to set it.
data?: string;Property Value
string
Remarks
kind
Gets the field's kind.
kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold";Property Value
Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"
Remarks
locked
Specifies whether the field is locked. true if the field is locked, false otherwise.
locked?: boolean;Property Value
boolean
Remarks
result
Gets the field's result data.
result?: Word.Interfaces.RangeData;Property Value
Remarks
showCodes
Specifies whether the field codes are displayed for the specified field. true if the field codes are displayed, false otherwise.
showCodes?: boolean;Property Value
boolean
Remarks
type
Gets the field's type.
type?: Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined";Property Value
Word.FieldType | "Addin" | "AddressBlock" | "Advance" | "Ask" | "Author" | "AutoText" | "AutoTextList" | "BarCode" | "Bibliography" | "BidiOutline" | "Citation" | "Comments" | "Compare" | "CreateDate" | "Data" | "Database" | "Date" | "DisplayBarcode" | "DocProperty" | "DocVariable" | "EditTime" | "Embedded" | "EQ" | "Expression" | "FileName" | "FileSize" | "FillIn" | "FormCheckbox" | "FormDropdown" | "FormText" | "GotoButton" | "GreetingLine" | "Hyperlink" | "If" | "Import" | "Include" | "IncludePicture" | "IncludeText" | "Index" | "Info" | "Keywords" | "LastSavedBy" | "Link" | "ListNum" | "MacroButton" | "MergeBarcode" | "MergeField" | "MergeRec" | "MergeSeq" | "Next" | "NextIf" | "NoteRef" | "NumChars" | "NumPages" | "NumWords" | "OCX" | "Page" | "PageRef" | "Print" | "PrintDate" | "Private" | "Quote" | "RD" | "Ref" | "RevNum" | "SaveDate" | "Section" | "SectionPages" | "Seq" | "Set" | "Shape" | "SkipIf" | "StyleRef" | "Subject" | "Subscriber" | "Symbol" | "TA" | "TC" | "Template" | "Time" | "Title" | "TOA" | "TOC" | "UserAddress" | "UserInitials" | "UserName" | "XE" | "Empty" | "Others" | "Undefined"