PowerPoint.TextFrame class
表示形状对象的文本框。
- 扩展
注解
示例
// 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();
});
属性
| auto |
文本框的自动调整大小设置。 可以将文本框设置为自动调整文本大小以适应文本框，或自动调整文本框大小以适应文本，或者不使用自动调整大小设置。 |
| bottom |
表示文本框的下边距（以磅为单位）。 |
| context | 与 对象关联的请求上下文。 这会将加载项的进程连接到 Office 主机应用程序的进程。 |
| has |
指定文本框是否包含文本。 |
| left |
表示文本框的左边距（以磅为单位）。 |
| right |
表示文本框的右边距（以磅为单位）。 |
| text |
表示附加到文本框中形状上的文本，以及用于操作文本的属性和方法。 有关详细信息，请参阅 PowerPoint.TextRange 。 |
| top |
表示文本框的上边距（以磅为单位）。 |
| vertical |
表示文本框的垂直对齐方式。 有关详细信息，请参阅 PowerPoint.TextVerticalAlignment 。 |
| word |
确定是否自动换行以适合形状内的文本。 |
方法
| delete |
删除文本框中的所有文本。 |
| get |
返回包含此 |
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 重写 JavaScript |
属性详细信息
autoSizeSetting
文本框的自动调整大小设置。 可以将文本框设置为自动调整文本大小以适应文本框，或自动调整文本框大小以适应文本，或者不使用自动调整大小设置。
autoSizeSetting: PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed";属性值
PowerPoint.ShapeAutoSize | "AutoSizeNone" | "AutoSizeTextToFitShape" | "AutoSizeShapeToFitText" | "AutoSizeMixed"
注解
bottomMargin
context
hasText
leftMargin
rightMargin
textRange
表示附加到文本框中形状上的文本，以及用于操作文本的属性和方法。 有关详细信息，请参阅 PowerPoint.TextRange 。
readonly textRange: PowerPoint.TextRange;属性值
注解
topMargin
verticalAlignment
表示文本框的垂直对齐方式。 有关详细信息，请参阅 PowerPoint.TextVerticalAlignment 。
verticalAlignment: PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered";属性值
PowerPoint.TextVerticalAlignment | "Top" | "Middle" | "Bottom" | "TopCentered" | "MiddleCentered" | "BottomCentered"
注解
wordWrap
方法详细信息
deleteText()
getParentShape()
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: PowerPoint.Interfaces.TextFrameLoadOptions): PowerPoint.TextFrame;参数
提供要加载对象的属性的选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): PowerPoint.TextFrame;参数
- propertyNames
-
string | string[]
逗号分隔的字符串或指定要加载的属性的字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.TextFrame;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。
返回
toJSON()
重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。
JSON.stringify
(，反过来又调用toJSON传递给它的 对象的 方法。) 而原始PowerPoint.TextFrame对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.TextFrameData) ，其中包含原始对象中任何已加载子属性的浅表副本。
toJSON(): PowerPoint.Interfaces.TextFrameData;