Word.Interfaces.ContentControlLoadOptions interface

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

プロパティ

$all

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

appearance

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

buildingBlockGalleryContentControl

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

cannotDelete

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

cannotEdit

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

checkboxContentControl

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

color

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

datePickerContentControl

コンテンツ コントロールが Word である場合は、日付の選択に関連するデータを取得します。ContentControlTypedatePicker です。 それ以外の場合は null です。

font

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

groupContentControl

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

id

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

parentBody

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

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

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

parentTableCell

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

parentTableCellOrNullObject

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

parentTableOrNullObject

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

pictureContentControl

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

placeholderText

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

removeWhenEdited

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

repeatingSectionContentControl

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

style

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

styleBuiltIn

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

subtype

コンテンツ コントロールのサブタイプを取得します。 サブタイプには、リッチ テキスト コンテンツ コントロール用の richTextInlinerichTextParagraphsrichTextTableCellrichTextTableRowrichTextTable、プレーン テキスト コンテンツ コントロール用のplainTextInlinecheckBoxplainTextParagraph、チェックボックス コンテンツ コントロール用のと、ドロップダウン リスト コンテンツ コントロールのdropDownList、コンボ ボックス コンテンツ コントロール用のcomboBox、ビルディング ブロック ギャラリー コンテンツ コントロール用のbuildingBlockGallery、日付選択コンテンツ コントロール用のdatePicker、セクション コンテンツの繰り返しコントロール用のrepeatingSection、画像コンテンツ コントロール用のpicture、およびグループ コンテンツ コントロール用のgroupがあります。

tag

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

text

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

title

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

type

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

xmlMapping

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

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

appearance

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

appearance?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

buildingBlockGalleryContentControl

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

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions;

プロパティ値

注釈

API セット: 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.CheckboxContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.7

color

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

color?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

datePickerContentControl

コンテンツ コントロールが Word である場合は、日付の選択に関連するデータを取得します。ContentControlTypedatePicker です。 それ以外の場合は null です。

datePickerContentControl?: Word.Interfaces.DatePickerContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

font

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

font?: Word.Interfaces.FontLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.1

groupContentControl

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

groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

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

pictureContentControl

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

pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

placeholderText

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

placeholderText?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

removeWhenEdited

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

removeWhenEdited?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

repeatingSectionContentControl

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

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

style

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

style?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

styleBuiltIn

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

styleBuiltIn?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

subtype

コンテンツ コントロールのサブタイプを取得します。 サブタイプには、リッチ テキスト コンテンツ コントロール用の richTextInlinerichTextParagraphsrichTextTableCellrichTextTableRowrichTextTable、プレーン テキスト コンテンツ コントロール用のplainTextInlinecheckBoxplainTextParagraph、チェックボックス コンテンツ コントロール用のと、ドロップダウン リスト コンテンツ コントロールのdropDownList、コンボ ボックス コンテンツ コントロール用のcomboBox、ビルディング ブロック ギャラリー コンテンツ コントロール用のbuildingBlockGallery、日付選択コンテンツ コントロール用のdatePicker、セクション コンテンツの繰り返しコントロール用のrepeatingSection、画像コンテンツ コントロール用のpicture、およびグループ コンテンツ コントロール用のgroupがあります。

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

xmlMapping

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

xmlMapping?: Word.Interfaces.XmlMappingLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3