Excel.TextFrame class
Представляет текстовый фрейм объекта-фигуры.
- Extends
Свойства
| auto |
Автоматические параметры размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера. |
| bottom |
Представляет нижнее поле рамки с текстом (в пунктах). |
| context | Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office. |
| has |
Определяет, содержит ли текстовый фрейм текст. |
| horizontal |
Представляет горизонтальное выравнивание рамки с текстом. См. |
| horizontal |
Представляет действие горизонтального переполнения рамки с текстом. См. |
| left |
Представляет левое поле рамки с текстом (в пунктах). |
| orientation | Указывает угол, под которым текст ориентирован для текстового фрейма. См. |
| reading |
Представляет направление чтения рамки с текстом (слева направо или справа налево). См. |
| right |
Представляет правое поле рамки с текстом (в пунктах). |
| text |
Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. См. |
| top |
Представляет верхнее поле рамки с текстом (в пунктах). |
| vertical |
Представляет вертикальное выравнивание для рамки с текстом. См. |
| vertical |
Представляет действие вертикального переполнения рамки с текстом. См. |
Методы
| delete |
Удаляет весь текст в рамке с текстом. |
| load(options) | Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| load(property |
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод |
| set(properties, options) | Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа. |
| set(properties) | Одновременно задает несколько свойств объекта на основе существующего загруженного объекта. |
| toJSON() | Переопределяет метод JavaScript |
Сведения о свойстве
autoSizeSetting
Автоматические параметры размера текстового фрейма. Для рамки с текстом можно настроить автоматический подбор размера текста в соответствии с размером рамки, автоматический подбор размера рамки в соответствии с содержимым или не выполнять автоматический подбор размера.
autoSizeSetting: Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";Значение свойства
Excel.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"
Комментарии
bottomMargin
Представляет нижнее поле рамки с текстом (в пунктах).
bottomMargin: number;Значение свойства
number
Комментарии
context
Контекст запроса, связанный с объектом. Это соединяет процесс надстройки с процессом основного приложения Office.
context: RequestContext;Значение свойства
hasText
Определяет, содержит ли текстовый фрейм текст.
readonly hasText: boolean;Значение свойства
boolean
Комментарии
horizontalAlignment
Представляет горизонтальное выравнивание рамки с текстом. См. Excel.ShapeTextHorizontalAlignment дополнительные сведения.
horizontalAlignment: Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed";Значение свойства
Excel.ShapeTextHorizontalAlignment | "Left" | "Center" | "Right" | "Justify" | "JustifyLow" | "Distributed" | "ThaiDistributed"
Комментарии
horizontalOverflow
Представляет действие горизонтального переполнения рамки с текстом. См. Excel.ShapeTextHorizontalOverflow дополнительные сведения.
horizontalOverflow: Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip";Значение свойства
Excel.ShapeTextHorizontalOverflow | "Overflow" | "Clip"
Комментарии
leftMargin
Представляет левое поле рамки с текстом (в пунктах).
leftMargin: number;Значение свойства
number
Комментарии
orientation
Указывает угол, под которым текст ориентирован для текстового фрейма. См. Excel.ShapeTextOrientation дополнительные сведения.
orientation: Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL";Значение свойства
Excel.ShapeTextOrientation | "Horizontal" | "Vertical" | "Vertical270" | "WordArtVertical" | "EastAsianVertical" | "MongolianVertical" | "WordArtVerticalRTL"
Комментарии
readingOrder
Представляет направление чтения рамки с текстом (слева направо или справа налево). См. Excel.ShapeTextReadingOrder дополнительные сведения.
readingOrder: Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft";Значение свойства
Excel.ShapeTextReadingOrder | "LeftToRight" | "RightToLeft"
Комментарии
rightMargin
Представляет правое поле рамки с текстом (в пунктах).
rightMargin: number;Значение свойства
number
Комментарии
textRange
Представляет текст, присоединенный к фигуре в текстовой рамке, а также свойства и методы для операций с текстом. См. Excel.TextRange дополнительные сведения.
readonly textRange: Excel.TextRange;Значение свойства
Комментарии
topMargin
Представляет верхнее поле рамки с текстом (в пунктах).
topMargin: number;Значение свойства
number
Комментарии
verticalAlignment
Представляет вертикальное выравнивание для рамки с текстом. См. Excel.ShapeTextVerticalAlignment дополнительные сведения.
verticalAlignment: Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed";Значение свойства
Excel.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom" | "Justified" | "Distributed"
Комментарии
verticalOverflow
Представляет действие вертикального переполнения рамки с текстом. См. Excel.ShapeTextVerticalOverflow дополнительные сведения.
verticalOverflow: Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip";Значение свойства
Excel.ShapeTextVerticalOverflow | "Overflow" | "Ellipsis" | "Clip"
Комментарии
Сведения о методе
deleteText()
Удаляет весь текст в рамке с текстом.
deleteText(): void;Возвращаемое значение
void
Комментарии
Примеры
// 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;Параметры
Предоставляет параметры для загружаемых свойств объекта.
Возвращаемое значение
load(propertyNames)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNames?: string | string[]): Excel.TextFrame;Параметры
- propertyNames
-
string | string[]
Строка с разделителями-запятыми или массив строк, которые определяют свойства для загрузки.
Возвращаемое значение
load(propertyNamesAndPaths)
Добавляет в очередь команду для загрузки указанных свойств объекта. Перед чтением свойств требуется вызвать метод context.sync().
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Excel.TextFrame;Параметры
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select — это строка с разделителями-запятыми, указывающая загружаемые свойства, и строка propertyNamesAndPaths.expand через запятую, указывающая свойства навигации для загрузки.
Возвращаемое значение
set(properties, options)
Задает несколько свойств объекта одновременно. Вы можете передать либо простой объект с соответствующими свойствами, либо другой объект API того же типа.
set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;Параметры
- properties
- Excel.Interfaces.TextFrameUpdateData
Объект JavaScript со свойствами, структурированными изоморфно свойствам объекта, для которого вызывается метод.
- options
- OfficeExtension.UpdateOptions
Предоставляет возможность подавления ошибок, если объект properties пытается задать какие-либо свойства только для чтения.
Возвращаемое значение
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;