Word.Selection class

表示 Word 文档中的选定区域或插入点。

注解

注：范围对象与 Selection 对象共享许多相同的方法和属性。 Range当没有理由物理更改当前所选内容时，使用对象更适合操作文档。

使用方

Word.文档：选择
Word.窗格：选择

示例

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

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

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

属性

borders	返回 `BorderUniversalCollection` 表示所选内容中对象的所有边框的对象。
characters	返回 `RangeScopedCollection` 表示所选内容中每个字符的对象。
comments	返回表示 `CommentCollection` 所选内容中所有注释的对象。
context	与对象关联的请求上下文。这将加载项的进程连接到 Office 主机应用程序的进程。
end	指定所选内容的结束字符位置。
fields	返回 `FieldCollection` 表示所选内容中所有字段的对象。
fitTextWidth	指定 Word 适合当前所选内容中的文本的宽度。
font	返回 `Font` 表示所选内容的字符格式的对象。
formattedText	指定在 `Range` 区域或所选内容中包含格式化文本的对象。
hasNoProofing	返回拼写和语法检查是否忽略所选文本。如果所选文本混合包含已校对和未校对的内容，则此 API 将返回 `null`。
isActive	返回指定窗口或窗格中的选择是否处于活动状态。
isColumnSelectModeActive	指定列选择模式是否处于活动状态。
isEndOfRowMark	返回所选内容是否位于表中的行尾标记处。
isExtendModeActive	指定“扩展”模式是否处于活动状态。
isInsertionPointAtEndOfLine	返回插入点是否位于行尾。
isStartActive	指定所选内容的开头是否处于活动状态。
languageDetected	指定 Word 是否检测到所选文本的语言。
languageId	返回所选语言。
languageIdFarEast	返回所选内容的东亚语言。
languageIdOther	返回未归类为东亚语言的所选语言。
orientation	指定所选内容中文本的方向。
paragraphs	返回 `ParagraphCollection` 表示所选内容中所有段落的对象。
range	返回 `Range` 所选内容中包含的文档部分的对象。
sections	返回 `SectionCollection` 所选内容中的对象。
sentences	返回 `RangeScopedCollection` 所选内容中每个句子的对象。
shading	返回 `ShadingUniversal` 所选内容的底纹格式的对象。
start	指定所选内容的起始字符位置。
storyLength	返回文章中包含所选内容的字符数。
storyType	返回所选内容的故事类型。
tables	返回 `TableCollection` 所选内容中的对象。
text	指定所选内容中的文本。
topLevelTables	返回当前选定内容中最外层嵌套级别的表。
type	返回选择类型。
words	返回 `RangeScopedCollection` 表示所选内容中每个单词的对象。

方法

