Style

Style class

Represents display style of excel document,such as font,color,alignment,border,etc. The Style object contains all style attributes (font, number format, alignment, and so on) as properties.

class Style;

Methods

Method	Description
getBackgroundThemeColor()	Gets and sets the background theme color.
setBackgroundThemeColor(ThemeColor)	Gets and sets the background theme color.
getForegroundThemeColor()	Gets and sets the foreground theme color.
setForegroundThemeColor(ThemeColor)	Gets and sets the foreground theme color.
getName()	Gets or sets the name of the style.
setName(string)	Gets or sets the name of the style.
getPattern()	Gets or sets the cell background pattern type.
setPattern(BackgroundType)	Gets or sets the cell background pattern type.
getBorders()	Gets the BorderCollection of the style.
getBackgroundColor()	Gets or sets a style’s background color.
setBackgroundColor(Color)	Gets or sets a style’s background color.
getBackgroundArgbColor()	Gets and sets the background color with a 32-bit ARGB value.
setBackgroundArgbColor(number)	Gets and sets the background color with a 32-bit ARGB value.
getForegroundColor()	Gets or sets a style’s foreground color.
setForegroundColor(Color)	Gets or sets a style’s foreground color.
getForegroundArgbColor()	Gets and sets the foreground color with a 32-bit ARGB value.
setForegroundArgbColor(number)	Gets and sets the foreground color with a 32-bit ARGB value.
getHasBorders()	Checks whether there are borders have been set for the style.
getParentStyle()	Gets the parent style of this style.
isNumberFormatApplied()	Indicate whether the number formatting should be applied.
setIsNumberFormatApplied(boolean)	Indicate whether the number formatting should be applied.
isFontApplied()	Indicate whether the font formatting should be applied.
setIsFontApplied(boolean)	Indicate whether the font formatting should be applied.
isAlignmentApplied()	Indicate whether the alignment formatting should be applied.
setIsAlignmentApplied(boolean)	Indicate whether the alignment formatting should be applied.
isBorderApplied()	Indicate whether the border formatting should be applied.
setIsBorderApplied(boolean)	Indicate whether the border formatting should be applied.
isFillApplied()	Indicate whether the fill formatting should be applied.
setIsFillApplied(boolean)	Indicate whether the fill formatting should be applied.
isProtectionApplied()	Indicate whether the protection formatting should be applied.
setIsProtectionApplied(boolean)	Indicate whether the protection formatting should be applied.
getIndentLevel()	Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
setIndentLevel(number)	Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
getFont()	Gets a Font object.
getRotationAngle()	Represents text rotation angle.
setRotationAngle(number)	Represents text rotation angle.
getHorizontalAlignment()	Gets or sets the horizontal alignment type of the text in a cell.
setHorizontalAlignment(TextAlignmentType)	Gets or sets the horizontal alignment type of the text in a cell.
getVerticalAlignment()	Gets or sets the vertical alignment type of the text in a cell.
setVerticalAlignment(TextAlignmentType)	Gets or sets the vertical alignment type of the text in a cell.
isTextWrapped()	Gets or sets a value indicating whether the text within a cell is wrapped.
setIsTextWrapped(boolean)	Gets or sets a value indicating whether the text within a cell is wrapped.
getNumber()	Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.
setNumber(number)	Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.
isLocked()	Gets or sets a value indicating whether a cell can be modified or not.
setIsLocked(boolean)	Gets or sets a value indicating whether a cell can be modified or not.
getCustom()	Represents the custom number format string of this style object. If the custom number format is not set(For example, the number format is builtin), "" will be returned.
getCultureCustom()	Gets and sets the culture-dependent pattern string for number format. If no number format has been set for this object, null will be returned. If number format is builtin, the pattern string corresponding to the builtin number will be returned.
setCultureCustom(string)	Gets and sets the culture-dependent pattern string for number format. If no number format has been set for this object, null will be returned. If number format is builtin, the pattern string corresponding to the builtin number will be returned.
getInvariantCustom()	Gets the culture-independent pattern string for number format. If no number format has been set for this object, null will be returned. If number format is builtin, the pattern string corresponding to the builtin number will be returned.
isFormulaHidden()	Represents if the formula will be hidden when the worksheet is protected.
setIsFormulaHidden(boolean)	Represents if the formula will be hidden when the worksheet is protected.
getShrinkToFit()	Represents if text automatically shrinks to fit in the available column width.
setShrinkToFit(boolean)	Represents if text automatically shrinks to fit in the available column width.
getTextDirection()	Represents text reading order.
setTextDirection(TextDirectionType)	Represents text reading order.
isJustifyDistributed()	Indicates if the cells justified or distributed alignment should be used on the last line of text.
setIsJustifyDistributed(boolean)	Indicates if the cells justified or distributed alignment should be used on the last line of text.
getQuotePrefix()	Indicates whether the cell’s value starts with single quote mark.
setQuotePrefix(boolean)	Indicates whether the cell’s value starts with single quote mark.
isGradient()	Indicates whether the cell shading is a gradient pattern.
setIsGradient(boolean)	Indicates whether the cell shading is a gradient pattern.
isPercent()	Indicates whether the number format is a percent format.
isDateTime()	Indicates whether the number format is a date format.
setPatternColor(BackgroundType, Color, Color)	Sets the background color.
copy(Style)	Copies data from another style object
update()	Apply the named style to the styles of the cells which use this named style. It works like clicking the “ok” button after you finished modifying the style. Only applies for named style.
isModified(StyleModifyFlag)	Checks whether the specified properties of the style have been modified. Used for style of ConditionalFormattings to check whether the specified properties of this style should be used when applying the ConditionalFormattings on a cell.
getHashCode()	Serves as a hash function for a Style object.
setBorder(BorderType, CellBorderType, Color)	Sets the borders of the style.
setBorder(BorderType, CellBorderType, CellsColor)	Sets the borders of the style.
setCustom(string, boolean)	Sets the Custom number format string of a cell.
setTwoColorGradient(Color, Color, GradientStyleType, number)	Sets the specified fill to a two-color gradient.
getTwoColorGradientSetting()	Get the two-color gradient setting.
toJson()	Convert Style to JSON struct data.

