Excel.Interfaces.RangeFormatData interface
An interface describing the data returned by calling rangeFormat.toJSON().
Properties
| auto |
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. |
| column |
Specifies the width of all columns within the range. If the column widths are not uniform, |
| fill | Returns the fill object defined on the overall range. |
| font | Returns the font object defined on the overall range. |
| horizontal |
Represents the horizontal alignment for the specified object. See |
| indent |
An integer from 0 to 250 that indicates the indent level. |
| protection | Returns the format protection object for a range. |
| reading |
The reading order for the range. |
| row |
The height of all rows in the range. If the row heights are not uniform, |
| shrink |
Specifies if text automatically shrinks to fit in the available column width. |
| text |
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 |
| use |
Determines if the row height of the |
| use |
Specifies if the column width of the |
| vertical |
Represents the vertical alignment for the specified object. See |
| wrap |
Specifies if Excel wraps the text in the object. A |
Property Details
autoIndent
Specifies if text is automatically indented when text alignment is set to equal distribution.
autoIndent?: boolean;Property Value
boolean
Remarks
borders
Collection of border objects that apply to the overall range.
borders?: Excel.Interfaces.RangeBorderData[];Property Value
Remarks
columnWidth
Specifies the width of all columns within the range. If the column widths are not uniform, null will be returned.
columnWidth?: number;Property Value
number
Remarks
fill
Returns the fill object defined on the overall range.
fill?: Excel.Interfaces.RangeFillData;Property Value
Remarks
font
Returns the font object defined on the overall range.
font?: Excel.Interfaces.RangeFontData;Property Value
Remarks
horizontalAlignment
Represents the horizontal alignment for the specified object. See Excel.HorizontalAlignment for details.
horizontalAlignment?: Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed";Property Value
Excel.HorizontalAlignment | "General" | "Left" | "Center" | "Right" | "Fill" | "Justify" | "CenterAcrossSelection" | "Distributed"
Remarks
indentLevel
An integer from 0 to 250 that indicates the indent level.
indentLevel?: number;Property Value
number
Remarks
protection
Returns the format protection object for a range.
protection?: Excel.Interfaces.FormatProtectionData;Property Value
Remarks
readingOrder
The reading order for the range.
readingOrder?: Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft";Property Value
Excel.ReadingOrder | "Context" | "LeftToRight" | "RightToLeft"
Remarks
rowHeight
The height of all rows in the range. If the row heights are not uniform, null will be returned.
rowHeight?: number;Property Value
number
Remarks
shrinkToFit
Specifies if text automatically shrinks to fit in the available column width.
shrinkToFit?: boolean;Property Value
boolean
Remarks
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?: number;Property Value
number
Remarks
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
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
verticalAlignment
Represents the vertical alignment for the specified object. See Excel.VerticalAlignment for details.
verticalAlignment?: Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed";Property Value
Excel.VerticalAlignment | "Top" | "Center" | "Bottom" | "Justify" | "Distributed"
Remarks
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
Office Add-ins
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for