次の方法で共有


Word.Interfaces.ContentControlLoadOptions interface

コンテンツ コントロールを表します。 コンテンツ コントロールは、特定の種類のコンテンツのコンテナーとして機能し、ドキュメント内で境界線で区切られ、ラベルが付いた領域になる場合もあります。 個々のコンテンツ コントロールには、画像、テーブル、書式設定されたテキストの段落などのコンテンツが含まれていることがあります。 現時点では、リッチ テキスト、プレーン テキスト、およびチェック ボックス コンテンツ コントロールのみがサポートされています。

注釈

[ API セット: WordApi 1.1 ]

プロパティ

$all

読み込みオプションに $all を指定すると、すべてのスカラー プロパティ ( Range.addressなど) が読み込まれますが、ナビゲーション プロパティ ( Range.format.fill.color など) は読み込まれません。

appearance

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

cannotDelete

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

cannotEdit

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

checkboxContentControl

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

color

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

font

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

id

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

parentBody

コンテンツ コントロールの親の本文を取得します。

parentContentControl

コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound エラーをスローします。

parentContentControlOrNullObject

コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTable

コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTableCell

コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTableCellOrNullObject

コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTableOrNullObject

コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

placeholderText

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

removeWhenEdited

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

style

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

styleBuiltIn

コンテンツ コントロールの組み込みスタイル名を指定します。 ロケール間で移植可能な組み込みスタイルの場合は、このプロパティを使用します。 カスタム スタイルまたはローカライズされたスタイルの名前を使用するには、"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

注釈

[ 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.CheckboxContentControlLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.7 ]

color

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

color?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

font

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

font?: Word.Interfaces.FontLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

id

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

id?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

parentBody

コンテンツ コントロールの親の本文を取得します。

parentBody?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

parentContentControl

コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合は、 ItemNotFound エラーをスローします。

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.1 ]

parentContentControlOrNullObject

コンテンツ コントロールを含むコンテンツ コントロールを取得します。 親コンテンツ コントロールがない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

parentTable

コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTable?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

parentTableCell

コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合は、 ItemNotFound エラーをスローします。

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

parentTableCellOrNullObject

コンテンツ コントロールを含むテーブル セルを取得します。 テーブル セルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

parentTableOrNullObject

コンテンツ コントロールを含むテーブルを取得します。 テーブルに含まれていない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

[ API セット: WordApi 1.3 ]

placeholderText

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

placeholderText?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

removeWhenEdited

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

removeWhenEdited?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

style

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

style?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

styleBuiltIn

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

styleBuiltIn?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

subtype

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

subtype?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.3 ]

tag

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

tag?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

text

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

text?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

title

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

title?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]

type

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

type?: boolean;

プロパティ値

boolean

注釈

[ API セット: WordApi 1.1 ]