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

Excel.TextFrame class

  • Ссылка
Пакет:
excel

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

Extends
OfficeExtension.ClientObject

Комментарии

[ Набор API: ExcelApi 1.9 ]

Свойства

autoSizeSetting

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

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

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

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

Представляет горизонтальное выравнивание рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextHorizontalAlignment статье.
horizontalOverflow

Представляет действие горизонтального переполнения рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextHorizontalOverflow статье.
leftMargin

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

Представляет угол, на который ориентирован текст для текстового фрейма. Дополнительные сведения см. в этой Excel.ShapeTextOrientation статье.
readingOrder

Представляет направление чтения рамки с текстом (слева направо или справа налево). Дополнительные сведения см. в этой Excel.ShapeTextReadingOrder статье.
rightMargin

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

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

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

Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextVerticalAlignment статье.
verticalOverflow

Представляет действие вертикального переполнения рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextVerticalOverflow статье.

Методы

deleteText()

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

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

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

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

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.
set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.
toJSON()

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

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

autoSizeSetting

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

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

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

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

Комментарии

[ Набор API: ExcelApi 1.9 ]

bottomMargin

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

bottomMargin: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

context

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

context: RequestContext;

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

Excel.RequestContext

hasText

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

readonly hasText: boolean;

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

boolean

Комментарии

[ Набор API: ExcelApi 1.9 ]

horizontalAlignment

Представляет горизонтальное выравнивание рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextHorizontalAlignment статье.

horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";

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

Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"

Комментарии

[ Набор API: ExcelApi 1.9 ]

horizontalOverflow

Представляет действие горизонтального переполнения рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextHorizontalOverflow статье.

horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";

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

Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"

Комментарии

[ Набор API: ExcelApi 1.9 ]

leftMargin

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

leftMargin: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

orientation

Представляет угол, на который ориентирован текст для текстового фрейма. Дополнительные сведения см. в этой Excel.ShapeTextOrientation статье.

orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";

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

Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"

Комментарии

[ Набор API: ExcelApi 1.9 ]

readingOrder

Представляет направление чтения рамки с текстом (слева направо или справа налево). Дополнительные сведения см. в этой Excel.ShapeTextReadingOrder статье.

readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";

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

Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"

Комментарии

[ Набор API: ExcelApi 1.9 ]

rightMargin

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

rightMargin: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

textRange

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

readonly textRange: Excel.TextRange;

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

Excel.TextRange

Комментарии

[ Набор API: ExcelApi 1.9 ]

topMargin

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

topMargin: number;

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

number

Комментарии

[ Набор API: ExcelApi 1.9 ]

verticalAlignment

Представляет вертикальное выравнивание для рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextVerticalAlignment статье.

verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";

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

Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"

Комментарии

[ Набор API: ExcelApi 1.9 ]

verticalOverflow

Представляет действие вертикального переполнения рамки с текстом. Дополнительные сведения см. в этой Excel.ShapeTextVerticalOverflow статье.

verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";

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

Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"

Комментарии

[ Набор API: ExcelApi 1.9 ]

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

deleteText()

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

deleteText(): void;

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

void

Комментарии

[ Набор API: ExcelApi 1.9 ]

Примеры

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-textboxes.yaml

await Excel.run(async (context) => {
    const shapes = context.workbook.worksheets.getItem("Shapes").shapes;
    const textbox = shapes.getItem("Textbox");
    textbox.textFrame.deleteText();
    await context.sync();
});

load(options)

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

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

Параметры

options
Excel.Interfaces.TextFrameLoadOptions

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

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

Excel.TextFrame

load(propertyNames)

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

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

Параметры

propertyNames

string | string[]

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

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

Excel.TextFrame

load(propertyNamesAndPaths)

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

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

Параметры

propertyNamesAndPaths

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

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

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

Excel.TextFrame

set(properties, options)

Задает несколько свойств объекта одновременно. Можно передать обычный объект с соответствующими свойствами или другой объект API того же типа.

set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;

Параметры

properties
Excel.Interfaces.TextFrameUpdateData

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

options
OfficeExtension.UpdateOptions

Предоставляет возможность подавления ошибок, если объект свойств пытается задать какие-либо свойства, доступные только для чтения.

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

void

set(properties)

Задает несколько свойств объекта одновременно на основе существующего загруженного объекта.

set(properties: Excel.TextFrame): void;

Параметры

properties
Excel.TextFrame

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

void

toJSON()

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

toJSON(): Excel.Interfaces.TextFrameData;

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

Excel.Interfaces.TextFrameData