Excel.Interfaces.StyleCollectionLoadOptions interface

Package:

excel

Represents a collection of all the styles.

Remarks

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

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

For EACH ITEM in the collection: Specifies if text is automatically indented when the text alignment in a cell is set to equal distribution.

autoIndent?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

borders

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the style is a built-in style.

builtIn?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

fill

For EACH ITEM in the collection: The fill of the style.

fill?: Excel.Interfaces.RangeFillLoadOptions;

Property Value

Excel.Interfaces.RangeFillLoadOptions

Remarks

[ API set: ExcelApi 1.7 ]

font

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the formula will be hidden when the worksheet is protected.

formulaHidden?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

horizontalAlignment

For EACH ITEM in the collection: Represents the horizontal alignment for the style. See Excel.HorizontalAlignment for details.

horizontalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includeAlignment

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the style includes the number format property.

includeNumber?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

includePatterns

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the style includes the formula hidden and locked protection properties.

includeProtection?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

indentLevel

For EACH ITEM in the collection: 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

For EACH ITEM in the collection: Specifies if the object is locked when the worksheet is protected.

locked?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

name

For EACH ITEM in the collection: The name of the style.

name?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

numberFormat

For EACH ITEM in the collection: The format code of the number format for the style.

numberFormat?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

numberFormatLocal

For EACH ITEM in the collection: The localized format code of the number format for the style.

numberFormatLocal?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

readingOrder

For EACH ITEM in the collection: The reading order for the style.

readingOrder?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

shrinkToFit

For EACH ITEM in the collection: Specifies if text automatically shrinks to fit in the available column width.

shrinkToFit?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

textOrientation

For EACH ITEM in the collection: The text orientation for the style.

textOrientation?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.8 ]

verticalAlignment

For EACH ITEM in the collection: Specifies the vertical alignment for the style. See Excel.VerticalAlignment for details.

verticalAlignment?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]

wrapText

For EACH ITEM in the collection: Specifies if Excel wraps the text in the object.

wrapText?: boolean;

Property Value

boolean

Remarks

[ API set: ExcelApi 1.7 ]