通过

Word JavaScript API 仅限桌面的要求集 1.3

要求WordApiDesktop集是一个特殊要求集，包括仅在 Windows 和 Mac 上可用于Word的功能。 此要求集中的 API 被视为 Windows 和 Mac 上的 Word 应用程序的生产 API。 它们遵循 Microsoft 365 开发人员支持策略。 WordApiDesktop API 被视为其他平台的“预览”API， (例如 Web) ，并且可能不受其中任何平台的支持。

当所有平台都支持要求集中的 WordApiDesktop API 时，它们将添加到下一个发布的要求集 (WordApi 1.[NEXT]) 。 新要求集公开后，这些 API 将继续在此 WordApiDesktop 要求集中标记。 若要了解有关平台特定要求的详细信息，请参阅 了解特定于平台的要求集。

重要

WordApiDesktop 1.3 是仅限桌面的要求集。 它是 WordApiDesktop 1.2 的超集。

WordApiDesktop 1.3由于只有 Windows 和 Mac 上的 Word支持 API，因此，如果在调用这些 API 之前支持要求集，则外接程序应检查。 这可避免在不支持的平台上尝试使用仅限桌面的 API。

if (Office.context.requirements.isSetSupported("WordApiDesktop", "1.3")) {
   // Any API exclusive to this WordApiDesktop requirement set.
}

API 进入跨平台要求集后，应删除或编辑isSetSupported检查。 这将在其他平台上启用加载项的功能。 进行此更改时，请务必在这些平台上测试该功能。

重要

清单不能指定 WordApiDesktop 1.3 为激活要求。 它不是 在 Set 元素中使用的有效值。

API 列表

下表列出了要求集中当前包含WordApiDesktop 1.3Word JavaScript API。 有关所有Word JavaScript API 的完整列表， (包括 WordApiDesktop 1.3 API 和以前发布的 API) ，请参阅所有Word JavaScript API。

