Excel.Interfaces.RangeFormatLoadOptions interface

Package:

excel

A format object encapsulating the range's font, fill, borders, alignment, and other properties.

Remarks

[ API set: ExcelApi 1.1 ]

Properties

$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).
borders	Collection of border objects that apply to the overall range.
fill	Returns the fill object defined on the overall range.
font	Returns the font object defined on the overall range.
horizontalAlignment	Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details.
verticalAlignment	Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details.
wrapText	Specifies if Excel wraps the text in the object. A null value indicates that the entire range doesn't have a uniform wrap setting

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

borders

Collection of border objects that apply to the overall range.

borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;

Property Value

Excel.Interfaces.RangeBorderCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

fill

Returns the fill object defined on the overall range.

fill?: Excel.Interfaces.RangeFillLoadOptions;

Property Value

Excel.Interfaces.RangeFillLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

font

Returns the font object defined on the overall range.

font?: Excel.Interfaces.RangeFontLoadOptions;

Property Value

Excel.Interfaces.RangeFontLoadOptions

Remarks

[ API set: ExcelApi 1.1 ]

horizontalAlignment

Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details.

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

verticalAlignment

Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]

wrapText

Specifies if Excel wraps the text in the object. A null value indicates that the entire range doesn't have a uniform wrap setting

wrapText?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.1 ]