Word. Document class

activeThemeDisplayName

获取活动主题的显示名称。

readonly activeThemeDisplayName: string;

属性值

string

注解

activeWindow

获取文档的活动窗口。

readonly activeWindow: Word.Window;

属性值

Word.Window

注解

API 集：WordApiDesktop 1.2

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the first paragraph of each page.
  console.log("Getting first paragraph of each page...");

  // Get the active window.
  const activeWindow: Word.Window = context.document.activeWindow;
  activeWindow.load();

  // Get the active pane.
  const activePane: Word.Pane = activeWindow.activePane;
  activePane.load();

  // Get all pages.
  const pages: Word.PageCollection = activePane.pages;
  pages.load();

  await context.sync();

  // Get page index and paragraphs of each page.
  const pagesIndexes = [];
  const pagesNumberOfParagraphs = [];
  const pagesFirstParagraphText = [];
  for (let i = 0; i < pages.items.length; i++) {
    const page = pages.items[i];
    page.load("index");
    pagesIndexes.push(page);

    const paragraphs = page.getRange().paragraphs;
    paragraphs.load("items/length");
    pagesNumberOfParagraphs.push(paragraphs);

    const firstParagraph = paragraphs.getFirst();
    firstParagraph.load("text");
    pagesFirstParagraphText.push(firstParagraph);
  }

  await context.sync();

  for (let i = 0; i < pagesIndexes.length; i++) {
    console.log(`Page index: ${pagesIndexes[i].index}`);
    console.log(`Number of paragraphs: ${pagesNumberOfParagraphs[i].items.length}`);
    console.log("First paragraph's text:", pagesFirstParagraphText[i].text);
  }
});

areFilePropertiesPasswordEncrypted

获取 Word 是否加密受密码保护的文档的文件属性。

readonly areFilePropertiesPasswordEncrypted: boolean;

属性值

boolean

注解

areGrammaticalErrorsShown

指定是否在文档中用波浪绿线标记语法错误。

areGrammaticalErrorsShown: boolean;

属性值

boolean

注解

areMathDefaultsUsed

指定在创建新方程式时是否使用默认数学设置。

areMathDefaultsUsed: boolean;

属性值

boolean

注解

areNewerFeaturesDisabled

指定是否禁用在指定版本之后引入的功能。

areNewerFeaturesDisabled: boolean;

属性值

boolean

注解

areSpellingErrorsShown

指定 Microsoft Word 是否为文档中的拼写错误添加下划线。

areSpellingErrorsShown: boolean;

属性值

boolean

注解

areStylesUpdatedOnOpen

指定是否每次打开文档时更新此文档中的样式以匹配附加模板中的样式。

areStylesUpdatedOnOpen: boolean;

属性值

boolean

注解

areTrueTypeFontsEmbedded

指定保存文档时 Microsoft Word 是否在文档中嵌入 TrueType 字体。

areTrueTypeFontsEmbedded: boolean;

属性值

boolean

注解

attachedTemplate

指定表示 Template 附加到文档的模板的对象。

attachedTemplate: Word.Template;

属性值

Word.Template

注解

autoHyphenation

指定是否为文档启用自动连字符。

autoHyphenation: boolean;

属性值

boolean

注解

autoSaveOn

指定是否自动保存文档中的编辑。

autoSaveOn: boolean;

属性值

boolean

注解

background

获取表示 Shape 文档背景图像的对象。

readonly background: Word.Shape;

属性值

Word.Shape

注解

bibliography

返回 Bibliography 表示文档中包含的书目参考的对象。

readonly bibliography: Word.Bibliography;

属性值

Word.Bibliography

注解

body

获取 Body 主文档的对象。正文是不包括页眉、页脚、脚注、文本框等的文本。

readonly body: Word.Body;

属性值

Word.Body

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-body.yaml

// Inserts the body from the external document at the beginning of this document.
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
  // Create a proxy object for the document body.
  const body: Word.Body = context.document.body;

  // Queue a command to insert the Base64-encoded string representation of the body of the selected .docx file at the beginning of the current document.
  body.insertFileFromBase64(externalDocument, Word.InsertLocation.start);

  // Synchronize the document state by executing the queued commands, and return a promise to indicate task completion.
  await context.sync();

  console.log("Added Base64-encoded text to the beginning of the document body.");
});

bookmarks

返回表示 BookmarkCollection 文档中所有书签的对象。

readonly bookmarks: Word.BookmarkCollection;

属性值

Word.BookmarkCollection

注解

builtInDocumentProperties

获取表示 DocumentProperties 文档所有内置文档属性的对象。

readonly builtInDocumentProperties: Word.DocumentProperties;

属性值

Word.DocumentProperties

注解

changeTrackingMode

指定更改跟踪模式。

changeTrackingMode: Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly";

属性值

Word.ChangeTrackingMode | "Off" | "TrackAll" | "TrackMineOnly"

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-change-tracking.yaml

// Gets the current change tracking mode.
await Word.run(async (context) => {
  const document: Word.Document = context.document;
  document.load("changeTrackingMode");
  await context.sync();

  if (document.changeTrackingMode === Word.ChangeTrackingMode.trackMineOnly) {
    console.log("Only my changes are being tracked.");
  } else if (document.changeTrackingMode === Word.ChangeTrackingMode.trackAll) {
    console.log("Everyone's changes are being tracked.");
  } else {
    console.log("No changes are being tracked.");
  }
});

characters

获取 RangeScopedCollection 表示文档中所有字符的对象。

readonly characters: Word.RangeScopedCollection;

属性值

Word.RangeScopedCollection

注解

coauthoring

获取用于 Coauthoring 管理文档中共同创作的对象。

readonly coauthoring: Word.Coauthoring;

属性值

Word.Coauthoring

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/05-coauthoring/manage-coauthors.yaml

// Gets the coauthoring capabilities and pending-update status of the document.
await Word.run(async (context) => {
  const coauthoring: Word.Coauthoring = context.document.coauthoring;
  coauthoring.load("canCoauthor,canMerge,pendingUpdates");
  await context.sync();

  console.log("Can coauthor:", coauthoring.canCoauthor);
  console.log("Can merge:", coauthoring.canMerge);
  console.log("Pending updates:", coauthoring.pendingUpdates);
});

codeName

获取文档的代码名称。

readonly codeName: string;

属性值

string

注解

comments

获取 CommentCollection 表示文档中所有注释的对象。

readonly comments: Word.CommentCollection;

属性值

Word.CommentCollection

注解

compatibilityMode

获取 Word 打开文档时使用的兼容性模式。

readonly compatibilityMode: Word.CompatibilityMode | "Word2003" | "Word2007" | "Word2010" | "Word2013" | "Current";

属性值

注解

consecutiveHyphensLimit

指定可以以连字符结尾的连续行的最大数目。

consecutiveHyphensLimit: number;

属性值

number

注解

content

获取 Range 表示主文档情景的对象。

readonly content: Word.Range;

属性值

Word.Range

注解

contentControls

获取文档中的对象集合 ContentControl 。这包括文档正文、页眉、页脚、文本框等内容控件。

readonly contentControls: Word.ContentControlCollection;

属性值

Word.ContentControlCollection

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-content-controls.yaml

// Adds title and colors to odd and even content controls and changes their appearance.
await Word.run(async (context) => {
  // Get the complete sentence (as range) associated with the insertion point.
  let evenContentControls = context.document.contentControls.getByTag("even");
  let oddContentControls = context.document.contentControls.getByTag("odd");
  evenContentControls.load("length");
  oddContentControls.load("length");

  await context.sync();

  for (let i = 0; i < evenContentControls.items.length; i++) {
    // Change a few properties and append a paragraph.
    evenContentControls.items[i].set({
      color: "red",
      title: "Odd ContentControl #" + (i + 1),
      appearance: Word.ContentControlAppearance.tags
    });
    evenContentControls.items[i].insertParagraph("This is an odd content control", "End");
  }

  for (let j = 0; j < oddContentControls.items.length; j++) {
    // Change a few properties and append a paragraph.
    oddContentControls.items[j].set({
      color: "green",
      title: "Even ContentControl #" + (j + 1),
      appearance: "Tags"
    });
    oddContentControls.items[j].insertHtml("This is an <b>even</b> content control", "End");
  }

  await context.sync();
});

context

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

context: RequestContext;

属性值

Word.RequestContext

currentRsid

获取 Word 分配给文档更改的随机数。

readonly currentRsid: number;

属性值

number

注解

customDocumentProperties

获取表示 DocumentProperties 文档的所有自定义文档属性的集合。

readonly customDocumentProperties: Word.DocumentProperties;

属性值

Word.DocumentProperties

注解

customXmlParts

获取文档中的自定义 XML 部分。

readonly customXmlParts: Word.CustomXmlPartCollection;

属性值

Word.CustomXmlPartCollection

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-custom-xml-part.yaml

// Adds a custom XML part.
await Word.run(async (context) => {
  const originalXml =
    "<Reviewers><Reviewer>Juan</Reviewer><Reviewer>Hong</Reviewer><Reviewer>Sally</Reviewer></Reviewers>";
  const customXmlPart: Word.CustomXmlPart = context.document.customXmlParts.add(originalXml);
  customXmlPart.load("id");
  const xmlBlob = customXmlPart.getXml();

  await context.sync();

  const readableXml = addLineBreaksToXML(xmlBlob.value);
  console.log("Added custom XML part:", readableXml);

  // Store the XML part's ID in a setting so the ID is available to other functions.
  const settings: Word.SettingCollection = context.document.settings;
  settings.add("ContosoReviewXmlPartId", customXmlPart.id);

  await context.sync();
});

defaultTabStop