calculate()	计算选区内的第一个数学表达式。
cancelMode()	取消扩展或列选择等模式。这相当于按 Esc 键。
clearCharacterStyleFormatting()	删除通过字符样式应用的字符格式。
clearFormatting()	从所选内容中删除字符和段落格式。
clearManualCharacterFormatting()	从所选文本中删除手动应用的字符格式。
clearManualParagraphFormatting()	从所选文本中删除手动应用的段落格式。
clearParagraphFormatting()	从所选文本中删除所有段落格式。
clearParagraphStyle()	删除通过段落样式应用的段落格式。
collapse(direction)	将所选内容折叠到开始或结束位置。
collapse(direction)	将所选内容折叠到开始或结束位置。
convertToTable(options)	将范围内的文本转换为表格。
copyAsPictureToClipboard()	将所选内容作为图片复制到剪贴板。
copyFormat()	复制选定文字第一个字符的字符格式。
copyToClipboard()	将所选内容复制到剪贴板。
createTextBox()	在所选内容周围添加默认大小的文本框。
cut()	从文档中删除所选内容并将其移动到剪贴板。
delete(options)	删除指定数量的字符或单词。
detectLanguage()	分析所选文本以确定其写入语言。
expand(unit)	展开所选内容。
expand(unit)	展开所选内容。
expandToWholeStory()	展开所选内容以包括整个故事。
extend(character)	打开扩展模式。如果扩展模式已经打开，则将选定内容扩展到下一个更大的文本单位。
extend(character)	打开扩展模式。如果扩展模式已经打开，则将选定内容扩展到下一个更大的文本单位。
getNextRange(options)	返回表示 `Range` 相对于所选内容的下一个单位的对象。
getPreviousRange(options)	返回表示 `Range` 相对于所选内容的上一个单位的对象。
goTo(options)	返回 `Range` 表示由指定的 `options` 区域的对象，并将插入点移到紧接指定项目前面的字符位置。
goToNext(what)	返回一个 `Range` 对象，该对象引用参数指定的 `what` 下一个项目或位置的起始位置，并将所选内容移动到指定项目。
goToNext(what)	返回一个 `Range` 对象，该对象引用参数指定的 `what` 下一个项目或位置的起始位置，并将所选内容移动到指定项目。
goToPrevious(what)	返回一个 `Range` 对象，该对象引用参数指定的 `what` 上一项或位置的起始位置，并将所选内容移动到指定项。
goToPrevious(what)	返回一个 `Range` 对象，该对象引用参数指定的 `what` 上一项或位置的起始位置，并将所选内容移动到指定项。
insertAfter(text)	在区域或所选内容的末尾插入指定的文本。
insertBefore(text)	在所选内容之前插入指定文本。
insertCells(shiftCells)	向原有表添加单元格。
insertCells(shiftCells)	向原有表添加单元格。
insertColumnsLeft()	在选定内容的左侧插入新列。
insertColumnsRight()	在当前选定内容的右边插入列。
insertDateTime(options)	将当前日期或时间作为文本或时间字段插入。
insertFormula(options)	在所选内容处插入公式字段。
insertNewPage()	在插入点的位置插入新页。
insertParagraphAfter()	在所选内容后插入段落标记。
insertParagraphBefore()	在所选内容或区域之前插入新段落。
insertParagraphStyleSeparator()	插入一个特殊的隐藏段落标记，使 Word 能够联接使用不同段落样式设置格式的段落。
insertRowsAbove(numRows)	在当前选定内容上方插入行。
insertRowsBelow(numRows)	在当前选定内容的下方插入行。
insertSymbol(characterNumber, options)	插入一个符号，用来替换指定的所选内容。
insertText(Text)	插入指定的文本。
insertXml(xml, transform)	将指定的 XML 插入文档中的光标处，并且替换任何选定文本。
isEqual(range)	返回所选内容是否等于指定的范围。
isInRange(range)	如果所选内容包含在指定范围内，则返回 `true` 。
isInStory(range)	返回所选内容是否与指定范围位于同一故事中。
load(options)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNames)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
load(propertyNamesAndPaths)	将命令加入队列以加载对象的指定属性。阅读属性前必须先调用 `context.sync()`。
move(options)	将所选内容折叠到其起始或结束位置，然后按指定的单位数移动折叠对象。
moveDown(options)	下移所选内容。
moveEnd(options)	移动区域或选区的结束字符位置。
moveEndUntil(characters, count)	移动所选内容的结束位置，直到在文档中找到任何指定字符。
moveEndWhile(characters, count)	当在文档中找到任何指定字符时移动所选内容的结束字符位置。
moveLeft(options)	向左移动所选内容。
moveRight(options)	向右移动所选内容。
moveStart(options)	移动所选内容的起始位置。
moveStartUntil(characters, count)	移动所选内容的起始位置，直到在文档中找到指定字符之一。
moveStartWhile(characters, count)	当在文档中找到任何指定字符时移动所选内容的起始位置。
moveUntil(characters, count)	移动所选内容，直到在文档中找到指定字符之一。
moveUp(options)	向上移动所选内容。
moveWhile(characters, count)	在文档中找到任何指定字符时移动所选内容。
nextField()	选定下一个域。
nextSubdocument()	将所选内容移至下一个子文档。
pasteAndFormat(type)	粘贴剪贴板中的内容并按指定格式设置其格式。
pasteAndFormat(type)	粘贴剪贴板中的内容并按指定格式设置其格式。
pasteExcelTable(linkedToExcel, wordFormatting, rtf)	粘贴 Microsoft Excel 表格并设置其格式。
pasteFormat()	将使用 `copyFormat` 该方法复制的格式应用于所选内容。
pasteTableCellsAppendTable()	通过在所选行之间插入粘贴的行，将粘贴的单元格合并到现有的表格中。
pasteTableCellsAsNestedTable()	将一个或一组单元格作为嵌套表格粘贴到所选内容中。
previousField()	选择并返回前一域。
previousSubdocument()	将所选内容移至上一个子文档。
replaceParagraph()	将所选内容替换为新段落。
select()	选择当前文本。
selectCell()	当所选内容位于表中时，选择包含当前选定内容的整个单元格。
selectColumn()	选择包含插入点的列，或者当所选内容位于表中时，选择包含所选内容的所有列。
selectCurrentAlignment()	向前扩展选定部分，直到遇到另一种段落对齐方式为止。
selectCurrentColor()	向前扩展选定内容，直至遇到另一种颜色的文字为止。
selectCurrentFont()	向前扩展选定内容，直至遇到另一种字体或字号。
selectCurrentIndent()	向前扩展选定内容，直至遇到具有另一种段落左右缩进量的文本为止。
selectCurrentSpacing()	向前扩展选定内容，直至遇到具有另一种行间距的段落为止。
selectCurrentTabs()	向前扩展选定内容，直至遇到另一种制表位的段落为止。
selectRow()	选择包含插入点的行，或者当所选内容位于表中时，选择包含所选内容的所有行。
setRange(start, end)	设置所选内容的起始字符和结束字符的位置。角色位置值从故事的开头开始，第一个值为 0。将计算所有字符，包括非打印字符。隐藏字符即便未显示也计算在内。
shrink()	将所选内容缩减至下一级较小的文字单位。此方法的单位级数如下：整篇文档、节、段落、句子、单词及插入点。
shrinkDiscontiguousSelection()	当当前所选内容包含多个未连接的选择时，取消选择除最近选择的文本之外的所有文本。
splitTable()	在所选内容的第一行上方插入一个空段落。如果选定内容不在表格中的第一行，则将该表格拆分为两个表格。如果选定内容不在表格中，则会导致出错。
toggleCharacterCode()	在 Unicode 字符与其对应的十六进制值之间切换选区。
toJSON()	覆盖 JavaScript `toJSON()` 方法，以便在将 API 对象传递给 `JSON.stringify()`时提供更有用的输出。 (`JSON.stringify`反过来调用 `toJSON` 传递给它的对象的方法。) 虽然原始 `Word.Selection` 对象是 API 对象， `toJSON` 但该方法返回一个纯 JavaScript 对象， (类型化为 `Word.Interfaces.SelectionData`) ，其中包含从原始对象加载的任何子属性的浅层副本。
track()	根据文档中的相应更改来跟踪对象，以便进行自动调整。此调用是 context.trackedObjects.add (thisObject) 的简写。如果在调用中 `.sync` 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。如果此对象是集合的一部分，您还应跟踪父集合。
typeBackspace()	如果折叠) 或插入点，则删除所选内容 (之前的字符。
untrack()	释放与此对象关联的内存（如果先前已跟踪过）。此调用是 context.trackedObjects.remove (thisObject) 的简写。拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。需要在内存释放生效之前调用 `context.sync()` 。

borders

返回 BorderUniversalCollection 表示所选内容中对象的所有边框的对象。

readonly borders: Word.BorderUniversalCollection;

属性值

Word.BorderUniversalCollection

注解

API 集：WordApiDesktop 1.4

characters

返回 RangeScopedCollection 表示所选内容中每个字符的对象。

readonly characters: Word.RangeScopedCollection;

属性值

Word.RangeScopedCollection

注解

API 集：WordApiDesktop 1.4

comments

返回表示 CommentCollection 所选内容中所有注释的对象。

readonly comments: Word.CommentCollection;

属性值

Word.CommentCollection

注解

API 集：WordApiDesktop 1.4

context

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

context: RequestContext;

属性值

Word.RequestContext

end

指定所选内容的结束字符位置。

end: number;

属性值

number

注解

API 集：WordApiDesktop 1.4

fields

返回 FieldCollection 表示所选内容中所有字段的对象。

readonly fields: Word.FieldCollection;

属性值

Word.FieldCollection

注解

API 集：WordApiDesktop 1.4

fitTextWidth

指定 Word 适合当前所选内容中的文本的宽度。

fitTextWidth: number;

属性值

number

注解

API 集：WordApiDesktop 1.4

font

返回 Font 表示所选内容的字符格式的对象。

readonly font: Word.Font;

属性值

Word.Font

注解

API 集：WordApiDesktop 1.4

formattedText

指定在 Range 区域或所选内容中包含格式化文本的对象。

formattedText: Word.Range;

属性值

Word.Range

注解

API 集：WordApiDesktop 1.4

hasNoProofing

返回拼写和语法检查是否忽略所选文本。如果所选文本混合包含已校对和未校对的内容，则此 API 将返回 null。

readonly hasNoProofing: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

isActive

返回指定窗口或窗格中的选择是否处于活动状态。

readonly isActive: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

isColumnSelectModeActive

指定列选择模式是否处于活动状态。

isColumnSelectModeActive: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

isEndOfRowMark

返回所选内容是否位于表中的行尾标记处。

readonly isEndOfRowMark: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

isExtendModeActive

指定“扩展”模式是否处于活动状态。

isExtendModeActive: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

isInsertionPointAtEndOfLine

返回插入点是否位于行尾。

readonly isInsertionPointAtEndOfLine: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

isStartActive

指定所选内容的开头是否处于活动状态。

isStartActive: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

languageDetected

指定 Word 是否检测到所选文本的语言。

languageDetected: boolean;

属性值

boolean

注解

API 集：WordApiDesktop 1.4

languageId

返回所选语言。

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

属性值

注解

API 集：WordApiDesktop 1.4

languageIdFarEast

返回所选内容的东亚语言。

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

属性值

注解

API 集：WordApiDesktop 1.4

languageIdOther

返回未归类为东亚语言的所选语言。

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

属性值

注解

API 集：WordApiDesktop 1.4

orientation

指定所选内容中文本的方向。

orientation: Word.TextOrientation | "Horizontal" | "Upward" | "Downward" | "VerticalFarEast" | "HorizontalRotatedFarEast" | "Vertical";

属性值

注解

API 集：WordApiDesktop 1.4

paragraphs

返回 ParagraphCollection 表示所选内容中所有段落的对象。

readonly paragraphs: Word.ParagraphCollection;

属性值

Word.ParagraphCollection

注解

API 集：WordApiDesktop 1.4

range

返回 Range 所选内容中包含的文档部分的对象。

readonly range: Word.Range;

属性值

Word.Range

注解

API 集：WordApiDesktop 1.4

sections

返回 SectionCollection 所选内容中的对象。

readonly sections: Word.SectionCollection;

属性值

Word.SectionCollection

注解

API 集：WordApiDesktop 1.4

sentences

返回 RangeScopedCollection 所选内容中每个句子的对象。

readonly sentences: Word.RangeScopedCollection;

属性值

Word.RangeScopedCollection

注解

API 集：WordApiDesktop 1.4

shading

返回 ShadingUniversal 所选内容的底纹格式的对象。

readonly shading: Word.ShadingUniversal;

属性值

Word.ShadingUniversal

注解

API 集：WordApiDesktop 1.4

start

指定所选内容的起始字符位置。

start: number;

属性值

number

注解

API 集：WordApiDesktop 1.4

storyLength

返回文章中包含所选内容的字符数。

readonly storyLength: number;

属性值

number

注解

API 集：WordApiDesktop 1.4

storyType

返回所选内容的故事类型。

readonly storyType: Word.StoryType | "MainText" | "Footnotes" | "Endnotes" | "Comments" | "TextFrame" | "EvenPagesHeader" | "PrimaryHeader" | "EvenPagesFooter" | "PrimaryFooter" | "FirstPageHeader" | "FirstPageFooter" | "FootnoteSeparator" | "FootnoteContinuationSeparator" | "FootnoteContinuationNotice" | "EndnoteSeparator" | "EndnoteContinuationSeparator" | "EndnoteContinuationNotice";

属性值

注解

API 集：WordApiDesktop 1.4

tables

返回 TableCollection 所选内容中的对象。

readonly tables: Word.TableCollection;

属性值

Word.TableCollection

注解

API 集：WordApiDesktop 1.4

text

指定所选内容中的文本。

text: string;

属性值

string

注解

API 集：WordApiDesktop 1.4

topLevelTables

返回当前选定内容中最外层嵌套级别的表。

readonly topLevelTables: Word.TableCollection;

属性值

Word.TableCollection

注解

API 集：WordApiDesktop 1.4

type

返回选择类型。

readonly type: Word.SelectionType | "NoSelection" | "InsertionPoint" | "Normal" | "Frame" | "Column" | "Row" | "Block" | "InlineShape" | "SelectionShape";

属性值

注解

API 集：WordApiDesktop 1.4

words

返回 RangeScopedCollection 表示所选内容中每个单词的对象。

readonly words: Word.RangeScopedCollection;

属性值

Word.RangeScopedCollection

注解

API 集：WordApiDesktop 1.4

calculate()

计算选区内的第一个数学表达式。

calculate(): OfficeExtension.ClientResult<number>;

返回

OfficeExtension.ClientResult<number>

计算结果。

注解

API 集：WordApiDesktop 1.4

cancelMode()

取消扩展或列选择等模式。这相当于按 Esc 键。

cancelMode(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

clearCharacterStyleFormatting()

删除通过字符样式应用的字符格式。

clearCharacterStyleFormatting(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

clearFormatting()

从所选内容中删除字符和段落格式。

clearFormatting(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

clearManualCharacterFormatting()

从所选文本中删除手动应用的字符格式。

clearManualCharacterFormatting(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

clearManualParagraphFormatting()

从所选文本中删除手动应用的段落格式。

clearManualParagraphFormatting(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

clearParagraphFormatting()

从所选文本中删除所有段落格式。

clearParagraphFormatting(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

clearParagraphStyle()

删除通过段落样式应用的段落格式。

clearParagraphStyle(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

collapse(direction)

将所选内容折叠到开始或结束位置。

collapse(direction?: Word.CollapseDirection): void;

参数

direction: Word.CollapseDirection

可选。折叠方向。

返回

void

注解

API 集：WordApiDesktop 1.4

collapse(direction)

将所选内容折叠到开始或结束位置。

collapse(direction?: "Start" | "End"): void;

参数

direction: "Start" | "End"

可选。折叠方向。

返回

void

注解

API 集：WordApiDesktop 1.4

convertToTable(options)

注意

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

将范围内的文本转换为表格。

convertToTable(options?: Word.SelectionConvertToTableOptions): Word.Table;

参数

options: Word.SelectionConvertToTableOptions

可选。将文本转换为表格的选项。

返回

Word.Table

Table表示新创建的表的对象。

注解

API 集：WordApi BETA (仅预览版)

copyAsPictureToClipboard()

将所选内容作为图片复制到剪贴板。

copyAsPictureToClipboard(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

copyFormat()

复制选定文字第一个字符的字符格式。

copyFormat(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

copyToClipboard()

将所选内容复制到剪贴板。

copyToClipboard(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

createTextBox()

在所选内容周围添加默认大小的文本框。

createTextBox(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

cut()

从文档中删除所选内容并将其移动到剪贴板。

cut(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

delete(options)

删除指定数量的字符或单词。

delete(options?: Word.SelectionDeleteOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionDeleteOptions

可选。用于删除文本的选项。

返回

OfficeExtension.ClientResult<number>

删除的字符数。

注解

API 集：WordApiDesktop 1.4

detectLanguage()

分析所选文本以确定其写入语言。

detectLanguage(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

expand(unit)

展开所选内容。

expand(unit?: Word.OperationUnit): OfficeExtension.ClientResult<number>;

参数

unit: Word.OperationUnit

可选。要展开的单元。

返回

OfficeExtension.ClientResult<number>

添加到范围或所选内容的字符数。

注解

API 集：WordApiDesktop 1.4

expand(unit)

展开所选内容。

expand(unit?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): OfficeExtension.ClientResult<number>;

参数

unit: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"

可选。要展开的单元。

返回

OfficeExtension.ClientResult<number>

添加到范围或所选内容的字符数。

注解

API 集：WordApiDesktop 1.4

expandToWholeStory()

展开所选内容以包括整个故事。

expandToWholeStory(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

extend(character)

打开扩展模式。如果扩展模式已经打开，则将选定内容扩展到下一个更大的文本单位。

extend(character?: Word.OperationUnit): void;

参数

character: Word.OperationUnit

可选。通过该扩展所选内容的字符。此参数区分大小写，必须计算为字符串，否则将发生错误。此外，如果该参数的值的长度超过一个字符，Word 将完全忽略该命令。

返回

void

注解

API 集：WordApiDesktop 1.4

extend(character)

打开扩展模式。如果扩展模式已经打开，则将选定内容扩展到下一个更大的文本单位。

extend(character?: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"): void;

参数

character: "Character" | "Word" | "Sentence" | "Paragraph" | "Line" | "Story" | "Screen" | "Section" | "Column" | "Row" | "Window" | "Cell" | "CharacterFormat" | "ParagraphFormat" | "Table" | "Item"

可选。通过该扩展所选内容的字符。此参数区分大小写，必须计算为字符串，否则将发生错误。此外，如果该参数的值的长度超过一个字符，Word 将完全忽略该命令。

返回

void

注解

API 集：WordApiDesktop 1.4

getNextRange(options)

返回表示 Range 相对于所选内容的下一个单位的对象。

getNextRange(options?: Word.SelectionNextOptions): Word.Range;

参数

options: Word.SelectionNextOptions

可选。操作的 next 选项。

返回

Word.Range

Range表示相对于选区的下一个单位的对象。

注解

API 集：WordApiDesktop 1.4

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/55-selection/get-previous-next-range.yaml

// Gets the range of the next paragraph relative to the current selection.
await Word.run(async (context) => {
  const options: Word.SelectionNextOptions = {
    unit: Word.OperationUnit.paragraph,
    count: 1,
  };
  const nextRange: Word.Range = context.document.selection.getNextRange(options);
  nextRange.load("text");
  await context.sync();

  console.log(`Next paragraph: "${nextRange.text.trim()}"`);
});

getPreviousRange(options)

返回表示 Range 相对于所选内容的上一个单位的对象。

getPreviousRange(options?: Word.SelectionPreviousOptions): Word.Range;

参数

options: Word.SelectionPreviousOptions

可选。操作的 previous 选项。

返回

Word.Range

Range表示相对于所选内容的上一个单位的对象。

注解

API 集：WordApiDesktop 1.4

示例

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/55-selection/get-previous-next-range.yaml

// Gets the range of the previous sentence relative to the current selection.
await Word.run(async (context) => {
  const options: Word.SelectionPreviousOptions = {
    unit: Word.OperationUnit.sentence,
    count: 1,
  };
  const previousRange: Word.Range = context.document.selection.getPreviousRange(options);
  previousRange.load("text");
  await context.sync();

  console.log(`Previous sentence: "${previousRange.text.trim()}"`);
});

goTo(options)

注意

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

返回 Range 表示由指定的 options 区域的对象，并将插入点移到紧接指定项目前面的字符位置。

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

参数

options: Word.GoToOptions

可选。操作的 goTo 选项。

返回

Word.Range

Range现在选定的对象。

注解

API 集：WordApi BETA (仅预览版)

goToNext(what)

返回一个 Range 对象，该对象引用参数指定的 what 下一个项目或位置的起始位置，并将所选内容移动到指定项目。

goToNext(what: Word.GoToItem): Word.Range;

参数

what: Word.GoToItem

要转到的项类型。

返回

Word.Range

Range指用于参数指定的what下一个项目或位置的起始位置的对象。

注解

API 集：WordApiDesktop 1.4

goToNext(what)

返回一个 Range 对象，该对象引用参数指定的 what 下一个项目或位置的起始位置，并将所选内容移动到指定项目。

goToNext(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range;

参数

what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"

要转到的项类型。

返回

Word.Range

Range指用于参数指定的what下一个项目或位置的起始位置的对象。

注解

API 集：WordApiDesktop 1.4

goToPrevious(what)

返回一个 Range 对象，该对象引用参数指定的 what 上一项或位置的起始位置，并将所选内容移动到指定项。

goToPrevious(what: Word.GoToItem): Word.Range;

参数

what: Word.GoToItem

要转到的项类型。

返回

Word.Range

Range指上一项的起始位置或参数指定what位置的对象。

注解

API 集：WordApiDesktop 1.4

goToPrevious(what)

返回一个 Range 对象，该对象引用参数指定的 what 上一项或位置的起始位置，并将所选内容移动到指定项。

goToPrevious(what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"): Word.Range;

参数

what: "Bookmark" | "Comment" | "Endnote" | "Field" | "Footnote" | "Graphic" | "Heading" | "Line" | "Page" | "Section" | "Table" | "EmbeddedObject" | "Equation" | "Percent" | "SpellingError" | "GrammaticalError" | "ProofreadingError"

要转到的项类型。

返回

Word.Range

Range指上一项的起始位置或参数指定what位置的对象。

注解

API 集：WordApiDesktop 1.4

insertAfter(text)

在区域或所选内容的末尾插入指定的文本。

insertAfter(text: string): void;

参数

text: string

要插入的文本。

返回

void

注解

API 集：WordApiDesktop 1.4

insertBefore(text)

在所选内容之前插入指定文本。

insertBefore(text: string): void;

参数

text: string

要插入的文本。

返回

void

注解

API 集：WordApiDesktop 1.4

insertCells(shiftCells)

向原有表添加单元格。

insertCells(shiftCells?: Word.TableCellInsertionLocation): void;

参数

shiftCells: Word.TableCellInsertionLocation

可选。指定如何将单元格插入到表的现有列和行中。默认值为 shiftDown。

返回

void

注解

API 集：WordApiDesktop 1.4

insertCells(shiftCells)

向原有表添加单元格。

insertCells(shiftCells?: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"): void;

参数

shiftCells: "ShiftRight" | "ShiftDown" | "ShiftRowDown" | "ShiftColumnRight"

insertDateTime(options?: Word.SelectionInsertDateTimeOptions): void;

参数

options: Word.SelectionInsertDateTimeOptions

可选。用于插入日期或时间的选项。

返回

void

注解

API 集：WordApiDesktop 1.4

insertFormula(options)

在所选内容处插入公式字段。

insertFormula(options?: Word.SelectionInsertFormulaOptions): void;

参数

options: Word.SelectionInsertFormulaOptions

可选。用于插入公式的选项。

返回

void

注解

API 集：WordApiDesktop 1.4

示例

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

// Inserts a custom formula at the selection.
// The selection must be in a table cell.
await Word.run(async (context) => {
  const options: Word.SelectionInsertFormulaOptions = {
    formula: "=AVERAGE(ABOVE)",
    numberFormat: "0.00",
  };
  context.document.selection.insertFormula(options);
  await context.sync();

  console.log("Inserted =AVERAGE(ABOVE) with decimal format.");
});

insertNewPage()

在插入点的位置插入新页。

insertNewPage(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

insertParagraphAfter()

在所选内容后插入段落标记。

insertParagraphAfter(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

insertParagraphBefore()

在所选内容或区域之前插入新段落。

insertParagraphBefore(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

insertParagraphStyleSeparator()

插入一个特殊的隐藏段落标记，使 Word 能够联接使用不同段落样式设置格式的段落。

insertParagraphStyleSeparator(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

insertRowsAbove(numRows)

在当前选定内容上方插入行。

insertRowsAbove(numRows: number): void;

参数

numRows: number

可选。要插入的行数。

返回

void

注解

API 集：WordApiDesktop 1.4

insertRowsBelow(numRows)

在当前选定内容的下方插入行。

insertRowsBelow(numRows: number): void;

参数

numRows: number

可选。要插入的行数。

返回

void

注解

API 集：WordApiDesktop 1.4

insertSymbol(characterNumber, options)

插入一个符号，用来替换指定的所选内容。

insertSymbol(characterNumber: number, options?: Word.SelectionInsertSymbolOptions): void;

参数

characterNumber: number

符号的字符编号。

options: Word.SelectionInsertSymbolOptions

可选。用于插入符号的选项。

返回

void

注解

API 集：WordApiDesktop 1.4

示例

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

// Inserts the copyright symbol © (Unicode U+00A9) at the selection.
await Word.run(async (context) => {
  const options: Word.SelectionInsertSymbolOptions = {
    unicode: true,
  };
  context.document.selection.insertSymbol(0x00a9, options);
  await context.sync();

  console.log("Inserted copyright symbol ©.");
});

insertText(Text)

插入指定的文本。

insertText(Text: string): void;

参数

Text: string

要插入的文本。

返回

void

注解

API 集：WordApiDesktop 1.4

insertXml(xml, transform)

将指定的 XML 插入文档中的光标处，并且替换任何选定文本。

insertXml(xml: string, transform?: string): void;

参数

xml: string

要插入的 XML 字符串。

transform: string

可选。要应用的 XSL 转换。

返回

void

注解

API 集：WordApiDesktop 1.4

isEqual(range)

返回所选内容是否等于指定的范围。

isEqual(range: Word.Range): OfficeExtension.ClientResult<boolean>;

参数

range: Word.Range

要比较的范围。

返回

OfficeExtension.ClientResult<boolean>

true 如果所选内容等于指定的范围。

注解

API 集：WordApiDesktop 1.4

isInRange(range)

如果所选内容包含在指定范围内，则返回 true 。

isInRange(range: Word.Range): OfficeExtension.ClientResult<boolean>;

参数

range: Word.Range

要比较的范围。

返回

OfficeExtension.ClientResult<boolean>

true 如果所选内容包含在指定范围内。

注解

API 集：WordApiDesktop 1.4

isInStory(range)

返回所选内容是否与指定范围位于同一故事中。

isInStory(range: Word.Range): OfficeExtension.ClientResult<boolean>;

参数

range: Word.Range

要比较的范围。

返回

OfficeExtension.ClientResult<boolean>

true 如果所选内容与指定范围位于同一楼层中。

注解

API 集：WordApiDesktop 1.4

load(options)

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

load(options?: Word.Interfaces.SelectionLoadOptions): Word.Selection;

参数

options: Word.Interfaces.SelectionLoadOptions

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

返回

Word.Selection

load(propertyNames)

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

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

参数

propertyNames: string | string[]

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

返回

Word.Selection

load(propertyNamesAndPaths)

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

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

参数

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

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

返回

Word.Selection

move(options)

将所选内容折叠到其起始或结束位置，然后按指定的单位数移动折叠对象。

move(options?: Word.SelectionMoveOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveOptions

可选。用于移动所选内容的选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveDown(options)

下移所选内容。

moveDown(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveUpDownOptions

可选。下移选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveEnd(options)

移动区域或选区的结束字符位置。

moveEnd(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveStartEndOptions

可选。用于移动末尾的选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveEndUntil(characters, count)

移动所选内容的结束位置，直到在文档中找到任何指定字符。

moveEndUntil(characters: string, count?: number): OfficeExtension.ClientResult<number>;

参数

characters: string

要搜索的字符。例如。如果指定 “a”，则选择会将结束位置移动到第一个 “a” 字符之前。

count: number

可选。要搜索的最大字符数。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveEndWhile(characters, count)

当在文档中找到任何指定字符时移动所选内容的结束字符位置。

moveEndWhile(characters: string, count?: number): OfficeExtension.ClientResult<number>;

参数

characters: string

要搜索的字符。例如。如果指定“abcd”，则当找到“abcd”中的任何字母时，所选内容会移动结束位置。

count: number

可选。要搜索的最大字符数。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveLeft(options)

向左移动所选内容。

moveLeft(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveLeftRightOptions

可选。左移选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveRight(options)

向右移动所选内容。

moveRight(options?: Word.SelectionMoveLeftRightOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveLeftRightOptions

可选。右移选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveStart(options)

移动所选内容的起始位置。

moveStart(options?: Word.SelectionMoveStartEndOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveStartEndOptions

可选。操作的 moveStart 选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveStartUntil(characters, count)

移动所选内容的起始位置，直到在文档中找到指定字符之一。

moveStartUntil(characters: string, count?: number): OfficeExtension.ClientResult<number>;

参数

characters: string

要搜索的字符。如果指定 “a”，则选择会将起始位置移动到第一个 “a” 字符之前。

count: number

可选。要搜索的最大字符数。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveStartWhile(characters, count)

当在文档中找到任何指定字符时移动所选内容的起始位置。

moveStartWhile(characters: string, count?: number): OfficeExtension.ClientResult<number>;

参数

characters: string

要搜索的字符。例如。如果指定“abcd”，则当找到“abcd”中的任何字母时，所选内容会移动起始位置。

count: number

可选。要搜索的最大字符数。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveUntil(characters, count)

移动所选内容，直到在文档中找到指定字符之一。

moveUntil(characters: string, count?: number): OfficeExtension.ClientResult<number>;

参数

characters: string

要搜索的字符。例如。如果指定 “a”，则所选内容将移动到第一个 “a” 字符之前的位置。

count: number

可选。要搜索的最大字符数。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveUp(options)

向上移动所选内容。

moveUp(options?: Word.SelectionMoveUpDownOptions): OfficeExtension.ClientResult<number>;

参数

options: Word.SelectionMoveUpDownOptions

可选。用于上移的选项。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

moveWhile(characters, count)

在文档中找到任何指定字符时移动所选内容。

moveWhile(characters: string, count?: number): OfficeExtension.ClientResult<number>;

参数

characters: string

要搜索的字符。例如。如果指定“abcd”，则当找到“abcd”中的任何字母时，所选内容将移动到该位置。

count: number

可选。要搜索的最大字符数。

返回

OfficeExtension.ClientResult<number>

移动所选内容所依据的字符数。

注解

API 集：WordApiDesktop 1.4

nextField()

选定下一个域。

nextField(): Word.Field;

返回

Word.Field

下一个字段。

注解

API 集：WordApiDesktop 1.4

nextSubdocument()

将所选内容移至下一个子文档。

nextSubdocument(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

pasteAndFormat(type)

粘贴剪贴板中的内容并按指定格式设置其格式。

pasteAndFormat(type: Word.PasteFormatType): void;

参数

type: Word.PasteFormatType

表格单元格的格式粘贴类型。

返回

void

注解

API 集：WordApiDesktop 1.4

pasteAndFormat(type)

粘贴剪贴板中的内容并按指定格式设置其格式。

pasteAndFormat(type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"): void;

参数

type: "PasteDefault" | "SingleCellText" | "SingleCellTable" | "ListContinueNumbering" | "ListRestartNumbering" | "TableAppendTable" | "TableInsertAsRows" | "TableOriginalFormatting" | "ChartPicture" | "Chart" | "ChartLinked" | "FormatOriginalFormatting" | "FormatSurroundingFormattingWithEmphasis" | "FormatPlainText" | "TableOverwriteCells" | "ListCombineWithExistingList" | "ListDontMerge" | "UseDestinationStylesRecovery"

表格单元格的格式粘贴类型。

返回

void

注解

API 集：WordApiDesktop 1.4

pasteExcelTable(linkedToExcel, wordFormatting, rtf)

粘贴 Microsoft Excel 表格并设置其格式。

pasteExcelTable(linkedToExcel: boolean, wordFormatting: boolean, rtf: boolean): void;

参数

linkedToExcel: boolean

表格是否链接到 Excel。

wordFormatting: boolean

是否应用 Word 格式。

rtf: boolean

previousField(): Word.Field;

返回

Word.Field

前一个字段。

注解

API 集：WordApiDesktop 1.4

previousSubdocument()

将所选内容移至上一个子文档。

previousSubdocument(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

replaceParagraph()

将所选内容替换为新段落。

replaceParagraph(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

select()

选择当前文本。

select(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCell()

当所选内容位于表中时，选择包含当前选定内容的整个单元格。

selectCell(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectColumn()

选择包含插入点的列，或者当所选内容位于表中时，选择包含所选内容的所有列。

selectColumn(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCurrentAlignment()

向前扩展选定部分，直到遇到另一种段落对齐方式为止。

selectCurrentAlignment(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCurrentColor()

向前扩展选定内容，直至遇到另一种颜色的文字为止。

selectCurrentColor(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCurrentFont()

向前扩展选定内容，直至遇到另一种字体或字号。

selectCurrentFont(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCurrentIndent()

向前扩展选定内容，直至遇到具有另一种段落左右缩进量的文本为止。

selectCurrentIndent(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCurrentSpacing()

向前扩展选定内容，直至遇到具有另一种行间距的段落为止。

selectCurrentSpacing(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectCurrentTabs()

向前扩展选定内容，直至遇到另一种制表位的段落为止。

selectCurrentTabs(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

selectRow()

选择包含插入点的行，或者当所选内容位于表中时，选择包含所选内容的所有行。

selectRow(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

setRange(start, end)

设置所选内容的起始字符和结束字符的位置。角色位置值从故事的开头开始，第一个值为 0。将计算所有字符，包括非打印字符。隐藏字符即便未显示也计算在内。

setRange(start: number, end: number): void;

参数

start: number

当前故事的起始字符位置。

end: number

toJSON(): Word.Interfaces.SelectionData;

返回

Word.Interfaces.SelectionData

track()

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

track(): Word.Selection;

返回

Word.Selection

typeBackspace()

如果折叠) 或插入点，则删除所选内容 (之前的字符。

typeBackspace(): void;

返回

void

注解

API 集：WordApiDesktop 1.4

untrack()

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

untrack(): Word.Selection;

返回

Word.Selection

注解

使用方

示例

属性

方法

属性详细信息

borders

属性值

注解

characters

属性值

注解

comments

属性值

注解

context

属性值

end

属性值

注解

fields

属性值

注解

fitTextWidth

属性值

注解

font

属性值

注解

formattedText

属性值

注解

hasNoProofing

属性值

注解

isActive

属性值

注解

isColumnSelectModeActive

属性值

注解

isEndOfRowMark

属性值

注解

isExtendModeActive

属性值

注解

isInsertionPointAtEndOfLine

属性值

注解

isStartActive

属性值

注解

languageDetected

属性值

注解

languageId

属性值

注解

languageIdFarEast

属性值

注解

languageIdOther

属性值

注解

orientation

属性值

注解

paragraphs

属性值

注解

range

属性值

注解

sections

属性值

注解

sentences

属性值