Excel.ShapeLineFormat class

  • 参考
包:
excel

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

Extends
OfficeExtension.ClientObject

注解

[ API 集：ExcelApi 1.9 ]

属性

color

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

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

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

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

将指定线条的透明度表示为从 0.0（不透明）到 1.0（清晰）的值。 null当形状的透明度不一致时返回 。
visible

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

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

方法

load(options)

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

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

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

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。
set(properties)

基于现有的已加载对象，同时对对象设置多个属性。
toJSON()

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

属性详细信息

color

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

color: string;

属性值

string

注解

[ API 集：ExcelApi 1.9 ]

context

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

context: RequestContext;

属性值

Excel.RequestContext

dashStyle

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

dashStyle: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

属性值

Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot"

注解

[ API 集：ExcelApi 1.9 ]

style

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

style: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

属性值

Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin"

注解

[ API 集：ExcelApi 1.9 ]

transparency

将指定线条的透明度表示为从 0.0（不透明）到 1.0（清晰）的值。 null当形状的透明度不一致时返回 。

transparency: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

visible

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

visible: boolean;

属性值

boolean

注解

[ API 集：ExcelApi 1.9 ]

weight

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

weight: number;

属性值

number

注解

[ API 集：ExcelApi 1.9 ]

方法详细信息

load(options)

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

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

参数

options
Excel.Interfaces.ShapeLineFormatLoadOptions

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

返回

Excel.ShapeLineFormat

load(propertyNames)

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

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

参数

propertyNames

string | string[]

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

返回

Excel.ShapeLineFormat

load(propertyNamesAndPaths)

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

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

参数

propertyNamesAndPaths

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

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

返回

Excel.ShapeLineFormat

set(properties, options)

同时设置对象的多个属性。 可以传递具有相应属性的纯对象，也可以传递同一类型的另一个 API 对象。

set(properties: Interfaces.ShapeLineFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

参数

properties
Excel.Interfaces.ShapeLineFormatUpdateData

一个 JavaScript 对象，其属性按同构方式构造为调用方法的对象的属性。

options
OfficeExtension.UpdateOptions

提供一个选项，用于在 properties 对象尝试设置任何只读属性时禁止显示错误。

返回

void

set(properties)

基于现有的已加载对象，同时对对象设置多个属性。

set(properties: Excel.ShapeLineFormat): void;

参数

properties
Excel.ShapeLineFormat

返回

void

toJSON()

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

toJSON(): Excel.Interfaces.ShapeLineFormatData;

返回

Excel.Interfaces.ShapeLineFormatData