Word.RepeatingSectionContentControl class

RepeatingSectionContentControl オブジェクトを表します。

注釈

使用元

Word.ContentControl: repeatingSectionContentControl

プロパティ

allowInsertDeleteSection	ユーザーがユーザーインターフェイスを使用して、この繰り返しセクションコンテンツコントロールからセクションを追加または削除できるかどうかを指定します。
appearance	コンテンツコントロールの外観を指定します。
color	コンテンツコントロールの色の赤/緑-青 (RGB) 値を指定します。値は '#RRGGBB' 形式で指定できます。
context	オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。
id	コンテンツコントロールの ID を返します。
isTemporary	ユーザーがコントロールの内容を編集するときに、そのコンテンツコントロールをアクティブドキュメントから削除するかどうかを指定します。
level	コンテンツコントロールのレベル (コンテンツコントロールがテキスト、段落、表のセル、表の行のいずれを囲むか) を返します。またはインラインの場合。
lockContentControl	コンテンツコントロールがロックされている (削除できない) かどうかを指定します。 `true` は、ユーザーがアクティブなドキュメントから削除できないことを意味します `false` 、削除できることを意味します。
lockContents	コンテンツコントロールのコンテンツをロックする (編集できない) かどうかを指定します。 `true` は、ユーザーがコンテンツを編集できないことを意味します `false` 、コンテンツが編集可能であることを意味します。
placeholderText	コンテンツコントロールのプレースホルダーテキストを表す `BuildingBlock` オブジェクトを返します。
range	作業中のドキュメント内のコンテンツコントロールの内容を表す `Range` オブジェクトを取得します。
repeatingSectionItems	この繰り返しセクションコンテンツコントロールの繰り返しセクション項目のコレクションを返します。
repeatingSectionItemTitle	この繰り返しセクションコンテンツコントロールに関連付けられているコンテキストメニューで使用される繰り返しセクションアイテムの名前を指定します。
showingPlaceholderText	コンテンツコントロールのプレースホルダーテキストが表示されているかどうかを返します。
tag	コンテンツコントロールを識別するためのタグを指定します。
title	コンテンツコントロールのタイトルを指定します。
xmlMapping	ドキュメントのデータストア内の XML データに対するコンテンツコントロールのマッピングを表す `XmlMapping` オブジェクトを返します。

メソッド

copy()	作業中の文書のコンテンツコントロールをクリップボードにコピーします。
cut()	作業中の文書からコンテンツコントロールを削除し、コンテンツコントロールをクリップボードに移動します。
delete(deleteContents)	コンテンツコントロールとコンテンツコントロールのコンテンツを削除します。
load(options)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNames)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
load(propertyNamesAndPaths)	オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、`context.sync()` を呼び出す必要があります。
set(properties, options)	オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクト、または同じ型の別の API オブジェクトを渡すことができます。
set(properties)	既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
setPlaceholderText(options)	ユーザーが独自の文字列を入力するまでコンテンツコントロールに表示されるプレースホルダー文字列を設定します。
toJSON()	API オブジェクトが `JSON.stringify()` に渡されるときに、より有用な出力を提供するために、JavaScript `toJSON()` メソッドをオーバーライドします。 (次に、`JSON.stringify`渡されたオブジェクトの `toJSON` メソッドを呼び出します)。元の `Word.RepeatingSectionContentControl` オブジェクトが API オブジェクトであるのに対し、 `toJSON` メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( `Word.Interfaces.RepeatingSectionContentControlData` と型指定) を返します。
track()	ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。このオブジェクトを `.sync` 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
untrack()	前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリリリースを有効にする前に、 `context.sync()` を呼び出す必要があります。

allowInsertDeleteSection

ユーザーがユーザーインターフェイスを使用して、この繰り返しセクションコンテンツコントロールからセクションを追加または削除できるかどうかを指定します。

allowInsertDeleteSection: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

appearance

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

appearance: Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden";

プロパティ値

Word.ContentControlAppearance | "BoundingBox" | "Tags" | "Hidden"

注釈

API セット: WordApiDesktop 1.3

color