指定文档中默认制表位之间的间隔) (。

defaultTabStop: number;

属性值

number

注解

defaultTargetFrame

指定用于通过超链接显示网页的浏览器框架。

defaultTargetFrame: string;

属性值

string

注解

documentLibraryVersions

返回一个 DocumentLibraryVersionCollection 对象，该对象表示已启用版本控制并存储在服务器上的文档库中的共享文档的版本集合。

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

属性值

Word.DocumentLibraryVersionCollection

注解

doNotEmbedSystemFonts

指定 Word 是否不应嵌入常见系统字体。

doNotEmbedSystemFonts: boolean;

属性值

boolean

注解

encryptionProvider

指定 Microsoft Word 在加密文档时使用的算法加密提供程序的名称。

encryptionProvider: string;

属性值

string

注解

farEastLineBreakLanguage

指定用于换行的东亚语言。

farEastLineBreakLanguage: Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese";

属性值

Word.FarEastLineBreakLanguageId | "TraditionalChinese" | "Japanese" | "Korean" | "SimplifiedChinese"

注解

farEastLineBreakLevel

指定换行控制级别。

farEastLineBreakLevel: Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom";

属性值

Word.FarEastLineBreakLevel | "Normal" | "Strict" | "Custom"

注解

fields

获取 FieldCollection 表示文档中所有字段的对象。

readonly fields: Word.FieldCollection;

属性值

Word.FieldCollection

注解

formattingIsNextLevelShown

指定使用上一个标题级别时，Word 是否显示下一个标题级别。

formattingIsNextLevelShown: boolean;

属性值

boolean

注解

formattingIsUserStyleNameShown

指定是否显示用户定义的样式。

formattingIsUserStyleNameShown: boolean;

属性值

boolean

注解

frames

返回 FrameCollection 表示文档中所有帧的对象。

readonly frames: Word.FrameCollection;

属性值

Word.FrameCollection

注解

fullName

获取文档的名称，包括路径。

readonly fullName: string;

属性值

string

注解

grammaticalErrors

获取一个RangeCollection对象，该对象表示文档中未通过语法检查的句子。

readonly grammaticalErrors: Word.RangeCollection;

属性值

Word.RangeCollection

注解

gridDistanceHorizontal

指定在文档中绘制、移动和调整自选图形或东亚字符时 Microsoft Word 使用的不可见网格线之间的水平间距。

gridDistanceHorizontal: number;

属性值

number

注解

gridDistanceVertical

指定在文档中绘制、移动和调整自选图形或东亚字符时 Microsoft Word 使用的不可见网格线之间的垂直间距。

gridDistanceVertical: number;

属性值

number

注解

gridIsOriginFromMargin

指定字符网格是否从页面左上角开始。

gridIsOriginFromMargin: boolean;

属性值

boolean

注解

gridOriginHorizontal

指定不可见栅格的水平原点。

gridOriginHorizontal: number;

属性值

number

注解

gridOriginVertical

指定不可见栅格的垂直原点。

gridOriginVertical: number;

属性值

number

注解

gridSpaceBetweenHorizontalLines

指定页面视图中水平字符网格线的间隔。

gridSpaceBetweenHorizontalLines: number;

属性值

number

注解

gridSpaceBetweenVerticalLines

指定打印版式视图中垂直字符网格线的间隔。

gridSpaceBetweenVerticalLines: number;

属性值

number

注解

hasPassword

获取打开文档是否需要密码。

readonly hasPassword: boolean;

属性值

boolean

注解

hasVbProject

获取文档是否附加了 Microsoft Visual Basic for Applications 项目。

readonly hasVbProject: boolean;

属性值

boolean

注解

hyperlinks

返回 HyperlinkCollection 表示文档中所有超链接的对象。

readonly hyperlinks: Word.HyperlinkCollection;

属性值

Word.HyperlinkCollection

注解

hyphenateCaps

指定是否全部大写字母中的单词可以连接连字符。

hyphenateCaps: boolean;

属性值

boolean

注解

hyphenationZone

指定连字符区域的宽度（以磅为单位）。

hyphenationZone: number;

属性值

number

注解

indexes

返回 IndexCollection 表示文档中所有索引的对象。

readonly indexes: Word.IndexCollection;

属性值

Word.IndexCollection

注解

isAutoFormatOverrideOn

指定自动格式设置选项是否覆盖格式限制。

isAutoFormatOverrideOn: boolean;

属性值

boolean

注解

isChartDataPointTracked

指定活动文档中的图表是否使用单元格引用数据点跟踪。

isChartDataPointTracked: boolean;

属性值

boolean

注解

isCompatible

指定是否启用属性指定的 type 兼容性选项。

isCompatible: boolean;

属性值

boolean

注解

isFinal

指定文档是否为最终版本。

isFinal: boolean;

属性值

boolean

注解

isFontsSubsetSaved

指定 Microsoft Word 是否将嵌入的 TrueType 字体的子集与文档一起保存。

isFontsSubsetSaved: boolean;

属性值

boolean

注解

isFormsDataPrinted

指定 Microsoft Word 是否仅将相应联机表单中输入的数据打印到预打印表单上。

isFormsDataPrinted: boolean;

属性值

boolean

注解

isFormsDataSaved

指定 Microsoft Word 是否将窗体中输入的数据保存为制表符分隔的记录，以便在数据库中使用。

isFormsDataSaved: boolean;

属性值

boolean

注解

isGrammarChecked

指定是否已对文档运行语法检查。

isGrammarChecked: boolean;

属性值

boolean

注解

isInAutoSave

获取事件的 Application.DocumentBeforeSave 最近触发是文档自动保存还是用户手动保存的结果。

readonly isInAutoSave: boolean;

属性值

boolean

注解

isInFormsDesign

获取文档是否处于窗体设计模式。

readonly isInFormsDesign: boolean;

属性值

boolean

注解

isKerningByAlgorithm

指定 Word 是否对半角拉丁字符和标点符号进行字角调整。

isKerningByAlgorithm: boolean;

属性值

boolean

注解

isLinguisticDataEmbedded

指定是否嵌入语音和手写数据。

isLinguisticDataEmbedded: boolean;

属性值

boolean

注解

isMasterDocument

获取此文档是否为主文档。

readonly isMasterDocument: boolean;

属性值

boolean

注解

isOptimizedForWord97

指定 Word 是否针对 Word 97 优化文档。

isOptimizedForWord97: boolean;

属性值

boolean

注解

isPostScriptPrintedOverText

指定使用 PostScript 打印机时，是否要将文档中) 的 PostScript 命令等 PRINT 域指令 (打印在文本和图形之上。

isPostScriptPrintedOverText: boolean;

属性值

boolean

注解

isQuickStyleSetLocked

指定用户是否可以更改快速样式集。

isQuickStyleSetLocked: boolean;

属性值

boolean

注解

isReadOnly

获取对文档所做的更改是否无法保存到原始文档。

readonly isReadOnly: boolean;

属性值

boolean

注解

isReadOnlyRecommended

指定每当用户打开文档时，Microsoft Word 是否显示消息框，建议以只读方式打开文档。

isReadOnlyRecommended: boolean;

属性值

boolean

注解

isSnappedToGrid

指定“自选图形”或“东亚字符”是否与不可见网格自动对齐。

isSnappedToGrid: boolean;

属性值

boolean

注解

isSnappedToShapes

指定自选图形或东亚字符是否与其他形状中的不可见网格线对齐。

isSnappedToShapes: boolean;

属性值

boolean

注解

isSpellingChecked

指定是否检查了整个文档的拼写。

isSpellingChecked: boolean;

属性值

boolean

注解

isStyleEnforced

指定是否在受保护的文档中强制实施格式限制。

isStyleEnforced: boolean;

属性值

boolean

注解

isSubdocument

获取此文档是否为主文档的子文档。

readonly isSubdocument: boolean;

属性值

boolean

注解

isThemeLocked

指定用户能否更改文档主题。

isThemeLocked: boolean;

属性值

boolean

注解

isUserControl

指定文档是由用户创建还是打开。

isUserControl: boolean;

属性值

boolean

注解

isVbaSigned

获取 VBA 项目是否进行了数字签名。

readonly isVbaSigned: boolean;

属性值

boolean

注解

isWriteReserved

获取文档是否受写入密码保护。

readonly isWriteReserved: boolean;

属性值

boolean

注解

justificationMode

指定字符间距调整。

justificationMode: Word.JustificationMode | "Expand" | "Compress" | "CompressKana";

属性值

Word.JustificationMode | "Expand" | "Compress" | "CompressKana"

注解

kind

指定 Microsoft Word 在自动设置文档格式时使用的格式类型。

kind: Word.DocumentKind | "NotSpecified" | "Letter" | "Email";

属性值

Word.DocumentKind | "NotSpecified" | "Letter" | "Email"

注解

languageDetected

指定 Microsoft Word 是否检测到文档文本的语言。

languageDetected: boolean;

属性值

boolean

注解

listParagraphs

获取 ParagraphCollection 表示文档中所有编号段落的对象。

readonly listParagraphs: Word.ParagraphCollection;

属性值

Word.ParagraphCollection

注解

lists

获取包含 ListCollection 文档中所有格式列表的对象。

readonly lists: Word.ListCollection;

属性值

Word.ListCollection

注解

listTemplates

返回 ListTemplateCollection 表示文档中所有列表模板的对象。

readonly listTemplates: Word.ListTemplateCollection;

属性值

Word.ListTemplateCollection

注解

noLineBreakAfter

指定 kinsoku 字符，之后 Word 不会换行。

noLineBreakAfter: string;

属性值

string

注解

noLineBreakBefore

指定 Word 在该字符前面不会换行的 kinsoku 字符。

noLineBreakBefore: string;

属性值

string

注解

openEncoding

获取用于打开文档的编码。

readonly openEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

属性值

注解

originalDocumentTitle

获取法律黑线比较后原始文档的标题。

readonly originalDocumentTitle: string;

属性值

string

注解

pageSetup

返回 PageSetup 与文档关联的对象。

readonly pageSetup: Word.PageSetup;

属性值

Word.PageSetup

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-section-starts.yaml

await Word.run(async (context) => {

  // Configure document-wide page settings for a report that will be printed and bound.
  const pageSetup: Word.PageSetup = context.document.pageSetup;
  pageSetup.set({
    paperSize: Word.PaperSize.letter,
    orientation: Word.PageOrientation.portrait,
    topMargin: 72,
    bottomMargin: 72,
    leftMargin: 90,
    rightMargin: 72,
    gutter: 18,
    gutterPosition: Word.GutterPosition.left,
    mirrorMargins: true,
    oddAndEvenPagesHeaderFooter: true
  });

  const sections: Word.SectionCollection = context.document.sections;
  sections.load("items");
  await context.sync();

  // Start the main chapter on an odd-numbered page so it appears on the right in a bound document.
  const chapterPageSetup: Word.PageSetup = sections.items[1].pageSetup;
  chapterPageSetup.sectionStart = Word.SectionStart.oddPage;
  chapterPageSetup.differentFirstPageHeaderFooter = true;

  // Keep the appendix in a separate section, but let it begin on the current page.
  sections.items[2].pageSetup.sectionStart = Word.SectionStart.continuous;

  await context.sync();
  console.log("Applied print and binding settings to the report.");
});

paragraphs

获取 ParagraphCollection 表示文档中所有段落的对象。

readonly paragraphs: Word.ParagraphCollection;

属性值

Word.ParagraphCollection

注解

password

设置打开文档必须提供的密码。

password: string;

属性值

string

注解

passwordEncryptionAlgorithm

获取用于密码加密的算法。

readonly passwordEncryptionAlgorithm: string;

属性值

string

注解

passwordEncryptionKeyLength

获取用于密码加密的密钥长度。

readonly passwordEncryptionKeyLength: number;

属性值

number

注解

passwordEncryptionProvider

获取密码加密提供程序的名称。

readonly passwordEncryptionProvider: string;

属性值

string

注解

path

获取文档的磁盘或 Web 路径 (排除文档名) 。

readonly path: string;

属性值

string

注解

printRevisions

指定是否将修订标记与文档一起打印。

printRevisions: boolean;

属性值

boolean

注解

properties

获取文档的属性。

readonly properties: Word.DocumentProperties;

属性值

Word.DocumentProperties

注解

API 集：WordApi 1.3

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/30-properties/get-built-in-properties.yaml

await Word.run(async (context) => {
    const builtInProperties: Word.DocumentProperties = context.document.properties;
    builtInProperties.load("*"); // Let's get all!

    await context.sync();
    console.log(JSON.stringify(builtInProperties, null, 4));
});

protectionType

获取文档的保护类型。

readonly protectionType: Word.ProtectionType | "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading";

属性值

注解

readabilityStatistics

获取表示 ReadabilityStatisticCollection 文档可读性统计信息的对象。

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

属性值

Word.ReadabilityStatisticCollection

注解

readingLayoutSizeX

指定冻结时阅读布局视图中的页宽。

readingLayoutSizeX: number;

属性值

number

注解

readingLayoutSizeY

指定冻结时阅读布局视图中页面的高度。

readingLayoutSizeY: number;

属性值

number

注解

readingModeIsLayoutFrozen

指定是否为手写标记冻结阅读布局视图中的页面。

readingModeIsLayoutFrozen: boolean;

属性值

boolean

注解

removePersonalInformationOnSave

指定 Word 在保存时是否删除用户信息。

removePersonalInformationOnSave: boolean;

属性值

boolean

注解

revisedDocumentTitle

获取法律黑线比较后修订文档的标题。

readonly revisedDocumentTitle: string;

属性值

string

注解

revisions

获取表示文档中跟踪更改的修订集合。

readonly revisions: Word.RevisionCollection;

属性值

Word.RevisionCollection

注解

saved

指示是否已保存在文档中所做的更改。值 true 指示文档自保存后未更改。

readonly saved: boolean;

属性值

boolean

注解

saveEncoding

指定保存文档时使用的编码。

saveEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

属性值

注解

saveFormat

获取文档的文件格式。

readonly saveFormat: Word.FileSaveFormat | "Document" | "Template" | "Text" | "TextLineBreaks" | "DosText" | "DosTextLineBreaks" | "Rtf" | "UnicodeText" | "Html" | "WebArchive" | "FilteredHtml" | "Xml" | "XmlDocument" | "XmlDocumentMacroEnabled" | "XmlTemplate" | "XmlTemplateMacroEnabled" | "DocumentDefault" | "Pdf" | "Xps" | "FlatXml" | "FlatXmlMacroEnabled" | "FlatXmlTemplate" | "FlatXmlTemplateMacroEnabled" | "OpenDocumentText" | "StrictOpenXmlDocument";

属性值

注解

sections

获取文档中的对象集合 Section 。

readonly sections: Word.SectionCollection;

属性值

Word.SectionCollection

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/insert-header-and-footer.yaml

await Word.run(async (context) => {
  context.document.sections
    .getFirst()
    .getFooter("EvenPages")
    .insertParagraph("This is an even-pages footer.", "End");

  await context.sync();
});

selection

返回 Selection 表示文档中当前所选内容的对象。

readonly selection: Word.Selection;

属性值

Word.Selection

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/55-selection/insert-formula.yaml

// Inserts a formula field without specifying the formula expression.
// Word determines the formula automatically based on adjacent cell values:
// if there are values above the cell, it inserts =SUM(ABOVE);
// if there are values to the left, it inserts =SUM(LEFT).
// The selection must be in a table cell with at least one adjacent cell that contains a value.
await Word.run(async (context) => {
  const options: Word.SelectionInsertFormulaOptions = {
    numberFormat: "#,##0.00",
  };
  context.document.selection.insertFormula(options);
  await context.sync();

  console.log("Inserted formula (auto-determined by Word) with number format.");
});

sensitivityLabel

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

返回文档的敏感度标签。

readonly sensitivityLabel: Word.SensitivityLabel;

属性值

Word.SensitivityLabel

注解

sentences

获取 RangeScopedCollection 表示文档中所有句子的对象。

readonly sentences: Word.RangeScopedCollection;

属性值

Word.RangeScopedCollection

注解

settings

获取文档中加载项的设置。

readonly settings: Word.SettingCollection;

属性值

Word.SettingCollection

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml

// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
  const settings: Word.SettingCollection = context.document.settings;
  settings.load("items");
  await context.sync();

  if (settings.items.length == 0) {
    console.log("There are no settings.");
  } else {
    console.log("All settings:");
    for (let i = 0; i < settings.items.length; i++) {
      console.log(settings.items[i]);
    }
  }
});

