Word.Application class
アプリケーション オブジェクトを表します。
- 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();
});
プロパティ
| context | オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。 |
メソッド
| create |
オプションの Base64 でエンコードされた .docx ファイルを使用して、新しいドキュメントを作成します。 |
| new |
|
| open |
ドキュメントを開き、新しいタブまたはウィンドウに表示します。 サポートされているさまざまなクライアントとプラットフォームの例を次に示します。
|
| retrieve |
テンプレート Base64 ファイルからスタイルを解析し、取得したスタイルの JSON 形式を文字列として返します。 |
| toJSON() | API オブジェクトが |
プロパティの詳細
context
オブジェクトに関連付けられている要求コンテキスト。 これにより、アドインのプロセスが Office ホスト アプリケーションのプロセスに接続されます。
context: RequestContext;プロパティ値
メソッドの詳細
createDocument(base64File)
オプションの Base64 でエンコードされた .docx ファイルを使用して、新しいドキュメントを作成します。
createDocument(base64File?: string): Word.DocumentCreated;パラメーター
- base64File
-
string
省略可能。 Base64 でエンコードされた .docx ファイル。 既定値は null です。
戻り値
注釈
例
// 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();
});
newObject(context)
Word.Application オブジェクトの新しいインスタンスを作成します。
static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;パラメーター
戻り値
openDocument(filePath)
ドキュメントを開き、新しいタブまたはウィンドウに表示します。 サポートされているさまざまなクライアントとプラットフォームの例を次に示します。
リモートまたはクラウドの場所の例:
https://microsoft.sharepoint.com/some/path/Document.docxWindows のローカルの場所の例:
C:\\Users\\Someone\\Documents\\Document.docx(必要なエスケープされた円記号を含む)file://mycomputer/myfolder/Document.docxMac と iOS のローカルの場所の例:
/User/someone/document.docx
openDocument(filePath: string): void;パラメーター
- filePath
-
string
必須です。 .docx ファイルの絶対パス。 Web 上のWordはリモート (クラウド) の場所のみをサポートし、Windows、Mac、iOS ではローカルとリモートの場所にWordします。
戻り値
void
注釈
retrieveStylesFromBase64(base64File)
テンプレート Base64 ファイルからスタイルを解析し、取得したスタイルの JSON 形式を文字列として返します。
retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;パラメーター
- base64File
-
string
必須。 テンプレート ファイル。
戻り値
OfficeExtension.ClientResult<string>
注釈
例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/get-external-styles.yaml
// Gets style info from another document passed in as a Base64-encoded string.
await Word.run(async (context) => {
const retrievedStyles = context.application.retrieveStylesFromBase64(externalDocument);
await context.sync();
console.log("Styles from the other document:", retrievedStyles.value);
});
toJSON()
API オブジェクトがJSON.stringify()に渡されたときにより便利な出力を提供するために、JavaScript toJSON() メソッドをオーバーライドします。 (JSON.stringify、それに渡されるオブジェクトの toJSON メソッドを呼び出します)。元の Word.Application オブジェクトは API オブジェクトですが、 toJSON メソッドは、元のオブジェクトから読み込まれた子プロパティの浅いコピーを含むプレーンな JavaScript オブジェクト ( Word.Interfaces.ApplicationData として型指定) を返します。
toJSON(): {
[key: string]: string;
};戻り値
{ [key: string]: string; }
Office Add-ins