Word.DocumentCreated class
DocumentCreated オブジェクトは、Application.CreateDocument によって作成された最上位のオブジェクトです。 DocumentCreated オブジェクトは、特殊な Document オブジェクトです。
- Extends
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml
// Updates the text of the current document with the text from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
// Use the Base64-encoded string representation of the selected .docx file.
const externalDoc: Word.DocumentCreated = context.application.createDocument(externalDocument);
await context.sync();
if (!Office.context.requirements.isSetSupported("WordApiHiddenDocument", "1.3")) {
console.warn("The WordApiHiddenDocument 1.3 requirement set isn't supported on this client so can't proceed. Try this action on a platform that supports this requirement set.");
return;
}
const externalDocBody: Word.Body = externalDoc.body;
externalDocBody.load("text");
await context.sync();
// Insert the external document's text at the beginning of the current document's body.
const externalDocBodyText = externalDocBody.text;
const currentDocBody: Word.Body = context.document.body;
currentDocBody.insertText(externalDocBodyText, Word.InsertLocation.start);
await context.sync();
});
プロパティ
body | ドキュメントの body オブジェクトを取得します。 本文は、ヘッダー、フッター、脚注、テキスト ボックスなどを除外するテキストです。 |
content |
ドキュメント内のコンテンツ コントロール オブジェクトのコレクションを取得します。 これには、ドキュメントの本文、ヘッダー、フッター、テキスト ボックスなどのコンテンツ コントロールが含まれます。 |
context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
custom |
ドキュメント内のカスタム XML パーツを取得します。 |
properties | ドキュメントのプロパティを取得します。 |
saved | ドキュメント内の変更が保存されているかどうかを示します。 値 true は、ドキュメントが保存されてから変更されていないことを示します。 |
sections | ドキュメント内のセクション オブジェクトのコレクションを取得します。 |
settings | ドキュメント内のアドインの設定を取得します。 |
メソッド
add |
名前と種類によってスタイルをドキュメントに追加します。 |
add |
名前と種類によってスタイルをドキュメントに追加します。 |
delete |
ブックマークが存在する場合は、ドキュメントから削除します。 |
get |
ブックマークの範囲を取得します。 ブックマークが存在しない場合は、 |
get |
ブックマークの範囲を取得します。 ブックマークが存在しない場合、このメソッドは |
get |
ドキュメントで現在サポートされているコンテンツ コントロールを取得します。 |
get |
ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。 |
insert |
追加のプロパティを使用して、特定の場所にあるターゲット ドキュメントにドキュメントを挿入します。 ヘッダー、フッター、透かし、およびその他のセクション プロパティは、既定でコピーされます。 |
load(options) | オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
load(property |
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、 |
open() | ドキュメントを開きます。 |
save(save |
ドキュメントを保存します。 |
save(save |
ドキュメントを保存します。 |
set(properties, options) | オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。 |
set(properties) | 既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。 |
toJSON() | API オブジェクトが |
track() | ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを |
untrack() | 前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 |
プロパティの詳細
body
ドキュメントの body オブジェクトを取得します。 本文は、ヘッダー、フッター、脚注、テキスト ボックスなどを除外するテキストです。
readonly body: Word.Body;
プロパティ値
注釈
contentControls
ドキュメント内のコンテンツ コントロール オブジェクトのコレクションを取得します。 これには、ドキュメントの本文、ヘッダー、フッター、テキスト ボックスなどのコンテンツ コントロールが含まれます。
readonly contentControls: Word.ContentControlCollection;
プロパティ値
注釈
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;
プロパティ値
customXmlParts
ドキュメント内のカスタム XML パーツを取得します。
readonly customXmlParts: Word.CustomXmlPartCollection;
プロパティ値
注釈
properties
ドキュメントのプロパティを取得します。
readonly properties: Word.DocumentProperties;
プロパティ値
注釈
saved
ドキュメント内の変更が保存されているかどうかを示します。 値 true は、ドキュメントが保存されてから変更されていないことを示します。
readonly saved: boolean;
プロパティ値
boolean
注釈
sections
ドキュメント内のセクション オブジェクトのコレクションを取得します。
readonly sections: Word.SectionCollection;
プロパティ値
注釈
settings
ドキュメント内のアドインの設定を取得します。
readonly settings: Word.SettingCollection;
プロパティ値
注釈
メソッドの詳細
addStyle(name, type)
名前と種類によってスタイルをドキュメントに追加します。
addStyle(name: string, type: Word.StyleType): Word.Style;
パラメーター
- name
-
string
必須です。 スタイル名を表す文字列。
- type
- Word.StyleType
必須です。 文字、リスト、段落、またはテーブルを含むスタイルの種類。
戻り値
注釈
addStyle(name, typeString)
名前と種類によってスタイルをドキュメントに追加します。
addStyle(name: string, typeString: "Character" | "List" | "Paragraph" | "Table"): Word.Style;
パラメーター
- name
-
string
必須。 スタイル名を表す文字列。
- typeString
-
"Character" | "List" | "Paragraph" | "Table"
必須です。 文字、リスト、段落、またはテーブルを含むスタイルの種類。
戻り値
注釈
deleteBookmark(name)
ブックマークが存在する場合は、ドキュメントから削除します。
deleteBookmark(name: string): void;
パラメーター
- name
-
string
必須です。 大文字と小文字を区別しないブックマーク名。
戻り値
void
注釈
getBookmarkRange(name)
ブックマークの範囲を取得します。 ブックマークが存在しない場合は、 ItemNotFound
エラーをスローします。
getBookmarkRange(name: string): Word.Range;
パラメーター
- name
-
string
必須。 大文字と小文字を区別しないブックマーク名。
戻り値
注釈
getBookmarkRangeOrNullObject(name)
ブックマークの範囲を取得します。 ブックマークが存在しない場合、このメソッドは isNullObject
プロパティを true
に設定したオブジェクトを返します。 詳細については、「 *OrNullObject メソッドとプロパティ」を参照してください。
getBookmarkRangeOrNullObject(name: string): Word.Range;
パラメーター
- name
-
string
必須。 大文字と小文字を区別しないブックマーク名。 英数字とアンダースコア文字のみがサポートされています。 文字で始まる必要がありますが、ブックマークに非表示としてタグを付ける場合は、名前をアンダースコア文字で開始します。 名前は 40 文字以下にすることはできません。
戻り値
注釈
getContentControls(options)
ドキュメントで現在サポートされているコンテンツ コントロールを取得します。
getContentControls(options?: Word.ContentControlOptions): Word.ContentControlCollection;
パラメーター
- options
- Word.ContentControlOptions
省略可能。 返されるコンテンツ コントロールを定義するオプション。
戻り値
注釈
[ API set: WordApiHiddenDocument 1.5 ]
重要: options パラメーターに特定の型が指定されている場合、サポートされている型のコンテンツ コントロールのみが返されます。 ジェネリック Wordのメソッドを使用すると、例外がスローされることに注意してください。特定の種類に関連しない ContentControl。 時間によっては、追加の種類のコンテンツ コントロールがサポートされる場合があります。 そのため、アドインは特定の種類のコンテンツ コントロールを要求して処理する必要があります。
getStyles()
ドキュメントのスタイル セット全体を表す StyleCollection オブジェクトを取得します。
getStyles(): 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 でエンコードされたコンテンツ。
必須。 値は、'Replace'、'Start'、または 'End' である必要があります。
- insertFileOptions
- Word.InsertFileOptions
省略可能。 コピー先ドキュメントにインポートする必要がある追加のプロパティ。
戻り値
注釈
[ API set: WordApiHiddenDocument 1.5 ]
注: 挿入するドキュメントに ActiveX コントロールが含まれている場合 (フォーム フィールドの可能性があります)、挿入はサポートされません。 このようなフォーム フィールドを、シナリオに適したコンテンツ コントロールまたはその他のオプションに置き換えることを検討してください。
load(options)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(options?: Word.Interfaces.DocumentCreatedLoadOptions): Word.DocumentCreated;
パラメーター
読み込むオブジェクトのプロパティのオプションを提供します。
戻り値
load(propertyNames)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNames?: string | string[]): Word.DocumentCreated;
パラメーター
- propertyNames
-
string | string[]
読み込むプロパティを指定するコンマ区切り文字列または文字列の配列。
戻り値
load(propertyNamesAndPaths)
オブジェクトの指定されたプロパティを読み込むコマンドを待ち行列に入れます。 プロパティを読み取る前に、context.sync()
を呼び出す必要があります。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.DocumentCreated;
パラメーター
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select
は読み込むプロパティを指定するコンマ区切りの文字列で、 propertyNamesAndPaths.expand
は読み込むナビゲーション プロパティを指定するコンマ区切りの文字列です。
戻り値
open()
ドキュメントを開きます。
open(): void;
戻り値
void
注釈
例
// 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
注釈
[ API set: WordApiHiddenDocument 1.3 ]
注: wordApiHiddenDocument 1.5 では、 saveBehavior
パラメーターと fileName
パラメーターが導入されました。
save(saveBehaviorString, fileName)
ドキュメントを保存します。
save(saveBehaviorString?: "Save" | "Prompt", fileName?: string): void;
パラメーター
- saveBehaviorString
-
"Save" | "Prompt"
省略可能。 DocumentCreated では、'Save' のみがサポートされます。
- fileName
-
string
省略可能。 ファイル名 (ファイル拡張子を除外)。 新しいドキュメントに対してのみ有効になります。
戻り値
void
注釈
[ API set: WordApiHiddenDocument 1.3 ]
注: wordApiHiddenDocument 1.5 では、 saveBehavior
パラメーターと fileName
パラメーターが導入されました。
set(properties, options)
オブジェクトの複数のプロパティを同時に設定します。 適切なプロパティを持つプレーン オブジェクトまたは同じ型の別の API オブジェクトを渡すことができます。
set(properties: Interfaces.DocumentCreatedUpdateData, options?: OfficeExtension.UpdateOptions): void;
パラメーター
- properties
- Word.Interfaces.DocumentCreatedUpdateData
メソッドが呼び出されるオブジェクトのプロパティに等形的に構造化されたプロパティを持つ JavaScript オブジェクト。
- options
- OfficeExtension.UpdateOptions
properties オブジェクトが読み取り専用プロパティを設定しようとした場合にエラーを抑制するオプションを提供します。
戻り値
void
set(properties)
既存の読み込まれたオブジェクトに基づいて、オブジェクトに複数のプロパティを同時に設定します。
set(properties: Word.DocumentCreated): void;
パラメーター
- properties
- Word.DocumentCreated
戻り値
void
toJSON()
API オブジェクトがJSON.stringify()
に渡されたときにより便利な出力を提供するために、JavaScript toJSON()
メソッドをオーバーライドします。 (JSON.stringify
、それに渡されるオブジェクトの toJSON
メソッドを呼び出します)。元の Word.DocumentCreated
オブジェクトは API オブジェクトですが、 toJSON
メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.DocumentCreatedData
として型指定) を返します。
toJSON(): Word.Interfaces.DocumentCreatedData;
戻り値
track()
ドキュメントの環境変更に基づいて自動的に調整する目的でオブジェクトを追跡します。 この呼び出しは、 context.trackedObjects.add(thisObject)の短縮形です。 このオブジェクトを .sync
呼び出しで使用し、".run" バッチのシーケンシャル実行の外部でプロパティを設定するとき、またはオブジェクトに対してメソッドを呼び出すときに "InvalidObjectPath" エラーが発生する場合は、オブジェクトが最初に作成されたときに、追跡対象のオブジェクト コレクションにオブジェクトを追加する必要があります。 このオブジェクトがコレクションの一部である場合は、親コレクションも追跡する必要があります。
track(): Word.DocumentCreated;
戻り値
untrack()
前に追跡されていた場合、このオブジェクトに関連付けられているメモリを解放します。 この呼び出しは 、context.trackedObjects.remove(thisObject)の短縮形です。 追跡対象オブジェクトが多いとホスト アプリケーションの動作が遅くなります。追加したオブジェクトが不要になったら、必ずそれを解放してください。 メモリ解放が有効になる前に、 context.sync()
を呼び出す必要があります。
untrack(): Word.DocumentCreated;
戻り値
Office Add-ins