spellingErrors

获取一个 RangeCollection 对象，该对象表示文档中标识为拼写错误的单词。

readonly spellingErrors: Word.RangeCollection;

属性值

Word.RangeCollection

注解

storyRanges

获取 RangeCollection 表示文档中所有文章的对象。

readonly storyRanges: Word.RangeCollection;

属性值

Word.RangeCollection

注解

styles

获取文档的 a StyleCollection 。

readonly styles: Word.StyleCollection;

属性值

Word.StyleCollection

注解

tableOfAuthoritiesCategories

返回表示 TableOfAuthoritiesCategoryCollection 文档中可用的权威类别表的对象。

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

属性值

Word.TableOfAuthoritiesCategoryCollection

注解

tables

获取 TableCollection 表示文档中所有表的对象。

readonly tables: Word.TableCollection;

属性值

Word.TableCollection

注解

tablesOfAuthorities

返回表示 TableOfAuthoritiesCollection 文档中所有权威表的对象。

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

属性值

Word.TableOfAuthoritiesCollection

注解

tablesOfContents

返回 TableOfContentsCollection 表示文档中所有目录的对象。

readonly tablesOfContents: Word.TableOfContentsCollection;

属性值

Word.TableOfContentsCollection

注解

tablesOfFigures

返回 TableOfFiguresCollection 表示文档中所有图表表的对象。

readonly tablesOfFigures: Word.TableOfFiguresCollection;

属性值

Word.TableOfFiguresCollection

注解

textEncoding

指定用于另存为编码文本的编码。

textEncoding: Word.DocumentEncoding | "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8";

属性值

注解

textLineEnding

指定 Word 如何标记文本文件中的换行符和段落符。

textLineEnding: Word.LineEndingType | "Crlf" | "CrOnly" | "LfOnly" | "Lfcr" | "Lsps";

属性值

注解

trackedChangesAreDateAndTimeRemoved

指定是删除还是存储日期和时间元数据以进行跟踪的更改。

trackedChangesAreDateAndTimeRemoved: boolean;

属性值

boolean

注解

trackFormatting

指定是否在启用更改跟踪时跟踪格式更改。

trackFormatting: boolean;

属性值

boolean

注解

trackMoves

指定在跟踪更改打开时是否标记移动的文本。

trackMoves: boolean;

属性值

boolean

注解

trackRevisions

指定是否在文档中跟踪更改。

trackRevisions: boolean;

属性值

boolean

注解

type

