PowerPoint.ShapeLineFormat class
表示形状对象的线条格式。 对于图像和几何形状，线条格式表示形状的边框。
注解
使用方
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
// Get the type of shape for every shape in the collection.
const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
shapes.load("type");
await context.sync();
// Change the dash style for shapes of the type `line`.
shapes.items.forEach((shape) => {
if (shape.type === PowerPoint.ShapeType.line) {
shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
}
});
await context.sync();
});
属性
| color | 以 HTML 颜色格式表示线条颜色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”) 。 |
| context | 与对象关联的请求上下文。 这将加载项的进程连接到 Office 主机应用程序的进程。 |
| dash |
表示线条的虚线样式。 当线条不可见或存在不一致的虚线样式时，返回 null。 有关详细信息，请参阅 PowerPoint.ShapeLineDashStyle 。 |
| style | 表示形状的线条样式。 当线条不可见或样式不一致时，返回 null。 有关详细信息，请参阅 PowerPoint.ShapeLineStyle 。 |
| transparency | 指定线条的透明度百分比，其值范围为 0.0 (不透明) 到 1.0 (透明) 。 当形状的透明度不一致时，返回 null。 |
| visible | 指定形状元素的线条格式是否可见。 当形状具有不一致的可见性时返回 |
| weight | 表示线条的粗细（以磅为单位）。 在线条不可见或线条粗细不一致时返回 |
方法
| load(options) | 将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| load(property |
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 |
| toJSON() | 覆盖 JavaScript |
属性详细信息
color
以 HTML 颜色格式表示线条颜色，形式 #RRGGBB (例如“FFA500”) 或命名 HTML 颜色 (例如“orange”) 。
color: string;属性值
string
注解
context
dashStyle
表示线条的虚线样式。 当线条不可见或存在不一致的虚线样式时，返回 null。 有关详细信息，请参阅 PowerPoint.ShapeLineDashStyle 。
dashStyle: PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";属性值
PowerPoint.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"
注解
示例
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/powerpoint/shapes/get-shapes-by-type.yaml
// Changes the dash style of every line in the slide.
await PowerPoint.run(async (context) => {
// Get the type of shape for every shape in the collection.
const shapes: PowerPoint.ShapeCollection = context.presentation.slides.getItemAt(0).shapes;
shapes.load("type");
await context.sync();
// Change the dash style for shapes of the type `line`.
shapes.items.forEach((shape) => {
if (shape.type === PowerPoint.ShapeType.line) {
shape.lineFormat.style = PowerPoint.ShapeLineStyle.thickThin;
shape.lineFormat.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
}
});
await context.sync();
});
style
表示形状的线条样式。 当线条不可见或样式不一致时，返回 null。 有关详细信息，请参阅 PowerPoint.ShapeLineStyle 。
style: PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";属性值
PowerPoint.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"
注解
transparency
指定线条的透明度百分比，其值范围为 0.0 (不透明) 到 1.0 (透明) 。 当形状的透明度不一致时，返回 null。
transparency: number;属性值
number
注解
visible
weight
方法详细信息
load(options)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;参数
为要加载的对象属性提供选项。
返回
load(propertyNames)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;参数
- propertyNames
-
string | string[]
指定要加载的属性的逗号分隔的字符串或字符串数组。
返回
load(propertyNamesAndPaths)
将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths?: {
select?: string;
expand?: string;
}): PowerPoint.ShapeLineFormat;参数
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select 是指定要加载的属性的逗号分隔字符串，以及 propertyNamesAndPaths.expand 指定要加载的导航属性的逗号分隔字符串。
返回
toJSON()
覆盖 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 (JSON.stringify反过来调用 toJSON 传递给它的对象的方法。) 虽然原始 PowerPoint.ShapeLineFormat 对象是 API 对象， toJSON 但该方法返回一个纯 JavaScript 对象， (类型化为 PowerPoint.Interfaces.ShapeLineFormatData) ，其中包含从原始对象加载的任何子属性的浅层副本。
toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;