コンテンツコントロールの色の赤/緑-青 (RGB) 値を指定します。値は '#RRGGBB' 形式で指定できます。

color: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

context

オブジェクトに関連付けられている要求コンテキスト。これにより、アドインのプロセスが Office ホストアプリケーションのプロセスに接続されます。

context: RequestContext;

プロパティ値

Word.RequestContext

id

コンテンツコントロールの ID を返します。

readonly id: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

isTemporary

ユーザーがコントロールの内容を編集するときに、そのコンテンツコントロールをアクティブドキュメントから削除するかどうかを指定します。

isTemporary: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

level

コンテンツコントロールのレベル (コンテンツコントロールがテキスト、段落、表のセル、表の行のいずれを囲むか) を返します。またはインラインの場合。

readonly level: Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell";

プロパティ値

Word.ContentControlLevel | "Inline" | "Paragraph" | "Row" | "Cell"

注釈

API セット: WordApiDesktop 1.3

lockContentControl

コンテンツコントロールがロックされている (削除できない) かどうかを指定します。 true は、ユーザーがアクティブなドキュメントから削除できないことを意味します false 、削除できることを意味します。

lockContentControl: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

lockContents

コンテンツコントロールのコンテンツをロックする (編集できない) かどうかを指定します。 true は、ユーザーがコンテンツを編集できないことを意味します false 、コンテンツが編集可能であることを意味します。

lockContents: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

placeholderText

コンテンツコントロールのプレースホルダーテキストを表す BuildingBlock オブジェクトを返します。

readonly placeholderText: Word.BuildingBlock;

プロパティ値

Word.BuildingBlock

注釈

API セット: WordApiDesktop 1.3

range

作業中のドキュメント内のコンテンツコントロールの内容を表す Range オブジェクトを取得します。

readonly range: Word.Range;

プロパティ値

Word.Range

注釈

API セット: WordApiDesktop 1.3

repeatingSectionItems

この繰り返しセクションコンテンツコントロールの繰り返しセクション項目のコレクションを返します。

readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;

プロパティ値

Word.RepeatingSectionItemCollection

注釈

API セット: WordApiDesktop 1.3

repeatingSectionItemTitle

この繰り返しセクションコンテンツコントロールに関連付けられているコンテキストメニューで使用される繰り返しセクションアイテムの名前を指定します。

repeatingSectionItemTitle: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

showingPlaceholderText

コンテンツコントロールのプレースホルダーテキストが表示されているかどうかを返します。

readonly showingPlaceholderText: boolean;

プロパティ値

boolean

注釈

API セット: WordApiDesktop 1.3

tag

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

tag: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

title

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

title: string;

プロパティ値

string

注釈

API セット: WordApiDesktop 1.3

xmlMapping

注意

この API は開発者向けにプレビューとして提供されており、寄せられたフィードバックにもとづいて変更される場合があります。この API は運用環境で使用しないでください。

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

readonly xmlMapping: Word.XmlMapping;

プロパティ値

Word.XmlMapping

注釈

API セット: WordApi ベータ版 (プレビューのみ)

copy()

作業中の文書のコンテンツコントロールをクリップボードにコピーします。

copy(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

cut()

作業中の文書からコンテンツコントロールを削除し、コンテンツコントロールをクリップボードに移動します。

cut(): void;

返品

void

注釈

API セット: WordApiDesktop 1.3

delete(deleteContents)

コンテンツコントロールとコンテンツコントロールのコンテンツを削除します。

delete(deleteContents?: boolean): void;

パラメーター

deleteContents: boolean

省略可能。コントロール内のコンテンツを削除するかどうか。

返品

void

注釈

API セット: WordApiDesktop 1.3

load(options)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(options?: Word.Interfaces.RepeatingSectionContentControlLoadOptions): Word.RepeatingSectionContentControl;

パラメーター

options: Word.Interfaces.RepeatingSectionContentControlLoadOptions

読み込むオブジェクトのプロパティのオプションを指定します。

返品

Word.RepeatingSectionContentControl

load(propertyNames)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNames?: string | string[]): Word.RepeatingSectionContentControl;

パラメーター

propertyNames: string | string[]

