Word.Document class

获取活动主题和格式选项的名称。

readonly activeTheme: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly activeThemeDisplayName: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档的活动窗口。

readonly activeWindow: 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);
  }
});

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

readonly areFilePropertiesPasswordEncrypted: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

areGrammaticalErrorsShown: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

areMathDefaultsUsed: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

areNewerFeaturesDisabled: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

areSpellingErrorsShown: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

areStylesUpdatedOnOpen: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

areTrueTypeFontsEmbedded: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

attachedTemplate: Word.Template;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

autoHyphenation: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

autoSaveOn: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

获取一个 Shape 对象，该对象表示文档的背景图像。

readonly background: Word.Shape;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 Bibliography 对象，该对象表示文档中包含的书目引用。

readonly bibliography: Word.Bibliography;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

readonly body: Word.Body;

属性值

注解

[ API 集：WordApi 1.1 ]

返回一个 BookmarkCollection 对象，该对象代表文档中的所有书签。

readonly bookmarks: Word.BookmarkCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly builtInDocumentProperties: Word.DocumentProperties;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定 ChangeTracking 模式。

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

属性值

注解

[ API 集：WordApi 1.4 ]

示例

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

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

readonly characters: Word.RangeScopedCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly coauthoring: Word.Coauthoring;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档的代码名称。

readonly codeName: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly comments: Word.CommentCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

consecutiveHyphensLimit: number;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

readonly content: Word.Range;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly contentControls: Word.ContentControlCollection;

属性值

注解

[ API 集：WordApi 1.1 ]

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

context: RequestContext;

属性值

获取一个随机数，Word分配给文档中的更改。

readonly currentRsid: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly customDocumentProperties: Word.DocumentProperties;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly customXmlParts: Word.CustomXmlPartCollection;

属性值

注解

[ API 集：WordApi 1.4 ]

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

defaultTabStop: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

defaultTargetFrame: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly documentLibraryVersions: Word.DocumentLibraryVersionCollection;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

doNotEmbedSystemFonts: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

encryptionProvider: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定换行控制级别。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly fields: Word.FieldCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

formattingIsNextLevelShown: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

formattingIsUserStyleNameShown: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 FrameCollection 对象，该对象表示文档中的所有框架。

readonly frames: Word.FrameCollection;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

readonly fullName: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly grammaticalErrors: Word.RangeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

gridDistanceHorizontal: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

gridDistanceVertical: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

gridIsOriginFromMargin: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

gridOriginHorizontal: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

gridOriginVertical: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定打印布局视图中水平字符网格线的间隔。

gridSpaceBetweenHorizontalLines: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

gridSpaceBetweenVerticalLines: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly hasPassword: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly hasVbProject: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 HyperlinkCollection 对象，该对象代表文档中的所有超链接。

readonly hyperlinks: Word.HyperlinkCollection;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

指定是否可以对所有大写字母中的单词进行断字符。

hyphenateCaps: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

hyphenationZone: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 IndexCollection 对象，该对象代表文档中的所有索引。

readonly indexes: Word.IndexCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isAutoFormatOverrideOn: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isChartDataPointTracked: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isCompatible: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isFinal: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isFontsSubsetSaved: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isFormsDataPrinted: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isFormsDataSaved: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isGrammarChecked: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly isInAutoSave: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly isInFormsDesign: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否Word kerns 半角拉丁字符和标点符号。

isKerningByAlgorithm: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isLinguisticDataEmbedded: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly isMasterDocument: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isOptimizedForWord97: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定在使用 PostScript 打印机时，是否在文本和图形顶部打印 PRINT 字段 指令 (（如文档中) PostScript 命令）。

isPostScriptPrintedOverText: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isQuickStyleSetLocked: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly isReadOnly: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定Microsoft Word是否在用户打开文档时显示消息框，并建议将其以只读形式打开。

isReadOnlyRecommended: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isSnappedToGrid: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isSnappedToShapes: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是否已在整个文档中检查拼写。

