Word.Interfaces.ContentControlData interface

リファレンス

パッケージ:: word

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

プロパティ

appearance	コンテンツコントロールの外観を指定します。値には、'BoundingBox'、'Tags'、または 'Hidden' を指定できます。
cannotDelete	ユーザーがコンテンツコントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と同時に使用することはできません。
cannotEdit	ユーザーがコンテンツコントロールの内容を編集できるかどうかを示す値を指定します。
checkboxContentControl	コンテンツコントロールの種類が 'CheckBox' の場合は、チェックボックスに関連するデータを指定します。それ以外の場合は `null` 。
color	コンテンツコントロールの色を指定します。色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。
contentControls	コンテンツコントロールのコンテンツコントロールオブジェクトのコレクションを取得します。
fields	コンテンツコントロール内のフィールドオブジェクトのコレクションを取得します。
font	コンテンツコントロールのテキストの書式設定を取得します。これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。
id	コンテンツコントロールの識別子を表す整数値を取得します。
inlinePictures	コンテンツコントロール内の InlinePicture オブジェクトのコレクションを取得します。コレクションにはフローティングイメージは含まれません。
lists	コンテンツコントロールに含まれるリストオブジェクトのコレクションを取得します。
paragraphs	コンテンツコントロール内の段落オブジェクトのコレクションを取得します。
placeholderText	コンテンツコントロールのプレースホルダーテキストを指定します。コンテンツコントロールが空の場合は、淡色のテキストが表示されます。注: このプロパティの設定操作は、web 上のWordではサポートされていません。
removeWhenEdited	コンテンツコントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と同時に使用することはできません。
style	コンテンツコントロールのスタイル名を指定します。カスタムスタイルとローカライズされたスタイルの名前には、このプロパティを使用します。ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。
styleBuiltIn	コンテンツコントロールの組み込みスタイル名を指定します。ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。カスタムスタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。
subtype	コンテンツコントロールのサブタイプを取得します。サブタイプは、リッチテキストコンテンツコントロールの場合は 'RichTextInline'、'RichTextParagraphs'、'RichTextTableCell'、リッチテキストコンテンツコントロールの場合は 'RichTextTableRow'、'RichTextTable'、プレーンテキストコンテンツコントロールの場合は 'PlainTextInline' と 'PlainTextParagraph'、チェックボックスコンテンツコントロールの場合は 'CheckBox' です。
tables	コンテンツコントロールに含まれるテーブルオブジェクトのコレクションを取得します。
tag	コンテンツコントロールを識別するタグを指定します。
text	コンテンツコントロールのテキストを取得します。
title	コンテンツコントロールのタイトルを指定します。
type	コンテンツコントロールの種類を取得します。現在サポートされているのは、リッチテキスト、プレーンテキスト、チェックボックスコンテンツコントロールのみです。

プロパティの詳細

appearance

コンテンツコントロールの外観を指定します。値には、'BoundingBox'、'Tags'、または 'Hidden' を指定できます。

appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

プロパティ値

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

注釈

[ API セット: WordApi 1.1 ]

cannotDelete

ユーザーがコンテンツコントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と同時に使用することはできません。

cannotDelete?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

cannotEdit

ユーザーがコンテンツコントロールの内容を編集できるかどうかを示す値を指定します。

cannotEdit?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

checkboxContentControl

コンテンツコントロールの種類が 'CheckBox' の場合は、チェックボックスに関連するデータを指定します。それ以外の場合は null 。

checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;

プロパティ値

Word.Interfaces.CheckboxContentControlData

注釈

[ API セット: WordApi 1.7 ]

color

コンテンツコントロールの色を指定します。色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。

color?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

contentControls

コンテンツコントロールのコンテンツコントロールオブジェクトのコレクションを取得します。

contentControls?: Word.Interfaces.ContentControlData[];

プロパティ値

Word.Interfaces.ContentControlData[]

注釈

[ API セット: WordApi 1.1 ]

fields

コンテンツコントロール内のフィールドオブジェクトのコレクションを取得します。

fields?: Word.Interfaces.FieldData[];

プロパティ値

Word.Interfaces.FieldData[]

注釈

[ API セット: WordApi 1.4 ]

font

コンテンツコントロールのテキストの書式設定を取得します。これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。

font?: Word.Interfaces.FontData;

プロパティ値

Word.Interfaces.FontData

注釈

[ API セット: WordApi 1.1 ]

id

