Word. Document Created class

contentControls

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

readonly contentControls: Word.ContentControlCollection;

プロパティ値

Word.ContentControlCollection

注釈

context

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

context: RequestContext;

プロパティ値

Word.RequestContext

customXmlParts

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

readonly customXmlParts: Word.CustomXmlPartCollection;

プロパティ値

Word.CustomXmlPartCollection

注釈

properties

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

readonly properties: Word.DocumentProperties;

プロパティ値

Word.DocumentProperties

注釈

saved

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

readonly saved: boolean;

プロパティ値

boolean

注釈

sections

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

readonly sections: Word.SectionCollection;

プロパティ値

Word.SectionCollection

注釈

settings

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

readonly settings: Word.SettingCollection;

プロパティ値

Word.SettingCollection

注釈

メソッドの詳細

addStyle(name, type)

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

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

パラメーター

name: string

必須です。スタイル名を表す文字列。

type: Word.StyleType

必須です。文字、リスト、段落、またはテーブルを含むスタイルの種類。

戻り値

Word.Style

注釈

addStyle(name, typeString)

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

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

パラメーター

name: string

必須です。スタイル名を表す文字列。

typeString: "Character" | "List" | "Paragraph" | "Table"

必須です。文字、リスト、段落、またはテーブルを含むスタイルの種類。

戻り値

Word.Style

注釈

deleteBookmark(name)

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

deleteBookmark(name: string): void;

パラメーター

name: string

必須です。大文字と小文字を区別しないブックマーク名。

戻り値

void

注釈

getBookmarkRange(name)

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

getBookmarkRange(name: string): Word.Range;

パラメーター

name: string

必須です。大文字と小文字を区別しないブックマーク名。

戻り値

Word.Range

注釈

getBookmarkRangeOrNullObject(name)

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

getBookmarkRangeOrNullObject(name: string): Word.Range;

パラメーター

name: string

必須です。大文字と小文字を区別しないブックマーク名。英数字とアンダースコア文字のみがサポートされています。文字で始まる必要がありますが、ブックマークに非表示としてタグを付ける場合は、名前をアンダースコア文字で開始します。名前は 40 文字以下にすることはできません。

戻り値

Word.Range

注釈

getContentControls(options)

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

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

パラメーター

options: Word.ContentControlOptions

オプション。返されるコンテンツコントロールを定義するオプション。

戻り値

Word.ContentControlCollection

注釈

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

getStyles()

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

getStyles(): Word.StyleCollection;

戻り値

Word.StyleCollection

注釈

insertFileFromBase64(base64File, insertLocation, insertFileOptions)

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

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

パラメーター

base64File: string

必須です。 .docx ファイルの Base64 でエンコードされたコンテンツ。

insertLocation: replace | start | end | "Replace" | "Start" | "End"

必須です。値は、'Replace'、'Start'、または 'End' である必要があります。

insertFileOptions: Word.InsertFileOptions

オプション。コピー先ドキュメントにインポートする必要がある追加のプロパティ。

戻り値

Word.SectionCollection

注釈

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

load(options)

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

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

パラメーター

options: Word.Interfaces.DocumentCreatedLoadOptions

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

戻り値

Word.DocumentCreated

load(propertyNames)

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

パラメーター

propertyNames: string | string[]

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

戻り値

Word.DocumentCreated

load(propertyNamesAndPaths)

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

パラメーター

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

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

戻り値

Word.DocumentCreated

open()

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

open(): void;

戻り値

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, fileName)

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

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

パラメーター

saveBehavior: Word.SaveBehavior

オプション。 DocumentCreated では、'Save' のみがサポートされます。

fileName: string

オプション。ファイル名 (ファイル拡張子を除外)。新しいドキュメントに対してのみ有効になります。

戻り値

void

注釈

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

save(saveBehaviorString, fileName)

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

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

パラメーター

saveBehaviorString: "Save" | "Prompt"

オプション。 DocumentCreated では、'Save' のみがサポートされます。

fileName: string

オプション。ファイル名 (ファイル拡張子を除外)。新しいドキュメントに対してのみ有効になります。

戻り値

void

注釈