Word.Selection class

Представляет выделенный диапазон или точку вставки в документе Word.

Примечание. Объекты диапазона используют во многом те же методы и свойства, что Selection и объекты. Использование Range объектов предпочтительнее для работы с документом, когда нет необходимости физически изменять текущий выделенный фрагмент.

Используется

Примеры

// 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)	Вставка текущей даты или времени (или и того, и другого) в виде текстового поля или поля TIME.
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()	Переключение выбора между символом Юникода и соответствующим шестнадцатеричным значением.
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

characters

Возвращает объект, представляющий RangeScopedCollection каждый символ в выделенном фрагменте.

readonly characters: Word.RangeScopedCollection;

Значение свойства

Word.RangeScopedCollection

comments

Возвращает объект, CommentCollection представляющий все примечания в выделенном фрагменте.

readonly comments: Word.CommentCollection;

Значение свойства

Word.CommentCollection

context

Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.

context: RequestContext;

Значение свойства

Word.RequestContext

end

Определяет позицию конечного знака выделенного фрагмента.

end: number;

Значение свойства

number

fields

Возвращает объект, FieldCollection представляющий все поля в выделенном фрагменте.

readonly fields: Word.FieldCollection;

Значение свойства

Word.FieldCollection

fitTextWidth

Ширина подгонки Word под размер текста в текущем выделенном фрагменте.

fitTextWidth: number;

Значение свойства

number

font

Возвращает объект, Font представляющий форматирование выделенного символа.

readonly font: Word.Font;

Значение свойства

Word.Font

formattedText

Указывает объект, Range включающий отформатированный текст в диапазон или выделенный фрагмент.

formattedText: Word.Range;

Значение свойства

Word.Range

hasNoProofing

Возвращает, игнорирует ли средство проверки орфографии и грамматики выделенный текст. Если выделенный текст содержит смесь проверенного и непроверенного содержимого, этот API возвращает null.

readonly hasNoProofing: boolean;

Значение свойства

boolean

isActive

Возвращает, активен ли выделенный фрагмент в указанном окне или области.

readonly isActive: boolean;

Значение свойства

boolean

isColumnSelectModeActive

Указывает, активен ли режим выбора столбца.

isColumnSelectModeActive: boolean;

Значение свойства

boolean

isEndOfRowMark

Возвращает, находится ли выделенный фрагмент на отметке конца строки в таблице.

readonly isEndOfRowMark: boolean;

Значение свойства

boolean

isExtendModeActive

Указывает, активен ли режим расширения.

isExtendModeActive: boolean;

Значение свойства

boolean

isInsertionPointAtEndOfLine

Возвращает, находится ли точка вставки в конце строки.

readonly isInsertionPointAtEndOfLine: boolean;

Значение свойства

boolean

isStartActive

Указывает, активно ли начало выделения.

isStartActive: boolean;

Значение свойства

boolean

languageDetected

Указывает, определил ли Word язык выделенного текста.

languageDetected: boolean;

Значение свойства

boolean

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

Значение свойства

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

Значение свойства

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

Значение свойства

orientation

Определяет ориентацию текста в выделенном фрагменте.

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

Значение свойства

paragraphs

Возвращает объект, представляющий ParagraphCollection все абзацы в выделенном фрагменте.

readonly paragraphs: Word.ParagraphCollection;

Значение свойства

Word.ParagraphCollection

range

Возвращает Range объект для части документа, содержащейся в выделенном фрагменте.

readonly range: Word.Range;

Значение свойства

Word.Range

sections

Возвращает выделенный объект.SectionCollection

readonly sections: Word.SectionCollection;

Значение свойства

Word.SectionCollection

sentences

Возвращает RangeScopedCollection объект для каждого предложения в выделенном фрагменте.

readonly sentences: Word.RangeScopedCollection;

Значение свойства

Word.RangeScopedCollection

shading

Возвращает ShadingUniversal объект форматирования заливки для выделенной области.

readonly shading: Word.ShadingUniversal;

Значение свойства

Word.ShadingUniversal

start

Указывает начальную позицию выбранного знака.

start: number;

Значение свойства

number

storyLength