isSpellingChecked: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isStyleEnforced: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly isSubdocument: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定用户是否可以更改文档主题。

isThemeLocked: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

isUserControl: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取 VBA 项目是否经过数字签名。

readonly isVbaSigned: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档是否使用写入密码进行保护。

readonly isWriteReserved: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定字符间距调整。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

languageDetected: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

readonly listParagraphs: Word.ParagraphCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取一个 ListCollection 对象，该对象包含文档中所有带格式的列表。

readonly lists: Word.ListCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 ListTemplateCollection 对象，该对象代表文档中的所有列表模板。

readonly listTemplates: Word.ListTemplateCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定Word之后不会中断行的 kinsoku 字符。

noLineBreakAfter: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定在Word之前不会中断行的 kinsoku 字符。

noLineBreakBefore: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

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";

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly originalDocumentTitle: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly pageSetup: Word.PageSetup;

属性值

注解

[ API 集：WordApiDesktop 1.3 ]

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

readonly paragraphs: Word.ParagraphCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

password: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly passwordEncryptionAlgorithm: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly passwordEncryptionKeyLength: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly passwordEncryptionProvider: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly path: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

printRevisions: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档的属性。

readonly properties: 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));
});

获取文档的保护类型。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly readabilityStatistics: Word.ReadabilityStatisticCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readingLayoutSizeX: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readingLayoutSizeY: number;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readingModeIsLayoutFrozen: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

removePersonalInformationOnSave: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly revisedDocumentTitle: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取表示文档中修订修订的集合。

readonly revisions: Word.RevisionCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly saved: boolean;

属性值

注解

[ API 集：WordApi 1.1 ]

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

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";

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取文档的文件格式。

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";

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly sections: Word.SectionCollection;

属性值

注解

[ API 集：WordApi 1.1 ]

返回一个 Selection 对象，该对象代表文档中的当前选定内容。

readonly selection: Word.Selection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly sentences: Word.RangeScopedCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly settings: Word.SettingCollection;

属性值

注解

[ API 集：WordApi 1.4 ]

示例

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

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

readonly spellingErrors: Word.RangeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取一个 RangeCollection 对象，该对象表示文档中的所有情景。

readonly storyRanges: Word.RangeCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

StyleCollection获取文档的 。

readonly styles: Word.StyleCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 TableOfAuthoritiesCategoryCollection 对象，该对象表示文档中可用的引文目录类别。

readonly tableOfAuthoritiesCategories: Word.TableOfAuthoritiesCategoryCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

获取一个 TableCollection 对象，该对象表示文档中的所有表。

readonly tables: Word.TableCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 TableOfAuthoritiesCollection 对象，该对象代表文档中的所有引文表。

readonly tablesOfAuthorities: Word.TableOfAuthoritiesCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 TableOfContentsCollection 对象，该对象代表文档中的所有目录。

readonly tablesOfContents: Word.TableOfContentsCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 TableOfFiguresCollection 对象，该对象代表文档中的所有图表表。

readonly tablesOfFigures: Word.TableOfFiguresCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定保存为编码文本的编码。

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";

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定Word在文本文件中标记换行符和段落分隔符的方式。

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定是删除还是存储修订的日期和时间元数据。

trackedChangesAreDateAndTimeRemoved: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

trackFormatting: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

指定在“修订”处于打开状态时是否标记移动的文本。

trackMoves: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

trackRevisions: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly webSettings: Word.WebSettings;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

