ExcelScript.ShapeLineFormat interface

Package:

ExcelScript

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

Methods

getColor()	Represents the line color in HTML color format, in the form #RRGGBB (e.g., "FFA500") or as a named HTML color (e.g., "orange").
getDashStyle()	Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent dash styles. See ExcelScript.ShapeLineDashStyle for details.
getStyle()	Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See ExcelScript.ShapeLineStyle for details.
getTransparency()	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.
getVisible()	Specifies if the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.
getWeight()	Represents the weight of the line, in points. Returns null when the line is not visible or there are inconsistent line weights.
setColor(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").
setDashStyle(dashStyle)	Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent dash styles. See ExcelScript.ShapeLineDashStyle for details.
setStyle(style)	Represents the line style of the shape. Returns null when the line is not visible or there are inconsistent styles. See ExcelScript.ShapeLineStyle for details.
setTransparency(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.
setVisible(visible)	Specifies if the line formatting of a shape element is visible. Returns null when the shape has inconsistent visibilities.
setWeight(weight)	Represents the weight of the line, in points. Returns null when the line is not visible or there are inconsistent line weights.

Method Details

getColor()

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

TypeScript

getColor(): string;

Returns

string

getDashStyle()

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

TypeScript

getDashStyle(): ShapeLineDashStyle;

Returns

ExcelScript.ShapeLineDashStyle

getStyle()

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

TypeScript

getStyle(): ShapeLineStyle;

Returns

ExcelScript.ShapeLineStyle

getTransparency()

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.

TypeScript

getTransparency(): number;

Returns

number

getVisible()

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

TypeScript

getVisible(): boolean;

Returns

boolean

getWeight()

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

TypeScript

getWeight(): number;

Returns

number

setColor(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").

TypeScript

setColor(color: string): void;

Parameters

color

string

Returns

void

setDashStyle(dashStyle)

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

TypeScript

setDashStyle(dashStyle: ShapeLineDashStyle): void;

Parameters

dashStyle

ExcelScript.ShapeLineDashStyle

Returns

void

setStyle(style)

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

TypeScript

setStyle(style: ShapeLineStyle): void;

Parameters

style

ExcelScript.ShapeLineStyle

Returns

void

setTransparency(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.

TypeScript

setTransparency(transparency: number): void;

Parameters

transparency

number

Returns

void

setVisible(visible)

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

TypeScript

setVisible(visible: boolean): void;

Parameters

visible

boolean

Returns

void

setWeight(weight)

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

TypeScript

setWeight(weight: number): void;

Parameters

weight

number

Returns

void