类 域 说明
Application 书目 返回一个 Bibliography 对象，该对象表示存储在 Microsoft Word 中的书目引用源。
checkLanguage 指定Microsoft Word是否自动检测键入时使用的语言。
language 获取一个LanguageId值，该值表示为Microsoft Word用户界面选择的语言。
模板 返回一个 TemplateCollection 对象，该对象代表所有可用的模板：全局模板和附加到打开文档的模板。
Bibliography bibliographyStyle 指定要用于书目的活动样式的名称。
generateUniqueTag () 为书目源生成唯一的标识标记，并返回表示该标记的字符串。
来源 返回一个 SourceCollection 对象，该对象表示书目中包含的所有源。
BorderUniversal artStyle 指定文档的图形页面边框设计。
artWidth 指定属性中指定的 artStyle 图形页面边框 () 宽度（以磅为单位）。
color 指定对象的颜色 BorderUniversal 。
colorIndex 指定 或 Word的颜色BorderUniversal。Font 对象。
里面 true如果内部边框可以应用于指定的 对象，则返回 。
isVisible 指定边框是否可见。
lineStyle 指定边框的线条样式。
lineWidth 指定对象的边框的线条宽度。
BorderUniversalCollection applyPageBordersToAllSections () 将指定的页边框格式应用于文档中的所有节。
items 获取此集合中已加载的子项。
中断 pageIndex 返回发生中断的页码。
range 返回一个 Range 对象，该对象表示中断中包含的文档部分。
BreakCollection items 获取此集合中已加载的子项。
BuildingBlock 类别 返回一个 BuildingBlockCategory 对象，该对象代表构建基块的类别。
delete() 删除构建基块。
description 指定构建基块的说明。
id 返回构建基块的内部标识号。
index 返回此构建基块在集合中的位置。
插入 (范围：Word。Range，richText：布尔) 将构建基块的值插入到文档中，并返回一个 Range 对象，该对象代表文档中构建基块的内容。
insertType 指定一个 DocPartInsertType 值，该值表示如何将构建基块的内容插入文档中。
名称 指定生成块的名称。
type 返回一个 BuildingBlockTypeItem 对象，该对象表示构建基块的类型。
value 指定构建基块的内容。
BuildingBlockCategory buildingBlocks 返回一个 BuildingBlockCollection 对象，该对象表示类别的构建基块。
index 返回对象在集合中的位置 BuildingBlockCategory 。
名称 返回对象的名称 BuildingBlockCategory 。
type 返回一个 BuildingBlockTypeItem 对象，该对象表示构建基块类别的构建基块的类型。
BuildingBlockCategoryCollection getCount() 返回集合中的项数。
getItemAt(index: number) 返回一个 BuildingBlockCategory 对象，该对象代表集合中的指定项。
BuildingBlockCollection add (name： string， range： Word。Range， description： string， insertType： Word。DocPartInsertType) 创建新的构建基块并返回 对象 BuildingBlock 。
getCount() 返回集合中的项数。
getItemAt(index: number) 返回一个 BuildingBlock 对象，该对象代表集合中的指定项。
BuildingBlockEntryCollection add (name： string， type： Word。BuildingBlockType，类别：字符串，范围：Word。Range， description： string， insertType： Word。DocPartInsertType) 在模板中创建新的构建基块条目，并返回表示 BuildingBlock 新构建基块条目的 对象。
getCount() 返回集合中的项数。
getItemAt(index: number) 返回一个 BuildingBlock 对象，该对象代表集合中的指定项。
BuildingBlockGalleryContentControl 外观 指定内容控件的外观。
buildingBlockCategory 指定构建基块内容控件的类别。
buildingBlockType 指定一个 BuildingBlockType 值，该值表示构建基块内容控件的构建基块的类型。
color 指定内容控件颜色的红-绿-蓝 (RGB) 值。
复制 () 将活动文档中的内容控件复制到剪贴板。
剪切 () 从活动文档中删除内容控件并将该内容控件移动到剪贴板中。
delete (deleteContents？： 布尔) 删除内容控件及其内容（可选）。
id 获取内容控件的标识。
isTemporary 指定当用户编辑控件的内容时是否从活动文档中删除内容控件。
level 获取内容控件的级别 - 内容控件是包围文本、段落、表格单元格还是表行;或内联时。
lockContentControl 指定内容控件是否锁定 (无法) 删除。
lockContents 指定内容控件的内容是否锁定 (不可编辑) 。
placeholderText 返回一个 BuildingBlock 对象，该对象代表内容控件的占位符文本。
range 返回一个 Range 对象，该对象表示活动文档中的内容控件的内容。
setPlaceholderText (选项？：Word。ContentControlPlaceholderOptions) 设置在用户输入自己的文本之前显示在内容控件中的占位符文本。
显示PlaceholderText 获取是否正在显示内容控件的占位符文本。
标记 指定用于标识内容控件的标记。
title 指定内容控件的标题。
xmlMapping 返回一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。
BuildingBlockTypeItem 类别 返回一个 BuildingBlockCategoryCollection 对象，该对象代表构建基块类型的类别。
index 返回项在集合中的位置。
名称 返回构建基块类型的本地化名称。
BuildingBlockTypeItemCollection getByType (类型：Word。BuildingBlockType) BuildingBlockTypeItem按对象在集合中的类型获取对象。
getCount() 返回集合中的项数。
ColorFormat 亮度 指定指定形状颜色的亮度。
objectThemeColor 指定颜色格式的主题颜色。
rgb 指定指定颜色的红-绿-蓝 (RGB) 值。
tintAndShade 指定指定形状颜色的变亮或变暗。
type 返回形状颜色类型。
ContentControl buildingBlockGalleryContentControl 如果内容控件Word，则获取与构建基块库相关的数据。ContentControlType 为 buildingBlockGallery。
datePickerContentControl 如果内容控件的Word，则获取与日期选取器相关的数据。ContentControlType 为 datePicker。
groupContentControl 如果内容控件的Word，则获取与组相关的数据。ContentControlType 为 group。
pictureContentControl 如果内容控件的Word，则获取与图片相关的数据。ContentControlType 为 picture。
repeatingSectionContentControl 如果内容控件的Word，则获取与重复节相关的数据。ContentControlType 为 repeatingSection。
xmlMapping 返回一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。
ContentControlPlaceholderOptions buildingBlock 如果提供，则 BuildingBlock 指定要用作占位符的对象。
range 如果提供，则 Range 指定要用作占位符的对象。
text 如果提供，则指定要用作占位符的文本。
CustomXmlAddNodeOptions 名称 如果已提供，则指定要添加的元素的基名称。
namespaceUri 如果提供，则指定要追加的元素的命名空间。
nextSibling 如果提供，则指定应成为新节点的下一个同级节点的节点。
nodeType 如果提供，则指定要添加的节点类型。
nodeValue 如果提供，则为允许文本的节点指定添加的节点的值。
CustomXmlAddSchemaOptions alias 如果提供，则指定要添加到集合的架构的别名。
fileName 如果提供，则指定架构在磁盘上的位置。
installForAllUsers 如果已提供，则指定在将架构添加到架构库的情况下，是否应将架构库密钥写入注册表 (HKEY_LOCAL_MACHINE 所有用户或 HKEY_CURRENT_USER 仅针对当前用户) 。
namespaceUri 如果提供，则指定要添加到集合的架构的命名空间。
CustomXmlAppendChildNodeOptions 名称 如果提供，则指定要追加的元素的基名称。
namespaceUri 如果提供，则指定要追加的元素的命名空间。
nodeType 如果已提供，则指定要追加的节点类型。
nodeValue 如果提供，则为允许文本的节点指定追加节点的值。
CustomXmlInsertNodeBeforeOptions 名称 如果提供，则指定要插入的元素的基名称。
namespaceUri 如果提供，则指定要插入的元素的命名空间。
nextSibling 如果提供，则指定上下文节点。
nodeType 如果已提供，则指定要追加的节点类型。
nodeValue 如果提供，则为允许文本的节点指定插入节点的值。
CustomXmlInsertSubtreeBeforeOptions nextSibling 如果提供，则指定上下文节点。
CustomXmlNode appendChildNode (选项？：Word。CustomXmlAppendChildNodeOptions) 将单个节点作为树中上下文元素节点下的最后一个子节点追加。
appendChildSubtree (xml： string) 将子树作为树中上下文元素节点下的最后一个子节点添加。
attributes 获取一个 CustomXmlNodeCollection 对象，该对象表示当前节点中当前元素的特性。
baseName 获取不带命名空间前缀的节点的基名称（如有）。
childNodes 获取包含 CustomXmlNodeCollection 当前节点的所有子元素的 对象。
delete() 从树中删除当前节点（包括其所有子项，如果有）。
firstChild 获取与当前节点的第一个 CustomXmlNode 子元素对应的 对象。
hasChildNodes () 指定当前元素节点是否具有子元素节点。
insertNodeBefore (选项？：Word。CustomXmlInsertNodeBeforeOptions) 在树中的上下文节点前面插入新节点。
insertSubtreeBefore (xml： string， options？： Word。CustomXmlInsertSubtreeBeforeOptions) 将指定的子树插入上下文节点正前的位置。
lastChild 获取与当前节点的最后一个 CustomXmlNode 子元素对应的 对象。
namespaceUri 获取节点命名空间的唯一地址标识符。
nextSibling 获取当前节点的下一个同级节点（元素、注释或处理指令）。
nodeType 获取当前节点的类型。
nodeValue 指定当前节点的值。
ownerPart 获取代表与此节点关联的部件的对象。
parentNode 获取当前节点的父元素节点。
previousSibling 获取当前节点的前一个同级节点（元素、注释或处理指令）。
removeChild (child： Word。CustomXmlNode) 从树中删除指定的子节点。
replaceChildNode (oldNode：Word。CustomXmlNode，选项？：Word。CustomXmlReplaceChildNodeOptions) 删除指定的子节点，并将其替换为同一位置中的其他节点。
replaceChildSubtree (xml： string， oldNode： Word。CustomXmlNode) 删除指定的节点，并将其替换为同一位置中的不同子树。
selectNodes (xPath：string) 选择与 XPath 表达式匹配的节点的集合。
selectSingleNode (xPath：string) 从与 XPath 表达式匹配的集合中选择一个节点。
text 指定当前节点的文本。
xml 获取当前节点及其子节点的 XML 表示形式。
xpath 获取包含当前节点的规范化 XPath 的字符串。
CustomXmlNodeCollection getCount() 返回集合中的项数。
items 获取此集合中已加载的子项。
CustomXmlPart addNode (父级：Word。CustomXmlNode，选项？：Word。CustomXmlAddNodeOptions) 将节点添加到 XML 树。
内置 获取一个值，该值指示 是否 CustomXmlPart 为内置。
documentElement 获取文档中数据绑定区域的根元素。
loadXml (xml：字符串) CustomXmlPart从 XML 字符串填充 对象。
namespaceManager 获取针对当前 CustomXmlPart 对象使用的命名空间前缀映射集。
schemaCollection 指定一个 CustomXmlSchemaCollection 对象，该对象表示附加到文档中绑定数据区域的架构集。
selectNodes (xPath：string) 从自定义 XML 部件中选择节点的集合。
selectSingleNode (xPath：string) 选择自定义 XML 部件内与 XPath 表达式匹配的单个节点。
xml 获取当前 CustomXmlPart 对象的 XML 表示形式。
CustomXmlPrefixMapping namespaceUri 获取 对象的命名空间的唯一 CustomXmlPrefixMapping 地址标识符。
prefix 获取 对象的前缀 CustomXmlPrefixMapping 。
CustomXmlPrefixMappingCollection addNamespace (prefix： string， namespaceUri： string) 添加查询项时要使用的自定义命名空间/前缀映射。
getCount() 返回集合中的项数。
items 获取此集合中已加载的子项。
lookupNamespace (前缀：string) 获取与指定前缀对应的命名空间。
lookupPrefix (namespaceUri： string) 获取与指定命名空间对应的前缀。
CustomXmlReplaceChildNodeOptions 名称 如果提供，则指定替换元素的基名称。
namespaceUri 如果提供，则指定替换元素的命名空间。
nodeType 如果提供，则指定替换节点的类型。
nodeValue 如果提供，则为允许文本的节点指定替换节点的值。
CustomXmlSchema delete() 从Word中删除此架构。CustomXmlSchemaCollection 对象。
location 获取架构在计算机上的位置。
namespaceUri 获取 对象的命名空间的唯一 CustomXmlSchema 地址标识符。
重载 () 从文件重新加载架构。
CustomXmlSchemaCollection 添加 (选项？：Word。CustomXmlAddSchemaOptions) 将一个或多个架构添加到架构集合，然后将其添加到数据存储中的流和架构库中。
addCollection (schemaCollection：Word。CustomXmlSchemaCollection) 将现有的架构集合添加到当前架构集合。
getCount() 返回集合中的项数。
getItem(index: number) 返回一个 CustomXmlSchema 对象，该对象代表集合中的指定项。
getNamespaceUri () 返回集合中的项数。
items 获取此集合中已加载的子项。
验证 () 指定架构集合中的架构是否有效 (符合 XML 的语法规则和指定词汇) 的规则。
DatePickerContentControl 外观 指定内容控件的外观。
color 指定内容控件颜色的红-绿-蓝 (RGB) 值。
复制 () 将活动文档中的内容控件复制到剪贴板。
剪切 () 从活动文档中删除内容控件并将该内容控件移动到剪贴板中。
dateCalendarType 指定一个 CalendarType 值，该值表示日期选取器内容控件的日历类型。
dateDisplayFormat 指定显示日期的格式。
dateDisplayLocale 指定表示 LanguageId 日期选取器内容控件中显示的日期的语言格式的 。
dateStorageFormat 指定一个 ContentControlDateStorageFormat 值，该值表示在日期选取器内容控件绑定到活动文档的 XML 数据存储时用于存储和检索日期的格式。
delete (deleteContents？： 布尔) 删除此内容控件和内容控件的内容。
id 获取内容控件的标识。
isTemporary 指定当用户编辑控件的内容时是否从活动文档中删除内容控件。
level 指定内容控件的级别 - 内容控件是围绕文本、段落、表单元格还是表行;或内联时。
lockContentControl 指定内容控件是否锁定 (无法) 删除。
lockContents 指定内容控件的内容是否锁定 (不可编辑) 。
placeholderText 返回一个 BuildingBlock 对象，该对象代表内容控件的占位符文本。
range 获取一个 Range 对象，该对象表示活动文档中的内容控件的内容。
setPlaceholderText (选项？：Word。ContentControlPlaceholderOptions) 设置在用户输入自己的文本之前显示在内容控件中的占位符文本。
显示PlaceholderText 获取是否显示内容控件的占位符文本。
标记 指定用于标识内容控件的标记。
title 指定内容控件的标题。
xmlMapping 获取一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。
"文档" attachedTemplate 指定一个 Template 对象，该对象表示附加到文档的模板。
autoHyphenation 指定是否为文档启用自动断字。
autoSaveOn 指定是否自动保存文档中的编辑内容。
书目 返回一个 Bibliography 对象，该对象表示文档中包含的书目引用。
consecutiveHyphensLimit 指定以连字符结尾的连续行的最大数目。
detectLanguage () 分析文档文本以确定语言。
documentLibraryVersions 返回一个 DocumentLibraryVersionCollection 对象，该对象表示已启用版本控制且存储在服务器上的文档库中的共享文档的版本集合。
框架 返回一个 FrameCollection 对象，该对象表示文档中的所有框架。
超链接 返回一个 HyperlinkCollection 对象，该对象代表文档中的所有超链接。
hyphenateCaps 指定是否可以对所有大写字母中的单词进行断字符。
languageDetected 指定Microsoft Word是否检测到文档文本的语言。
manualHyphenation () 启动文档的手动断字设置，每次一行。
pageSetup 返回与 PageSetup 文档关联的 对象。
DocumentLibraryVersion comments 获取与此版本的共享文档关联的任何可选注释。
改 性 获取此版本的共享文档上次保存到服务器的日期和时间。
modifiedBy 获取上次将此版本的共享文档保存到服务器的用户的名称。
DocumentLibraryVersionCollection getItem(index: number) DocumentLibraryVersion按对象在集合中的索引获取对象。
isVersioningEnabled () 返回每次在网站上编辑文件时，是否将服务器上保存活动文档的文档库配置为创建备份副本或版本。
items 获取此集合中已加载的子项。
FillFormat backgroundColor 返回一个 ColorFormat 对象，该对象代表填充的背景色。
foregroundColor 返回一个 ColorFormat 对象，该对象代表填充的前景色。
gradientAngle 指定渐变填充的角度。
gradientColorType 获取渐变颜色类型。
gradientDegree 返回单色渐变填充的深色或浅色。
gradientStyle 返回填充的渐变样式。
gradientVariant 对于大多数渐变填充，以 1 到 4 的整数值的形式返回填充的渐变变体。
isVisible 指定对象或应用于该对象的格式是否可见。
pattern 返回一个 PatternType 值，该值代表应用于填充或线条的图案。
presetGradientType 返回填充的预设渐变类型。
presetTexture 获取预设纹理。
rotateWithObject 指定填充是否随形状一起旋转。
setOneColorGradient (样式：Word。GradientStyle， variant： number， degree： number) 将填充设置为单色渐变。
setPatterned (模式：Word。PatternType) 将填充设置为图案。
setPresetGradient (样式：Word。GradientStyle，variant： number，presetGradientType： Word。PresetGradientType) 将填充设置为预设渐变。
setPresetTextured (presetTexture： Word。PresetTexture) 将填充设置为预设纹理。
setTwoColorGradient (样式：Word。GradientStyle，variant：number) 将填充设置为双色渐变。
实心 () 将填充设置为统一颜色。
textureAlignment 指定用于平铺纹理填充的对齐方式（坐标网格的原点）。
textureHorizontalScale 指定纹理填充的水平缩放因子。
textureName 返回填充的自定义纹理文件的名称。
textureOffsetX 指定纹理与原点的水平偏移量（以磅为单位）。
textureOffsetY 指定纹理的垂直偏移量。
textureTile 指定纹理是否平铺。
textureType 返回填充的纹理类型。
textureVerticalScale 将纹理填充的垂直缩放因子指定为介于 0.0 和 1.0 之间的值。
transparency 将形状的填充透明度指定为介于 0.0 (不透明) 和 1.0 (清除) 之间的值。
type 获取填充格式类型。
Font allCaps 指定字体的格式是否设置为所有大写字母，这会使小写字母显示为大写字母。
boldBidirectional 指定字体是否在从右到左的语言文档中设置为粗体。
Borders 返回一个 BorderUniversalCollection 对象，该对象代表字体的所有边框。
colorIndex 指定一个 ColorIndex 值，该值表示字体的颜色。
colorIndexBidirectional 指定从右到左语言文档中对象的颜色 Font 。
contextualAlternates 指定是否为字体启用上下文替换。
decreaseFontSize () 将字号减小为下一个可用的字号。
diacriticColor 指定要用于对象的音调符号 Font 的颜色。
disableCharacterSpaceGrid 指定Microsoft Word是否忽略相应Font对象的每行字符数。
浮雕 指定字体的格式是否为浮雕。
emphasisMark 指定一个 EmphasisMark 值，该值代表字符或指定字符串的强调标记。
雕刻 指定字体的格式是否为刻字。
fill 返回一个 FillFormat 对象，该对象包含文本区域使用的字体的填充格式属性。
发亮 返回一个 GlowFormat 对象，该对象代表文本区域使用的字体的发光格式。
increaseFontSize () 将字号增大为下一个可用的字号。
italicBidirectional 指定字体是否在从右到左的语言文档中斜体。
字距调整 指定Microsoft Word自动调整字距的最小字号。
结扎 指定 对象的连字设置 Font 。
line 返回一个 LineFormat 对象，该对象指定行的格式。
nameAscii 指定用于拉丁文文本 (字符的字体，其字符代码从 0 (零) 到 127) 。
nameBidirectional 指定从右到左语言文档中的字体名称。
nameFarEast 指定东亚字体名称。
nameOther 指定用于代码介于 128 到 255 的字符的字体。
numberForm 指定 OpenType 字体的数字形式设置。
numberSpacing 指定字体的数字间距设置。
大纲 指定字体的格式是否为大纲格式。
position 指定文本 (相对于底线) 磅的位置。
反射 返回一个 ReflectionFormat 对象，该对象代表形状的反射格式。
重置 () 删除手动字符格式。
缩放 指定应用于字体的缩放百分比。
setAsTemplateDefault () 将指定的字体格式设置为活动文档和所有基于活动模板创建的新文档的默认格式。
影子 指定字体的格式是否为阴影。
sizeBidirectional 指定从右到左的文本的字号（以磅为单位）。
smallCaps 指定字体的格式是否设置为小写字母，使小写字母显示为小写字母。
间距 指定字符之间的间距。
stylisticSet 指定字体的样式集。
textColor 返回一个 ColorFormat 对象，该对象代表字体的颜色。
textShadow 返回一个 ShadowFormat 对象，该对象指定字体的阴影格式。
threeDimensionalFormat 返回一个 ThreeDimensionalFormat 对象，该对象包含字体的三维 (三维) 效果格式属性。
underlineColor 指定对象的下划线 Font 颜色。
Frame Borders 返回一个 BorderUniversalCollection 对象，该对象表示框架的所有边框。
复制 () 将帧复制到剪贴板。
剪切 () 从文档中删除框架并将其放在剪贴板上。
delete() 删除框架。
height 指定框架的高度 () 磅。
heightRule 指定一个 FrameSizeRule 值，该值表示用于确定框架高度的规则。
horizontalDistanceFromText 指定框架与周围文本之间的水平距离（以磅为单位）。
horizontalPosition 指定框架边缘与 属性指定的 relativeHorizontalPosition 项之间的水平距离。
lockAnchor 指定帧是否锁定。
range 返回一个 Range 对象，该对象表示框架中包含的文档部分。
relativeHorizontalPosition 指定帧的相对水平位置。
relativeVerticalPosition 指定框架的相对垂直位置。
select() 选择框架。
描影法 返回一个 ShadingUniversal 对象，该对象引用框架的底纹格式。
textWrap 指定文档文本是否环绕框架。
verticalDistanceFromText 指定框架与周围文本之间的垂直距离 (以磅为单位) 。
verticalPosition 指定框架边缘与 属性指定的 relativeVerticalPosition 项之间的垂直距离。
width 指定框架的宽度 (（以磅) 为单位）。
widthRule 指定用于确定框架宽度的规则。
FrameCollection 添加 (范围：Word。范围) 返回一个 Frame 对象，该对象表示添加到区域、选定内容或文档中的新框架。
delete() FrameCollection删除 对象。
getItem(index: number) Frame按对象在集合中的索引获取对象。
items 获取此集合中已加载的子项。
GlowFormat color 返回一个 ColorFormat 对象，该对象代表发光效果的颜色。
半径 指定发光效果的半径长度。
transparency 将发光效果的透明度指定为介于 0.0 (不透明) 和 1.0 (透明) 之间的值。
GroupContentControl 外观 指定内容控件的外观。
color 指定内容控件颜色的红-绿-蓝 (RGB) 值。
复制 () 将活动文档中的内容控件复制到剪贴板。
剪切 () 从活动文档中删除内容控件并将该内容控件移动到剪贴板中。
delete (deleteContents：布尔) 删除内容控件及其内容（可选）。
id 返回内容控件的标识。
isTemporary 指定当用户编辑控件的内容时是否从活动文档中删除内容控件。
level 获取内容控件的级别 - 内容控件是包围文本、段落、表格单元格还是表行;或内联时。
lockContentControl 指定内容控件是否锁定 (无法) 删除。
lockContents 指定内容控件的内容是否锁定 (不可编辑) 。
placeholderText 返回一个 BuildingBlock 对象，该对象代表内容控件的占位符文本。
range 获取一个 Range 对象，该对象表示活动文档中的内容控件的内容。
setPlaceholderText (选项？：Word。ContentControlPlaceholderOptions) 设置在用户输入自己的文本之前显示在内容控件中的占位符文本。
显示PlaceholderText 返回是否显示内容控件的占位符文本。
标记 指定用于标识内容控件的标记。
title 指定内容控件的标题。
ungroup() 从文档中删除组内容控件，使其子内容控件不再嵌套，并且可以自由编辑。
xmlMapping 获取一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。
Hyperlink addToFavorites () 创建文档或超链接的快捷方式，并将其添加到 “收藏夹” 文件夹中。
address 指定地址 (例如，超链接的文件名或 URL) 。
createNewDocument (fileName： string， editNow： boolean， overwrite： boolean) 创建链接到超链接的新文档。
delete() 删除超链接。
emailSubject 指定超链接的主题行的文本字符串。
isExtraInfoRequired true如果解析超链接需要额外信息，则返回 。
名称 返回对象的名称 Hyperlink 。
range 返回一个 Range 对象，该对象表示超链接中包含的文档部分。
screenTip 指定当鼠标指针位于超链接上时显示为屏幕提示的文本。
subAddress 指定超链接目标中的命名位置。
target 指定要在其中加载超链接的框架或窗口的名称。
textToDisplay 指定文档中超链接的可见文本。
type 返回超链接的类型。
HyperlinkAddOptions address 如果提供，则指定 (地址，例如超链接) 的 URL 或文件路径。
screenTip 如果提供，则指定显示为工具提示的文本。
subAddress 如果提供，则指定文件或文档中的位置。
target 如果提供，则指定要在其中加载超链接的框架或窗口的名称。
textToDisplay 如果提供，则指定超链接的可见文本。
HyperlinkCollection 添加 (定位点：Word。范围、选项？：Word。HyperlinkAddOptions) 返回一个 Hyperlink 对象，该对象表示添加到区域、选定内容或文档的新超链接。
items 获取此集合中已加载的子项。
LineFormat backgroundColor 获取一个 ColorFormat 对象，该对象表示图案线条的背景色。
beginArrowheadLength 指定线条开头的箭头的长度。
beginArrowheadStyle 指定线条开头的箭头样式。
beginArrowheadWidth 指定线条开头箭头的宽度。
dashStyle 指定线条的短划线样式。
endArrowheadLength 指定线条末尾箭头的长度。
endArrowheadStyle 指定线条末尾的箭头样式。
endArrowheadWidth 指定线条末尾箭头的宽度。
foregroundColor 获取一个 ColorFormat 对象，该对象表示线条的前景色。
insetPen 指定是否在形状内绘制线条。
isVisible 指定对象或应用于该对象的格式是否可见。
pattern 指定应用于行的模式。
style 指定线条格式样式。
transparency 将行的透明度指定为介于 0.0 (不透明) 和 1.0 之间的值， (清除) 。
weight 指定线条的粗细（以磅为单位）。
LineNumbering countBy 指定行号的数字增量。
distanceFromText 指定行号右边缘与文档文本左边缘之间的距离 (以磅为单位) 。
isActive 指定行号是否对指定的文档、节或节处于活动状态。
restartMode 指定行号的运行方式;即，它是在新页面或分区的开头重新开始，还是持续运行。
startingNumber 指定起始行号。
ListFormat applyBulletDefault (defaultListBehavior： Word。DefaultListBehavior) 向区域中的段落添加项目符号和格式。
applyListTemplateWithLevel (listTemplate： Word。ListTemplate，options？：Word。ListTemplateApplyOptions) 将具有特定级别的列表模板应用于区域中的段落。
applyNumberDefault (defaultListBehavior： Word。DefaultListBehavior) 向区域中的段落添加编号和格式。
applyOutlineNumberDefault (defaultListBehavior： Word。DefaultListBehavior) 向区域中的段落添加大纲编号和格式。
canContinuePreviousList (listTemplate： Word。ListTemplate) 确定对象是否可以 ListFormat 继续上一个列表。
convertNumbersToText (numberType： Word。NumberType) 将列表中的数字转换为纯文本。
countNumberedItems (选项？：Word。ListFormatCountNumberedItemsOptions) 对列表中的编号项进行计数。
isSingleList 指示对象是否 ListFormat 包含单个列表。
isSingleListTemplate 指示对象是否 ListFormat 包含单个列表模板。
列表 返回一个 List 对象，该对象表示对象中包含的 ListFormat 第一个格式化列表。
listIndent () 将列表缩进一个级别。
listLevelNumber 指定对象的第一个段落 ListFormat 的列表级别编号。
listOutdent () 将列表缩进一个级别。
listString 获取对象区域中 ListFormat 第一个段落的列表值的字符串表示形式。
listTemplate 获取与 对象关联的 ListFormat 列表模板。
listType 获取 对象的列表 ListFormat 类型。
listValue 获取对象范围中第一段的 ListFormat 数值。
removeNumbers (numberType： Word。NumberType) 从列表中删除编号。
ListFormatCountNumberedItemsOptions level 如果提供，则指定要计数的级别。
numberType 如果提供，则指定要计数的数字类型。
ListTemplateApplyOptions applyLevel 如果提供，则指定要在列表模板中应用的级别。
applyTo 如果提供，则指定要将模板应用到列表的哪个部分。
continuePreviousList 如果已提供，则指定是否继续上一个列表。
defaultListBehavior 如果提供，则指定默认列表行为。
Page 休息 获取一个 BreakCollection 对象，该对象表示页面上的分隔符。
PageSetup bookFoldPrinting 指定Microsoft Word是否将文档打印为小册子。
bookFoldPrintingSheets 指定每个小册子的页数。
bookFoldReversePrinting 指定Microsoft Word是否反转双向或亚洲语言文档的书折打印顺序。
bottomMargin 指定页面下边缘和正文文本底部边界之间 () 磅的距离。
charsLine 指定文档网格中每行的字符数。
differentFirstPageHeaderFooter 指定第一页是否具有不同的页眉和页脚。
footerDistance 指定页脚与页面底部之间的距离（以磅为单位）。
排水沟 指定添加到文档或节中每个页面的额外页边距空间) (量（以磅为单位）。
gutterPosition 指定在文档中显示装订线的哪一侧。
gutterStyle 指定Microsoft Word基于从右到左语言还是从左到右语言对当前文档使用装订线。
headerDistance 指定页眉与页面顶部之间的距离（以磅为单位）。
layoutMode 指定当前文档的布局模式。
leftMargin 指定 () 页面左边缘与正文文本的左边界之间的距离（以磅为单位）。
lineNumbering 指定一个 LineNumbering 对象，该对象表示对象的 PageSetup 行号。
linesPage 指定文档网格中每页的行数。
mirrorMargins 指定对页的内外边距是否具有相同的宽度。
oddAndEvenPagesHeaderFooter 指定奇数页和偶数页是否具有不同的页眉和页脚。
orientation 指定页面的方向。
pageHeight 指定页面高度（以磅为单位）。
pageWidth 指定页面宽度（以磅为单位）。
paperSize 指定页面的纸张大小。
rightMargin 指定页面右边缘与正文文本右边界之间的距离 () 磅。
sectionDirection 指定指定节的读取顺序和对齐方式。
sectionStart 指定指定对象的分节符类型。
setAsTemplateDefault () 将指定的页面设置格式设为活动文档和所有基于活动模板的新文档的默认格式。
showGrid 指定是否显示网格。
suppressEndnotes 指定是否在下一节的末尾打印了不禁止显示尾注的尾注。
textColumns 获取一个 TextColumnCollection 对象，该对象表示对象的一组文本列 PageSetup 。
togglePortrait () 在文档或节的纵向和横向页面方向之间切换。
topMargin 指定页面的上边距（以磅为单位）。
twoPagesOnOne 指定是否每页打印两页。
verticalAlignment 指定文档或节中每个页面上文本的垂直对齐方式。
Paragraph Borders 返回一个 BorderUniversalCollection 对象，该对象代表段落的所有边框。
描影法 返回一个 ShadingUniversal 对象，该对象引用段落的底纹格式。
PictureContentControl 外观 指定内容控件的外观。
color 指定内容控件颜色的红-绿-蓝 (RGB) 值。
复制 () 将活动文档中的内容控件复制到剪贴板。
剪切 () 从活动文档中删除内容控件并将该内容控件移动到剪贴板中。
delete (deleteContents？： 布尔) 删除内容控件及其内容（可选）。
id 返回内容控件的标识。
isTemporary 指定当用户编辑控件的内容时是否从活动文档中删除内容控件。
level 返回内容控件的级别 - 内容控件是包围文本、段落、表格单元格还是表行;或内联时。
lockContentControl 指定内容控件是否锁定 (无法) 删除。
lockContents 指定内容控件的内容是否锁定 (不可编辑) 。
placeholderText 返回一个 BuildingBlock 对象，该对象代表内容控件的占位符文本。
range 返回一个 Range 对象，该对象表示活动文档中的内容控件的内容。
setPlaceholderText (选项？：Word。ContentControlPlaceholderOptions) 设置在用户输入自己的文本之前显示在内容控件中的占位符文本。
显示PlaceholderText 返回是否显示内容控件的占位符文本。
标记 指定用于标识内容控件的标记。
title 指定内容控件的标题。
xmlMapping 返回一个 XmlMapping 对象，该对象表示内容控件到文档数据存储中的 XML 数据的映射。
区域 detectLanguage () 分析范围文本以确定其编写语言。
框架 获取一个 FrameCollection 对象，该对象表示范围中的所有帧。
hasNoProofing 指定 (拼写和语法检查) 范围的校对状态。
超链接 返回一个 HyperlinkCollection 对象，该对象代表范围中的所有超链接。
languageDetected 指定Microsoft Word是否检测到区域中文本的语言。
languageId 指定一个 LanguageId 值，该值表示区域的语言。
languageIdFarEast 指定区域的东亚语言。
languageIdOther 指定未分类为东亚语言的范围的语言。
listFormat 返回一个 ListFormat 对象，该对象表示区域的所有列表格式特征。
sections 获取区域中节的集合。
描影法 返回一个 ShadingUniversal 对象，该对象引用区域的底纹格式。
tableColumns 获取一个 TableColumnCollection 对象，该对象表示区域中的所有表列。
ReflectionFormat 模糊 指定应用于对象的模糊效果 ReflectionFormat 程度，该值介于 0.0 和 100.0 之间。
抵消 指定反射图像与形状的分隔量（以磅为单位）。
size 将反射的大小指定为反射形状的百分比（从 0 到 100）。
transparency 将反射效果的透明度指定为介于 0.0 (不透明) 和 1.0 (清晰) 之间的值。
type 指定一个 ReflectionType 值，该值表示形状反射的照明类型和方向。
RepeatingSectionContentControl allowInsertDeleteSection 指定用户是否可以使用用户界面在此重复节内容控件中添加或删除节。
外观 指定内容控件的外观。
color 指定内容控件颜色的红-绿-蓝 (RGB) 值。
复制 () 将活动文档中的内容控件复制到剪贴板。
剪切 () 从活动文档中删除内容控件并将该内容控件移动到剪贴板中。
delete (deleteContents？： 布尔) 删除内容控件和内容控件的内容。
id 返回内容控件的标识。
isTemporary 指定当用户编辑控件的内容时是否从活动文档中删除内容控件。
level 返回内容控件的级别 - 内容控件是包围文本、段落、表格单元格还是表行;或内联时。
lockContentControl 指定内容控件是否锁定 (无法) 删除。
lockContents 指定内容控件的内容是否锁定 (不可编辑) 。
placeholderText 返回一个 BuildingBlock 对象，该对象代表内容控件的占位符文本。
range 获取一个 Range 对象，该对象表示活动文档中的内容控件的内容。
repeatingSectionItemTitle 指定与此重复节内容控件关联的上下文菜单中使用的重复节项的名称。
repeatingSectionItems 返回此重复节内容控件中的重复节项的集合。
setPlaceholderText (选项？：Word。ContentControlPlaceholderOptions) 设置在用户输入自己的文本之前显示在内容控件中的占位符文本。
显示PlaceholderText 返回是否显示内容控件的占位符文本。
标记 指定用于标识内容控件的标记。
title 指定内容控件的标题。
RepeatingSectionItem delete() 删除此 RepeatingSectionItem 对象。
insertItemAfter () 在此项后面添加重复节项，并返回新项。
insertItemBefore () 在此项之前添加重复节项，并返回新项。
range 返回此重复节项的范围，不包括开始标记和结束标记。
RepeatingSectionItemCollection getItemAt(index: number) 返回一个单独的重复节项。
Section Borders 返回一个 BorderUniversalCollection 对象，该对象代表 节中的所有边框。
pageSetup 返回与 PageSetup 节关联的 对象。
protectedForForms 指定节是否受窗体保护。
ShadingUniversal backgroundPatternColor 指定应用于对象背景 ShadingUniversal 的颜色。
backgroundPatternColorIndex 指定应用于对象背景 ShadingUniversal 的颜色。
foregroundPatternColor 指定应用于对象前景 ShadingUniversal 的颜色。
foregroundPatternColorIndex 指定应用于对象前景 ShadingUniversal 的颜色。
质地 指定对象的底纹纹理。
ShadowFormat 模糊 将阴影格式的模糊级别指定为介于 0.0 和 100.0 之间的值。
foregroundColor 返回一个 ColorFormat 对象，该对象代表填充、线条或阴影的前景色。
incrementOffsetX (increment： number) 将阴影的水平偏移量更改为磅数。
incrementOffsetY (increment： number) 按指定磅值更改阴影的垂直偏移量。
isVisible 指定对象或应用于该对象的格式是否可见。
遮蔽 指定 true 形状的阴影是否显示为填充，并且被形状遮盖，即使形状没有填充，
OffsetX 指定从形状) 阴影的水平偏移量 (磅。
OffsetY 指定垂直偏移量 (（以磅为单位）) 阴影与形状。
rotateWithShape 指定在旋转形状时是否旋转阴影。
size 指定阴影的宽度。
style 指定要应用于形状的阴影格式的类型。
transparency 将阴影的透明度指定为介于 0.0 (不透明) 和 1.0 (透明) 之间的值。
type 指定形状阴影类型。
Source delete() Source删除 对象。
getFieldByName (name： string) 返回书目 Source 对象中字段的值。
isCited 获取是否已 Source 在文档中引用对象。
标记 获取源的 标记。
xml 获取源的 XML 表示形式。
SourceCollection add (xml： string) 将新 Source 对象添加到集合。
items 获取此集合中已加载的子项。
样式 automaticallyUpdate 指定是否根据所选内容自动重新定义样式。
框架 返回一个 Frame 对象，该对象表示样式的框架格式。
hasProofing 指定拼写和语法检查器是否忽略使用此样式设置格式的文本。
languageId 指定一个 LanguageId 值，该值表示样式的语言。
languageIdFarEast 指定样式的东亚语言。
linkStyle 指定段落和字符样式之间的链接。
linkToListTemplate (listTemplate：Word。ListTemplate) 此样式链接到列表模板，以便样式的格式可以应用于列表。
listLevelNumber 返回样式的列表级别。
locked 指定是无法更改还是编辑样式。
noSpaceBetweenParagraphsOfSameStyle 指定是否删除使用相同样式设置格式的段落之间的间距。
TableColumn autoFit () 更改表格列的宽度以适应文本的宽度，而不更改单元格中文本的换行方式。
Borders 返回一个 BorderUniversalCollection 对象，该对象代表表列的所有边框。
columnIndex 返回此列在集合中的位置。
delete() 删除列。
isFirst true如果列或行是表中的第一个列或行，则返回 ;false否则返回 。
isLast true如果列或行是表中的最后一行，则返回 ;false否则返回 。
nestingLevel 返回列的嵌套级别。
preferredWidth 指定首选宽度 (（以磅为单位），或者指定列) 窗口宽度的百分比。
preferredWidthType 指定要用于表列宽度的首选度量单位。
select() 选择表列。
setWidth (columnWidth： number， rulerStyle： Word。RulerStyle) 设置表中列的宽度。
描影法 返回一个 ShadingUniversal 对象，该对象引用列的底纹格式。
排序 () 对表列进行排序。
width 指定列的宽度（以磅为单位）。
TableColumnCollection add (beforeColumn？： Word。TableColumn) 返回一个 TableColumn 对象，该对象表示添加到表中的列。
autoFit () 改变表格列宽，使之在单元格文本换行方式不变的情况下，适应文本宽度。
delete() 删除指定列。
distributWidth () 将指定列调整为等宽。
items 获取此集合中已加载的子项。
select() 选择指定表格列。
setWidth (columnWidth： number， rulerStyle： Word。RulerStyle) 设置表格列的宽度。
模板 buildingBlockEntries 返回一个 BuildingBlockEntryCollection 对象，该对象表示模板中构建基块条目的集合。
buildingBlockTypes 返回一个 BuildingBlockTypeItemCollection 对象，该对象表示模板中包含的构建基块类型的集合。
farEastLineBreakLanguage 指定在文档或模板中断行文本时使用的东亚语言。
farEastLineBreakLevel 指定文档的换行控制级别。
fullName 返回模板的名称，包括驱动器或 Web 路径。
hasNoProofing 指定拼写和语法检查器是否忽略基于此模板的文档。
justificationMode 指定模板的字符间距调整。
kerningByAlgorithm 指定文档中是否Microsoft Word半角拉丁字符和标点符号。
languageId 指定一个 LanguageId 值，该值表示模板中的语言。
languageIdFarEast 为模板中的语言指定东亚语言。
名称 仅返回文档模板的名称， (排除) 的任何路径或其他位置信息。
noLineBreakAfter 指定Microsoft Word不会中断行的 kinsoku 字符。
noLineBreakBefore 指定Microsoft Word不会中断行的 kinsoku 字符。
path 返回文档模板的路径。
save() 保存模板。
保存 指定true模板自上次保存以来是否未更改，false如果Microsoft Word在文档关闭时显示保存更改的提示。
type 返回模板的类型。
TemplateCollection getCount() 返回集合中的项数。
getItemAt(index: number) Template按对象在集合中的索引获取对象。
importBuildingBlocks () 将所有模板的构建基块导入Microsoft Word。
items 获取此集合中已加载的子项。
TextColumn spaceAfter 指定指定段落或文本列后) (磅的间距量。
width 指定指定文本列的宽度（以磅为单位）。
TextColumnAddOptions isEvenlySpaced 如果已提供，则指定是否对文档中的所有文本列进行均匀间距。
间距 如果提供，则指定文档中文本列之间的间距（以磅为单位）。
width 如果提供，则指定文档中新文本列的宽度（以磅为单位）。
TextColumnCollection 添加 (选项？：Word。TextColumnAddOptions) 返回一个 TextColumn 对象，该对象表示添加到节或文档的新文本列。
getFlowDirection () 获取文本从一个文本列流向下一个文本列的方向。
getHasLineBetween () 获取是否在 对象中的所有列 TextColumnCollection 之间显示垂直线。
getIsEvenlySpaced () 获取文本列的间距是否均匀。
items 获取此集合中已加载的子项。
setCount (numColumns： number) 将文字编排为指定数量的文本栏。
setFlowDirection (值：Word。FlowDirection) 设置文本从一个文本列流向下一个文本列的方向。
setHasLineBetween (值：布尔) 设置是否在对象中的所有列 TextColumnCollection 之间显示垂直线。
setIsEvenlySpaced (值：布尔) 设置文本列的间距是否均匀。
ThreeDimensionalFormat bevelBottomDepth 指定底部棱台的深度。
bevelBottomInset 指定底部凹凸的嵌入大小。
bevelBottomType 指定一个 BevelType 值，该值表示底部棱台的棱台类型。
bevelTopDepth 指定顶部棱台的深度。
bevelTopInset 指定顶部棱台的嵌入大小。
bevelTopType 指定一个 BevelType 值，该值表示顶部棱台的棱台类型。
contourColor 返回一个 ColorFormat 对象，该对象表示形状轮廓的颜色。
contourWidth 指定形状轮廓的宽度。
深度 指定形状延伸的深度。
extrusionColor 返回一个 ColorFormat 对象，该对象表示形状延伸的颜色。
extrusionColorType 指定延伸颜色是否基于延伸形状的填充 (延伸)
fieldOfView 指定形状的透视量。
incrementRotationHorizontal (increment： number) 水平旋转 x 轴上的形状。
incrementRotationVertical (increment： number) 垂直旋转 y 轴上的形状。
incrementRotationX (increment： number) 更改围绕 x 轴的旋转。
incrementRotationY (increment： number) 更改围绕 y 轴的旋转。
incrementRotationZ (增量：数字) 在 z 轴上旋转形状。
isPerspective 指定 true 延伸是否显示在透视中，即延伸的墙壁是否向消失点变窄，
isVisible 指定指定对象或应用于该对象的格式是否可见。
lightAngle 指定照明的角度。
presetCamera 返回一个 PresetCamera 值，该值表示相机预设。
presetExtrusionDirection 返回延伸经过的路径前导离延伸形状 (延伸的正面) 的方向。
presetLighting 指定表示 LightRigType 照明预设的值。
presetLightingDirection 指定光源相对于延伸的位置。
presetLightingSoftness 指定延伸照明的强度。
presetMaterial 指定延伸表面的材料。
presetThreeDimensionalFormat 返回预设的延伸格式。
projectText 指定形状上的文本是否随形状一起旋转。
resetRotation () 将围绕 x 轴、y 轴和 z 轴的延伸旋转重置为 0。
rotationX 指定延伸形状围绕 x 轴的旋转（以度为单位）。
rotationY 指定延伸形状围绕 y 轴旋转（以度为单位）。
rotationZ 指定相机的 Z 轴旋转。
setExtrusionDirection (presetExtrusionDirection： Word。PresetExtrusionDirection) 设置延伸的扫描路径的方向。
setPresetCamera (presetCamera：Word。PresetCamera) 设置形状的相机预设。
setThreeDimensionalFormat (presetThreeDimensionalFormat： Word。PresetThreeDimensionalFormat) 返回预设的延伸格式。
z 指定形状的 z 轴上的位置。
XmlMapping customXmlNode 返回一个 CustomXmlNode 对象，该对象表示文档中内容控件映射到的数据存储中的自定义 XML 节点。
customXmlPart 返回一个 CustomXmlPart 对象，该对象表示文档中的内容控件映射到的自定义 XML 部件。
delete() 从父内容控件中删除 XML 映射。
isMapped 返回文档中的内容控件是否映射到文档的 XML 数据存储中的 XML 节点。
prefixMappings 返回用于评估当前 XML 映射的 XPath 的前缀映射。
setMapping (xPath： string， options？： Word。XmlSetMappingOptions) 允许在内容控件上创建或更改 XML 映射。
setMappingByNode (节点：Word。CustomXmlNode) 允许在内容控件上创建或更改 XML 数据映射。
xpath 返回 XML 映射的 XPath，该映射的计算结果为当前映射的 XML 节点。
XmlSetMappingOptions prefixMapping 如果提供，则指定在查询调用方法的 参数XmlMapping.setMapping中xPath提供的表达式时要使用的前缀映射。
源 如果提供，则指定要将内容控件映射到的所需自定义 XML 数据。

另请参阅