Возвращает количество символов в истории, которая содержит выделенный фрагмент.

readonly storyLength: number;

Значение свойства

number

storyType

Возвращает тип выбранного периода.

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

Значение свойства

tables

Возвращает выделенный объект.TableCollection

readonly tables: Word.TableCollection;

Значение свойства

Word.TableCollection

text

Указывает текст в выделенном фрагменте.

text: string;

Значение свойства

string

topLevelTables

Возвращает таблицы на крайнем внешнем уровне вложенности в текущей выборке.

readonly topLevelTables: Word.TableCollection;

Значение свойства

Word.TableCollection

type

Возвращает тип выбора.

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

Значение свойства

words

Возвращает объект, RangeScopedCollection представляющий каждое слово в выделенном фрагменте.

readonly words: Word.RangeScopedCollection;

Значение свойства

Word.RangeScopedCollection

calculate()

Вычисляет первое математическое выражение в выделенном фрагменте.

calculate(): OfficeExtension.ClientResult<number>;

Возвращаемое значение

OfficeExtension.ClientResult<number>

Результат вычисления.

cancelMode()

Отменяет режим, например расширение или выбор столбца. Это эквивалентно нажатию клавиши ESC.

cancelMode(): void;

Возвращаемое значение

void

clearCharacterStyleFormatting()

Удаляет форматирование символов, применяемое к стилям символов.

clearCharacterStyleFormatting(): void;

Возвращаемое значение

void

clearFormatting()

Удаляет из выделенного фрагмента форматирование символов и абзацев.

clearFormatting(): void;

Возвращаемое значение

void

clearManualCharacterFormatting()

Удаляет примененное вручную форматирование символов из выделенного текста.

clearManualCharacterFormatting(): void;

Возвращаемое значение

void

clearManualParagraphFormatting()

Удаляет из выделенного текста примененное вручную форматирование абзаца.

clearManualParagraphFormatting(): void;

Возвращаемое значение

void

clearParagraphFormatting()

Удаляет все форматирование абзаца из выделенного текста.

clearParagraphFormatting(): void;

Возвращаемое значение

void

clearParagraphStyle()

Удаление форматирования абзаца, примененного с помощью стилей абзацев.

clearParagraphStyle(): void;

Возвращаемое значение

void

collapse(direction)

Сворачивание выделенного фрагмента в начальную или конечную позицию.

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

Параметры

direction: Word.CollapseDirection

Необязательный параметр. Направление на сворачивание.

Возвращаемое значение

void

collapse(direction)

Сворачивание выделенного фрагмента в начальную или конечную позицию.

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

Параметры

direction: "Start" | "End"

Необязательный параметр. Направление на сворачивание.

Возвращаемое значение

void

convertToTable(options)

Примечание

Этот API предоставляется в качестве предварительной версии для разработчиков и может быть изменен на основе полученных нами отзывов. Не используйте этот API в рабочей среде.

Преобразует текст в диапазоне в таблицу.

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

Параметры

options: Word.SelectionConvertToTableOptions

Необязательный параметр. Параметры для преобразования текста в таблицу.

Возвращаемое значение

Word.Table

Объект Table , представляющий только что созданную таблицу.

copyAsPictureToClipboard()

Копирование выделенного фрагмента в буфер обмена в виде рисунка.

copyAsPictureToClipboard(): void;

Возвращаемое значение

void

copyFormat()

Копирует форматирование первого знака в выделенном тексте.

copyFormat(): void;

Возвращаемое значение

void

copyToClipboard()

Копирование выделенного фрагмента в буфер обмена.

copyToClipboard(): void;

Возвращаемое значение

void

createTextBox()

Добавляет вокруг выделенного фрагмента текстовое поле стандартного размера.

createTextBox(): void;

Возвращаемое значение

void

cut()

Удаляет выбранное содержимое из документа и перемещает его в буфер обмена.

cut(): void;

Возвращаемое значение

void

delete(options)

Удаляет указанное количество символов или слов.

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

Параметры

options: Word.SelectionDeleteOptions

Необязательный параметр. Параметры для удаления текста.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество удаленных символов.

detectLanguage()

Анализирует выбранный текст, чтобы определить его написанный.

