Edit

Share via

Excel.Interfaces.RangeFormatLoadOptions interface

  • Reference
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).
autoIndent

Specifies if text is automatically indented when text alignment is set to equal distribution.
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.
indentLevel

An integer from 0 to 250 that indicates the indent level.
protection

Returns the format protection object for a range.
readingOrder

The reading order for the range.
rowHeight

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

Specifies if text automatically shrinks to fit in the available column width.
textOrientation

The text orientation of all the cells within the range. The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then null will be returned.
useStandardHeight

Determines if the row height of the Range object equals the standard height of the sheet. Returns true if the row height of the Range object equals the standard height of the sheet. Returns null if the range contains more than one row and the rows aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.
useStandardWidth

Specifies if the column width of the Range object equals the standard width of the sheet. Returns true if the column width of the Range object equals the standard width of the sheet. Returns null if the range contains more than one column and the columns aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.
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

autoIndent

Specifies if text is automatically indented when text alignment is set to equal distribution.

autoIndent?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

indentLevel

An integer from 0 to 250 that indicates the indent level.

indentLevel?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

protection

Returns the format protection object for a range.

protection?: Excel.Interfaces.FormatProtectionLoadOptions;

Property Value

Excel.Interfaces.FormatProtectionLoadOptions

Remarks

[ API set: ExcelApi 1.2 ]

readingOrder

The reading order for the range.

readingOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

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 ]

shrinkToFit

Specifies if text automatically shrinks to fit in the available column width.

shrinkToFit?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.9 ]

textOrientation

The text orientation of all the cells within the range. The text orientation should be an integer either from -90 to 90, or 180 for vertically-oriented text. If the orientation within a range are not uniform, then null will be returned.

textOrientation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

useStandardHeight

Determines if the row height of the Range object equals the standard height of the sheet. Returns true if the row height of the Range object equals the standard height of the sheet. Returns null if the range contains more than one row and the rows aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.

useStandardHeight?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

useStandardWidth

Specifies if the column width of the Range object equals the standard width of the sheet. Returns true if the column width of the Range object equals the standard width of the sheet. Returns null if the range contains more than one column and the columns aren't all the same height. Returns false otherwise. Note: This property is only intended to be set to true. Setting it to false has no effect.

useStandardWidth?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

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 ]