Word.TextFrame class
表示 Word 的文本框架。形状对象。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Gets the text frame of the first text box in the main document.
const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
shape.load("textFrame");
await context.sync();
if (shape.isNullObject) {
console.log("No shapes with text boxes found in the main document.");
return;
}
console.log("Text frame of first text box:", shape.textFrame);
});
属性
| auto |
指定文本框架的自动调整大小设置。 可以将文本框设置为自动调整文本大小以适应文本框，或自动调整文本框大小以适应文本，或者不使用自动调整大小设置。 |
| bottom |
指定文本框架的下边距（以磅为单位）。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| has |
如果文本框包含文本，则返回 |
| left |
指定文本框架的左边距（以磅为单位）。 |
| no |
指定形状旋转时文本框中的文本是否不应旋转。 |
| orientation | 指定文本框架的方向角度。 有关详细信息，请参阅 |
| right |
指定文本框架的右边距（以磅为单位）。 |
| top |
指定文本框架的上边距（以磅为单位）。 |
| vertical |
指定文本框架的垂直对齐方式。 有关详细信息，请参阅 |
| word |
确定线条是否自动分行以适应形状内的文本。 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| set(properties, options) | 同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。 |
| set(properties) | 基于现有加载的对象，同时在对象上设置多个属性。 |
| toJSON() | 覆盖 JavaScript |
| track() | 根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 |
| untrack() | 释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 |
属性详细信息
autoSizeSetting
指定文本框架的自动调整大小设置。 可以将文本框设置为自动调整文本大小以适应文本框，或自动调整文本框大小以适应文本，或者不使用自动调整大小设置。
autoSizeSetting: Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed";属性值
Word.ShapeAutoSize | "None" | "TextToFitShape" | "ShapeToFitText" | "Mixed"
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Sets text frame properties of the first text box in the main document.
const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
shape.load("textFrame");
await context.sync();
if (shape.isNullObject) {
console.log("No shapes with text boxes found in the main document.");
return;
}
const textFrame: Word.TextFrame = shape.textFrame;
textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
textFrame.orientation = Word.ShapeTextOrientation.vertical270;
textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;
console.log("The first text box's text frame properties were updated:", textFrame);
});
bottomMargin
context
hasText
leftMargin
noTextRotation
orientation
指定文本框架的方向角度。 有关详细信息，请参阅 Word.ShapeTextOrientation。
orientation: Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed";属性值
Word.ShapeTextOrientation | "None" | "Horizontal" | "EastAsianVertical" | "Vertical270" | "Vertical" | "EastAsianHorizontalRotated" | "Mixed"
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Sets text frame properties of the first text box in the main document.
const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
shape.load("textFrame");
await context.sync();
if (shape.isNullObject) {
console.log("No shapes with text boxes found in the main document.");
return;
}
const textFrame: Word.TextFrame = shape.textFrame;
textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
textFrame.orientation = Word.ShapeTextOrientation.vertical270;
textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;
console.log("The first text box's text frame properties were updated:", textFrame);
});
rightMargin
topMargin
verticalAlignment
指定文本框架的垂直对齐方式。 有关详细信息，请参阅 Word.ShapeTextVerticalAlignment。
verticalAlignment: Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom";属性值
Word.ShapeTextVerticalAlignment | "Top" | "Middle" | "Bottom"
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/45-shapes/manage-shapes-text-boxes.yaml
await Word.run(async (context) => {
// Sets text frame properties of the first text box in the main document.
const shape: Word.Shape = context.document.body.shapes.getByTypes([Word.ShapeType.textBox]).getFirstOrNullObject();
shape.load("textFrame");
await context.sync();
if (shape.isNullObject) {
console.log("No shapes with text boxes found in the main document.");
return;
}
const textFrame: Word.TextFrame = shape.textFrame;
textFrame.verticalAlignment = Word.ShapeTextVerticalAlignment.bottom;
textFrame.orientation = Word.ShapeTextOrientation.vertical270;
textFrame.autoSizeSetting = Word.ShapeAutoSize.shapeToFitText;
console.log("The first text box's text frame properties were updated:", textFrame);
});
wordWrap
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: Word.Interfaces.TextFrameLoadOptions): Word.TextFrame;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): Word.TextFrame;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): Word.TextFrame;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
set(properties, options)
同时设置对象的多个属性。 可以传递具有相应属性的纯文本对象，也可以传递另一个相同类型的 API 对象。
set(properties: Interfaces.TextFrameUpdateData, options?: OfficeExtension.UpdateOptions): void;参数
- properties
- Word.Interfaces.TextFrameUpdateData
一个 JavaScript 对象，其属性与调用该方法的对象的属性同构结构。
- options
- OfficeExtension.UpdateOptions
提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止错误。
返回
void
set(properties)
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 Word.TextFrame 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 Word.Interfaces.TextFrameData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): Word.Interfaces.TextFrameData;返回
track()
根据文档中的相应更改来跟踪对象，以便进行自动调整。 此调用是 context.trackedObjects.add (thisObject) 的简写。 如果在调用中 .sync 使用此对象，并且在“.run”批处理的顺序执行之外使用此对象，并且在设置属性或对对象调用方法时收到“InvalidObjectPath”错误，则需要在首次创建对象时将对象添加到跟踪对象集合。 如果此对象是集合的一部分，您还应跟踪父集合。
track(): Word.TextFrame;返回
untrack()
释放与此对象关联的内存（如果先前已跟踪过）。 此调用是 context.trackedObjects.remove (thisObject) 的简写。 拥有许多跟踪对象会降低主机应用程序的速度，因此请在使用完毕后释放所添加的任何对象。 需要在内存释放生效之前调用 context.sync() 。
untrack(): Word.TextFrame;