次の方法で共有


Word.Interfaces.ContentControlData interface

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

プロパティ

appearance

コンテンツ コントロールの外観を指定します。 値は、 boundingBoxtags、または hiddenできます。

buildingBlockGalleryContentControl

コンテンツ コントロールのWord場合は、文書パーツ ギャラリーに関連するデータを取得します。ContentControlTypebuildingBlockGallery。 それ以外の場合は null

cannotDelete

ユーザーがコンテンツ コントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と相互に排他的です。

cannotEdit

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

checkboxContentControl

コンテンツ コントロールの型が checkBoxされたときに、コンテンツ コントロールのデータを取得します。 それ以外の場合は null

color

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

comboBoxContentControl

コンテンツ コントロールの型が comboBoxされたときに、コンテンツ コントロールのデータを取得します。 それ以外の場合は null

contentControls

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

datePickerContentControl

コンテンツ コントロールのWord場合は、日付ピッカー関連のデータを取得します。ContentControlTypedatePicker。 それ以外の場合は null

dropDownListContentControl

コンテンツ コントロールの型が dropDownListされたときに、コンテンツ コントロールのデータを取得します。 それ以外の場合は null

fields

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

font

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

groupContentControl

コンテンツ コントロールのWord場合は、グループ関連のデータを取得します。ContentControlTypegroup。 それ以外の場合は null

id

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

inlinePictures

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

lists

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

paragraphs

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

pictureContentControl

コンテンツ コントロールのWord場合は、画像関連のデータを取得します。ContentControlTypepicture。 それ以外の場合は null

placeholderText

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

removeWhenEdited

コンテンツ コントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と相互に排他的です。

repeatingSectionContentControl

コンテンツ コントロールのWord場合に繰り返しセクション関連のデータを取得します。ContentControlTyperepeatingSection。 それ以外の場合は null

style

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

styleBuiltIn

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

subtype

コンテンツ コントロールのサブタイプを取得します。 サブタイプは、リッチ テキスト コンテンツ コントロールの richTextInlinerichTextParagraphsrichTextTableCellrichTextTableRowrichTextTable できます。 プレーン テキスト コンテンツ コントロールの plainTextInlineplainTextParagraph 、チェック ボックス コンテンツ コントロールの checkBox 、ドロップダウン リスト コンテンツ コントロールの dropDownList 、コンボ ボックス コンテンツ コントロールの comboBox 、文書パーツ ギャラリー コンテンツ コントロールの buildingBlockGallery 、日付ピッカー コンテンツ コントロールの datePicker 、セクション コンテンツ コントロールの繰り返し用の repeatingSection 、画像コンテンツ コントロールの picture 、グループ コンテンツ コントロールの group

tables

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

tag

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

text

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

title

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

type

コンテンツ コントロールの種類を取得します。 現在、リッチ テキスト、プレーン テキスト、チェック ボックス、ドロップダウン リスト、コンボ ボックス、文書パーツ ギャラリー、日付ピッカー、繰り返しセクション、画像、およびグループ コンテンツ コントロールのみがサポートされています。

xmlMapping

ドキュメントのデータ ストア内の XML データへのコンテンツ コントロールのマッピングを表す XmlMapping オブジェクトを返します。

プロパティの詳細

appearance

コンテンツ コントロールの外観を指定します。 値は、 boundingBoxtags、または hiddenできます。

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

プロパティ値

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

注釈

[ API セット: WordApi 1.1 ]

buildingBlockGalleryContentControl

コンテンツ コントロールのWord場合は、文書パーツ ギャラリーに関連するデータを取得します。ContentControlTypebuildingBlockGallery。 それ以外の場合は null

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

cannotDelete

ユーザーがコンテンツ コントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と相互に排他的です。

cannotDelete?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

cannotEdit

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

cannotEdit?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

checkboxContentControl

コンテンツ コントロールの型が checkBoxされたときに、コンテンツ コントロールのデータを取得します。 それ以外の場合は null

checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;

プロパティ値

注釈

[ API セット: WordApi 1.7 ]

color

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

color?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

comboBoxContentControl

コンテンツ コントロールの型が comboBoxされたときに、コンテンツ コントロールのデータを取得します。 それ以外の場合は null

comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;

プロパティ値

注釈

[ API セット: WordApi 1.9 ]

contentControls

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

contentControls?: Word.Interfaces.ContentControlData[];

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

datePickerContentControl

コンテンツ コントロールのWord場合は、日付ピッカー関連のデータを取得します。ContentControlTypedatePicker。 それ以外の場合は null

datePickerContentControl?: Word.Interfaces.DatePickerContentControlData;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

dropDownListContentControl

コンテンツ コントロールの型が dropDownListされたときに、コンテンツ コントロールのデータを取得します。 それ以外の場合は null

dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;

プロパティ値

注釈

[ API セット: WordApi 1.9 ]

fields

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

fields?: Word.Interfaces.FieldData[];

プロパティ値

注釈

[ API セット: WordApi 1.4 ]

font

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

font?: Word.Interfaces.FontData;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

groupContentControl

コンテンツ コントロールのWord場合は、グループ関連のデータを取得します。ContentControlTypegroup。 それ以外の場合は null

groupContentControl?: Word.Interfaces.GroupContentControlData;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

id

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

id?: number;

プロパティ値

number

注釈

[ API セット: WordApi 1.1 ]

inlinePictures

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

inlinePictures?: Word.Interfaces.InlinePictureData[];

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

lists

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

lists?: Word.Interfaces.ListData[];

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

paragraphs

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

paragraphs?: Word.Interfaces.ParagraphData[];

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

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

pictureContentControl

コンテンツ コントロールのWord場合は、画像関連のデータを取得します。ContentControlTypepicture。 それ以外の場合は null

pictureContentControl?: Word.Interfaces.PictureContentControlData;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

placeholderText

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

placeholderText?: string;

プロパティ値

string

注釈

[ API セット: WordApi 1.1 ]

removeWhenEdited

コンテンツ コントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と相互に排他的です。

removeWhenEdited?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

repeatingSectionContentControl

コンテンツ コントロールのWord場合に繰り返しセクション関連のデータを取得します。ContentControlTyperepeatingSection。 それ以外の場合は null

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

プロパティ値

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

コンテンツ コントロールのサブタイプを取得します。 サブタイプは、リッチ テキスト コンテンツ コントロールの richTextInlinerichTextParagraphsrichTextTableCellrichTextTableRowrichTextTable できます。 プレーン テキスト コンテンツ コントロールの plainTextInlineplainTextParagraph 、チェック ボックス コンテンツ コントロールの checkBox 、ドロップダウン リスト コンテンツ コントロールの dropDownList 、コンボ ボックス コンテンツ コントロールの comboBox 、文書パーツ ギャラリー コンテンツ コントロールの buildingBlockGallery 、日付ピッカー コンテンツ コントロールの datePicker 、セクション コンテンツ コントロールの繰り返し用の repeatingSection 、画像コンテンツ コントロールの picture 、グループ コンテンツ コントロールの group

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

プロパティ値

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

注釈

[ API セット: WordApi 1.3 ]

tables

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

tables?: 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" | "Group";

プロパティ値

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

注釈

[ API セット: WordApi 1.1 ]

xmlMapping

ドキュメントのデータ ストア内の XML データへのコンテンツ コントロールのマッピングを表す XmlMapping オブジェクトを返します。

xmlMapping?: Word.Interfaces.XmlMappingData;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]