readonly windows: 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}`);
});

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

readonly words: Word.RangeScopedCollection;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

writePassword: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

xmlAreAdvancedErrorsShown: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

xmlIsXsltUsedWhenSaving: boolean;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

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

xmlSaveThroughXslt: string;

属性值

注解

[ API 集：WordApiDesktop 1.4 ]

接受文档中的所有修订。

acceptAllRevisions(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

acceptAllRevisionsShown(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

activate(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi 1.5 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/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: string, type: "Character" | "List" | "Paragraph" | "Table"): Word.Style;

参数

返回

注解

[ API 集：WordApi 1.5 ]

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

addToFavorites(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

applyQuickStyleSet(style: Word.ApplyQuickStyleSet): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

applyTheme(name: string): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

自动设置文档的格式。

autoFormat(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

true如果Microsoft Word可以在文档中检查到服务器，则返回 。

canCheckin(): OfficeExtension.ClientResult<boolean>;

返回

true 如果文档可以签入，则为 ;否则为 false。

注解

[ API 集：WordApiDesktop 1.4 ]

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

checkConsistencyJapanese(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

开始文档的拼写和语法检查。

checkGrammar(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

将文档从本地计算机签入到服务器，并将本地文档设置为只读，以便无法在本地编辑文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

将文档从本地计算机保存到服务器，并将本地文档设置为只读，以便无法在本地编辑。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

开始文档的拼写检查。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

关闭当前文档。

注意：Web 上的Word不支持此 API。

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

参数

返回

注解

[ API 集：WordApi 1.5 ]

示例

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

关闭当前文档。

注意：Web 上的Word不支持此 API。

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

参数

返回

注解

[ API 集：WordApi 1.5 ]

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

closePrintPreview(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

compare(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: string, documentCompareOptions?: Word.DocumentCompareOptions): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.2 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

convert(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

convertAutoHyphens(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

convertVietnameseDocument(codePageOrigin: number): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

copyStylesFromTemplate(StyleTemplate: string): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

编号项的计数。

注解

[ API 集：WordApi BETA (仅预览版) ]

删除文档中的所有注释。

deleteAllComments(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

deleteAllCommentsShown(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

deleteAllInkAnnotations(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

deleteBookmark(name: string): void;

参数

返回

注解

[ API 集：WordApi 1.4 ]

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

detectLanguage(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

以 PDF 或 XPS 格式保存文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

以 PDF 或 XPS 格式保存文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

以 PDF 或 XPS 格式保存文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

以 PDF 或 XPS 格式保存文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

使用改进的标记以 PDF 或 XPS 格式保存文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

使用改进的标记以 PDF 或 XPS 格式保存文档。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

减小文本的字号，使文档页数减少一个。

fitToPages(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

freezeLayout(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

getAnnotationById(id: string): Word.Annotation;

参数

返回

注解

[ API 集：WordApi 1.7 ]

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

getBookmarkRange(name: string): Word.Range;

参数

返回

注解

[ API 集：WordApi 1.4 ]

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

getBookmarkRangeOrNullObject(name: string): Word.Range;

参数

返回

注解

[ API 集：WordApi 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi 1.5 ]

重要说明：如果在 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: Word.ReferenceType): OfficeExtension.ClientResult<string[]>;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

getEndnoteBody(): Word.Body;

返回

注解

[ API 集：WordApi 1.5 ]

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

getFootnoteBody(): Word.Body;

返回

注解

[ API 集：WordApi 1.5 ]

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

getParagraphByUniqueLocalId(id: string): Word.Paragraph;

参数

返回

注解

[ API 集：WordApi 1.6 ]

示例

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

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

getSelection(): Word.Range;

返回

注解

[ API 集：WordApi 1.1 ]

示例

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

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

getStyles(): Word.StyleCollection;

返回

注解

[ API 集：WordApi 1.5 ]

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/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}`);
});

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

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

参数

返回

注解

[ API 集：WordApi 1.6 ]

注意：参数 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);
});

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

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

参数

返回

注解

[ API 集：WordApi 1.6 ]

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

使用其他属性将文档插入到目标文档中的特定位置。 默认情况下会复制页眉、页脚、水印和其他节属性。

insertFileFromBase64(base64File: string, insertLocation: Word.InsertLocation.replace | Word.InsertLocation.start | Word.InsertLocation.end | "Replace" | "Start" | "End", insertFileOptions?: Word.InsertFileOptions): Word.SectionCollection;

参数

返回

注解

[ API 集：WordApi 1.5 ]

如果要插入的文档在窗体字段中) 中包含 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();
});

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

load(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.');
    }
});

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

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

参数

返回

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

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

参数

返回

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

