Excel.Interfaces.StyleLoadOptions interface

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

[ API set: ExcelApi 1.7 ]

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

autoIndent

Indicates if text is automatically indented when the text alignment in a cell is set to equal distribution.

[ API set: ExcelApi 1.8 ]

borders

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

[ API set: ExcelApi 1.7 ]

builtIn

Indicates if the style is a built-in style.

[ API set: ExcelApi 1.7 ]

fill

The Fill of the style.

[ API set: ExcelApi 1.7 ]

font

A Font object that represents the font of the style.

[ API set: ExcelApi 1.7 ]

formulaHidden

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

[ API set: ExcelApi 1.7 ]

horizontalAlignment

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

[ API set: ExcelApi 1.7 ]

includeAlignment

Indicates if the style includes the AutoIndent, HorizontalAlignment, VerticalAlignment, WrapText, IndentLevel, and TextOrientation properties.

[ API set: ExcelApi 1.7 ]

includeBorder

Indicates if the style includes the Color, ColorIndex, LineStyle, and Weight border properties.

[ API set: ExcelApi 1.7 ]

includeFont

Indicates if the style includes the Background, Bold, Color, ColorIndex, FontStyle, Italic, Name, Size, Strikethrough, Subscript, Superscript, and Underline font properties.

[ API set: ExcelApi 1.7 ]

includeNumber

Indicates if the style includes the NumberFormat property.

[ API set: ExcelApi 1.7 ]

includePatterns

Indicates if the style includes the Color, ColorIndex, InvertIfNegative, Pattern, PatternColor, and PatternColorIndex interior properties.

[ API set: ExcelApi 1.7 ]

includeProtection

Indicates if the style includes the FormulaHidden and Locked protection properties.

[ API set: ExcelApi 1.7 ]

indentLevel

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

[ API set: ExcelApi 1.7 ]

locked

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

[ API set: ExcelApi 1.7 ]

name

The name of the style.

[ API set: ExcelApi 1.7 ]

numberFormat

The format code of the number format for the style.

[ API set: ExcelApi 1.7 ]

numberFormatLocal

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

[ API set: ExcelApi 1.7 ]

readingOrder

The reading order for the style.

[ API set: ExcelApi 1.7 ]

shrinkToFit

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

[ API set: ExcelApi 1.7 ]

textOrientation

The text orientation for the style.

[ API set: ExcelApi 1.8 ]

verticalAlignment

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

[ API set: ExcelApi 1.7 ]

wrapText

Indicates if Microsoft Excel wraps the text in the object.

[ API set: ExcelApi 1.7 ]

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

autoIndent

Indicates if text is automatically indented when the text alignment in a cell is set to equal distribution.

[ API set: ExcelApi 1.8 ]

autoIndent?: boolean;

Property Value

boolean

borders

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

[ API set: ExcelApi 1.7 ]

borders?: Excel.Interfaces.RangeBorderCollectionLoadOptions;

Property Value

builtIn

Indicates if the style is a built-in style.

[ API set: ExcelApi 1.7 ]

builtIn?: boolean;

Property Value

boolean

fill

The Fill of the style.

[ API set: ExcelApi 1.7 ]

fill?: Excel.Interfaces.RangeFillLoadOptions;

Property Value

font

A Font object that represents the font of the style.

[ API set: ExcelApi 1.7 ]

font?: Excel.Interfaces.RangeFontLoadOptions;

Property Value

formulaHidden

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

[ API set: ExcelApi 1.7 ]

formulaHidden?: boolean;

Property Value

boolean

horizontalAlignment

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

[ API set: ExcelApi 1.7 ]

horizontalAlignment?: boolean;

Property Value

boolean

includeAlignment

Indicates if the style includes the AutoIndent, HorizontalAlignment, VerticalAlignment, WrapText, IndentLevel, and TextOrientation properties.

[ API set: ExcelApi 1.7 ]

includeAlignment?: boolean;

Property Value

boolean

includeBorder

Indicates if the style includes the Color, ColorIndex, LineStyle, and Weight border properties.

[ API set: ExcelApi 1.7 ]

includeBorder?: boolean;

Property Value

boolean

includeFont

Indicates if the style includes the Background, Bold, Color, ColorIndex, FontStyle, Italic, Name, Size, Strikethrough, Subscript, Superscript, and Underline font properties.

[ API set: ExcelApi 1.7 ]

includeFont?: boolean;

Property Value

boolean

includeNumber

Indicates if the style includes the NumberFormat property.

[ API set: ExcelApi 1.7 ]

includeNumber?: boolean;

Property Value

boolean

includePatterns

Indicates if the style includes the Color, ColorIndex, InvertIfNegative, Pattern, PatternColor, and PatternColorIndex interior properties.

[ API set: ExcelApi 1.7 ]

includePatterns?: boolean;

Property Value

boolean

includeProtection

Indicates if the style includes the FormulaHidden and Locked protection properties.

[ API set: ExcelApi 1.7 ]

includeProtection?: boolean;

Property Value

boolean

indentLevel

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

[ API set: ExcelApi 1.7 ]

indentLevel?: boolean;

Property Value

boolean

locked

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

[ API set: ExcelApi 1.7 ]

locked?: boolean;

Property Value

boolean

name

The name of the style.

[ API set: ExcelApi 1.7 ]

name?: boolean;

Property Value

boolean

numberFormat

The format code of the number format for the style.

[ API set: ExcelApi 1.7 ]

numberFormat?: boolean;

Property Value

boolean

numberFormatLocal

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

[ API set: ExcelApi 1.7 ]

numberFormatLocal?: boolean;

Property Value

boolean

readingOrder

The reading order for the style.

[ API set: ExcelApi 1.7 ]

readingOrder?: boolean;

Property Value

boolean

shrinkToFit

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

[ API set: ExcelApi 1.7 ]

shrinkToFit?: boolean;

Property Value

boolean

textOrientation

The text orientation for the style.

[ API set: ExcelApi 1.8 ]

textOrientation?: boolean;

Property Value

boolean

verticalAlignment

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

[ API set: ExcelApi 1.7 ]

verticalAlignment?: boolean;

Property Value

boolean

wrapText

Indicates if Microsoft Excel wraps the text in the object.

[ API set: ExcelApi 1.7 ]

wrapText?: boolean;

Property Value

boolean