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 LoadOptions loads all the scalar properties (e.g.: Range.address) but not the navigational properties (e.g.: Range.format.fill.color).
borders	Collection of border objects that apply to the overall range.
columnWidth	Specifies the width of all columns within the range. If the column widths are not uniform, null will be returned.
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.
protection	Returns the format protection object for a range.
rowHeight	The height of all rows in the range. If the row heights are not uniform, null will be returned.
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 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

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 ]

columnWidth

Specifies the width of all columns within the range. If the column widths are not uniform, null will be returned.

columnWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.2 ]

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 ]

protection

Returns the format protection object for a range.

protection?: Excel.Interfaces.FormatProtectionLoadOptions;

Property Value

Excel.Interfaces.FormatProtectionLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]

rowHeight

The height of all rows in the range. If the row heights are not uniform, null will be returned.

rowHeight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.2 ]

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 ]