Word.Interfaces.ContentControlCollectionLoadOptions interface

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

プロパティ

$all

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

appearance

For each ITEM in the collection: コンテンツ コントロールの外観を指定します。 値には、 boundingBoxtags、または hidden を指定できます。

buildingBlockGalleryContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合に文書パーツ ギャラリー関連のデータを取得します。ContentControlTypebuildingBlockGallery です。 それ以外の場合は null です。

cannotDelete

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

cannotEdit

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

checkboxContentControl

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

color

コレクション内の各アイテムの場合: コンテンツ コントロールの色を指定します。 色は、'#RRGGBB' 形式で指定するか、色名を使用して指定します。

datePickerContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合、日付の選択に関連するデータを取得します。ContentControlTypedatePicker です。 それ以外の場合は null です。

font

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

groupContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合、グループ関連のデータを取得します。ContentControlTypegroup です。 それ以外の場合は null です。

id

For each ITEM in the collection: コンテンツ コントロール識別子を表す整数を取得します。

parentBody

For each ITEM in the collection: コンテンツ コントロールの親本文を取得します。

parentContentControl

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

parentContentControlOrNullObject

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

parentTable

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

parentTableCell

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

parentTableCellOrNullObject

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

parentTableOrNullObject

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

pictureContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合、画像関連のデータを取得します。ContentControlTypepicture です。 それ以外の場合は null です。

placeholderText

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

removeWhenEdited

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

repeatingSectionContentControl

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

style

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

styleBuiltIn

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

subtype

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

tag

For each ITEM in the collection: コンテンツ コントロールを識別するためのタグを指定します。

text

For each ITEM in the collection: コンテンツ コントロールのテキストを取得します。

title

For each ITEM in the collection: コンテンツ コントロールのタイトルを指定します。

type

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

xmlMapping

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

プロパティの詳細

$all

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

$all?: boolean;

プロパティ値

boolean

appearance

For each ITEM in the collection: コンテンツ コントロールの外観を指定します。 値には、 boundingBoxtags、または hidden を指定できます。

appearance?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

buildingBlockGalleryContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合に文書パーツ ギャラリー関連のデータを取得します。ContentControlTypebuildingBlockGallery です。 それ以外の場合は null です。

buildingBlockGalleryContentControl?: Word.Interfaces.BuildingBlockGalleryContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

cannotDelete

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

cannotDelete?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

cannotEdit

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

cannotEdit?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

checkboxContentControl

For each ITEM in the collection: 種類が 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

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

font?: Word.Interfaces.FontLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.1

groupContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合、グループ関連のデータを取得します。ContentControlTypegroup です。 それ以外の場合は null です。

groupContentControl?: Word.Interfaces.GroupContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

id

For each ITEM in the collection: コンテンツ コントロール識別子を表す整数を取得します。

id?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

parentBody

For each ITEM in the collection: コンテンツ コントロールの親本文を取得します。

parentBody?: Word.Interfaces.BodyLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentContentControl

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

parentContentControl?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.1

parentContentControlOrNullObject

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

parentContentControlOrNullObject?: Word.Interfaces.ContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTable

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

parentTable?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTableCell

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

parentTableCell?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTableCellOrNullObject

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

parentTableCellOrNullObject?: Word.Interfaces.TableCellLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

parentTableOrNullObject

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

parentTableOrNullObject?: Word.Interfaces.TableLoadOptions;

プロパティ値

注釈

API セット: WordApi 1.3

pictureContentControl

コレクション内の各アイテムの場合: コンテンツ コントロールの Word の場合、画像関連のデータを取得します。ContentControlTypepicture です。 それ以外の場合は null です。

pictureContentControl?: Word.Interfaces.PictureContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

placeholderText

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

placeholderText?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

removeWhenEdited

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

removeWhenEdited?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

repeatingSectionContentControl

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

repeatingSectionContentControl?: Word.Interfaces.RepeatingSectionContentControlLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3

style

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

style?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

styleBuiltIn

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

styleBuiltIn?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

subtype

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

subtype?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.3

tag

For each ITEM in the collection: コンテンツ コントロールを識別するためのタグを指定します。

tag?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

text

For each ITEM in the collection: コンテンツ コントロールのテキストを取得します。

text?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

title

For each ITEM in the collection: コンテンツ コントロールのタイトルを指定します。

title?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

type

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

type?: boolean;

プロパティ値

boolean

注釈

API セット: WordApi 1.1

xmlMapping

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

xmlMapping?: Word.Interfaces.XmlMappingLoadOptions;

プロパティ値

注釈

API セット: WordApiDesktop 1.3