Word.RepeatingSectionContentControl class

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

allowInsertDeleteSection: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

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

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

color: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

context: RequestContext;

プロパティ値

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

readonly id: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

ユーザーがコントロールの内容を編集するときに、作業中の文書からコンテンツ コントロールを削除するかどうかを指定します。

isTemporary: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

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

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

lockContentControl: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

lockContents: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

readonly placeholderText: Word.BuildingBlock;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

readonly range: Word.Range;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

readonly repeatingSectionItems: Word.RepeatingSectionItemCollection;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

repeatingSectionItemTitle: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

readonly showingPlaceholderText: boolean;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

tag: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

title: string;

プロパティ値

注釈

[ API set: WordApiDesktop 1.3 ]

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

readonly xmlMapping: Word.XmlMapping;

プロパティ値

注釈

[ API セット: WordApi BETA (プレビューのみ) ]

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

copy(): void;

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

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

cut(): void;

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

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

delete(deleteContents?: boolean): void;

パラメーター

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

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

set(properties: Word.RepeatingSectionContentControl): void;

パラメーター

戻り値

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

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

パラメーター

戻り値

注釈

[ API set: WordApiDesktop 1.3 ]

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

toJSON(): Word.Interfaces.RepeatingSectionContentControlData;

戻り値

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

track(): Word.RepeatingSectionContentControl;

戻り値

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

untrack(): Word.RepeatingSectionContentControl;

戻り値