読み込むプロパティを指定するコンマ区切りの文字列または文字列の配列。

返品

Word.RepeatingSectionContentControl

load(propertyNamesAndPaths)

オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。プロパティを読み取る前に、context.sync() を呼び出す必要があります。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.RepeatingSectionContentControl;

パラメーター

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select は読み込むプロパティを指定するコンマ区切りの文字列であり、 propertyNamesAndPaths.expand は読み込むナビゲーションのプロパティを指定するコンマ区切りの文字列です。

返品

Word.RepeatingSectionContentControl

set(properties, options)

オブジェクトの複数のプロパティを同時に設定します。適切なプロパティを持つプレーンオブジェクト、または同じ型の別の API オブジェクトを渡すことができます。

set(properties: Interfaces.RepeatingSectionContentControlUpdateData, options?: OfficeExtension.UpdateOptions): void;

パラメーター

properties: Word.Interfaces.RepeatingSectionContentControlUpdateData

メソッドが呼び出されたオブジェクトのプロパティと同型構造のプロパティを持つ JavaScript オブジェクト。

options: OfficeExtension.UpdateOptions

プロパティオブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。

返品

void

set(properties)

既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。

set(properties: Word.RepeatingSectionContentControl): void;

パラメーター

properties: Word.RepeatingSectionContentControl

返品

void

setPlaceholderText(options)

ユーザーが独自の文字列を入力するまでコンテンツコントロールに表示されるプレースホルダー文字列を設定します。

setPlaceholderText(options?: Word.ContentControlPlaceholderOptions): void;

パラメーター

options: Word.ContentControlPlaceholderOptions

省略可能。コンテンツコントロールのプレースホルダーテキストを構成するためのオプション。

返品

void

注釈

API セット: WordApiDesktop 1.3

toJSON()

API オブジェクトが JSON.stringify() に渡されるときに、より有用な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (次に、JSON.stringify渡されたオブジェクトの toJSON メソッドを呼び出します)。元の Word.RepeatingSectionContentControl オブジェクトが API オブジェクトであるのに対し、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.RepeatingSectionContentControlData と型指定) を返します。

toJSON(): Word.Interfaces.RepeatingSectionContentControlData;

返品

Word.Interfaces.RepeatingSectionContentControlData

track()

ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。この呼び出しは、 context.trackedObjects.add(thisObject) の短縮形です。このオブジェクトを .sync 呼び出しと ".run" バッチの連続実行の外部で使用していて、プロパティを設定したり、オブジェクトでメソッドを呼び出したりするときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクトコレクションにオブジェクトを追加する必要があります。このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。

track(): Word.RepeatingSectionContentControl;

返品

Word.RepeatingSectionContentControl

untrack()

前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。この呼び出しは、 context.trackedObjects.remove(thisObject) の省略形です。追跡対象オブジェクトが多いとホストアプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。メモリリリースを有効にする前に、 context.sync() を呼び出す必要があります。

untrack(): Word.RepeatingSectionContentControl;

返品

Word.RepeatingSectionContentControl

注釈

使用元

プロパティ

メソッド

プロパティの詳細

allowInsertDeleteSection

プロパティ値

注釈

appearance

プロパティ値

注釈

color

プロパティ値

注釈

context

プロパティ値

id

プロパティ値

注釈

isTemporary

プロパティ値

注釈

level

プロパティ値

注釈

lockContentControl

プロパティ値

注釈

lockContents

プロパティ値

注釈

placeholderText

プロパティ値

注釈

range

プロパティ値

注釈

repeatingSectionItems

プロパティ値

注釈

repeatingSectionItemTitle

プロパティ値

注釈

showingPlaceholderText

プロパティ値

注釈

tag

プロパティ値

注釈

title

プロパティ値

注釈

xmlMapping

プロパティ値

注釈

メソッドの詳細

copy()

返品

注釈

cut()

返品

注釈

delete(deleteContents)

パラメーター

返品

注釈

load(options)

パラメーター

返品

load(propertyNames)

パラメーター

返品

load(propertyNamesAndPaths)

パラメーター

返品

set(properties, options)

パラメーター

返品

set(properties)