Excel.Interfaces.StyleLoadOptions interface

Package:

excel

An object encapsulating a style's format and other properties.

Remarks

[ API set: ExcelApi 1.7 ]

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	A collection of four border objects that represent the style of the four borders.
builtIn	Specifies if the style is a built-in style.
fill	The fill of the style.
font	A Font object that represents the font of the style.
formulaHidden	Specifies if the formula will be hidden when the worksheet is protected.
horizontalAlignment	Represents the horizontal alignment for the style. See Excel.HorizontalAlignment for details.
includeAlignment	Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.
includeBorder	Specifies if the style includes the color, color index, line style, and weight border properties.
includeFont	Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.
includeNumber	Specifies if the style includes the number format property.
includePatterns	Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.
includeProtection	Specifies if the style includes the formula hidden and locked protection properties.
indentLevel	An integer from 0 to 250 that indicates the indent level for the style.
locked	Specifies if the object is locked when the worksheet is protected.
name	The name of the style.
numberFormat	The format code of the number format for the style.
numberFormatLocal	The localized format code of the number format for the style.
readingOrder	The reading order for the style.
shrinkToFit	Specifies if text automatically shrinks to fit in the available column width.
verticalAlignment	Specifies the vertical alignment for the style. See Excel.VerticalAlignment for details.
wrapText	Specifies if Excel wraps the text in the object.

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

A collection of four border objects that represent the style of the four borders.

borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;

Property Value

Excel.Interfaces.RangeBorderCollectionLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

builtIn

Specifies if the style is a built-in style.

builtIn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

fill

The fill of the style.

fill?: Excel.Interfaces.RangeFillLoadOptions;

Property Value

Excel.Interfaces.RangeFillLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

font

A Font object that represents the font of the style.

font?: Excel.Interfaces.RangeFontLoadOptions;

Property Value

Excel.Interfaces.RangeFontLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

formulaHidden

Specifies if the formula will be hidden when the worksheet is protected.

formulaHidden?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

horizontalAlignment

Represents the horizontal alignment for the style. See Excel.HorizontalAlignment for details.

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includeAlignment

Specifies if the style includes the auto indent, horizontal alignment, vertical alignment, wrap text, indent level, and text orientation properties.

includeAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includeBorder

Specifies if the style includes the color, color index, line style, and weight border properties.

includeBorder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includeFont

Specifies if the style includes the background, bold, color, color index, font style, italic, name, size, strikethrough, subscript, superscript, and underline font properties.

includeFont?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includeNumber

Specifies if the style includes the number format property.

includeNumber?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includePatterns

Specifies if the style includes the color, color index, invert if negative, pattern, pattern color, and pattern color index interior properties.

includePatterns?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includeProtection

Specifies if the style includes the formula hidden and locked protection properties.

includeProtection?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

indentLevel

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

indentLevel?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

locked

Specifies if the object is locked when the worksheet is protected.

locked?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

name

The name of the style.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

numberFormat

The format code of the number format for the style.

numberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

numberFormatLocal

The localized format code of the number format for the style.

numberFormatLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

readingOrder

The reading order for the style.

readingOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

shrinkToFit

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

shrinkToFit?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

verticalAlignment

Specifies the vertical alignment for the style. See Excel.VerticalAlignment for details.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

wrapText

Specifies if Excel wraps the text in the object.

wrapText?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]