通过

PowerPoint.ShapeLineFormat class

  • 参考
包:
powerpoint

表示形状对象的线条格式。 对于图像和几何形状，线条格式表示形状的边框。

扩展
OfficeExtension.ClientObject

注解

[ API 集：PowerPointApi 1.4 ]

示例

// 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 = 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.dashStyle = PowerPoint.ShapeLineDashStyle.dashDot;
    }
  });
  await context.sync();
});

属性

color

表示 HTML 颜色格式的线条颜色，格式 #RRGGBB (例如“FFA500”) 或命名的 HTML 颜色 (例如“orange”) 。
context

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

表示线条的短划线样式。 当线条不可见或短划线样式不一致时，返回 null。 有关详细信息，请参阅 PowerPoint.ShapeLineDashStyle。
style

表示形状的线条样式。 当线条不可见或样式不一致时，返回 null。 有关详细信息，请参阅 PowerPoint.ShapeLineStyle。
transparency

将行的透明度百分比指定为从 0.0 (不透明) 到 1.0 (清除) 的值。 当形状的透明度不一致时，返回 null。
visible

指定形状元素的线条格式是否可见。 null当形状的可见性不一致时返回 。
weight

表示线条的粗细（以磅为单位）。 null当线条不可见或线条粗细不一致时返回 。

方法

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。
toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始PowerPoint.ShapeLineFormat对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.ShapeLineFormatData) ，其中包含原始对象中任何已加载子属性的浅表副本。

属性详细信息

color

表示 HTML 颜色格式的线条颜色，格式 #RRGGBB (例如“FFA500”) 或命名的 HTML 颜色 (例如“orange”) 。

color: string;

属性值

string

注解

[ API 集：PowerPointApi 1.4 ]

context

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

context: RequestContext;

属性值

PowerPoint.RequestContext

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"

注解

[ API 集：PowerPointApi 1.4 ]

示例

// 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 = 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.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"

注解

[ API 集：PowerPointApi 1.4 ]

transparency

将行的透明度百分比指定为从 0.0 (不透明) 到 1.0 (清除) 的值。 当形状的透明度不一致时，返回 null。

transparency: number;

属性值

number

注解

[ API 集：PowerPointApi 1.4 ]

visible

指定形状元素的线条格式是否可见。 null当形状的可见性不一致时返回 。

visible: boolean;

属性值

boolean

注解

[ API 集：PowerPointApi 1.4 ]

weight

表示线条的粗细（以磅为单位）。 null当线条不可见或线条粗细不一致时返回 。

weight: number;

属性值

number

注解

[ API 集：PowerPointApi 1.4 ]

方法详细信息

load(options)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(options?: PowerPoint.Interfaces.ShapeLineFormatLoadOptions): PowerPoint.ShapeLineFormat;

参数

options
PowerPoint.Interfaces.ShapeLineFormatLoadOptions

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

返回

PowerPoint.ShapeLineFormat

load(propertyNames)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNames?: string | string[]): PowerPoint.ShapeLineFormat;

参数

propertyNames

string | string[]

逗号分隔的字符串或指定要加载的属性的字符串数组。

返回

PowerPoint.ShapeLineFormat

load(propertyNamesAndPaths)

将命令加入队列以加载对象的指定属性。 阅读属性前必须先调用 context.sync()。

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): PowerPoint.ShapeLineFormat;

参数

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select 是一个逗号分隔的字符串，指定要加载的属性，是 propertyNamesAndPaths.expand 一个逗号分隔的字符串，指定要加载的导航属性。

返回

PowerPoint.ShapeLineFormat

toJSON()

重写 JavaScript toJSON() 方法，以便在将 API 对象传递给 JSON.stringify()时提供更有用的输出。 JSON.stringify (，反过来又调用toJSON传递给它的 对象的 方法。) 而原始PowerPoint.ShapeLineFormat对象是 API 对象，toJSON该方法返回一个纯 JavaScript 对象， (类型为 PowerPoint.Interfaces.ShapeLineFormatData) ，其中包含原始对象中任何已加载子属性的浅表副本。

toJSON(): PowerPoint.Interfaces.ShapeLineFormatData;

返回

PowerPoint.Interfaces.ShapeLineFormatData