Word.Interfaces.ContentControlCollectionLoadOptions interface
Wordのコレクションを格納します。ContentControl オブジェクト。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能する、ラベルを付けることのできる、境界線で区切られたドキュメント内の領域です。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキストとプレーン テキスト コンテンツ コントロールのみがサポートされています。
注釈
プロパティ
$all | 読み込みオプションに |
appearance | コレクション内の各項目の場合: コンテンツ コントロールの外観を指定します。 値には、'BoundingBox'、'Tags'、または 'Hidden' を指定できます。 |
cannot |
コレクション内の各項目の場合: ユーザーがコンテンツ コントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と同時に使用することはできません。 |
cannot |
コレクション内の各項目について: ユーザーがコンテンツ コントロールの内容を編集できるかどうかを示す値を指定します。 |
checkbox |
コレクション内の各項目について: コンテンツ コントロールの種類が 'CheckBox' の場合に、コンテンツ コントロールのデータを取得します。 それ以外の場合は |
color | コレクション内の各項目の場合: コンテンツ コントロールの色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。 |
font | コレクション内の各項目について: コンテンツ コントロールのテキスト形式を取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。 |
id | コレクション内の各項目について: コンテンツ コントロール識別子を表す整数を取得します。 |
parent |
コレクション内の各項目について: コンテンツ コントロールの親本体を取得します。 |
parent |
コレクション内の各項目について: コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 |
parent |
コレクション内の各項目について: コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは |
parent |
コレクション内の各項目について: コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合は、 |
parent |
コレクション内の各項目について: コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 |
parent |
コレクション内の各項目について: コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは |
parent |
コレクション内の各項目について: コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは |
placeholder |
コレクション内の各項目の場合: コンテンツ コントロールのプレースホルダー テキストを指定します。 コンテンツ コントロールが空の場合は、淡色のテキストが表示されます。 |
remove |
コレクション内の各項目について: コンテンツ コントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と同時に使用することはできません。 |
style | コレクション内の各項目の場合: コンテンツ コントロールのスタイル名を指定します。 カスタム スタイルとローカライズされたスタイルの名前には、このプロパティを使用します。 ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。 |
style |
コレクション内の各項目の場合: コンテンツ コントロールの組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。 |
subtype | コレクション内の各項目について: コンテンツ コントロールのサブタイプを取得します。 サブタイプは、リッチ テキスト コンテンツ コントロールの場合は 'RichTextInline'、'RichTextParagraphs'、'RichTextTableCell'、リッチ テキスト コンテンツ コントロールの場合は 'RichTextTableRow'、'RichTextTable'、プレーン テキスト コンテンツ コントロールの場合は 'PlainTextInline' と 'PlainTextParagraph'、チェックボックス コンテンツ コントロールの場合は 'CheckBox' です。 |
tag | コレクション内の各項目に対して: コンテンツ コントロールを識別するタグを指定します。 |
text | コレクション内の各項目について: コンテンツ コントロールのテキストを取得します。 |
title | コレクション内の各項目の場合: コンテンツ コントロールのタイトルを指定します。 |
type | コレクション内の各項目について: コンテンツ コントロールの種類を取得します。 現在サポートされているのは、リッチ テキスト、プレーン テキスト、チェックボックス コンテンツ コントロールのみです。 |
プロパティの詳細
$all
読み込みオプションに $all
を指定すると、すべてのスカラー プロパティ ( Range.address
など) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color
など) は読み込まれません。
$all?: boolean;
プロパティ値
boolean
appearance
コレクション内の各項目の場合: コンテンツ コントロールの外観を指定します。 値には、'BoundingBox'、'Tags'、または 'Hidden' を指定できます。
appearance?: boolean;
プロパティ値
boolean
注釈
cannotDelete
コレクション内の各項目の場合: ユーザーがコンテンツ コントロールを削除できるかどうかを示す値を指定します。 removeWhenEdited と同時に使用することはできません。
cannotDelete?: boolean;
プロパティ値
boolean
注釈
cannotEdit
コレクション内の各項目について: ユーザーがコンテンツ コントロールの内容を編集できるかどうかを示す値を指定します。
cannotEdit?: boolean;
プロパティ値
boolean
注釈
checkboxContentControl
コレクション内の各項目について: コンテンツ コントロールの種類が 'CheckBox' の場合に、コンテンツ コントロールのデータを取得します。 それ以外の場合は null
。
checkboxContentControl?: Word.Interfaces.CheckboxContentControlLoadOptions;
プロパティ値
注釈
color
コレクション内の各項目の場合: コンテンツ コントロールの色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。
color?: boolean;
プロパティ値
boolean
注釈
font
コレクション内の各項目について: コンテンツ コントロールのテキスト形式を取得します。 これを使用して、フォント名、サイズ、色、およびその他のプロパティを取得および設定します。
font?: Word.Interfaces.FontLoadOptions;
プロパティ値
注釈
id
コレクション内の各項目について: コンテンツ コントロール識別子を表す整数を取得します。
id?: boolean;
プロパティ値
boolean
注釈
parentBody
コレクション内の各項目について: コンテンツ コントロールの親本体を取得します。
parentBody?: Word.Interfaces.BodyLoadOptions;
プロパティ値
注釈
parentContentControl
コレクション内の各項目について: コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound
エラーをスローします。
parentContentControl?: Word.Interfaces.ContentControlLoadOptions;
プロパティ値
注釈
parentContentControlOrNullObject
コレクション内の各項目について: コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;
プロパティ値
注釈
parentTable
コレクション内の各項目について: コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound
エラーをスローします。
parentTable?: Word.Interfaces.TableLoadOptions;
プロパティ値
注釈
parentTableCell
コレクション内の各項目について: コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound
エラーをスローします。
parentTableCell?: Word.Interfaces.TableCellLoadOptions;
プロパティ値
注釈
parentTableCellOrNullObject
コレクション内の各項目について: コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;
プロパティ値
注釈
parentTableOrNullObject
コレクション内の各項目について: コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;
プロパティ値
注釈
placeholderText
コレクション内の各項目の場合: コンテンツ コントロールのプレースホルダー テキストを指定します。 コンテンツ コントロールが空の場合は、淡色のテキストが表示されます。
placeholderText?: boolean;
プロパティ値
boolean
注釈
removeWhenEdited
コレクション内の各項目について: コンテンツ コントロールが編集後に削除されるかどうかを示す値を指定します。 cannotDelete と同時に使用することはできません。
removeWhenEdited?: boolean;
プロパティ値
boolean
注釈
style
コレクション内の各項目の場合: コンテンツ コントロールのスタイル名を指定します。 カスタム スタイルとローカライズされたスタイルの名前には、このプロパティを使用します。 ロケール間で移植可能な組み込みスタイルを使用するには、"styleBuiltIn" プロパティを参照してください。
style?: boolean;
プロパティ値
boolean
注釈
styleBuiltIn
コレクション内の各項目の場合: コンテンツ コントロールの組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイルの名前を使用するには、"style" プロパティを参照してください。
styleBuiltIn?: boolean;
プロパティ値
boolean
注釈
subtype
コレクション内の各項目について: コンテンツ コントロールのサブタイプを取得します。 サブタイプは、リッチ テキスト コンテンツ コントロールの場合は 'RichTextInline'、'RichTextParagraphs'、'RichTextTableCell'、リッチ テキスト コンテンツ コントロールの場合は 'RichTextTableRow'、'RichTextTable'、プレーン テキスト コンテンツ コントロールの場合は 'PlainTextInline' と 'PlainTextParagraph'、チェックボックス コンテンツ コントロールの場合は 'CheckBox' です。
subtype?: boolean;
プロパティ値
boolean
注釈
tag
コレクション内の各項目に対して: コンテンツ コントロールを識別するタグを指定します。
tag?: boolean;
プロパティ値
boolean
注釈
text
コレクション内の各項目について: コンテンツ コントロールのテキストを取得します。
text?: boolean;
プロパティ値
boolean
注釈
title
コレクション内の各項目の場合: コンテンツ コントロールのタイトルを指定します。
title?: boolean;
プロパティ値
boolean
注釈
type
コレクション内の各項目について: コンテンツ コントロールの種類を取得します。 現在サポートされているのは、リッチ テキスト、プレーン テキスト、チェックボックス コンテンツ コントロールのみです。
type?: boolean;
プロパティ値
boolean
注釈
Office Add-ins