Word. Document Created class

contentControls

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

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

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

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

名前と種類で文書にスタイルを追加します。

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

パラメーター

name: string

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

type: "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)

ブックマークの範囲を取得します。ブックマークが存在しない場合、このメソッドは、 isNullObject プロパティが true に設定されたオブジェクトを返します。詳細については、「 *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)

追加プロパティを使用してターゲットドキュメントの特定の位置にドキュメントを挿入します。ヘッダー、フッター、透かし、およびその他のセクションプロパティは既定でコピーされます。挿入する文書の最大サイズは 4 MB です。

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)

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

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

パラメーター

propertyNames: string | string[]

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

返品

Word.DocumentCreated

load(propertyNamesAndPaths)

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

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

注釈

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

save(saveBehavior, fileName)

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

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

パラメーター

saveBehavior: "Save" | "Prompt"

省略可能。 DocumentCreated save のみをサポートしています。

fileName: string

省略可能。ファイル名 (ファイル拡張子を除く)。新しいドキュメントに対してのみ有効です。

返品

void

注釈