Описание. Возвращает выделенный текст в виде строки. Параметр-объект задаёт, какие элементы включать в результат и чем разделять абзацы, ячейки и строки таблицы.
Редакторы: документы, таблицы, презентации.
Параметры
Параметр необязательный. Это объект со свойствами:
| Свойство | Тип | По умолчанию | Описание |
|---|---|---|---|
| NewLine | логическое | true | Включать разрывы строк (Shift+Enter). При false разрыв строки удаляется |
| NewLineParagraph | логическое | true | Разделять абзацы. При false абзацы и ячейки таблицы склеиваются без разделителей |
| Numbering | логическое | true | Включать номера и маркеры списков. Номер отделяется от текста табуляцией: "1.\tтекст" |
| Math | логическое | true | Включать формулы. При false формулы в текст не попадают |
| ParaSeparator | строка | "\r\n" | Разделитель абзацев |
| NewLineSeparator | строка | "\r" | Чем заменять разрыв строки |
| TabSymbol | строка | пробел | Чем заменять символ табуляции в тексте. Табуляция после номера списка не заменяется |
| TableCellSeparator | строка | "\t" | Разделитель ячеек в строке таблицы |
| TableRowSeparator | строка | "\r\n" | Разделитель строк таблицы |
Если вызвать метод без параметра, действуют значения по умолчанию: разрывы строк, абзацы, нумерация и формулы включаются.
Возвращаемое значение
Строка с выделенным текстом.
- Если ничего не выделено, метод возвращает пустую строку.
- Если выделен абзац целиком, строка заканчивается разделителем абзаца (по умолчанию
"\r\n").
Пример
window.Asc.plugin.executeMethod("GetSelectedText", [{
Numbering: false,
ParaSeparator: "\n",
TableCellSeparator: " | ",
TableRowSeparator: "\n"
}], function (text) {
if (!text) {
console.log("Ничего не выделено");
return;
}
console.log(text.trim());
});Особенность в Таблицах
В редакторе таблиц метод не возвращает содержимое выделенных ячеек и выделенных целиком фигур: результат — пустая строка. Текст возвращается в двух случаях: пользователь редактирует ячейку и выделил текст внутри неё или выделил текст внутри фигуры.
Чтобы получить значения выделенных ячеек, используйте callCommand:
window.Asc.plugin.callCommand(function () {
return JSON.stringify(Api.GetSelection().GetValue());
}, false, false, function (result) {
var values = JSON.parse(result);
// для диапазона A1:B2: [["a1","b1"],["a2","b2"]]
console.log(values);
});