コンテンツコントロールの識別子を表す整数値を取得します。

id?: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.1 ]

inlinePictures

コンテンツコントロール内の InlinePicture オブジェクトのコレクションを取得します。コレクションにはフローティングイメージは含まれません。

inlinePictures?: Word.Interfaces.InlinePictureData[];

プロパティ値

Word.Interfaces.InlinePictureData[]

注釈

[ API セット: WordApi 1.1 ]

lists

コンテンツコントロールに含まれるリストオブジェクトのコレクションを取得します。

lists?: Word.Interfaces.ListData[];

プロパティ値

Word.Interfaces.ListData[]

注釈

[ API セット: WordApi 1.3 ]

paragraphs

コンテンツコントロール内の段落オブジェクトのコレクションを取得します。

paragraphs?: Word.Interfaces.ParagraphData[];

プロパティ値

Word.Interfaces.ParagraphData[]

注釈

[ API セット: WordApi 1.1 ]

重要: 要件セット 1.1 と 1.2 の場合、このコンテンツコントロールに完全に含まれるテーブル内の段落は返されません。要件セット 1.3 から、そのようなテーブル内の段落も返されます。

placeholderText

コンテンツコントロールのプレースホルダーテキストを指定します。コンテンツコントロールが空の場合は、淡色のテキストが表示されます。

注: このプロパティの設定操作は、web 上のWordではサポートされていません。

placeholderText?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

removeWhenEdited

コンテンツコントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と同時に使用することはできません。

removeWhenEdited?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

style

コンテンツコントロールのスタイル名を指定します。カスタムスタイルとローカライズされたスタイルの名前には、このプロパティを使用します。ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。

style?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

styleBuiltIn

コンテンツコントロールの組み込みスタイル名を指定します。ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。カスタムスタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。

styleBuiltIn?: Word.BuiltInStyleName | "Other" | "Normal" | "Heading1" | "Heading2" | "Heading3" | "Heading4" | "Heading5" | "Heading6" | "Heading7" | "Heading8" | "Heading9" | "Toc1" | "Toc2" | "Toc3" | "Toc4" | "Toc5" | "Toc6" | "Toc7" | "Toc8" | "Toc9" | "FootnoteText" | "Header" | "Footer" | "Caption" | "FootnoteReference" | "EndnoteReference" | "EndnoteText" | "Title" | "Subtitle" | "Hyperlink" | "Strong" | "Emphasis" | "NoSpacing" | "ListParagraph" | "Quote" | "IntenseQuote" | "SubtleEmphasis" | "IntenseEmphasis" | "SubtleReference" | "IntenseReference" | "BookTitle" | "Bibliography" | "TocHeading" | "TableGrid" | "PlainTable1" | "PlainTable2" | "PlainTable3" | "PlainTable4" | "PlainTable5" | "TableGridLight" | "GridTable1Light" | "GridTable1Light_Accent1" | "GridTable1Light_Accent2" | "GridTable1Light_Accent3" | "GridTable1Light_Accent4" | "GridTable1Light_Accent5" | "GridTable1Light_Accent6" | "GridTable2" | "GridTable2_Accent1" | "GridTable2_Accent2" | "GridTable2_Accent3" | "GridTable2_Accent4" | "GridTable2_Accent5" | "GridTable2_Accent6" | "GridTable3" | "GridTable3_Accent1" | "GridTable3_Accent2" | "GridTable3_Accent3" | "GridTable3_Accent4" | "GridTable3_Accent5" | "GridTable3_Accent6" | "GridTable4" | "GridTable4_Accent1" | "GridTable4_Accent2" | "GridTable4_Accent3" | "GridTable4_Accent4" | "GridTable4_Accent5" | "GridTable4_Accent6" | "GridTable5Dark" | "GridTable5Dark_Accent1" | "GridTable5Dark_Accent2" | "GridTable5Dark_Accent3" | "GridTable5Dark_Accent4" | "GridTable5Dark_Accent5" | "GridTable5Dark_Accent6" | "GridTable6Colorful" | "GridTable6Colorful_Accent1" | "GridTable6Colorful_Accent2" | "GridTable6Colorful_Accent3" | "GridTable6Colorful_Accent4" | "GridTable6Colorful_Accent5" | "GridTable6Colorful_Accent6" | "GridTable7Colorful" | "GridTable7Colorful_Accent1" | "GridTable7Colorful_Accent2" | "GridTable7Colorful_Accent3" | "GridTable7Colorful_Accent4" | "GridTable7Colorful_Accent5" | "GridTable7Colorful_Accent6" | "ListTable1Light" | "ListTable1Light_Accent1" | "ListTable1Light_Accent2" | "ListTable1Light_Accent3" | "ListTable1Light_Accent4" | "ListTable1Light_Accent5" | "ListTable1Light_Accent6" | "ListTable2" | "ListTable2_Accent1" | "ListTable2_Accent2" | "ListTable2_Accent3" | "ListTable2_Accent4" | "ListTable2_Accent5" | "ListTable2_Accent6" | "ListTable3" | "ListTable3_Accent1" | "ListTable3_Accent2" | "ListTable3_Accent3" | "ListTable3_Accent4" | "ListTable3_Accent5" | "ListTable3_Accent6" | "ListTable4" | "ListTable4_Accent1" | "ListTable4_Accent2" | "ListTable4_Accent3" | "ListTable4_Accent4" | "ListTable4_Accent5" | "ListTable4_Accent6" | "ListTable5Dark" | "ListTable5Dark_Accent1" | "ListTable5Dark_Accent2" | "ListTable5Dark_Accent3" | "ListTable5Dark_Accent4" | "ListTable5Dark_Accent5" | "ListTable5Dark_Accent6" | "ListTable6Colorful" | "ListTable6Colorful_Accent1" | "ListTable6Colorful_Accent2" | "ListTable6Colorful_Accent3" | "ListTable6Colorful_Accent4" | "ListTable6Colorful_Accent5" | "ListTable6Colorful_Accent6" | "ListTable7Colorful" | "ListTable7Colorful_Accent1" | "ListTable7Colorful_Accent2" | "ListTable7Colorful_Accent3" | "ListTable7Colorful_Accent4" | "ListTable7Colorful_Accent5" | "ListTable7Colorful_Accent6";

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

