Word.CustomXmlSchemaCollection class

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

context: RequestContext;

プロパティ値

このコレクション内に読み込まれた子アイテムを取得します。

readonly items: Word.CustomXmlSchema[];

プロパティ値

1 つ以上のスキーマをスキーマ コレクションに追加します。このスキーマは、データ ストア内のストリームおよびスキーマ ライブラリに追加できます。

add(options?: Word.CustomXmlAddSchemaOptions): Word.CustomXmlSchema;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

現在のスキーマ コレクションに既存のスキーマ コレクションを追加します。

addCollection(schemaCollection: Word.CustomXmlSchemaCollection): Word.CustomXmlSchemaCollection;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

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

getCount(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: WordApiDesktop 1.3

コレクション内の指定された項目を表す CustomXmlSchema オブジェクトを返します。

getItem(index: number): Word.CustomXmlSchema;

パラメーター

返品

注釈

API セット: WordApiDesktop 1.3

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

getNamespaceUri(): OfficeExtension.ClientResult<number>;

返品

注釈

API セット: WordApiDesktop 1.3

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

load(options?: Word.Interfaces.CustomXmlSchemaCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.CustomXmlSchemaCollection;

パラメーター

返品

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

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

パラメーター

返品

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

load(propertyNamesAndPaths?: OfficeExtension.LoadOption): Word.CustomXmlSchemaCollection;

パラメーター

返品

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

toJSON(): Word.Interfaces.CustomXmlSchemaCollectionData;

返品

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

track(): Word.CustomXmlSchemaCollection;

返品

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

untrack(): Word.CustomXmlSchemaCollection;

返品

スキーマ コレクション内のスキーマが有効かどうか (XML の構文規則および指定されたボキャブラリの規則に準拠している) かどうかを指定します。

validate(): OfficeExtension.ClientResult<boolean>;

返品

注釈

API セット: WordApiDesktop 1.3