Edit

Excel.Interfaces.ShapeLineFormatLoadOptions interface

  • Reference
Package:
excel

Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.

Remarks

[ API set: ExcelApi 1.9 ]

Properties

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
color

Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
dashStyle

Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent dash styles. See Excel.ShapeLineDashStyle for details.
style

Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See Excel.ShapeLineStyle for details.
transparency

Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.
visible

Specifies if the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.
weight

Represents the weight of the line, in points. Returns null when the line is not visible or there are inconsistent line weights.

Property Details

$all

Specifying $all for the LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).

$all?: boolean;

Property Value

boolean

color

Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").

color?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

dashStyle

Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent dash styles. See Excel.ShapeLineDashStyle for details.

dashStyle?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

style

Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See Excel.ShapeLineStyle for details.

style?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

transparency

Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns null when the shape has inconsistent transparencies.

transparency?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

visible

Specifies if the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.

visible?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

weight

Represents the weight of the line, in points. Returns null when the line is not visible or there are inconsistent line weights.

weight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]