Excel.Interfaces.ShapeLineFormatLoadOptions interface
Represents the line formatting for the shape object. For images and geometric shapes, line formatting represents the border of the shape.
Remarks
Properties
$all | Specifying |
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"). |
dash |
Represents the line style of the shape. Returns |
style | Represents the line style of the shape. Returns |
transparency | Represents the degree of transparency of the specified line as a value from 0.0 (opaque) through 1.0 (clear). Returns |
visible | Specifies if the line formatting of a shape element is visible. Returns |
weight | Represents the weight of the line, in points. Returns |
Property Details
$all
Specifying $all
for the load options loads all the scalar properties (such as Range.address
) but not the navigational properties (such as 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
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
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
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
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
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
Office Add-ins