Word.DocumentCreated class

ドキュメントの body オブジェクトを取得します。 本文は、ヘッダー、フッター、脚注、テキスト ボックスなどを除外するテキストです。

readonly body: Word.Body;

プロパティ値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

ドキュメント内のコンテンツ コントロール オブジェクトのコレクションを取得します。 これには、ドキュメントの本文、ヘッダー、フッター、テキスト ボックスなどのコンテンツ コントロールが含まれます。

readonly contentControls: Word.ContentControlCollection;

プロパティ値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

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

context: RequestContext;

プロパティ値

ドキュメント内のカスタム XML パーツを取得します。

readonly customXmlParts: Word.CustomXmlPartCollection;

プロパティ値

注釈

[ API セット: WordApiHiddenDocument 1.4 ]

ドキュメントのプロパティを取得します。

readonly properties: Word.DocumentProperties;

プロパティ値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

ドキュメント内の変更が保存されているかどうかを示します。 値 true は、ドキュメントが保存されてから変更されていないことを示します。

readonly saved: boolean;

プロパティ値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

ドキュメント内のセクション オブジェクトのコレクションを取得します。

readonly sections: Word.SectionCollection;

プロパティ値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

ドキュメント内のアドインの設定を取得します。

readonly settings: Word.SettingCollection;

プロパティ値

注釈

[ API セット: WordApiHiddenDocument 1.4 ]

名前と種類によってスタイルをドキュメントに追加します。

addStyle(name: string, type: Word.StyleType): Word.Style;

パラメーター

戻り値

注釈

[ API set: WordApiHiddenDocument 1.5 ]

名前と種類によってスタイルをドキュメントに追加します。

addStyle(name: string, typeString: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

パラメーター

戻り値

注釈

[ API set: WordApiHiddenDocument 1.5 ]

ブックマークが存在する場合は、ドキュメントから削除します。

deleteBookmark(name: string): void;

パラメーター

戻り値

注釈

[ API セット: WordApiHiddenDocument 1.4 ]

ブックマークの範囲を取得します。 ブックマークが存在しない場合は、 ItemNotFound エラーをスローします。

getBookmarkRange(name: string): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApiHiddenDocument 1.4 ]

ブックマークの範囲を取得します。 ブックマークが存在しない場合、このメソッドは isNullObject プロパティを true に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。

getBookmarkRangeOrNullObject(name: string): Word.Range;

パラメーター

戻り値

注釈

[ API セット: WordApiHiddenDocument 1.4 ]

ドキュメントで現在サポートされているコンテンツ コントロールを取得します。

getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;

パラメーター

戻り値

注釈

[ API set: WordApiHiddenDocument 1.5 ]

重要: options パラメーターに特定の型が指定されている場合、サポートされている型のコンテンツ コントロールのみが返されます。 ジェネリック Wordのメソッドを使用すると、例外がスローされることに注意してください。特定の種類に関連しない ContentControl。 時間によっては、追加の種類のコンテンツ コントロールがサポートされる場合があります。 そのため、アドインは特定の種類のコンテンツ コントロールを要求して処理する必要があります。

ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。

getStyles(): Word.StyleCollection;

戻り値

注釈

[ API set: WordApiHiddenDocument 1.5 ]

追加のプロパティを使用して、特定の場所にあるターゲット ドキュメントにドキュメントを挿入します。 ヘッダー、フッター、透かし、およびその他のセクション プロパティは、既定でコピーされます。

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

パラメーター

戻り値

注釈

[ API set: WordApiHiddenDocument 1.5 ]

注: 挿入するドキュメントに ActiveX コントロールが含まれている場合 (フォーム フィールドの可能性があります)、挿入はサポートされません。 このようなフォーム フィールドを、シナリオに適したコンテンツ コントロールまたはその他のオプションに置き換えることを検討してください。

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

load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated;

パラメーター

戻り値

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

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

パラメーター

戻り値

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

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

パラメーター

戻り値

ドキュメントを開きます。

open(): void;

戻り値

注釈

[ API セット: WordApi 1.3 ]

例

// Create and open a new document in a new tab or window.
await Word.run(async (context) => {
    const externalDoc = context.application.createDocument();
    await context.sync();

    externalDoc.open();
    await context.sync();
});

ドキュメントを保存します。

save(saveBehavior?: Word.SaveBehavior, fileName?: string): void;

パラメーター

戻り値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

注: wordApiHiddenDocument 1.5 では、 saveBehavior パラメーターと fileName パラメーターが導入されました。

ドキュメントを保存します。

save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;

パラメーター

戻り値

注釈

[ API set: WordApiHiddenDocument 1.3 ]

注: wordApiHiddenDocument 1.5 では、 saveBehavior パラメーターと fileName パラメーターが導入されました。

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

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

パラメーター

戻り値

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

set(properties: Word.DocumentCreated): void;

パラメーター

戻り値

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

toJSON(): Word.Interfaces.DocumentCreatedData;

戻り値

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

track(): Word.DocumentCreated;

戻り値

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

untrack(): Word.DocumentCreated;

戻り値