获取模板或文档) (文档类型。

readonly type: Word.DocumentType | "Document" | "Template" | "Frameset";

属性值

Word.DocumentType | "Document" | "Template" | "Frameset"

注解

webSettings

获取 WebSettings 网页相关属性的对象。

readonly webSettings: Word.WebSettings;

属性值

Word.WebSettings

注解

windows

获取文档的对象集合 Word.Window 。

readonly windows: Word.WindowCollection;

属性值

Word.WindowCollection

注解

API 集：WordApiDesktop 1.2

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/35-ranges/get-pages.yaml

await Word.run(async (context) => {
  // Gets the document windows.
  const windows: Word.WindowCollection = context.document.windows;
  windows.load("windows/items/length");

  await context.sync();

  console.log(`Number of windows for this document: ${windows.items.length}`);
});

words

获取 RangeScopedCollection 表示文档中每个单词的对象。

readonly words: Word.RangeScopedCollection;

属性值

Word.RangeScopedCollection

注解

writePassword

设置用于保存对文档所做的更改的密码。

writePassword: string;

属性值

string

注解

xmlAreAdvancedErrorsShown

指定错误消息是从内置 Word 消息生成还是从Microsoft XML) 生成的 MSXML (。

xmlAreAdvancedErrorsShown: boolean;

属性值

boolean

注解

xmlIsXsltUsedWhenSaving

指定是否通过可扩展样式表语言转换 (XSLT) 保存文档。

xmlIsXsltUsedWhenSaving: boolean;

属性值

boolean

注解

xmlSaveThroughXslt

指定保存文档时要应用的 XSLT 的路径和文件名。

xmlSaveThroughXslt: string;

属性值

string

注解

acceptAllRevisions()

接受文档中的所有跟踪更改。

acceptAllRevisions(): void;

返回

void

注解

acceptAllRevisionsShown()

接受屏幕上显示的文档中的所有修订。

acceptAllRevisionsShown(): void;

返回

void

注解

activate()

激活文档，使其成为活动文档。

activate(): void;

返回

void

注解

addStyle(name, type)

按名称和类型将样式添加到文档中。

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

参数

name: string

表示样式名称的字符串。

type: Word.StyleType

样式类型，包括字符、列表、段落或表格。

返回

Word.Style

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Adds a new style.
await Word.run(async (context) => {
  const newStyleName = (document.getElementById("new-style-name") as HTMLInputElement).value;
  if (newStyleName == "") {
    console.warn("Enter a style name to add.");
    return;
  }

  const style: Word.Style = context.document.getStyles().getByNameOrNullObject(newStyleName);
  style.load();
  await context.sync();

  if (!style.isNullObject) {
    console.warn(
      `There's an existing style with the same name '${newStyleName}'! Please provide another style name.`
    );
    return;
  }

  const newStyleType = ((document.getElementById("new-style-type") as HTMLSelectElement).value as unknown) as Word.StyleType;
  context.document.addStyle(newStyleName, newStyleType);
  await context.sync();

  console.log(newStyleName + " has been added to the style list.");
});

addStyle(name, type)

按名称和类型将样式添加到文档中。

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

参数

name: string

表示样式名称的字符串。

type: "Character" | "List" | "Paragraph" | "Table"

样式类型，包括字符、列表、段落或表格。

返回

Word.Style

注解

addToFavorites()

创建文档或超链接的快捷方式并将其添加到 “收藏夹” 文件夹。

addToFavorites(): void;

返回

void

注解

applyQuickStyleSet(style)

将指定的快速样式集应用于文档。

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

参数

style: Word.ApplyQuickStyleSet

要应用的样式集。

返回

void

注解

applyQuickStyleSet(style)

将指定的快速样式集应用于文档。

applyQuickStyleSet(style: "SessionStart" | "Template"): void;

参数

style: "SessionStart" | "Template"

要应用的样式集。

返回

void

注解

applyTheme(name)

将指定主题应用于此文档。

applyTheme(name: string): void;

参数

name: string

主题的名称。

返回

void

注解

autoFormat()

自动设置文档格式。

autoFormat(): void;

返回

void

注解

canCheckin()

true返回 Microsoft Word 是否可以将文档检查到服务器。

canCheckin(): OfficeExtension.ClientResult<boolean>;

返回

OfficeExtension.ClientResult<boolean>

true 文件是否可以签入;否则为 false.

注解

checkConsistencyJapanese()

搜索日语文档中的所有文字，并显示对相同单词的字符用法不一致的实例。

checkConsistencyJapanese(): void;

返回

void

注解

checkGrammar()

开始对文档进行拼写和语法检查。

checkGrammar(): void;

返回

void

注解

checkIn(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将文档从本地计算机签入到服务器，并将本地文档设置为只读，这样就不能在本地对其进行编辑。

checkIn(options?: Word.DocumentCheckInOptions): void;

参数

options: Word.DocumentCheckInOptions

可选。用于签入文档的配置选项。

返回

void

注解

checkInWithVersion(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将文档从本地计算机保存到服务器，并将本地文档设置为只读，这样就不能在本地对其进行编辑。

checkInWithVersion(options?: Word.DocumentCheckInWithVersionOptions): void;

参数

options: Word.DocumentCheckInWithVersionOptions

可选。用于使用版本控制签入文档的配置选项。

返回

void

注解

checkSpelling(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

开始对文档进行拼写检查。

checkSpelling(options?: Word.DocumentCheckSpellingOptions): void;

参数

options: Word.DocumentCheckSpellingOptions

可选。拼写检查操作的配置选项。

返回

void

注解

close(closeBehavior)

关闭当前文档。

注意：Word 网页版不支持此 API。

close(closeBehavior?: Word.CloseBehavior): void;

参数

closeBehavior: Word.CloseBehavior

可选。关闭行为必须是 save OR skipSave。默认值为 save。

返回

void

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Closes the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.close();
});

close(closeBehavior)

关闭当前文档。

注意：Word 网页版不支持此 API。

close(closeBehavior?: "Save" | "SkipSave"): void;

参数

closeBehavior: "Save" | "SkipSave"

可选。关闭行为必须是 save OR skipSave。默认值为 save。

返回

void

注解

closePrintPreview()

将文档从打印预览切换到上一个视图。

closePrintPreview(): void;

返回

void

注解

compare(filePath, documentCompareOptions)

显示修订标记，以表明指定的文档与另一个文档的区别。

compare(filePath: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

参数

filePath: string

与指定文档进行比较的文档的路径。

documentCompareOptions: Word.DocumentCompareOptions

可选。指定比较文档行为的附加选项。

返回

void

注解

API 集：WordApiDesktop 1.1

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/compare-documents.yaml

// Compares the current document with a specified external document.
await Word.run(async (context) => {
  // Absolute path of an online or local document.
  const filePath = (document.getElementById("filePath") as HTMLInputElement).value;
  // Options that configure the compare operation.
  const options: Word.DocumentCompareOptions = {
    compareTarget: Word.CompareTarget.compareTargetCurrent,
    detectFormatChanges: false
    // Other options you choose...
    };
  context.document.compare(filePath, options);

  await context.sync();

  console.log("Differences shown in the current document.");
});

compareFromBase64(base64File, documentCompareOptions)

显示修订标记，以表明指定的文档与另一个文档的区别。

compareFromBase64(base64File: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

参数

base64File: string

与指定文档进行比较的文档的 Base64 编码内容。

documentCompareOptions: Word.DocumentCompareOptions

可选。指定比较文档的行为的其他选项。请注意，此 API 中不允许compareTargetSelected出现该compareTarget选项。

返回

void

注解

API 集：WordApiDesktop 1.2

computeStatistics(statistic, includeFootnotesAndEndnotes)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

返回基于文档内容的统计信息。

computeStatistics(statistic: Word.StatisticType, includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

参数

statistic: Word.StatisticType

要返回的统计信息的类型。

includeFootnotesAndEndnotes: boolean

可选。是否包含脚注和尾注。默认值为 false。

返回

注解

computeStatistics(statistic, includeFootnotesAndEndnotes)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

返回基于文档内容的统计信息。

computeStatistics(statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters", includeFootnotesAndEndnotes?: boolean): OfficeExtension.ClientResult<number>;

参数

statistic: "Words" | "Lines" | "Pages" | "Characters" | "Paragraphs" | "CharactersWithSpaces" | "FarEastCharacters"

要返回的统计信息的类型。

includeFootnotesAndEndnotes: boolean

可选。是否包含脚注和尾注。默认值为 false。

返回

注解

convert()

将文件转换为最新格式并启用所有功能。

convert(): void;

返回

void

注解

convertAutoHyphens()

将自动连字符转换为手动连字符。

convertAutoHyphens(): void;

返回

void

注解

convertNumbersToText(numberType)

将文档中的列表编号和 LISTNUM 字段更改为文本。

convertNumbersToText(numberType?: Word.NumberType): void;

参数

numberType: Word.NumberType

可选。要转换的编号类型。

返回

void

注解

convertNumbersToText(numberType)

将文档中的列表编号和 LISTNUM 字段更改为文本。

convertNumbersToText(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

参数

numberType: "Paragraph" | "ListNum" | "AllNumbers"

可选。要转换的编号类型。

返回

void

注解

convertVietnameseDocument(codePageOrigin)

使用非默认的代码页将一篇越南语文档重新转换为 Unicode。

convertVietnameseDocument(codePageOrigin: number): void;

参数

codePageOrigin: number

要使用的代码页。

返回

void

注解

copyStylesFromTemplate(StyleTemplate)

将样式从指定模板复制到文档。

copyStylesFromTemplate(StyleTemplate: string): void;

参数

StyleTemplate: string

要从中复制样式的模板。

返回

void

注解

countNumberedItems(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

返回文档中项目符号或编号项和 LISTNUM 字段的数量。

countNumberedItems(options?: Word.DocumentCountNumberedItemsOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.DocumentCountNumberedItemsOptions

可选。用于计数编号项的配置选项。

返回

编号项的计数。

注解

deleteAllComments()

从文档中删除所有批注。

deleteAllComments(): void;

返回

void

注解

deleteAllCommentsShown()

删除文档中屏幕上显示的所有修订。

deleteAllCommentsShown(): void;

返回

void

注解

deleteAllInkAnnotations()

删除文档中的所有手写墨迹批注。

deleteAllInkAnnotations(): void;

返回

void

注解

deleteBookmark(name)

从文档中删除书签（如果存在）。

deleteBookmark(name: string): void;

参数

name: string

不区分大小写的书签名称。

返回

void

注解

detectLanguage()

分析文档文本以确定语言。

detectLanguage(): void;

返回

void

注解

endReview(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

终止对已发送以供审阅的文件的评审。

endReview(options?: Word.DocumentEndReviewOptions): void;

参数

options: Word.DocumentEndReviewOptions

可选。结束评审过程的配置选项。

返回

void

注解

exportAsFixedFormat(outputFileName, exportFormat, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

以 PDF 或 XPS 格式保存文档。

exportAsFixedFormat(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormatOptions): void;

参数

outputFileName: string

输出文件的名称。

exportFormat: Word.ExportFormat

导出格式。

options: Word.DocumentExportAsFixedFormatOptions

可选。导出操作的配置选项。

返回

void

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/99-preview-apis/export.yaml

await Word.run(async (context) => {
  // Choose whether the exported PDF uses Word headings, named bookmarks, or neither.
  const bookmarkMode = (document.getElementById("bookmark-mode") as HTMLSelectElement).value;
  let createBookmarks: Word.ExportCreateBookmarks;

  switch (bookmarkMode) {
    case "Headings":
      createBookmarks = Word.ExportCreateBookmarks.headings;
      break;
    case "WordBookmarks":
      createBookmarks = Word.ExportCreateBookmarks.wordBookmarks;
      break;
    default:
      createBookmarks = Word.ExportCreateBookmarks.none;
      break;
  }

  // Export the current document as a PDF saved in your default location, usually Documents.
  const filename = `exported-doc-${bookmarkMode}-${getCurrentDate()}.pdf`;
  console.log(`File name: ${filename}`);
  const options: Word.DocumentExportAsFixedFormatOptions = {
    item: Word.ExportItem.documentContent,
    openAfterExport: true,
    optimizeFor: Word.ExportOptimizeFor.onScreen,
    createBookmarks: createBookmarks,
  };

  // If a file with the same name already exists at the default location, it's silently overwritten.
  context.document.exportAsFixedFormat(filename, Word.ExportFormat.pdf, options);

  await context.sync();
});

exportAsFixedFormat(outputFileName, exportFormat, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

以 PDF 或 XPS 格式保存文档。

exportAsFixedFormat(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormatOptions): void;

参数

outputFileName: string

输出文件的名称。

exportFormat: "Pdf" | "Xps"

导出格式。

options: Word.DocumentExportAsFixedFormatOptions

可选。导出操作的配置选项。

返回

void

注解

exportAsFixedFormat2(outputFileName, exportFormat, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

以 PDF 或 XPS 格式保存文档。

exportAsFixedFormat2(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat2Options): void;

参数

outputFileName: string

输出文件名。

exportFormat: Word.ExportFormat

要导出 (PDF/XPS) 的格式。

options: Word.DocumentExportAsFixedFormat2Options

可选。导出操作的配置选项。

返回

void

注解

exportAsFixedFormat2(outputFileName, exportFormat, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

以 PDF 或 XPS 格式保存文档。

exportAsFixedFormat2(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat2Options): void;

参数

outputFileName: string

输出文件名。

exportFormat: "Pdf" | "Xps"

要导出 (PDF/XPS) 的格式。

options: Word.DocumentExportAsFixedFormat2Options

可选。导出操作的配置选项。

返回

void

注解

exportAsFixedFormat3(outputFileName, exportFormat, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

以 PDF 或 XPS 格式保存文档，并改进了标记。

exportAsFixedFormat3(outputFileName: string, exportFormat: Word.ExportFormat, options?: Word.DocumentExportAsFixedFormat3Options): void;

参数

outputFileName: string

输出文件名。

exportFormat: Word.ExportFormat

要导出 (PDF/XPS) 的格式。

options: Word.DocumentExportAsFixedFormat3Options

可选。导出操作的配置选项。

返回

void

注解

exportAsFixedFormat3(outputFileName, exportFormat, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

以 PDF 或 XPS 格式保存文档，并改进了标记。

exportAsFixedFormat3(outputFileName: string, exportFormat: "Pdf" | "Xps", options?: Word.DocumentExportAsFixedFormat3Options): void;

参数

outputFileName: string

输出文件名。

exportFormat: "Pdf" | "Xps"

要导出 (PDF/XPS) 的格式。

options: Word.DocumentExportAsFixedFormat3Options

可选。导出操作的配置选项。

返回

void

注解

fitToPages()

将文本的字号减小到足以使文档页数减少 1 的程度。

fitToPages(): void;

返回

void

注解

followHyperlink(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

显示一个缓存文档（如果该文档已下载）。否则，此方法将解析该超链接，下载目标文档，并在相应的应用程序中显示此文档。

followHyperlink(options?: Word.DocumentFollowHyperlinkOptions): void;

参数

options: Word.DocumentFollowHyperlinkOptions

可选。跟踪超链接的配置选项。

返回

void

注解

freezeLayout()

修复了文档在 Web 视图中的布局。

freezeLayout(): void;

返回

void

注解

getAnnotationById(id)

按 ID 获取批注。如果未找到注释，则引发 ItemNotFound 错误。

getAnnotationById(id: string): Word.Annotation;

参数

id: string

要获取的批注的 ID。

返回

Word.Annotation

注解

getBookmarkRange(name)

获取书签的范围。如果书签不存在，则引发 ItemNotFound 错误。

getBookmarkRange(name: string): Word.Range;

参数

name: string

不区分大小写的书签名称。

返回

Word.Range

注解

getBookmarkRangeOrNullObject(name)

获取书签的范围。如果书签不存在，则此方法将返回其 isNullObject 属性设置为 true的对象。有关详细信息，请参阅 *OrNullObject 方法和属性。

getBookmarkRangeOrNullObject(name: string): Word.Range;

参数

name: string

不区分大小写的书签名称。

返回

Word.Range

注解

getContentControls(options)

获取文档中当前支持的内容控件。

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

参数

options: Word.ContentControlOptions

可选。用于定义返回哪些内容控件的选项。

返回

Word.ContentControlCollection

注解

重要提示：如果在 options 参数中提供了特定类型，则仅返回受支持类型的内容控件。请注意，使用通用 Word 的方法将引发异常。与特定类型无关的 ContentControl。随着时间的推移，可能会支持其他类型的内容控件。因此，加载项应请求和处理特定类型的内容控件。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/insert-and-change-checkbox-content-control.yaml

// Toggles the isChecked property on all checkbox content controls.
await Word.run(async (context) => {
  let contentControls = context.document.getContentControls({
    types: [Word.ContentControlType.checkBox]
  });
  contentControls.load("items");

  await context.sync();

  const length = contentControls.items.length;
  console.log(`Number of checkbox content controls: ${length}`);

  if (length <= 0) {
    return;
  }

  const checkboxContentControls = [];
  for (let i = 0; i < length; i++) {
    let contentControl = contentControls.items[i];
    contentControl.load("id,checkboxContentControl/isChecked");
    checkboxContentControls.push(contentControl);
  }

  await context.sync();

  console.log("isChecked state before:");
  const updatedCheckboxContentControls = [];
  for (let i = 0; i < checkboxContentControls.length; i++) {
    const currentCheckboxContentControl = checkboxContentControls[i];
    const isCheckedBefore = currentCheckboxContentControl.checkboxContentControl.isChecked;
    console.log(`id: ${currentCheckboxContentControl.id} ... isChecked: ${isCheckedBefore}`);

    currentCheckboxContentControl.checkboxContentControl.isChecked = !isCheckedBefore;
    currentCheckboxContentControl.load("id,checkboxContentControl/isChecked");
    updatedCheckboxContentControls.push(currentCheckboxContentControl);
  }

  await context.sync();

  console.log("isChecked state after:");
  for (let i = 0; i < updatedCheckboxContentControls.length; i++) {
    const currentCheckboxContentControl = updatedCheckboxContentControls[i];
    console.log(
      `id: ${currentCheckboxContentControl.id} ... isChecked: ${currentCheckboxContentControl.checkboxContentControl.isChecked}`
    );
  }
});

getCrossReferenceItems(referenceType)

返回一个项目数组，根据指定的交叉引用类型可对该数组中的项目进行交叉引用。

getCrossReferenceItems(referenceType: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

参数

referenceType: Word.ReferenceType

引用的类型。

返回

注解

getCrossReferenceItems(referenceType)

返回一个项目数组，根据指定的交叉引用类型可对该数组中的项目进行交叉引用。

getCrossReferenceItems(referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"): OfficeExtension.ClientResult<string[]>;

参数

referenceType: "NumberedItem" | "Heading" | "Bookmark" | "Footnote" | "Endnote"

引用的类型。

返回

注解

getEndnoteBody()

在单个正文中获取文档的尾注。

getEndnoteBody(): Word.Body;

返回

Word.Body

注解

getFootnoteBody()

在单个正文中获取文档的脚注。

getFootnoteBody(): Word.Body;

返回

Word.Body

注解

getParagraphByUniqueLocalId(id)

按段落的唯一本地 ID 获取段落。如果集合为空，则引发 ItemNotFound 错误。

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

参数

id: string

标准 8-4-4-4-12 GUID 格式的唯一本地 ID，不带大括号。请注意，ID 因会话和共同创作者而异。

返回

Word.Paragraph

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

await Word.run(async (context) => {
  const paragraphId = (document.getElementById("paragraph-id") as HTMLInputElement).value;
  const paragraph: Word.Paragraph = context.document.getParagraphByUniqueLocalId(paragraphId);
  paragraph.load();
  await paragraph.context.sync();

  console.log(paragraph);
});

getRange(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

使用指定的开始和结束字符位置返回 Range 对象。

getRange(options?: Word.DocumentRangeOptions): Word.Range;

参数

options: Word.DocumentRangeOptions

可选。用于指定范围参数的配置选项。

返回

Word.Range

注解

getSelection()

获取文档的当前选定内容。不支持多选。

getSelection(): Word.Range;

返回

Word.Range

注解

示例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    const textSample = 'This is an example of the insert text method. This is a method ' + 
        'which allows users to insert text into a selection. It can insert text into a ' +
        'relative location or it can overwrite the current selection. Since the ' +
        'getSelection method returns a range object, look up the range object documentation ' +
        'for everything you can do with a selection.';
    
    // Create a range proxy object for the current selection.
    const range = context.document.getSelection();
    
    // Queue a command to insert text at the end of the selection.
    range.insertText(textSample, Word.InsertLocation.end);
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    console.log('Inserted the text at the end of the selection.');
});

getStyles()

获取表示 StyleCollection 文档的整个样式集的对象。

getStyles(): Word.StyleCollection;

返回

Word.StyleCollection

注解

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/28-formatting/manage-styles.yaml

// Gets the number of available styles stored with the document.
await Word.run(async (context) => {
  const styles: Word.StyleCollection = context.document.getStyles();
  const count = styles.getCount();
  await context.sync();

  console.log(`Number of styles: ${count.value}`);
});

goTo(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

返回 Range 表示指定项起始位置的对象，例如页面、书签或字段。

goTo(options?: Word.GoToOptions): Word.Range;

参数

options: Word.GoToOptions

可选。用于指定参数的 goTo 配置选项。

返回

Word.Range

注解

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

从 JSON 格式的字符串导入样式。

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: Word.ImportedStylesConflictBehavior): OfficeExtension.ClientResult<string[]>;

参数

stylesJson: string

表示样式的 JSON 格式字符串。

importedStylesConflictBehavior: Word.ImportedStylesConflictBehavior

可选。指定如何处理与当前文档中的现有样式同名的任何导入的样式。默认值为 ignore。

返回

注解

注意：该 importedStylesConflictBehavior 参数是在 WordApiDesktop 1.1 中引入的。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/40-tables/manage-custom-style.yaml

// Imports styles from JSON.
await Word.run(async (context) => {
  const str =
    '{"styles":[{"baseStyle":"Default Paragraph Font","builtIn":false,"inUse":true,"linked":false,"nameLocal":"NewCharStyle","priority":2,"quickStyle":true,"type":"Character","unhideWhenUsed":false,"visibility":false,"paragraphFormat":null,"font":{"name":"DengXian Light","size":16.0,"bold":true,"italic":false,"color":"#F1A983","underline":"None","subscript":false,"superscript":true,"strikeThrough":true,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#FF0000"}},{"baseStyle":"Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewParaStyle","nameLocal":"NewParaStyle","priority":1,"quickStyle":true,"type":"Paragraph","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Centered","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":72.0,"lineSpacing":18.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":72.0,"spaceAfter":30.0,"spaceBefore":30.0,"widowControl":true},"font":{"name":"DengXian","size":14.0,"bold":true,"italic":true,"color":"#8DD873","underline":"Single","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":true,"highlightColor":null,"hidden":false},"shading":{"backgroundPatternColor":"#00FF00"}},{"baseStyle":"Table Normal","builtIn":false,"inUse":true,"linked":false,"nextParagraphStyle":"NewTableStyle","nameLocal":"NewTableStyle","priority":100,"type":"Table","unhideWhenUsed":false,"visibility":false,"paragraphFormat":{"alignment":"Left","firstLineIndent":0.0,"keepTogether":false,"keepWithNext":false,"leftIndent":0.0,"lineSpacing":12.0,"lineUnitAfter":0.0,"lineUnitBefore":0.0,"mirrorIndents":false,"outlineLevel":"OutlineLevelBodyText","rightIndent":0.0,"spaceAfter":0.0,"spaceBefore":0.0,"widowControl":true},"font":{"name":"DengXian","size":20.0,"bold":false,"italic":true,"color":"#D86DCB","underline":"None","subscript":false,"superscript":false,"strikeThrough":false,"doubleStrikeThrough":false,"highlightColor":null,"hidden":false},"tableStyle":{"allowBreakAcrossPage":true,"alignment":"Left","bottomCellMargin":0.0,"leftCellMargin":0.08,"rightCellMargin":0.08,"topCellMargin":0.0,"cellSpacing":0.0},"shading":{"backgroundPatternColor":"#60CAF3"}}]}';
  const styles = context.document.importStylesFromJson(str);

  // If you'd like to set how conflicting styles are handled, use the importedStylesConflictBehavior parameter that was introduced in the Desktop 1.1 requirement set. "Ignore" is the default.
  ////const styles = context.document.importStylesFromJson(str, Word.ImportedStylesConflictBehavior.Ignore);

  await context.sync();
  console.log("Styles imported from JSON:", styles);
});

importStylesFromJson(stylesJson, importedStylesConflictBehavior)

从 JSON 格式的字符串导入样式。

importStylesFromJson(stylesJson: string, importedStylesConflictBehavior?: "Ignore" | "Overwrite" | "CreateNew"): OfficeExtension.ClientResult<string[]>;

参数

stylesJson: string

表示样式的 JSON 格式字符串。

importedStylesConflictBehavior: "Ignore" | "Overwrite" | "CreateNew"

可选。指定如何处理与当前文档中的现有样式同名的任何导入的样式。默认值为 ignore。

返回

注解

注意：该 importedStylesConflictBehavior 参数是在 WordApiDesktop 1.1 中引入的。

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 控件，则不支持插入， (可能在表单字段) 中。请考虑将此类窗体字段替换为适合你的场景的内容控件或其他选项。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/insert-external-document.yaml

// Inserts content (applying selected settings) 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.
  context.document.insertFileFromBase64(externalDocument, "Replace", {
    importTheme: true,
    importStyles: true,
    importParagraphSpacing: true,
    importPageColor: true,
    importChangeTrackingMode: true,
    importCustomProperties: true,
    importCustomXmlParts: true,
    importDifferentOddEvenPages: true
  });
  await context.sync();
});

load(options)

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

load(options?: Word.Interfaces.DocumentLoadOptions): Word.Document;

参数

options: Word.Interfaces.DocumentLoadOptions

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

返回

Word.Document

示例

// Run a batch operation against the Word object model.
await Word.run(async (context) => {
    
    // Create a proxy object for the document.
    const thisDocument = context.document;
    
    // Queue a command to load content control properties.
    thisDocument.load('contentControls/id, contentControls/text, contentControls/tag');
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
    if (thisDocument.contentControls.items.length !== 0) {
        for (let i = 0; i < thisDocument.contentControls.items.length; i++) {
            console.log(thisDocument.contentControls.items[i].id);
            console.log(thisDocument.contentControls.items[i].text);
            console.log(thisDocument.contentControls.items[i].tag);
        }
    } else {
        console.log('No content controls in this document.');
    }
});

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

返回

Word.Document

load(propertyNamesAndPaths)

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

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

参数

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

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

返回

Word.Document

lockServerFile()

在服务器上锁定文件，以避免任何其他人进行编辑。

lockServerFile(): void;

返回

void

注解

makeCompatibilityDefault()

设置兼容性选项。

makeCompatibilityDefault(): void;

返回

void

注解

manualHyphenation()

启动文档的手动断字设置，每次一行。

manualHyphenation(): void;

返回

void

注解

merge(fileName, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将文档中用修订标记标识的修改合并到另一篇文档。

merge(fileName: string, options?: Word.DocumentMergeOptions): void;

参数

fileName: string

要合并的文件的名称。

options: Word.DocumentMergeOptions

可选。合并操作的配置选项。

返回

void

注解

post()

将文档发布到 Microsoft Exchange 中的公用文件夹。

post(): void;

返回

void

注解

presentIt()

打开已加载 Word 文档的 PowerPoint。

presentIt(): void;

返回

void

注解

printOut(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

打印全部或部分文档。

printOut(options?: Word.DocumentPrintOutOptions): void;

参数

options: Word.DocumentPrintOutOptions

可选。打印操作的配置选项。

返回

void

注解

printPreview()

将视图切换到打印预览。

printPreview(): void;

返回

void

注解

protect(type, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

保护文档免受未经授权的更改。

protect(type: Word.ProtectionType, options?: Word.DocumentProtectOptions): void;

参数

type: Word.ProtectionType

保护的类型。

options: Word.DocumentProtectOptions

可选。文档保护的配置选项。

返回

void

注解

protect(type, options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

保护文档免受未经授权的更改。

protect(type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading", options?: Word.DocumentProtectOptions): void;

参数

type: "NoProtection" | "AllowOnlyRevisions" | "AllowOnlyComments" | "AllowOnlyFormFields" | "AllowOnlyReading"

保护的类型。

options: Word.DocumentProtectOptions

可选。文档保护的配置选项。

返回

void

注解

redo(times)

重做撤消的最后一个操作 (undo 反转方法) 。

redo(times?: number): OfficeExtension.ClientResult<boolean>;

参数

times: number

可选。要重做的操作数。

返回

OfficeExtension.ClientResult<boolean>

true 操作是否成功重做;否则为 false.

注解

rejectAllRevisions()

拒绝文档中所有跟踪的更改。

rejectAllRevisions(): void;

返回

void

注解

rejectAllRevisionsShown()

拒绝文档中屏幕上显示的所有修订。

rejectAllRevisionsShown(): void;

返回

void

注解

reload()

通过解析指向缓冲文档的超链接再下载该文档来重新加载该文档。

reload(): void;

返回

void

注解

reloadAs(encoding)

使用文档编码，基于 HTML 文档重新加载文档。

reloadAs(encoding: Word.DocumentEncoding): void;

参数

encoding: Word.DocumentEncoding

要使用的编码。

返回

void

注解

reloadAs(encoding)

使用文档编码，基于 HTML 文档重新加载文档。

reloadAs(encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"): void;

参数

encoding: "Thai" | "JapaneseShiftJis" | "SimplifiedChineseGbk" | "Korean" | "TraditionalChineseBig5" | "UnicodeLittleEndian" | "UnicodeBigEndian" | "CentralEuropean" | "Cyrillic" | "Western" | "Greek" | "Turkish" | "Hebrew" | "Arabic" | "Baltic" | "Vietnamese" | "AutoDetect" | "JapaneseAutoDetect" | "SimplifiedChineseAutoDetect" | "KoreanAutoDetect" | "TraditionalChineseAutoDetect" | "CyrillicAutoDetect" | "GreekAutoDetect" | "ArabicAutoDetect" | "Iso88591Latin1" | "Iso88592CentralEurope" | "Iso88593Latin3" | "Iso88594Baltic" | "Iso88595Cyrillic" | "Iso88596Arabic" | "Iso88597Greek" | "Iso88598Hebrew" | "Iso88599Turkish" | "Iso885915Latin9" | "Iso88598HebrewLogical" | "Iso2022JpNoHalfwidthKatakana" | "Iso2022JpJisX02021984" | "Iso2022JpJisX02011989" | "Iso2022Kr" | "Iso2022CnTraditionalChinese" | "Iso2022CnSimplifiedChinese" | "MacRoman" | "MacJapanese" | "MacTraditionalChineseBig5" | "MacKorean" | "MacArabic" | "MacHebrew" | "MacGreek1" | "MacCyrillic" | "MacSimplifiedChineseGb2312" | "MacRomania" | "MacUkraine" | "MacLatin2" | "MacIcelandic" | "MacTurkish" | "MacCroatia" | "EbcdicUsCanada" | "EbcdicInternational" | "EbcdicMultilingualRoeceLatin2" | "EbcdicGreekModern" | "EbcdicTurkishLatin5" | "EbcdicGermany" | "EbcdicDenmarkNorway" | "EbcdicFinlandSweden" | "EbcdicItaly" | "EbcdicLatinAmericaSpain" | "EbcdicUnitedKingdom" | "EbcdicJapaneseKatakanaExtended" | "EbcdicFrance" | "EbcdicArabic" | "EbcdicGreek" | "EbcdicHebrew" | "EbcdicKoreanExtended" | "EbcdicThai" | "EbcdicIcelandic" | "EbcdicTurkish" | "EbcdicRussian" | "EbcdicSerbianBulgarian" | "EbcdicJapaneseKatakanaExtendedAndJapanese" | "EbcdicUsCanadaAndJapanese" | "EbcdicKoreanExtendedAndKorean" | "EbcdicSimplifiedChineseExtendedAndSimplifiedChinese" | "EbcdicUsCanadaAndTraditionalChinese" | "EbcdicJapaneseLatinExtendedAndJapanese" | "OemUnitedStates" | "OemGreek437G" | "OemBaltic" | "OemMultilingualLatinI" | "OemMultilingualLatinIi" | "OemCyrillic" | "OemTurkish" | "OemPortuguese" | "OemIcelandic" | "OemHebrew" | "OemCanadianFrench" | "OemArabic" | "OemNordic" | "OemCyrillicIi" | "OemModernGreek" | "EucJapanese" | "EucChineseSimplifiedChinese" | "EucKorean" | "EucTaiwaneseTraditionalChinese" | "IsciiDevanagari" | "IsciiBengali" | "IsciiTamil" | "IsciiTelugu" | "IsciiAssamese" | "IsciiOriya" | "IsciiKannada" | "IsciiMalayalam" | "IsciiGujarati" | "IsciiPunjabi" | "ArabicAsmo" | "ArabicTransparentAsmo" | "KoreanJohab" | "TaiwanCns" | "TaiwanTca" | "TaiwanEten" | "TaiwanIbm5550" | "TaiwanTeleText" | "TaiwanWang" | "Ia5Irv" | "Ia5German" | "Ia5Swedish" | "Ia5Norwegian" | "UsaAscii" | "T61" | "Iso6937NonSpacingAccent" | "Koi8R" | "ExtAlphaLowercase" | "Koi8U" | "Europa3" | "HzGbSimplifiedChinese" | "SimplifiedChineseGb18030" | "Utf7" | "Utf8"

要使用的编码。

返回

void

注解

removeDocumentInformation(removeDocInfoType)

从文档中删除敏感信息、属性、批注和其他元数据。

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

参数

removeDocInfoType: Word.RemoveDocInfoType

要删除的文档信息的类型。

返回

void

注解

removeDocumentInformation(removeDocInfoType)

从文档中删除敏感信息、属性、批注和其他元数据。

removeDocumentInformation(removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"): void;

参数

removeDocInfoType: "Comments" | "Revisions" | "Versions" | "RemovePersonalInformation" | "EmailHeader" | "RoutingSlip" | "SendForReview" | "DocumentProperties" | "Template" | "DocumentWorkspace" | "InkAnnotations" | "DocumentServerProperties" | "DocumentManagementPolicy" | "ContentType" | "TaskpaneWebExtensions" | "AtMentions" | "DocumentTasks" | "DocumentIntelligence" | "CommentReactions" | "All"

要删除的文档信息的类型。

返回

void

注解

removeLockedStyles()

在文档中应用格式限制时，清除文档中锁定的样式。

removeLockedStyles(): void;

返回

void

注解

removeNumbers(numberType)

从文档中删除数字或项目符号。

removeNumbers(numberType?: Word.NumberType): void;

参数

numberType: Word.NumberType

可选。要删除的编号类型。

返回

void

注解

removeNumbers(numberType)

从文档中删除数字或项目符号。

removeNumbers(numberType?: "Paragraph" | "ListNum" | "AllNumbers"): void;

参数

numberType: "Paragraph" | "ListNum" | "AllNumbers"

可选。要删除的编号类型。

返回

void

注解

removeTheme()

删除当前文档中的活动主题。

removeTheme(): void;

返回

void

注解

repaginate()

对整篇文档重新分页。

repaginate(): void;

返回

void

注解

replyWithChanges(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

向已发送进行审阅的文档的作者发送电子邮件，通知他们审阅者已完成文档的审阅。

replyWithChanges(options?: Word.DocumentReplyWithChangesOptions): void;

参数

options: Word.DocumentReplyWithChangesOptions

可选。用于回复更改的配置选项。

返回

void

注解

resetFormFields()

清除文档中的所有表单字段，准备再次填写表单。

resetFormFields(): void;

返回

void

注解

returnToLastReadPosition()

将文档返回到上次保存的阅读位置。

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

返回

注解

runAutoMacro(autoMacro)

运行存储在文档中的自动宏。如果没有自动宏，则不做任何操作。

runAutoMacro(autoMacro: Word.AutoMacro): void;

参数

autoMacro: Word.AutoMacro

要运行的自动宏。

返回

void

注解

runAutoMacro(autoMacro)

运行存储在文档中的自动宏。如果没有自动宏，则不做任何操作。

runAutoMacro(autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"): void;

参数

autoMacro: "StartWord" | "New" | "Open" | "Close" | "Exit" | "Sync"

要运行的自动宏。

返回

void

注解

save(saveBehavior, fileName)

保存文档。

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

参数

saveBehavior: Word.SaveBehavior

可选。保存行为必须是 save OR prompt。默认值为 save。

fileName: string

可选。文件名 (不包括文件扩展名) 。仅对新文档生效。

返回

void

注解

注意：和fileName参数是在 saveBehavior WordApi 1.5 中引入的。

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/save-close.yaml

// Saves the document with default behavior
// for current state of the document.
await Word.run(async (context) => {
  context.document.save();
  await context.sync();
});

save(saveBehavior, fileName)

保存文档。

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

参数

saveBehavior: "Save" | "Prompt"

可选。保存行为必须是 save OR prompt。默认值为 save。

fileName: string

可选。文件名 (不包括文件扩展名) 。仅对新文档生效。

返回

void

注解

注意：和fileName参数是在 saveBehavior WordApi 1.5 中引入的。

saveAsQuickStyleSet(fileName)

保存当前所用的快速样式组。

saveAsQuickStyleSet(fileName: string): void;

参数

fileName: string

要保存的文件的名称。

返回

void

注解

search(searchText, searchOptions)

使用指定的搜索选项对整个文档的范围执行搜索。搜索结果是对象的 Range 集合。

search(searchText: string, searchOptions?: Word.SearchOptions | {
            ignorePunct?: boolean;
            ignoreSpace?: boolean;
            matchCase?: boolean;
            matchPrefix?: boolean;
            matchSuffix?: boolean;
            matchWholeWord?: boolean;
            matchWildcards?: boolean;
        }): Word.RangeCollection;

参数

searchText: string

要搜索的文本。

searchOptions: Word.SearchOptions | { ignorePunct?: boolean; ignoreSpace?: boolean; matchCase?: boolean; matchPrefix?: boolean; matchSuffix?: boolean; matchWholeWord?: boolean; matchWildcards?: boolean; }

可选。定义搜索执行方式的选项。

返回

Word.RangeCollection

注解

select()

选择文档的内容。

select(): void;

返回

void

注解

selectContentControlsByTag(tag)

返回具有指定标记的所有内容控件。

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

参数

tag: string

用于筛选内容控件的标记值。

返回

Word.ContentControlCollection

注解

selectContentControlsByTitle(title)

返回一个 ContentControlCollection 对象，该对象表示文档中具有指定标题的所有内容控件。

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

参数

title: string

内容控件的标题。

返回

Word.ContentControlCollection

注解

selectLinkedControls(node)

返回表示 ContentControlCollection 文档中链接到特定自定义 XML 节点的所有内容控件的对象。

selectLinkedControls(node: Word.CustomXmlNode): Word.ContentControlCollection;

参数

node: Word.CustomXmlNode

自定义 XML 节点。

返回

Word.ContentControlCollection

注解

selectNodes(xPath, options)

返回一个 XmlNodeCollection 对象，该对象表示与 XPath 参数匹配的所有节点（按照它们在文档中出现的顺序）。

selectNodes(xPath: string, options?: Word.SelectNodesOptions): Word.XmlNodeCollection;

参数

xPath: string

XPath 表达式。

options: Word.SelectNodesOptions

可选。节点选择的配置选项。

返回

Word.XmlNodeCollection

注解

selectSingleNode(xPath, options)

返回一个 XmlNode 对象，该对象表示与文档中与 XPath 参数匹配的第一个节点。

selectSingleNode(xPath: string, options?: Word.SelectSingleNodeOptions): Word.XmlNode;

参数

xPath: string

XPath 表达式。

options: Word.SelectSingleNodeOptions

可选。节点选择的配置选项。

返回

Word.XmlNode

注解

selectUnlinkedControls(stream)

返回表示 ContentControlCollection 文档中未链接到 XML 节点的所有内容控件的对象。

selectUnlinkedControls(stream?: Word.CustomXmlPart): Word.ContentControlCollection;

参数

stream: Word.CustomXmlPart

可选。自定义 XML 部分。

返回

Word.ContentControlCollection

注解

sendFax(address, subject)

以传真形式发送文档，无需任何用户交互。

sendFax(address: string, subject?: string): void;

参数

address: string

传真地址。

subject: string

可选。传真的主题。

返回

void

注解

sendFaxOverInternet(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

将文档发送给传真服务提供商，该服务提供商将文档传真给一个或多个指定收件人。

sendFaxOverInternet(options?: Word.DocumentSendFaxOverInternetOptions): void;

参数

options: Word.DocumentSendFaxOverInternetOptions

可选。通过 Internet 发送传真的配置选项。

返回

void

注解

sendForReview(options)

注意

此 API 以预览状态提供给开发者，可能根据我们收到的反馈更改。请勿在生产环境中使用此 API。

通过电子邮件发送文档供指定的收件人审阅。

sendForReview(options?: Word.DocumentSendForReviewOptions): void;

参数

options: Word.DocumentSendForReviewOptions

可选。用于发送文档以供审阅的配置选项。

返回

void

注解

sendMail()

打开用于通过 Microsoft Exchange 发送文档的消息窗口。

sendMail(): void;

返回

void

注解

set(properties, options)

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

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

参数

properties: Word.Interfaces.DocumentUpdateData

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

options: OfficeExtension.UpdateOptions

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

返回

void

set(properties)

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

set(properties: Word.Document): void;

参数

properties: Word.Document

返回

void

setDefaultTableStyle(style, setInTemplate)

指定要用于文档中新创建的表的表格样式。

setDefaultTableStyle(style: string, setInTemplate: boolean): void;

参数

style: string

要应用的样式。

setInTemplate: boolean

是否在模板中设置样式。

返回

void

注解

setPasswordEncryptionOptions(passwordEncryptionProvider, passwordEncryptionAlgorithm, passwordEncryptionKeyLength, passwordEncryptFileProperties)

设置 Microsoft Word 用于通过密码加密文档的选项

setPasswordEncryptionOptions(passwordEncryptionProvider: string, passwordEncryptionAlgorithm: string, passwordEncryptionKeyLength: number, passwordEncryptFileProperties?: boolean): void;

参数

passwordEncryptionProvider: string

加密提供程序。

passwordEncryptionAlgorithm: string

加密算法。

passwordEncryptionKeyLength: number

密钥长度。

passwordEncryptFileProperties: boolean

可选。是否加密文件属性。

返回

void

注解

toggleFormsDesign()

在打开和关闭窗体设计模式之间切换。

toggleFormsDesign(): void;

返回

void

注解

toJSON()

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

toJSON(): Word.Interfaces.DocumentData;

返回

Word.Interfaces.DocumentData

track()

根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。如果此对象是集合的一部分，您还应跟踪父集合。

track(): Word.Document;

返回

Word.Document

transformDocument(path, dataOnly)

将指定的可扩展样式表语言转换 (XSLT) 文件应用到此文档，并将该文档替换为结果。

transformDocument(path: string, dataOnly?: boolean): void;

参数

path: string

XSLT 文件的路径。

dataOnly: boolean

可选。是否仅使用数据。

返回

void

注解

undo(times)

撤消最后一次操作或最后一系列操作，这些操作显示在“撤消”列表中。

undo(times?: number): OfficeExtension.ClientResult<boolean>;

参数

times: number

可选。要撤消的操作数。

返回

OfficeExtension.ClientResult<boolean>

true 操作是否成功撤消;否则为 false.

注解

undoClear()

清除文档中可撤消的操作列表。

undoClear(): void;

返回

void

注解

unprotect(password)

从文档中删除保护。

unprotect(password?: string): void;

参数

password: string

可选。用于取消保护文档的密码。

返回

void

注解

untrack()

释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。需要在内存释放生效之前调用 context.sync() 。

untrack(): Word.Document;

返回

Word.Document

updateStyles()

将所有样式从附加模板复制到文档中，同时覆盖文档中所有现有同名的样式。

updateStyles(): void;

返回

void

注解

viewCode()

显示文档中所选 Microsoft ActiveX 控件的代码窗口。

viewCode(): void;

返回

void

注解

viewPropertyBrowser()

显示文档中所选 Microsoft ActiveX 控件的属性窗口。

viewPropertyBrowser(): void;

返回

void

注解

webPagePreview()

显示当前文档的预览，就像保存为网页时的外观一样。

webPagePreview(): void;

返回

void

注解

OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>

onAnnotationClicked

当用户单击批注 (或使用 Alt+向下) 选择它时发生。

readonly onAnnotationClicked: OfficeExtension.EventHandlers<Word.AnnotationClickedEventArgs>;

事件类型

注解

OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onClickedHandler(args: Word.AnnotationClickedEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationClicked: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationHovered

当用户将光标悬停在批注上时发生。

readonly onAnnotationHovered: OfficeExtension.EventHandlers<Word.AnnotationHoveredEventArgs>;

事件类型

注解

OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onHoveredHandler(args: Word.AnnotationHoveredEventArgs) {
  await Word.run(async (context) => {
    const annotation: Word.Annotation = context.document.getAnnotationById(args.id);
    annotation.load("critiqueAnnotation");

    await context.sync();

    console.log(`AnnotationHovered: ID ${args.id}:`, annotation.critiqueAnnotation.critique);
  });
}

onAnnotationInserted

当用户添加一个或多个批注时发生。

readonly onAnnotationInserted: OfficeExtension.EventHandlers<Word.AnnotationInsertedEventArgs>;

事件类型

注解

OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onInsertedHandler(args: Word.AnnotationInsertedEventArgs) {
  await Word.run(async (context) => {
    const annotations = [];
    for (let i = 0; i < args.ids.length; i++) {
      let annotation: Word.Annotation = context.document.getAnnotationById(args.ids[i]);
      annotation.load("id,critiqueAnnotation");

      annotations.push(annotation);
    }

    await context.sync();

    for (let annotation of annotations) {
      console.log(`AnnotationInserted: ID ${annotation.id}:`, annotation.critiqueAnnotation.critique);
    }
  });
}

onAnnotationPopupAction

当用户在批注弹出菜单中执行操作时发生。

readonly onAnnotationPopupAction: OfficeExtension.EventHandlers<Word.AnnotationPopupActionEventArgs>;

事件类型

注解

API 集：WordApi 1.8

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onPopupActionHandler(args: Word.AnnotationPopupActionEventArgs) {
  await Word.run(async (context) => {
    let message = `AnnotationPopupAction: ID ${args.id} = `;
    if (args.action === "Accept") {
      message += `Accepted: ${args.critiqueSuggestion}`;
    } else {
      message += "Rejected";
    }

    console.log(message);
  });
}

onAnnotationRemoved

当用户删除一个或多个批注时发生。

readonly onAnnotationRemoved: OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>;

事件类型

OfficeExtension.EventHandlers<Word.AnnotationRemovedEventArgs>

注解

OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-annotations.yaml

// Registers event handlers.
await Word.run(async (context) => {
  eventContexts[0] = context.document.onParagraphAdded.add(paragraphChanged);
  eventContexts[1] = context.document.onParagraphChanged.add(paragraphChanged);

  eventContexts[2] = context.document.onAnnotationClicked.add(onClickedHandler);
  eventContexts[3] = context.document.onAnnotationHovered.add(onHoveredHandler);
  eventContexts[4] = context.document.onAnnotationInserted.add(onInsertedHandler);
  eventContexts[5] = context.document.onAnnotationRemoved.add(onRemovedHandler);
  eventContexts[6] = context.document.onAnnotationPopupAction.add(onPopupActionHandler);

  await context.sync();

  console.log("Event handlers registered.");
});

...

async function onRemovedHandler(args: Word.AnnotationRemovedEventArgs) {
  await Word.run(async (context) => {
    for (let id of args.ids) {
      console.log(`AnnotationRemoved: ID ${id}`);
    }
  });
}

onContentControlAdded

在添加内容控件时发生。在处理程序中运行 context.sync () 以获取新内容控件的属性。

readonly onContentControlAdded: OfficeExtension.EventHandlers<Word.ContentControlAddedEventArgs>;

事件类型

注解

OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/10-content-controls/content-control-onadded-event.yaml

// Registers the onAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onContentControlAdded.add(contentControlAdded);
  await context.sync();

  console.log("Added event handler for when content controls are added.");
});

...

async function contentControlAdded(event: Word.ContentControlAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.eventType} event detected. IDs of content controls that were added:`, event.ids);
  });
}

onParagraphAdded

当用户添加新段落时发生。

readonly onParagraphAdded: OfficeExtension.EventHandlers<Word.ParagraphAddedEventArgs>;

事件类型

注解

OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onadded-event.yaml

// Registers the onParagraphAdded event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphAdded.add(paragraphAdded);
  await context.sync();

  console.log("Added event handler for when paragraphs are added.");
});

...

async function paragraphAdded(event: Word.ParagraphAddedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs that were added:`, event.uniqueLocalIds);
  });
}

onParagraphChanged

当用户更改段落时发生。

readonly onParagraphChanged: OfficeExtension.EventHandlers<Word.ParagraphChangedEventArgs>;

事件类型

注解

OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/25-paragraph/onchanged-event.yaml

// Registers the onParagraphChanged event handler on the document.
await Word.run(async (context) => {
  eventContext = context.document.onParagraphChanged.add(paragraphChanged);
  await context.sync();

  console.log("Added event handler for when content is changed in paragraphs.");
});

...

async function paragraphChanged(event: Word.ParagraphChangedEventArgs) {
  await Word.run(async (context) => {
    console.log(`${event.type} event detected. IDs of paragraphs where content was changed:`, event.uniqueLocalIds);
  });
}

onParagraphDeleted

当用户删除段落时发生。

readonly onParagraphDeleted: OfficeExtension.EventHandlers<Word.ParagraphDeletedEventArgs>;

事件类型

注解