getBackgroundThemeColor()

Gets and sets the background theme color.

getBackgroundThemeColor() : ThemeColor;

Returns

ThemeColor

Remarks

If the background color is not a theme color, NULL will be returned.

setBackgroundThemeColor(ThemeColor)

Gets and sets the background theme color.

setBackgroundThemeColor(value: ThemeColor) : void;

Parameters:

Parameter	Type	Description
value	ThemeColor	The value to set.

Remarks

If the background color is not a theme color, NULL will be returned.

getForegroundThemeColor()

Gets and sets the foreground theme color.

getForegroundThemeColor() : ThemeColor;

Returns

ThemeColor

Remarks

If the foreground color is not a theme color, NULL will be returned.

setForegroundThemeColor(ThemeColor)

Gets and sets the foreground theme color.

setForegroundThemeColor(value: ThemeColor) : void;

Parameters:

Parameter	Type	Description
value	ThemeColor	The value to set.

Remarks

If the foreground color is not a theme color, NULL will be returned.

getName()

Gets or sets the name of the style.

getName() : string;

setName(string)

Gets or sets the name of the style.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getPattern()

Gets or sets the cell background pattern type.

getPattern() : BackgroundType;

Returns

BackgroundType

setPattern(BackgroundType)

Gets or sets the cell background pattern type.

setPattern(value: BackgroundType) : void;

Parameters:

Parameter	Type	Description
value	BackgroundType	The value to set.

getBorders()

Gets the BorderCollection of the style.

getBorders() : BorderCollection;

Returns

BorderCollection

getBackgroundColor()

Gets or sets a style’s background color.

getBackgroundColor() : Color;

Returns

Color

Remarks

If you want to set a cell’s color, please use Style.ForegroundColor property. Only if the cell style pattern is other than none or solid, this property will take effect.

setBackgroundColor(Color)

Gets or sets a style’s background color.

setBackgroundColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

Remarks

If you want to set a cell’s color, please use Style.ForegroundColor property. Only if the cell style pattern is other than none or solid, this property will take effect.

getBackgroundArgbColor()

Gets and sets the background color with a 32-bit ARGB value.

getBackgroundArgbColor() : number;

setBackgroundArgbColor(number)

Gets and sets the background color with a 32-bit ARGB value.

setBackgroundArgbColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getForegroundColor()

