Word.Interfaces.FieldData interface

パッケージ:

word

field.toJSON() を呼び出すことによって返されるデータを記述するインターフェイス。

プロパティ

code	フィールドのコード命令を指定します。
data	"Addin" フィールドにデータを指定します。 フィールドが "Addin" フィールドでない場合は、 null され、コードで設定しようとすると一般的な例外がスローされます。
kind	フィールドの種類を取得します。
locked	フィールドがロックされているかどうかを指定します。 true フィールドがロックされている場合は、それ以外の場合 false 。
result	フィールドの結果データを取得します。
showCodes	指定したフィールドのフィールド コードを表示するかどうかを指定します。 true フィールド コードが表示される場合は、それ以外の場合 false 。
type	フィールドの型を取得します。

プロパティの詳細

code

フィールドのコード命令を指定します。

code?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.4 ]

注: コードを設定する機能は、WordApi 1.5 で導入されました。

data

"Addin" フィールドにデータを指定します。 フィールドが "Addin" フィールドでない場合は、 null され、コードで設定しようとすると一般的な例外がスローされます。

data?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.5 ]

kind

フィールドの種類を取得します。

kind?: Word.FieldKind | "None" | "Hot" | "Warm" | "Cold";

プロパティ値

Word.FieldKind | "None" | "Hot" | "Warm" | "Cold"

注釈

[ API セット: WordApi 1.5 ]

locked

フィールドがロックされているかどうかを指定します。 true フィールドがロックされている場合は、それ以外の場合 false 。

locked?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.5 ]

result

フィールドの結果データを取得します。

result?: Word.Interfaces.RangeData;

プロパティ値

Word.Interfaces.RangeData

注釈

[ API セット: WordApi 1.4 ]

showCodes

指定したフィールドのフィールド コードを表示するかどうかを指定します。 true フィールド コードが表示される場合は、それ以外の場合 false 。

showCodes?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApiDesktop 1.1 ]

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";

プロパティ値

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"

注釈

[ API セット: WordApi 1.5 ]