Word.Application class

包:: word

代表 Application 对象。

扩展: OfficeExtension.ClientObject

注解

使用方

Word.RequestContext： application

示例

// 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();
});

属性

bibliography	返回一个`Bibliography`对象，该对象表示存储在 Microsoft Word 中的书目参考源。
checkLanguage	指定 Microsoft Word 是否在你键入时自动检测所使用的语言。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
fontNames	返回表示 `FontNameCollection` Microsoft Word 中所有可用字体名称的对象。
language	获取表示`LanguageId`为 Microsoft Word 用户界面选择的语言的值。
listTemplateGalleries	返回一个`ListTemplateGalleryCollection`对象，该对象表示 Microsoft Word 中的所有列表模板库。
templates	返回 `TemplateCollection` 表示所有可用模板的对象：全局模板和附加到打开文档的模板。

方法

createDocument(base64File)	使用可选的 Base64 编码 .docx 文件创建新文档。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
newObject(context)	创建对象的新 `Word.Application` 实例。
openDocument(filePath)	打开文档并在新选项卡或窗口中显示该文档。下面是各种受支持客户端和平台的示例。远程或云位置示例： `https://microsoft.sharepoint.com/some/path/Document.docx` Windows 的本地位置示例： `C:\\Users\\Someone\\Documents\\Document.docx` (包括必需的转义反斜杠) 、 `file://mycomputer/myfolder/Document.docx` Mac 和 iOS 的本地位置示例： `/User/someone/document.docx`
retrieveStylesFromBase64(base64File)	分析模板 Base64 文件中的样式，并以字符串形式返回检索到样式的 JSON 格式。
set(properties, options)	同时设置对象的多个属性。可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties)	基于现有加载的对象，同时在对象上设置多个属性。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `Word.Application` 对象是 API 对象， `toJSON` 但该方法返回一个纯 JavaScript 对象， (类型化为 `Word.Interfaces.ApplicationData`) ，其中包含从原始对象加载的任何子属性的浅层副本。

属性详细信息

bibliography

返回一个Bibliography对象，该对象表示存储在 Microsoft Word 中的书目参考源。

readonly bibliography: Word.Bibliography;

属性值

Word.Bibliography

注解

API 集：WordApiDesktop 1.3

checkLanguage

指定 Microsoft Word 是否在你键入时自动检测所使用的语言。

checkLanguage: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.3

context

与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。

context: RequestContext;

属性值

Word.RequestContext

fontNames

返回表示 FontNameCollection Microsoft Word 中所有可用字体名称的对象。

readonly fontNames: Word.FontNameCollection;

属性值

Word.FontNameCollection

注解

API 集：WordApiDesktop 1.4

language

获取表示LanguageId为 Microsoft Word 用户界面选择的语言的值。

readonly language: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

属性值

注解

API 集：WordApiDesktop 1.3

listTemplateGalleries

返回一个ListTemplateGalleryCollection对象，该对象表示 Microsoft Word 中的所有列表模板库。

readonly listTemplateGalleries: Word.ListTemplateGalleryCollection;

属性值

Word.ListTemplateGalleryCollection

注解

API 集：WordApiDesktop 1.4

templates

返回 TemplateCollection 表示所有可用模板的对象：全局模板和附加到打开文档的模板。

readonly templates: Word.TemplateCollection;

属性值

Word.TemplateCollection

注解

API 集：WordApiDesktop 1.3

方法详细信息

createDocument(base64File)

使用可选的 Base64 编码 .docx 文件创建新文档。

createDocument(base64File?: string): Word.DocumentCreated;

参数

base64File: string

可选。 Base64 编码的 .docx 文件。默认值为 null。

Word.DocumentCreated

注解

API 集：WordApi 1.3

示例

// 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();
});

load(options)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

load(options?: Word.Interfaces.ApplicationLoadOptions): Word.Application;

参数

options: Word.Interfaces.ApplicationLoadOptions

为要加载的对象属性提供选项。

Word.Application

load(propertyNames)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

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

参数

propertyNames: string | string[]

指定要加载的属性的逗号分隔的字符串或字符串数组。

Word.Application

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 context.sync()。

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

参数

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

propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。

Word.Application

newObject(context)

创建对象的新 Word.Application 实例。

static newObject(context: OfficeExtension.ClientRequestContext): Word.Application;

参数

context: OfficeExtension.ClientRequestContext

Word.Application

openDocument(filePath)

打开文档并在新选项卡或窗口中显示该文档。下面是各种受支持客户端和平台的示例。

远程或云位置示例： https://microsoft.sharepoint.com/some/path/Document.docx
Windows 的本地位置示例： C:\\Users\\Someone\\Documents\\Document.docx (包括必需的转义反斜杠) 、 file://mycomputer/myfolder/Document.docx
Mac 和 iOS 的本地位置示例： /User/someone/document.docx

openDocument(filePath: string): void;

参数

filePath: string

.docx 文件的绝对路径。 Web 上的 Word 仅支持远程 (云) 位置，而 Windows、Mac 和 iOS 上的 Word 支持本地和远程位置。

void

注解

API 集：WordApi 1.6

retrieveStylesFromBase64(base64File)

分析模板 Base64 文件中的样式，并以字符串形式返回检索到样式的 JSON 格式。

retrieveStylesFromBase64(base64File: string): OfficeExtension.ClientResult<string>;

参数

base64File: string

模板文件。

OfficeExtension.ClientResult<string>

注解

API 集：WordApi 1.5

示例

// 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);
});

set(properties, options)

同时设置对象的多个属性。可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。

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

参数

properties: Word.Interfaces.ApplicationUpdateData

一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。

options: OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。

void

set(properties)

基于现有加载的对象，同时在对象上设置多个属性。

set(properties: Word.Application): void;

参数

properties: Word.Application

void

toJSON()

覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.Application 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.ApplicationData) ，其中包含从原始对象加载的任何子属性的浅层副本。

toJSON(): Word.Interfaces.ApplicationData;

Word.Interfaces.ApplicationData

反馈

此页面是否有帮助？