PowerPoint.TextRange class

Пакет:

powerpoint

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

Extends

OfficeExtension.ClientObject

Комментарии

[ Набор 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	ShapeFont Возвращает объект , представляющий атрибуты шрифта для текстового диапазона.
paragraphFormat	Представляет формат абзаца текстового диапазона. Дополнительные сведения см. в разделе PowerPoint.ParagraphFormat .
text	Представляет содержимое с обычным текстом в диапазоне текста.

Методы

getSubstring(start, length)	TextRange Возвращает объект для подстроки в заданном диапазоне.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
toJSON()	Переопределяет метод JavaScript toJSON() , чтобы обеспечить более полезные выходные данные при передаче объекта API в JSON.stringify(). (JSON.stringifyв свою очередь вызывает toJSON метод переданного ему объекта.) В то время как исходный PowerPoint.TextRange объект является объектом API, toJSON метод возвращает обычный объект JavaScript (типизированный как PowerPoint.Interfaces.TextRangeData), который содержит неглубокие копии всех загруженных дочерних свойств из исходного объекта.

Сведения о свойстве

context

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

context: RequestContext;

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

PowerPoint.RequestContext

font

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

readonly font: PowerPoint.ShapeFont;

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

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();
});

paragraphFormat

Представляет формат абзаца текстового диапазона. Дополнительные сведения см. в разделе PowerPoint.ParagraphFormat .

readonly paragraphFormat: PowerPoint.ParagraphFormat;

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

PowerPoint.ParagraphFormat

Комментарии

[ Набор API: PowerPointApi 1.4 ]

text

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

text: string;

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

string

Комментарии

[ Набор API: PowerPointApi 1.4 ]

Сведения о методе

getSubstring(start, length)

TextRange Возвращает объект для подстроки в заданном диапазоне.

getSubstring(start: number, length?: number): PowerPoint.TextRange;

Параметры

start

number

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

length

number

Необязательный параметр. Количество символов, возвращаемых в новом текстовом диапазоне. Если длина опущена, будут возвращены все символы от начала до конца последнего абзаца текстового диапазона.

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

PowerPoint.TextRange

Комментарии

[ Набор API: PowerPointApi 1.4 ]

load(options)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(options?: PowerPoint.Interfaces.TextRangeLoadOptions): PowerPoint.TextRange;

Параметры

options

PowerPoint.Interfaces.TextRangeLoadOptions

Предоставляет параметры свойств объекта для загрузки.

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

PowerPoint.TextRange

load(propertyNames)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNames?: string | string[]): PowerPoint.TextRange;

Параметры

propertyNames

string | string[]

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

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

PowerPoint.TextRange

load(propertyNamesAndPaths)

Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.TextRange;

Параметры

propertyNamesAndPaths

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

propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и propertyNamesAndPaths.expand строка с разделителями-запятыми, указывающая загружаемые свойства навигации.

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

PowerPoint.TextRange

toJSON()

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

toJSON(): PowerPoint.Interfaces.TextRangeData;

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

PowerPoint.Interfaces.TextRangeData