PowerPoint.TextRange class
Содержит текст, присоединенный к фигуре, в дополнение к свойствам и методам для управления текстом.
- Extends
Комментарии
[ Набор API: PowerPointApi 1.4 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
Свойства
| context | Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office. |
| font |
|
| length | Возвращает или задает длину диапазона, который он |
| paragraph |
Представляет формат абзаца текстового диапазона. Дополнительные сведения см. в разделе PowerPoint.ParagraphFormat . |
| start | Возвращает или задает отсчитываемый от нуля индекс относительно родительского текстового фрейма для начальной позиции диапазона, который он |
| text | Представляет содержимое с обычным текстом в диапазоне текста. |
Методы
| get |
Возвращает родительский объект PowerPoint.TextFrame , содержащий этот |
| get |
|
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set |
Выбирает его |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
context
Контекст запроса, связанный с объектом . Это соединяет процесс надстройки с процессом ведущего приложения Office.
context: RequestContext;Значение свойства
font
ShapeFont Возвращает объект , представляющий атрибуты шрифта для текстового диапазона.
readonly font: PowerPoint.ShapeFont;Значение свойства
Комментарии
[ Набор API: PowerPointApi 1.4 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Sets the color of the selected text range to green.
await PowerPoint.run(async (context) => {
const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
textRange.font.color = "green";
await context.sync();
});
length
Возвращает или задает длину диапазона, который он TextRange представляет.
InvalidArgument Создает исключение, если задано отрицательное значение или значение больше длины доступного текста из начальной точки.
length: number;Значение свойства
number
Комментарии
paragraphFormat
Представляет формат абзаца текстового диапазона. Дополнительные сведения см. в разделе PowerPoint.ParagraphFormat .
readonly paragraphFormat: PowerPoint.ParagraphFormat;Значение свойства
Комментарии
start
Возвращает или задает отсчитываемый от нуля индекс относительно родительского текстового фрейма для начальной позиции диапазона, который он TextRange представляет.
InvalidArgument Создает исключение, если задано отрицательное значение или значение больше длины текста.
start: number;Значение свойства
number
Комментарии
text
Представляет содержимое с обычным текстом в диапазоне текста.
text: string;Значение свойства
string
Комментарии
Сведения о методе
getParentTextFrame()
Возвращает родительский объект PowerPoint.TextFrame , содержащий этот TextRangeобъект .
getParentTextFrame(): PowerPoint.TextFrame;Возвращаемое значение
Комментарии
getSubstring(start, length)
TextRange Возвращает объект для подстроки в заданном диапазоне.
getSubstring(start: number, length?: number): PowerPoint.TextRange;Параметры
- start
-
number
Отсчитываемый от нуля индекс первого символа, который будет получен из текстового диапазона.
- length
-
number
Необязательный параметр. Количество символов, возвращаемых в новом текстовом диапазоне. Если длина опущена, будут возвращены все символы от начала до конца последнего абзаца текстового диапазона.
Возвращаемое значение
Комментарии
load(options)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;Параметры
Предоставляет параметры свойств объекта для загрузки.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): PowerPoint.TextRange;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, указывающих свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.TextRange;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.
Возвращаемое значение
setSelected()
Выбирает его TextRange в текущем представлении.
setSelected(): void;Возвращаемое значение
void
Комментарии
[ Набор API: PowerPointApi 1.5 ]
Примеры
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml
// Selects the first 10 characters of the selected shape.
await PowerPoint.run(async (context) => {
const shapes: PowerPoint.ShapeScopedCollection = context.presentation.getSelectedShapes();
const shapeCount = shapes.getCount();
await context.sync();
if (shapeCount.value !== 1) {
console.warn("You must select only one shape with text in it.");
return;
}
const shape: PowerPoint.Shape = shapes.getItemAt(0);
const textFrame: PowerPoint.TextFrame = shape.textFrame.load("textRange,hasText");
await context.sync();
if (textFrame.hasText != true) {
console.warn("You must select only one shape with text in it.");
return;
}
const textRange: PowerPoint.TextRange = textFrame.textRange;
textRange.load("text");
await context.sync();
if (textRange.text.length < 10) {
console.warn("You must select only one shape with at least 10 characters in it.");
return;
}
const textRange10 = textRange.getSubstring(0, 10);
textRange10.setSelected();
await context.sync();
});
...
// Sets the range selection to the range that was saved previously.
await PowerPoint.run(async (context) => {
const slide1: PowerPoint.Slide = context.presentation.slides.getItem(savedTextSlideSelection[0]);
const shape1: PowerPoint.Shape = slide1.shapes.getItem(savedTextShapeSelection[0]);
const textRange: PowerPoint.TextRange = shape1.textFrame.textRange.getSubstring(savedTextTextRangeStart, savedTextTextRangeLength);
textRange.setSelected();
await context.sync();
});
toJSON()
Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.TextRange объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.TextRangeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.
toJSON(): PowerPoint.Interfaces.TextRangeData;Возвращаемое значение
Office Add-ins