Excel.TextFrame class

表示形状对象的文本框。

扩展

注解

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

属性值

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;

属性值

注解

[ 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

提供要加载对象的属性的选项。

返回

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;

返回