subtype

コンテンツコントロールのサブタイプを取得します。サブタイプは、リッチテキストコンテンツコントロールの場合は 'RichTextInline'、'RichTextParagraphs'、'RichTextTableCell'、リッチテキストコンテンツコントロールの場合は 'RichTextTableRow'、'RichTextTable'、プレーンテキストコンテンツコントロールの場合は 'PlainTextInline' と 'PlainTextParagraph'、チェックボックスコンテンツコントロールの場合は 'CheckBox' です。

subtype?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

tables

コンテンツコントロールに含まれるテーブルオブジェクトのコレクションを取得します。

tables?: Word.Interfaces.TableData[];

プロパティ値

Word.Interfaces.TableData[]

注釈

[ API セット: WordApi 1.3 ]

tag

コンテンツコントロールを識別するタグを指定します。

tag?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

text

コンテンツコントロールのテキストを取得します。

text?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

title

コンテンツコントロールのタイトルを指定します。

title?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

type

コンテンツコントロールの種類を取得します。現在サポートされているのは、リッチテキスト、プレーンテキスト、チェックボックスコンテンツコントロールのみです。

type?: Word.ContentControlType | "Unknown" | "RichTextInline" | "RichTextParagraphs" | "RichTextTableCell" | "RichTextTableRow" | "RichTextTable" | "PlainTextInline" | "PlainTextParagraph" | "Picture" | "BuildingBlockGallery" | "CheckBox" | "ComboBox" | "DropDownList" | "DatePicker" | "RepeatingSection" | "RichText" | "PlainText";

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

次の方法で共有

Word.Interfaces.ContentControlData interface

プロパティ

プロパティの詳細

appearance

プロパティ値

注釈

cannotDelete

プロパティ値

注釈

cannotEdit

プロパティ値

注釈

checkboxContentControl

プロパティ値

注釈

color

プロパティ値

注釈

contentControls

プロパティ値

注釈

fields

プロパティ値

注釈

font

プロパティ値

注釈

id

プロパティ値

注釈

inlinePictures

プロパティ値

注釈

lists

プロパティ値

注釈

paragraphs

プロパティ値

注釈

placeholderText

プロパティ値

注釈

removeWhenEdited

プロパティ値

注釈

style

プロパティ値

注釈

styleBuiltIn

プロパティ値

注釈

subtype

プロパティ値

注釈

tables

プロパティ値

注釈

tag

プロパティ値

注釈

text

プロパティ値

注釈

title

プロパティ値

注釈

type

プロパティ値

注釈

その他のリソース