Excel.ShapeLineFormat class

Package:

excel

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

Extends

OfficeExtension.ClientObject

Remarks

[ API set: ExcelApi 1.9 ]

Properties

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").
context	The request context associated with the object. This connects the add-in's process to the Office host application's process.
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.

Methods

load(options)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNames)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
load(propertyNamesAndPaths)	Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.
set(properties, options)	Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.
set(properties)	Sets multiple properties on the object at the same time, based on an existing loaded object.
toJSON()	Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeLineFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeLineFormatData) that contains shallow copies of any loaded child properties from the original object.

Property Details

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: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.9 ]

context

The request context associated with the object. This connects the add-in's process to the Office host application's process.

context: RequestContext;

Property Value

Excel.RequestContext

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: Excel.ShapeLineDashStyle | "Dash" | "DashDot" | "DashDotDot" | "LongDash" | "LongDashDot" | "RoundDot" | "Solid" | "SquareDot" | "LongDashDotDot" | "SystemDash" | "SystemDot" | "SystemDashDot";

Property Value

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

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: Excel.ShapeLineStyle | "Single" | "ThickBetweenThin" | "ThickThin" | "ThinThick" | "ThinThin";

Property Value

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

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: number;

Property Value

number

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: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.9 ]

Method Details

load(options)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

options

Excel.Interfaces.ShapeLineFormatLoadOptions

Provides options for which properties of the object to load.

Returns

Excel.ShapeLineFormat

load(propertyNames)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNames

string | string[]

A comma-delimited string or an array of strings that specify the properties to load.

Returns

Excel.ShapeLineFormat

load(propertyNamesAndPaths)

Queues up a command to load the specified properties of the object. You must call context.sync() before reading the properties.

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

Parameters

propertyNamesAndPaths

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

propertyNamesAndPaths.select is a comma-delimited string that specifies the properties to load, and propertyNamesAndPaths.expand is a comma-delimited string that specifies the navigation properties to load.

Returns

Excel.ShapeLineFormat

set(properties, options)

Sets multiple properties of an object at the same time. You can pass either a plain object with the appropriate properties, or another API object of the same type.

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

Parameters

properties

Excel.Interfaces.ShapeLineFormatUpdateData

A JavaScript object with properties that are structured isomorphically to the properties of the object on which the method is called.

options

OfficeExtension.UpdateOptions

Provides an option to suppress errors if the properties object tries to set any read-only properties.

Returns

void

set(properties)

Sets multiple properties on the object at the same time, based on an existing loaded object.

set(properties: Excel.ShapeLineFormat): void;

Parameters

properties

Excel.ShapeLineFormat

Returns

void

toJSON()

Overrides the JavaScript toJSON() method in order to provide more useful output when an API object is passed to JSON.stringify(). (JSON.stringify, in turn, calls the toJSON method of the object that is passed to it.) Whereas the original Excel.ShapeLineFormat object is an API object, the toJSON method returns a plain JavaScript object (typed as Excel.Interfaces.ShapeLineFormatData) that contains shallow copies of any loaded child properties from the original object.

toJSON(): Excel.Interfaces.ShapeLineFormatData;

Returns

Excel.Interfaces.ShapeLineFormatData