Word.EditorCollection class

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

context: RequestContext;

プロパティ値

指定したユーザーがドキュメント内の範囲を変更するための新しいアクセス許可を表す Editor オブジェクトを返します。

addById(editorId: string): Word.Editor;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

指定したユーザー グループがドキュメント内の範囲を変更するための新しいアクセス許可を表す Editor オブジェクトを返します。

addByType(editorType: Word.EditorType): Word.Editor;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

指定したユーザー グループがドキュメント内の範囲を変更するための新しいアクセス許可を表す Editor オブジェクトを返します。

addByType(editorType: "Current" | "Editors" | "Everyone" | "Owners"): Word.Editor;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

コレクション内の項目の数を返します。

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: WordApiDesktop 1.4

コレクション内のインデックスによって Editor オブジェクトを取得します。

getItemAt(index: number): Word.Editor;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.4

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

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

パラメーター

返品

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

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

パラメーター

返品

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

toJSON(): {
            [key: string]: string;
        };

返品

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

track(): Word.EditorCollection;

返品

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

untrack(): Word.EditorCollection;

返品