detectLanguage(): void;

Возвращаемое значение

void

expand(unit)

Расширяет выбор.

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

Параметры

unit: Word.OperationUnit

Необязательный параметр. Подразделение для расширения.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество символов, добавленных к диапазону или выделенному фрагменту.

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>

Количество символов, добавленных к диапазону или выделенному фрагменту.

expandToWholeStory()

Расширяет выделенный фрагмент, чтобы включить всю историю.

expandToWholeStory(): void;

Возвращаемое значение

void

extend(character)

Включает режим выделения или, если он уже включен, расширяет выделенный фрагмент до следующего большего фрагмента текста.

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

Параметры

character: Word.OperationUnit

Необязательный параметр. Знак, с помощью которого расширяется выбор. Этот аргумент чувствителен к регистру и должен оцениваться как строка, иначе возникнет ошибка. Кроме того, если значение этого аргумента больше одного символа, Microsoft Word полностью игнорирует команду.

Возвращаемое значение

void

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"

Необязательный параметр. Знак, с помощью которого расширяется выбор. Этот аргумент чувствителен к регистру и должен оцениваться как строка, иначе возникнет ошибка. Кроме того, если значение этого аргумента больше одного символа, Microsoft Word полностью игнорирует команду.

Возвращаемое значение

void

getNextRange(options)

Возвращает объект, Range представляющий следующую единицу измерения относительно выделенного фрагмента.

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

Параметры

options: Word.SelectionNextOptions

Необязательный параметр. Параметры next операции.

Возвращаемое значение

Word.Range

Объект Range , представляющий следующую единицу относительно выделенной области.

Примеры

// 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 , представляющий предыдущую единицу относительно выделенной области.

Примеры

// 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 , который теперь выделен.

goToNext(what)

Возвращает объект, Range который ссылается на начальную позицию следующего элемента или расположения, указанного аргументом what , и перемещает выбранный объект к указанному элементу.

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

Параметры

what: Word.GoToItem

Тип элемента для перехода.

Возвращаемое значение

Word.Range

Объект Range , который ссылается на начальную позицию следующего элемента или расположение, указанное аргументом what .

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 .

goToPrevious(what)

Возвращает объект, Range ссылающийся на начальную позицию предыдущего элемента или расположения, указанного аргументом what , и перемещает выбранный объект к указанному элементу.

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

Параметры

what: Word.GoToItem

Тип элемента для перехода.

Возвращаемое значение

Word.Range

Объект Range , который ссылается на начальную позицию предыдущего элемента или расположения, указанного аргументом what .

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 .

insertAfter(text)

Вставляет указанный текст в конец диапазона или выделенного фрагмента.

insertAfter(text: string): void;

Параметры

text: string

Текст для вставки.

Возвращаемое значение

void

insertBefore(text)

Вставляет указанный текст перед выделением.

insertBefore(text: string): void;

Параметры

text: string

Текст для вставки.

Возвращаемое значение

void

insertCells(shiftCells)

Добавляет ячейки в существующую таблицу.

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

Параметры

shiftCells: Word.TableCellInsertionLocation

Необязательный параметр. Указывает, как вставлять ячейки в существующие столбцы и строки таблицы. Значение по умолчанию: shiftDown.

Возвращаемое значение

void

insertCells(shiftCells)

Добавляет ячейки в существующую таблицу.

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

Параметры

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

Необязательный параметр. Указывает, как вставлять ячейки в существующие столбцы и строки таблицы. Значение по умолчанию: shiftDown.

Возвращаемое значение

void

insertColumnsLeft()

Вставляет столбцы слева от столбца, содержащего выделенный фрагмент.

insertColumnsLeft(): void;

Возвращаемое значение

void

insertColumnsRight()

Вставляет столбцы справа от выделенного.

insertColumnsRight(): void;

Возвращаемое значение

void

insertDateTime(options)

Вставка текущей даты или времени (или и того, и другого) в виде текстового поля или поля TIME.

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

Параметры

options: Word.SelectionInsertDateTimeOptions

Необязательный параметр. Параметры для вставки даты и времени.

Возвращаемое значение

void

insertFormula(options)

