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

PowerPoint.TextFrame 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

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

Свойства

autoSizeSetting

Параметры автоматического изменения размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера.
bottomMargin

Представляет нижнее поле рамки с текстом (в пунктах).
context

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

Указывает, содержит ли текстовый фрейм текст.
leftMargin

Представляет левое поле рамки с текстом (в пунктах).
rightMargin

Представляет правое поле рамки с текстом (в пунктах).
textRange

Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. Дополнительные сведения см. в разделе PowerPoint.TextRange .
topMargin

Представляет верхнее поле рамки с текстом (в пунктах).
verticalAlignment

Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в статье PowerPoint.TextVerticalAlignment .
wordWrap

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

Методы

deleteText()

Удаляет весь текст в рамке с текстом.
getParentShape()

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

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

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

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

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

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

autoSizeSetting

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

autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";

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

PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"

Комментарии

[ Набор API: PowerPointApi 1.4 ]

bottomMargin

Представляет нижнее поле рамки с текстом (в пунктах).

bottomMargin: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

context

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

context: RequestContext;

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

PowerPoint.RequestContext

hasText

Указывает, содержит ли текстовый фрейм текст.

readonly hasText: boolean;

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

boolean

Комментарии

[ Набор API: PowerPointApi 1.4 ]

leftMargin

Представляет левое поле рамки с текстом (в пунктах).

leftMargin: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

rightMargin

Представляет правое поле рамки с текстом (в пунктах).

rightMargin: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

textRange

Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. Дополнительные сведения см. в разделе PowerPoint.TextRange .

readonly textRange: PowerPoint.TextRange;

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

PowerPoint.TextRange

Комментарии

[ Набор API: PowerPointApi 1.4 ]

topMargin

Представляет верхнее поле рамки с текстом (в пунктах).

topMargin: number;

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

number

Комментарии

[ Набор API: PowerPointApi 1.4 ]

verticalAlignment

Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в статье PowerPoint.TextVerticalAlignment .

verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";

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

PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"

Комментарии

[ Набор API: PowerPointApi 1.4 ]

wordWrap

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

wordWrap: boolean;

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

boolean

Комментарии

[ Набор API: PowerPointApi 1.4 ]

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

deleteText()

Удаляет весь текст в рамке с текстом.

deleteText(): void;

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

void

Комментарии

[ Набор API: PowerPointApi 1.4 ]

getParentShape()

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

getParentShape(): PowerPoint.Shape;

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

PowerPoint.Shape

Комментарии

[ Набор API: PowerPointApi 1.5 ]

load(options)

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

load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;

Параметры

options
PowerPoint.Interfaces.TextFrameLoadOptions

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

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

PowerPoint.TextFrame

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

PowerPoint.TextFrame

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

PowerPoint.TextFrame

toJSON()

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

toJSON(): PowerPoint.Interfaces.TextFrameData;

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

PowerPoint.Interfaces.TextFrameData