Word.Interfaces.ContentControlData interface
contentControl.toJSON()
の呼び出しによって返されるデータを記述するインターフェイス。
プロパティ
| appearance | コンテンツ コントロールの外観を指定します。 値には、 |
| building |
コンテンツ コントロールが Word の場合、文書パーツ ギャラリー関連のデータを取得します。ContentControlType は |
| cannot |
ユーザーがコンテンツ コントロールを削除できるかどうかを指定します。
|
| cannot |
ユーザーがコンテンツ コントロールの内容を編集できるかどうかを指定します。 |
| checkbox |
種類が |
| color | コンテンツ コントロールの色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。 |
| combo |
種類が |
| content |
コンテンツ コントロール内の |
| date |
コンテンツ コントロールが Word である場合は、日付の選択に関連するデータを取得します。ContentControlType は |
| drop |
種類が |
| fields | コンテンツ コントロール内の |
| font | コンテンツ コントロールのテキストの書式設定を取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。 |
| group |
コンテンツ コントロールが Word である場合は、グループ関連のデータを取得します。ContentControlType は |
| id | コンテンツ コントロールの識別子を表す整数値を取得します。 |
| inline |
コンテンツ コントロール内の |
| lists | コンテンツ コントロール内の |
| paragraphs | コンテンツ コントロール内の |
| picture |
コンテンツ コントロールが Word である場合は、画像関連データを取得します。ContentControlType は |
| placeholder |
コンテンツ コントロールのプレースホルダー テキストを指定します。 コンテンツ コントロールが空の場合は、淡色のテキストが表示されます。 |
| remove |
コンテンツ コントロールを編集後に削除するかどうかを指定します。
|
| repeating |
コンテンツ コントロールの Word の場合、繰り返しセクション関連のデータを取得します。ContentControlType は |
| style | コンテンツ コントロールのスタイル名を指定します。 カスタム スタイルとローカライズされたスタイルの名前には、このプロパティを使用します。 ロケール間で移植可能な組み込みスタイルを使用するには、 |
| style |
コンテンツ コントロールの組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイル名を使用するには、 |
| subtype | コンテンツ コントロールのサブタイプを取得します。 サブタイプには、リッチ テキスト コンテンツ コントロール用の |
| tables | コンテンツ コントロール内の |
| tag | コンテンツ コントロールを識別するためのタグを指定します。 |
| text | コンテンツ コントロールのテキストを取得します。 |
| title | コンテンツ コントロールのタイトルを指定します。 |
| type | コンテンツ コントロールの種類を取得します。 現在サポートされているのは、リッチ テキスト、プレーン テキスト、チェック ボックス、ドロップダウン リスト、コンボ ボックス、文書パーツ ギャラリー、日付選択、繰り返しセクション、画像、グループ コンテンツ コントロールのみです。 |
| xml |
ドキュメントのデータ ストア内の XML データに対するコンテンツ コントロールのマッピングを表す |
プロパティの詳細
appearance
コンテンツ コントロールの外観を指定します。 値には、 boundingBox、 tags、または hidden を指定できます。
appearance?: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";
プロパティ値
Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"
注釈
buildingBlockGalleryContentControl
コンテンツ コントロールが Word の場合、文書パーツ ギャラリー関連のデータを取得します。ContentControlType は buildingBlockGallery です。 それ以外の場合は null です。
buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlData;
プロパティ値
注釈
cannotDelete
ユーザーがコンテンツ コントロールを削除できるかどうかを指定します。
removeWhenEdited
と同時に使用することはできません。
cannotDelete?: boolean;
プロパティ値
boolean
注釈
cannotEdit
checkboxContentControl
種類が checkBox のときにコンテンツ コントロールのデータを取得します。 それ以外の場合は null です。
checkboxContentControl?: Word.Interfaces.CheckboxContentControlData;
プロパティ値
注釈
color
コンテンツ コントロールの色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。
color?: string;
プロパティ値
string
注釈
comboBoxContentControl
種類が comboBox のときにコンテンツ コントロールのデータを取得します。 それ以外の場合は null です。
comboBoxContentControl?: Word.Interfaces.ComboBoxContentControlData;
プロパティ値
注釈
contentControls
コンテンツ コントロール内の ContentControl オブジェクトのコレクションを取得します。
contentControls?: Word.Interfaces.ContentControlData[];
プロパティ値
注釈
datePickerContentControl
コンテンツ コントロールが Word である場合は、日付の選択に関連するデータを取得します。ContentControlType は datePicker です。 それ以外の場合は null です。
datePickerContentControl?: Word.Interfaces.DatePickerContentControlData;
プロパティ値
注釈
dropDownListContentControl
種類が dropDownList のときにコンテンツ コントロールのデータを取得します。 それ以外の場合は null です。
dropDownListContentControl?: Word.Interfaces.DropDownListContentControlData;
プロパティ値
注釈
fields
コンテンツ コントロール内の Field オブジェクトのコレクションを取得します。
fields?: Word.Interfaces.FieldData[];
プロパティ値
注釈
font
コンテンツ コントロールのテキストの書式設定を取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。
font?: Word.Interfaces.FontData;
プロパティ値
注釈
groupContentControl
コンテンツ コントロールが Word である場合は、グループ関連のデータを取得します。ContentControlType は group です。 それ以外の場合は null です。
groupContentControl?: Word.Interfaces.GroupContentControlData;
プロパティ値
注釈
id
inlinePictures
コンテンツ コントロール内の InlinePicture オブジェクトのコレクションを取得します。 コレクションには、フローティング イメージは含まれません。
inlinePictures?: Word.Interfaces.InlinePictureData[];
プロパティ値
注釈
lists
コンテンツ コントロール内の List オブジェクトのコレクションを取得します。
lists?: Word.Interfaces.ListData[];
プロパティ値
注釈
paragraphs
コンテンツ コントロール内の Paragraph オブジェクトのコレクションを取得します。
paragraphs?: Word.Interfaces.ParagraphData[];
プロパティ値
注釈
重要: 要件セット 1.1 および 1.2 の場合、このコンテンツ コントロールに完全に含まれるテーブル内の段落は返されません。 要件セット 1.3 から、このようなテーブルの段落も返されます。
pictureContentControl
コンテンツ コントロールが Word である場合は、画像関連データを取得します。ContentControlType は picture です。 それ以外の場合は null です。
pictureContentControl?: Word.Interfaces.PictureContentControlData;
プロパティ値
注釈
placeholderText
コンテンツ コントロールのプレースホルダー テキストを指定します。 コンテンツ コントロールが空の場合は、淡色のテキストが表示されます。
placeholderText?: string;
プロパティ値
string
注釈
removeWhenEdited
コンテンツ コントロールを編集後に削除するかどうかを指定します。
cannotDelete
と同時に使用することはできません。
removeWhenEdited?: boolean;
プロパティ値
boolean
注釈
repeatingSectionContentControl
コンテンツ コントロールの Word の場合、繰り返しセクション関連のデータを取得します。ContentControlType は repeatingSection です。 それ以外の場合は null です。
repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlData;
プロパティ値
注釈
style
コンテンツ コントロールのスタイル名を指定します。 カスタム スタイルとローカライズされたスタイルの名前には、このプロパティを使用します。 ロケール間で移植可能な組み込みスタイルを使用するには、 styleBuiltIn プロパティを参照してください。
style?: string;
プロパティ値
string
注釈
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"
注釈
subtype
コンテンツ コントロールのサブタイプを取得します。 サブタイプには、リッチ テキスト コンテンツ コントロール用の richTextInline、richTextParagraphs、richTextTableCell、richTextTableRow、richTextTable、プレーン テキスト コンテンツ コントロール用のplainTextInlineとcheckBoxplainTextParagraph、チェックボックス コンテンツ コントロール用のと、ドロップダウン リスト コンテンツ コントロールの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"
注釈
tables
コンテンツ コントロール内の Table オブジェクトのコレクションを取得します。
tables?: Word.Interfaces.TableData[];
プロパティ値
注釈
tag
text
title
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"
注釈
xmlMapping
ドキュメントのデータ ストア内の XML データに対するコンテンツ コントロールのマッピングを表す XmlMapping オブジェクトを返します。
xmlMapping?: Word.Interfaces.XmlMappingData;