Вставка поля формулы в выделенном фрагменте.

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

Параметры

options: Word.SelectionInsertFormulaOptions

Необязательный параметр. Параметры для вставки формулы.

Возвращаемое значение

void

Примеры

// 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

insertParagraphAfter()

Вставляет знак абзаца после выделенного фрагмента.

insertParagraphAfter(): void;

Возвращаемое значение

void

insertParagraphBefore()

Вставляет новый абзац перед выделенным фрагментом или диапазоном.

insertParagraphBefore(): void;

Возвращаемое значение

void

insertParagraphStyleSeparator()

Вставляет специальный скрытый знак абзаца, позволяющий Word объединять абзацы, отформатированные с использованием разных стилей абзацев.

insertParagraphStyleSeparator(): void;

Возвращаемое значение

void

insertRowsAbove(numRows)

Вставляет строки выше выделенного фрагмента.

insertRowsAbove(numRows: number): void;

Параметры

numRows: number

Необязательный параметр. Количество вставляемых строк.

Возвращаемое значение

void

insertRowsBelow(numRows)

Вставляет строки ниже выделенного фрагмента.

insertRowsBelow(numRows: number): void;

Параметры

numRows: number

Необязательный параметр. Количество вставляемых строк.

Возвращаемое значение

void

insertSymbol(characterNumber, options)

Вставляет символ на место указанного выделения.

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

Параметры

characterNumber: number

Номер знака символа.

options: Word.SelectionInsertSymbolOptions

Необязательный параметр. Параметры вставки символа.

Возвращаемое значение

void

Примеры

// 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

insertXml(xml, transform)

Вставляет указанный XML-код в документ в точке под курсором, заменяя выделенный текст.

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

Параметры

xml: string

Строка XML для вставки.

transform: string

Необязательный параметр. Применив преобразование XSL.

Возвращаемое значение

void

isEqual(range)

Возвращает, равно ли выделение указанному диапазону.

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

Параметры

range: Word.Range

Диапазон для сравнения.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

true Если выделение равно указанному диапазону.

isInRange(range)

Возвращает true , если выделенный фрагмент находится в указанном диапазоне.

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

Параметры

range: Word.Range

Диапазон для сравнения.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

true если выделенный фрагмент содержится в указанном диапазоне.

isInStory(range)

Возвращает, находится ли выборка в том же описании, что и указанный диапазон.

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

Параметры

range: Word.Range

Диапазон для сравнения.

Возвращаемое значение

OfficeExtension.ClientResult<boolean>

true если выборка находится в том же этаже, что и указанный диапазон.

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>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveDown(options)

Перемещение выделенного фрагмента вниз.

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

Параметры

options: Word.SelectionMoveUpDownOptions

Необязательный параметр. Варианты перемещения вниз.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveEnd(options)

Перемещение конечной позиции знака диапазона или выделенного фрагмента.

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

Параметры

options: Word.SelectionMoveStartEndOptions

Необязательный параметр. Варианты перемещения в конец.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveEndUntil(characters, count)

Перемещает конечную позицию выделенного фрагмента до тех пор, пока в документе не будет найден любой из указанных символов.

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

Параметры

characters: string

Символы для поиска. Пример. Если указать "a", конечная позиция будет помещена вперёд перед первым символом "a".

count: number

Необязательный параметр. Максимальное количество символов для поиска.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveEndWhile(characters, count)

Перемещает позицию выделенного символа в конце документа, если любой из указанных символов находится в документе.

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

Параметры

characters: string

Символы для поиска. Пример. Если указать "abcd", при обнаружении любой буквы из "abcd" будет выбрана конечная позиция.

count: number

Необязательный параметр. Максимальное количество символов для поиска.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveLeft(options)

Перемещение выделенного фрагмента влево.

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

Параметры

options: Word.SelectionMoveLeftRightOptions

Необязательный параметр. Параметры перемещения влево.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveRight(options)

Перемещение выделенного фрагмента вправо.

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

Параметры

options: Word.SelectionMoveLeftRightOptions

Необязательный параметр. Параметры перемещения вправо.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveStart(options)

Перемещение начальной позиции выбора.

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

Параметры

options: Word.SelectionMoveStartEndOptions

