通过

PowerPoint.TextFrame class

  • 参考
包:
powerpoint

表示形状对象的文本框。

扩展
OfficeExtension.ClientObject

注解

[ API 集：PowerPointApi 1.4 ]

属性

autoSizeSetting

文本框的自动调整大小设置。 可以将文本框设置为自动调整文本大小以适应文本框，或自动调整文本框大小以适应文本，或者不使用自动调整大小设置。
bottomMargin

表示文本框的下边距（以磅为单位）。
context

与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。
hasText

指定文本框是否包含文本。
leftMargin

表示文本框的左边距（以磅为单位）。
rightMargin

表示文本框的右边距（以磅为单位）。
textRange

表示附加到文本框中形状上的文本，以及用于操作文本的属性和方法。 有关详细信息，请参阅 PowerPoint.TextRange 。
topMargin

表示文本框的上边距（以磅为单位）。
verticalAlignment

表示文本框的垂直对齐方式。 有关详细信息，请参阅 PowerPoint.TextVerticalAlignment 。
wordWrap

确定是否自动换行以适合形状内的文本。

方法

deleteText()

删除文本框中的所有文本。
getParentShape()

返回包含此 TextFrame的父 PowerPoint.Shape 对象。
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()

返回包含此 TextFrame的父 PowerPoint.Shape 对象。

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