Gets or sets a style’s foreground color.

getForegroundColor() : Color;

Returns

Color

Remarks

It means no color setting if Color.Empty is returned.

setForegroundColor(Color)

Gets or sets a style’s foreground color.

setForegroundColor(value: Color) : void;

Parameters:

Parameter	Type	Description
value	Color	The value to set.

Remarks

It means no color setting if Color.Empty is returned.

getForegroundArgbColor()

Gets and sets the foreground color with a 32-bit ARGB value.

getForegroundArgbColor() : number;

setForegroundArgbColor(number)

Gets and sets the foreground color with a 32-bit ARGB value.

setForegroundArgbColor(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

getHasBorders()

Checks whether there are borders have been set for the style.

getHasBorders() : boolean;

getParentStyle()

Gets the parent style of this style.

getParentStyle() : Style;

Returns

Style

isNumberFormatApplied()

Indicate whether the number formatting should be applied.

isNumberFormatApplied() : boolean;

Remarks

Only for named style.

setIsNumberFormatApplied(boolean)

Indicate whether the number formatting should be applied.

setIsNumberFormatApplied(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for named style.

isFontApplied()

Indicate whether the font formatting should be applied.

isFontApplied() : boolean;

Remarks

Only for named style.

setIsFontApplied(boolean)

Indicate whether the font formatting should be applied.

setIsFontApplied(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for named style.

isAlignmentApplied()

Indicate whether the alignment formatting should be applied.

isAlignmentApplied() : boolean;

Remarks

Only for named style.

setIsAlignmentApplied(boolean)

Indicate whether the alignment formatting should be applied.

setIsAlignmentApplied(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for named style.

isBorderApplied()

Indicate whether the border formatting should be applied.

isBorderApplied() : boolean;

Remarks

Only for named style.

setIsBorderApplied(boolean)

Indicate whether the border formatting should be applied.

setIsBorderApplied(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for named style.

isFillApplied()

Indicate whether the fill formatting should be applied.

isFillApplied() : boolean;

Remarks

Only for named style.

setIsFillApplied(boolean)

Indicate whether the fill formatting should be applied.

setIsFillApplied(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for named style.

isProtectionApplied()

Indicate whether the protection formatting should be applied.

isProtectionApplied() : boolean;

Remarks

Only for named style.

setIsProtectionApplied(boolean)

Indicate whether the protection formatting should be applied.

setIsProtectionApplied(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Only for named style.

getIndentLevel()

Represents the indent level for the cell or range. Can only be an integer from 0 to 250.

getIndentLevel() : number;

Remarks

If text horizontal alignment type is set to value other than left or right, indent level will be reset to zero.

setIndentLevel(number)

Represents the indent level for the cell or range. Can only be an integer from 0 to 250.

setIndentLevel(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

If text horizontal alignment type is set to value other than left or right, indent level will be reset to zero.

getFont()

Gets a Font object.

getFont() : Font;

Returns

Font

getRotationAngle()

Represents text rotation angle.

getRotationAngle() : number;

Remarks

0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

You can set 255 or value ranged from -90 to 90.

setRotationAngle(number)

Represents text rotation angle.

setRotationAngle(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

You can set 255 or value ranged from -90 to 90.

getHorizontalAlignment()

Gets or sets the horizontal alignment type of the text in a cell.

getHorizontalAlignment() : TextAlignmentType;

Returns

TextAlignmentType

setHorizontalAlignment(TextAlignmentType)

Gets or sets the horizontal alignment type of the text in a cell.

setHorizontalAlignment(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

getVerticalAlignment()

Gets or sets the vertical alignment type of the text in a cell.

getVerticalAlignment() : TextAlignmentType;

Returns

TextAlignmentType

setVerticalAlignment(TextAlignmentType)

Gets or sets the vertical alignment type of the text in a cell.

setVerticalAlignment(value: TextAlignmentType) : void;

Parameters:

Parameter	Type	Description
value	TextAlignmentType	The value to set.

isTextWrapped()

Gets or sets a value indicating whether the text within a cell is wrapped.

isTextWrapped() : boolean;

setIsTextWrapped(boolean)

Gets or sets a value indicating whether the text within a cell is wrapped.

setIsTextWrapped(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getNumber()

Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.

getNumber() : number;

Remarks

For example, the formatting patterns represented by numbers for en_US region: Value Type Format String 0 General General 1 Decimal 0 2 Decimal 0.00 3 Decimal #,##0 4 Decimal #,##0.00 5 Currency $#,##0_);($#,##0) 6 Currency $#,##0_);Red 7 Currency $#,##0.00_);($#,##0.00) 8 Currency $#,##0.00_);Red 9 Percentage 0% 10 Percentage 0.00% 11 Scientific 0.00E+00 12 Fraction # ?/? 13 Fraction # ??/?? 14 Date m/d/yyyy 15 Date d-mmm-yy 16 Date d-mmm 17 Date mmm-yy 18 Time h:mm AM/PM 19 Time h:mm:ss AM/PM 20 Time h:mm 21 Time h:mm:ss 22 Time m/d/yyyy h:mm 37 Accounting #,##0_);(#,##0) 38 Accounting #,##0_);Red 39 Accounting #,##0.00_);(#,##0.00) 40 Accounting #,##0.00_);Red 41 Accounting (* #,##0);(* (#,##0);(* “-”);(@) 42 Currency ($* #,##0_);($* (#,##0);($* “-”);(@) 43 Accounting (* #,##0.00_);(* (#,##0.00);(* “-”??);(@) 44 Currency ($* #,##0.00_);($* (#,##0.00);($* “-”??);(@_) 45 Time mm:ss 46 Time [h]:mm:ss 47 Time mm:ss.0 48 Scientific ##0.0E+0 49 Text @

setNumber(number)

Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.

setNumber(value: number) : void;

Parameters:

Parameter	Type	Description
value	number	The value to set.

Remarks

isLocked()

Gets or sets a value indicating whether a cell can be modified or not.

isLocked() : boolean;

Remarks

Locking cells has no effect unless the worksheet is protected.

setIsLocked(boolean)

Gets or sets a value indicating whether a cell can be modified or not.

setIsLocked(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

Locking cells has no effect unless the worksheet is protected.

getCustom()

Represents the custom number format string of this style object. If the custom number format is not set(For example, the number format is builtin), "" will be returned.

getCustom() : string;

Remarks

The returned custom string is culture-independent.

getCultureCustom()

Gets and sets the culture-dependent pattern string for number format. If no number format has been set for this object, null will be returned. If number format is builtin, the pattern string corresponding to the builtin number will be returned.

getCultureCustom() : string;

Remarks

For builtin number format, both the pattern content(such as, one builtin date format is “m/d/y” for some locales, but for some other locales it becomes “d/m/y”) and the format specifier(such as, some locales is using character other than ‘y’ to represent the year part for date formatting) are culture-dependent; For user specified custom format, only format specifiers are changed according to the culture, other parts of the formatting pattern will not be modified.

setCultureCustom(string)

setCultureCustom(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

Remarks

getInvariantCustom()

Gets the culture-independent pattern string for number format. If no number format has been set for this object, null will be returned. If number format is builtin, the pattern string corresponding to the builtin number will be returned.

getInvariantCustom() : string;

Remarks

For builtin number formats, the returned pattern content is still culture-dependent, such as, for some locales it returns “m/d/y” and for some other locales it returns “d/m/y”. The difference from CultureCustom is(that is also what culture-independent means): the format specifiers and separators are kept as standard, such as ‘/’ will always be used as datetime separator and “y” will always be used as the “year” part no matter what other special character is used for the specific locale.

isFormulaHidden()

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

isFormulaHidden() : boolean;

setIsFormulaHidden(boolean)

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

setIsFormulaHidden(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getShrinkToFit()

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

getShrinkToFit() : boolean;

setShrinkToFit(boolean)

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

setShrinkToFit(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getTextDirection()

Represents text reading order.

getTextDirection() : TextDirectionType;

Returns

TextDirectionType

setTextDirection(TextDirectionType)

Represents text reading order.

setTextDirection(value: TextDirectionType) : void;

Parameters:

Parameter	Type	Description
value	TextDirectionType	The value to set.

isJustifyDistributed()

Indicates if the cells justified or distributed alignment should be used on the last line of text.

isJustifyDistributed() : boolean;

Remarks

This is typical for East Asian alignments but not typical in other contexts.

setIsJustifyDistributed(boolean)

Indicates if the cells justified or distributed alignment should be used on the last line of text.

setIsJustifyDistributed(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

Remarks

This is typical for East Asian alignments but not typical in other contexts.

getQuotePrefix()

Indicates whether the cell’s value starts with single quote mark.

getQuotePrefix() : boolean;

setQuotePrefix(boolean)

Indicates whether the cell’s value starts with single quote mark.

setQuotePrefix(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isGradient()

Indicates whether the cell shading is a gradient pattern.

isGradient() : boolean;

setIsGradient(boolean)

Indicates whether the cell shading is a gradient pattern.

setIsGradient(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

isPercent()

Indicates whether the number format is a percent format.

isPercent() : boolean;

isDateTime()

Indicates whether the number format is a date format.

isDateTime() : boolean;

setPatternColor(BackgroundType, Color, Color)

Sets the background color.

setPatternColor(pattern: BackgroundType, color1: Color, color2: Color) : void;

Parameters:

Parameter	Type	Description
pattern	BackgroundType	The pattern.
color1	Color	The foreground color.
color2	Color	The background color. Only works when pattern is not BackgroundType.None and BackgroundType.Solid.

copy(Style)

Copies data from another style object

copy(style: Style) : void;

Parameters:

Parameter	Type	Description
style	Style	Source Style object

Remarks

This method does not copy the name of the style. If you want to copy the name, please call the following codes after copying style: destStyle.Name = style.Name.

update()

Apply the named style to the styles of the cells which use this named style. It works like clicking the “ok” button after you finished modifying the style. Only applies for named style.

update() : void;

isModified(StyleModifyFlag)

Checks whether the specified properties of the style have been modified. Used for style of ConditionalFormattings to check whether the specified properties of this style should be used when applying the ConditionalFormattings on a cell.

isModified(modifyFlag: StyleModifyFlag) : boolean;

Parameters:

Parameter	Type	Description
modifyFlag	StyleModifyFlag	Style modified flags

Returns

true if the specified properties have been modified

getHashCode()

Serves as a hash function for a Style object.

getHashCode() : number;

Returns

A hash code for the current Object.

Remarks

This method is only for internal use.

setBorder(BorderType, CellBorderType, Color)

Sets the borders of the style.

setBorder(borderType: BorderType, borderStyle: CellBorderType, borderColor: Color) : boolean;

Parameters:

Parameter	Type	Description
borderType	BorderType	The border(s) to be set, can be combination of BorderType.
borderStyle	CellBorderType	The style of the border.
borderColor	Color	The color of the border.

Returns

Whether current border settings have been changed.

setBorder(BorderType, CellBorderType, CellsColor)

Sets the borders of the style.

setBorder(borderType: BorderType, borderStyle: CellBorderType, borderColor: CellsColor) : boolean;

Parameters:

Parameter	Type	Description
borderType	BorderType	The border(s) to be set, can be combination of BorderType.
borderStyle	CellBorderType	The style of the border.
borderColor	CellsColor	The color of the border.

Returns

Whether current border settings have been changed.

setCustom(string, boolean)

Sets the Custom number format string of a cell.

setCustom(custom: string, builtinPreference: boolean) : void;

Parameters:

Parameter	Type	Description
custom	string	Custom number format string, should be InvariantCulture pattern.
builtinPreference	boolean	If given Custom number format string matches one of the built-in number formats /// corresponding to current regional settings, whether set the number format as built-in instead of Custom.

setTwoColorGradient(Color, Color, GradientStyleType, number)

Sets the specified fill to a two-color gradient.

setTwoColorGradient(color1: Color, color2: Color, gradientStyleType: GradientStyleType, variant: number) : void;

Parameters:

Parameter	Type	Description
color1	Color	One gradient color.
color2	Color	Two gradient color.
gradientStyleType	GradientStyleType	Gradient shading style.
variant	number	The gradient variant. Can be a value from 1 through 4, corresponding to one of the four variants on the Gradient tab in the Fill Effects dialog box. If style is GradientStyle.FromCenter, the Variant argument can only be 1 or 2.

getTwoColorGradientSetting()

Get the two-color gradient setting.

getTwoColorGradientSetting() : TwoColorGradient;

Returns

TwoColorGradient

toJson()

Convert Style to JSON struct data.

toJson() : string;