Необязательный параметр. Параметры moveStart операции.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveStartUntil(characters, count)

Перемещает начальную позицию выделенного фрагмента до тех пор, пока в документе не будет найден один из указанных символов.

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

Параметры

characters: string

Символы для поиска. Если указана буква "a", начальная позиция перемещается вперёд перед первым символом "a".

count: number

Необязательный параметр. Максимальное количество символов для поиска.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveStartWhile(characters, count)

Перемещает начальную позицию выделенного фрагмента при наличии в документе любого из указанных символов.

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

Параметры

characters: string

Символы для поиска. Пример. Если указать "abcd", при обнаружении любой буквы из "abcd" будет выбрана начальная позиция.

count: number

Необязательный параметр. Максимальное количество символов для поиска.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveUntil(characters, count)

Выделенный фрагмент перемещается до тех пор, пока в документе не будет найден один из указанных символов.

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

Параметры

characters: string

Символы для поиска. Пример. Если для параметра «а» указана буква «а», выделенный фрагмент переместится на позицию перед первым символом «а».

count: number

Необязательный параметр. Максимальное количество символов для поиска.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveUp(options)

Перемещение выделенного фрагмента вверх.

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

Параметры

options: Word.SelectionMoveUpDownOptions

Необязательный параметр. Варианты перемещения вверх.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

moveWhile(characters, count)

Перемещает выделенный фрагмент при обнаружении в документе любого из указанных символов.

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

Параметры

characters: string

Символы для поиска. Пример. Если вы укажете "abcd", выделенный фрагмент переместится на позицию, когда найдена любая буква из "abcd".

count: number

Необязательный параметр. Максимальное количество символов для поиска.

Возвращаемое значение

OfficeExtension.ClientResult<number>

Количество знаков, на которое был перемещен выделенный фрагмент.

nextField()

Выбор следующего поля.

nextField(): Word.Field;

Возвращаемое значение

Word.Field

Следующее поле.

nextSubdocument()

Перемещение выделенного фрагмента в следующий подчиненный документ.

nextSubdocument(): void;

Возвращаемое значение

void

pasteAndFormat(type)

Вставляет содержимое буфера обмена и форматирует его в соответствии с указаниями.

pasteAndFormat(type: Word.PasteFormatType): void;

Параметры

type: Word.PasteFormatType

Тип формата вставки для ячеек таблицы.

Возвращаемое значение

void

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

pasteExcelTable(linkedToExcel, wordFormatting, rtf)

Вставка и форматирование таблицы Microsoft Excel.

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

Параметры

linkedToExcel: boolean

Связана ли таблица с Excel.

wordFormatting: boolean

Следует ли применять форматирование Word.

rtf: boolean

Следует ли вставлять в формате RTF (RTF).

Возвращаемое значение

void

pasteFormat()

Применение форматирования, скопированного с помощью этого copyFormat метода к выделенному фрагменту.

pasteFormat(): void;

Возвращаемое значение

void

pasteTableCellsAppendTable()

Объединяет вставленные ячейки в существующую таблицу путем вставки вставленных строк между выделенными строками.

pasteTableCellsAppendTable(): void;

Возвращаемое значение

void

pasteTableCellsAsNestedTable()

Вставляет ячейку или группу ячеек в качестве вложенной таблицы в выделенный фрагмент.

pasteTableCellsAsNestedTable(): void;

Возвращаемое значение

void

previousField()

Выбор и возврат предыдущего поля.

previousField(): Word.Field;

Возвращаемое значение

Word.Field

Предыдущее поле.

previousSubdocument()

Перемещение выделенного фрагмента к предыдущему подчиненному документу.

previousSubdocument(): void;

Возвращаемое значение

void

replaceParagraph()

Заменяет выделенный фрагмент новым абзацем.

replaceParagraph(): void;

Возвращаемое значение

void

select()

Выделение текущего текста.

select(): void;

Возвращаемое значение

void

selectCell()

Выделение всей ячейки, содержащей текущий выбранный элемент, если он находится в таблице.

selectCell(): void;

Возвращаемое значение

void

selectColumn()

