PowerPoint.TextRange class

Пакет:: powerpoint

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

Extends: OfficeExtension.ClientObject

// 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` Возвращает объект , представляющий атрибуты шрифта для текстового диапазона.
hyperlinks	Возвращает коллекцию гиперссылок, которые существуют в этом `TextRange`объекте .
length	Возвращает или задает длину диапазона, который он `TextRange` представляет. `InvalidArgument` Создает исключение, если задано отрицательное значение или значение больше длины доступного текста из начальной точки.
paragraphFormat	Представляет формат абзаца текстового диапазона. Дополнительные сведения см. в разделе PowerPoint.ParagraphFormat .
start	Возвращает или задает отсчитываемый от нуля индекс относительно родительского текстового фрейма для начальной позиции диапазона, который он `TextRange` представляет. `InvalidArgument` Создает исключение, если задано отрицательное значение или значение больше длины текста.
text	Представляет содержимое с обычным текстом в диапазоне текста.

Методы

getParentTextFrame()	Возвращает родительский объект PowerPoint.TextFrame , содержащий этот `TextRange`объект .
getSubstring(start, length)	`TextRange` Возвращает объект для подстроки в заданном диапазоне.
load(options)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNames)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
load(propertyNamesAndPaths)	Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод `context.sync()`.
setHyperlink(options)	Задает гиперссылку для этого `TextRange` объекта с указанными параметрами. При этом будут удалены все существующие гиперссылки на этом объекте `TextRange`.
setSelected()	Выбирает его `TextRange` в текущем представлении.
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

Примеры

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

hyperlinks

Примечание

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

Возвращает коллекцию гиперссылок, которые существуют в этом TextRangeобъекте .

readonly hyperlinks: PowerPoint.HyperlinkScopedCollection;

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

PowerPoint.HyperlinkScopedCollection

length

Возвращает или задает длину диапазона, который он TextRange представляет. InvalidArgument Создает исключение, если задано отрицательное значение или значение больше длины доступного текста из начальной точки.

length: number;

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

number

paragraphFormat

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

readonly paragraphFormat: PowerPoint.ParagraphFormat;

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

PowerPoint.ParagraphFormat

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/text/get-set-textrange.yaml

// Gets navigational (complex) properties of the selected text range.
await PowerPoint.run(async (context) => {
  const textRange: PowerPoint.TextRange = context.presentation.getSelectedTextRange();
  textRange.load("font,paragraphFormat/bulletFormat,paragraphFormat/horizontalAlignment");
  await context.sync();

  console.log("Font properties of selected text range:");
  console.log(`\tallCaps: ${textRange.font.allCaps}`);
  console.log(`\tbold: ${textRange.font.bold}`);
  console.log(`\tcolor: ${textRange.font.color}`);
  console.log(`\tdoubleStrikethrough: ${textRange.font.doubleStrikethrough}`);
  console.log(`\titalic: ${textRange.font.italic}`);
  console.log(`\tname: ${textRange.font.name}`);
  console.log(`\tsize: ${textRange.font.size}`);
  console.log(`\tsmallCaps: ${textRange.font.smallCaps}`);
  console.log(`\tstrikethrough: ${textRange.font.strikethrough}`);
  console.log(`\tsubscript: ${textRange.font.subscript}`);
  console.log(`\tsuperscript: ${textRange.font.superscript}`);
  console.log(`\tunderline: ${textRange.font.underline}`);

  console.log("Paragraph format properties of selected text range:");
  console.log(`\tbulletFormat.visible: ${textRange.paragraphFormat.bulletFormat.visible}`);
  console.log(`\thorizontalAlignment: ${textRange.paragraphFormat.horizontalAlignment}`);
});

start

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

start: number;

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

number

text

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

text: string;

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

string

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

getParentTextFrame()

Возвращает родительский объект PowerPoint.TextFrame , содержащий этот TextRangeобъект .

getParentTextFrame(): PowerPoint.TextFrame;

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

PowerPoint.TextFrame

getSubstring(start, length)

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

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

Параметры

start: number

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

length: number

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

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

PowerPoint.TextRange

load(options)

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

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

Параметры

options: PowerPoint.Interfaces.TextRangeLoadOptions

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

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

PowerPoint.TextRange

load(propertyNames)

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

Параметры

propertyNames: string | string[]

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

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

PowerPoint.TextRange

load(propertyNamesAndPaths)

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

Параметры

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

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

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

PowerPoint.TextRange

setHyperlink(options)

Примечание

Задает гиперссылку для этого TextRange объекта с указанными параметрами. При этом будут удалены все существующие гиперссылки на этом объекте TextRange.

setHyperlink(options?: PowerPoint.HyperlinkAddOptions): PowerPoint.Hyperlink;

Параметры

options: PowerPoint.HyperlinkAddOptions

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

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

PowerPoint.Hyperlink

Только что созданный объект PowerPoint.Hyperlink .

setSelected()

Выбирает его TextRange в текущем представлении.

setSelected(): void;

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

void

Примеры

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

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

PowerPoint.Interfaces.TextRangeData

Обратная связь

Была ли эта страница полезна?

Поделиться через

PowerPoint.TextRange class

Комментарии

Примеры

Свойства

Методы

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

context

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

font

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

Комментарии

Примеры

hyperlinks

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

Комментарии

length

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

Комментарии

paragraphFormat

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

Комментарии

Примеры

start

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

Комментарии

text

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

Комментарии

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

getParentTextFrame()

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

Комментарии

getSubstring(start, length)

Параметры

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

Комментарии

load(options)

Параметры

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

load(propertyNames)

Параметры

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

load(propertyNamesAndPaths)

Параметры

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

setHyperlink(options)

Параметры

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

Комментарии

setSelected()

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

Комментарии

Примеры

toJSON()

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

Обратная связь