lockServerFile(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

设置兼容性选项。

makeCompatibilityDefault(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

manualHyphenation(): void;

返回

注解

[ API 集：WordApiDesktop 1.3 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

post(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

打开 PowerPoint 并加载Word文档。

presentIt(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

打印文档的全部或部分内容。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

将视图切换到打印预览。

printPreview(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

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

参数

返回

true 如果成功重做作，则为 ;否则为 false。

注解

[ API 集：WordApiDesktop 1.4 ]

拒绝文档中的所有修订。

rejectAllRevisions(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

rejectAllRevisionsShown(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

reload(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

reloadAs(encoding: Word.DocumentEncoding): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

使用文档编码基于 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;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

removeDocumentInformation(removeDocInfoType: Word.RemoveDocInfoType): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

removeLockedStyles(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

removeTheme(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

对整篇文档重新分页。

repaginate(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

resetFormFields(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

returnToLastReadPosition(): OfficeExtension.ClientResult<number>;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

runAutoMacro(autoMacro: Word.AutoMacro): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

保存文档。

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

参数

返回

注解

[ API 集：WordApi 1.1 ]

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

示例

// 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 the document save state (on the saved property).
    thisDocument.load('saved');    
    
    // Synchronize the document state by executing the queued commands, 
    // and return a promise to indicate task completion.
    await context.sync();
        
    if (thisDocument.saved === false) {
        // Queue a command to save this document.
        thisDocument.save();
        
        // Synchronize the document state by executing the queued commands, 
        // and return a promise to indicate task completion.
        await context.sync();
        console.log('Saved the document');
    } else {
        console.log('The document has not changed since the last save.');
    }
});

// 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?: "Save" | "Prompt", fileName?: string): void;

参数

返回

注解

[ API 集：WordApi 1.1 ]

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

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

saveAsQuickStyleSet(fileName: string): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi 1.7 ]

选择文档的内容。

select(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

selectContentControlsByTag(tag: string): Word.ContentControlCollection;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

selectContentControlsByTitle(title: string): Word.ContentControlCollection;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

返回一个 XmlNodeCollection 对象，该对象代表与 XPath 参数匹配的所有节点，这些节点在文档中的出现顺序。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

将文档作为传真发送，无需任何用户交互。

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

在电子邮件中发送文档，供指定收件人审阅。

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

参数

返回

注解

[ API 集：WordApi BETA (仅预览版) ]

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

sendMail(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

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

set(properties: Word.Document): void;

参数

返回

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

toggleFormsDesign(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

toJSON(): Word.Interfaces.DocumentData;

返回

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

track(): Word.Document;

返回

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

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

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

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

参数

返回

true 如果已成功撤消作，则为 ;否则为 false。

注解

[ API 集：WordApiDesktop 1.4 ]

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

undoClear(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

从文档中删除保护。

unprotect(password?: string): void;

参数

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

untrack(): Word.Document;

返回

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

updateStyles(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

viewCode(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

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

viewPropertyBrowser(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

显示当前文档的预览，如果保存为网页，则显示该文档的外观。

webPagePreview(): void;

返回

注解

[ API 集：WordApiDesktop 1.4 ]

当用户单击批注 (或使用 Alt+Down) 进行选择时发生。

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

事件类型

注解

[ API 集：WordApi 1.7 ]

示例

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

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

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

事件类型

注解

[ API 集：WordApi 1.7 ]

示例

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

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

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

事件类型

注解

[ API 集：WordApi 1.7 ]

示例

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

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

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

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

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

事件类型

注解

[ API 集：WordApi 1.7 ]

示例

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

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

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

事件类型

注解

[ API 集：WordApi 1.5 ]

示例

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

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

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

事件类型

注解

[ API 集：WordApi 1.6 ]

示例

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

当用户更改段落时发生。

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

事件类型

注解

[ API 集：WordApi 1.6 ]

示例

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

当用户删除段落时发生。

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

事件类型

注解

[ API 集：WordApi 1.6 ]

示例

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

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

  console.log("Added event handlers for when paragraphs are deleted.");
});

...

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