Выделение столбца, содержащего точку вставки, или всех столбцов, содержащих выделенный фрагмент, если выбранный элемент находится в таблице.

selectColumn(): void;

Возвращаемое значение

void

selectCurrentAlignment()

Расширяет выделенный фрагмент до тех пор, пока не будет найден текст с другим выравниванием абзаца.

selectCurrentAlignment(): void;

Возвращаемое значение

void

selectCurrentColor()

Расширяет выделенный фрагмент до тех пор, пока не появится текст другого цвета.

selectCurrentColor(): void;

Возвращаемое значение

void

selectCurrentFont()

Расширяет выделенный фрагмент до тех пор, пока не появится текст другого шрифта или размера шрифта.

selectCurrentFont(): void;

Возвращаемое значение

void

selectCurrentIndent()

Расширяет выделенный фрагмент до тех пор, пока не будет найден текст с различными отступами абзаца слева или справа.

selectCurrentIndent(): void;

Возвращаемое значение

void

selectCurrentSpacing()

Расширяет выделенный фрагмент до тех пор, пока не будет найден абзац с другим междустрочным интервалом.

selectCurrentSpacing(): void;

Возвращаемое значение

void

selectCurrentTabs()

Расширяет выделенный фрагмент до тех пор, пока не будет найден абзац с другими позициями табуляции.

selectCurrentTabs(): void;

Возвращаемое значение

void

selectRow()

Выделяет строку, содержащую точку вставки, или все строки, содержащие выделенный фрагмент, если он находится в таблице.

selectRow(): void;

Возвращаемое значение

void

setRange(start, end)

Задает начальную и конечную позиции символов для выбора. Значения положения персонажа начинаются с начала истории, первое значение равно 0. Учитываются все символы, включая непечатаемые символы. Скрытые символы учитываются, даже если они не отображаются.

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

Параметры

start: number

Начальная позиция персонажа текущей истории.

end: number

Конечная позиция персонажа текущей истории.

Возвращаемое значение

void

shrink()

Уменьшает выделенный фрагмент до следующего меньшего фрагмента текста. Прогрессия единиц измерения для этого метода следующая: весь документ, раздел, абзац, предложение, слово, точка вставки.

shrink(): void;

Возвращаемое значение

void

shrinkDiscontiguousSelection()

Если выделенный фрагмент содержит несколько несвязанных фрагментов, выделение отменяет выделение всех фрагментов, кроме последнего выделенного.

shrinkDiscontiguousSelection(): void;

Возвращаемое значение

void

splitTable()

Вставляет пустой абзац над первой строкой выделенного фрагмента. Если выбранный элемент не находится в первой строке таблицы, таблица делится на две таблицы. Если выделенного элемента нет в таблице, возникает ошибка.

splitTable(): void;

Возвращаемое значение

void

toggleCharacterCode()

Переключение выбора между символом Юникода и соответствующим шестнадцатеричным значением.

toggleCharacterCode(): void;

Возвращаемое значение

void

toJSON()

Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringify, в свою очередь, вызывает toJSON метод переданного ему объекта.) В то время как исходный Word.Selection объект является объектом API, toJSON метод возвращает простой объект JavaScript (типизированный как Word.Interfaces.SelectionData), который содержит неглубокие копии любых загруженных дочерних свойств исходного объекта.

toJSON(): Word.Interfaces.SelectionData;

Возвращаемое значение

Word.Interfaces.SelectionData

track()

Отслеживает объект для автоматической корректировки с учетом окружающих изменений в документе. Этот вызов является сокращением от context.trackedObjects.add(thisObject). Если вы используете этот объект во всех .sync вызовах и вне последовательного выполнения пакета ".run" и получаете сообщение об ошибке "InvalidObjectPath" при установке свойства или вызове метода объекта, необходимо добавить объект в коллекцию отслеживаемых объектов при его первом создании. Если этот объект является частью семейства, следует также отслеживать родительскую коллекцию.

track(): Word.Selection;

Возвращаемое значение

Word.Selection

typeBackspace()

Удаляет знак, предшествующий выделенному фрагменту (если он свернут) или точке вставки.

typeBackspace(): void;

Возвращаемое значение

void

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

Значение свойства