Excel.Interfaces.RangeFormatData interface

An interface describing the data returned by calling rangeFormat.toJSON().

Properties

autoIndent

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

[ API set: ExcelApi 1.9 ]

borders

Collection of border objects that apply to the overall range. Read-only.

[ API set: ExcelApi 1.1 ]

columnWidth

Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.

[ API set: ExcelApi 1.2 ]

fill

Returns the fill object defined on the overall range. Read-only.

[ API set: ExcelApi 1.1 ]

font

Returns the font object defined on the overall range. Read-only.

[ API set: ExcelApi 1.1 ]

horizontalAlignment

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

[ API set: ExcelApi 1.1 ]

indentLevel

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

[ API set: ExcelApi 1.9 ]

protection

Returns the format protection object for a range. Read-only.

[ API set: ExcelApi 1.2 ]

readingOrder

The reading order for the range.

[ API set: ExcelApi 1.9 ]

rowHeight

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

[ API set: ExcelApi 1.2 ]

shrinkToFit

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

[ API set: ExcelApi 1.9 ]

textOrientation

Gets or sets 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.

[ 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.

[ API set: ExcelApi 1.7 ]

useStandardWidth

Indicates whether 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.

[ API set: ExcelApi 1.7 ]

verticalAlignment

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

[ API set: ExcelApi 1.1 ]

wrapText

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

[ API set: ExcelApi 1.1 ]

Property Details

autoIndent

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

[ API set: ExcelApi 1.9 ]

autoIndent?: boolean;

Property Value

boolean

borders

Collection of border objects that apply to the overall range. Read-only.

[ API set: ExcelApi 1.1 ]

borders?: Excel.Interfaces.RangeBorderData[];

Property Value

columnWidth

Gets or sets the width of all colums within the range. If the column widths are not uniform, null will be returned.

[ API set: ExcelApi 1.2 ]

columnWidth?: number;

Property Value

number

fill

Returns the fill object defined on the overall range. Read-only.

[ API set: ExcelApi 1.1 ]

fill?: Excel.Interfaces.RangeFillData;

Property Value

font

Returns the font object defined on the overall range. Read-only.

[ API set: ExcelApi 1.1 ]

font?: Excel.Interfaces.RangeFontData;

Property Value

horizontalAlignment

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

[ API set: ExcelApi 1.1 ]

horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";

Property Value

Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"

indentLevel

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

[ API set: ExcelApi 1.9 ]

indentLevel?: number;

Property Value

number

protection

Returns the format protection object for a range. Read-only.

[ API set: ExcelApi 1.2 ]

protection?: Excel.Interfaces.FormatProtectionData;

Property Value

readingOrder

The reading order for the range.

[ API set: ExcelApi 1.9 ]

readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";

Property Value

Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"

rowHeight

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

[ API set: ExcelApi 1.2 ]

rowHeight?: number;

Property Value

number

shrinkToFit

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

[ API set: ExcelApi 1.9 ]

shrinkToFit?: boolean;

Property Value

boolean

textOrientation

Gets or sets 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.

[ API set: ExcelApi 1.7 ]

textOrientation?: number;

Property Value

number

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.

[ API set: ExcelApi 1.7 ]

useStandardHeight?: boolean;

Property Value

boolean

useStandardWidth

Indicates whether 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.

[ API set: ExcelApi 1.7 ]

useStandardWidth?: boolean;

Property Value

boolean

verticalAlignment

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

[ API set: ExcelApi 1.1 ]

verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";

Property Value

Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"

wrapText

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

[ API set: ExcelApi 1.1 ]

wrapText?: boolean;

Property Value

boolean