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;

Example

//First method
const { Workbook, Color } = AsposeCells;

var excel = new Workbook();
var style = excel.createStyle();
style.font.setName("Times New Roman");
style.font.setColor(Color.Blue);
for (var i = 0; i < 100; i++) {
    excel.worksheets.get(0).cells.get(0, i).setStyle(style);
}

//Second method
var style1 = excel.worksheets.get(0).cells.get("A1").getStyle();
style1.font.setName("Times New Roman");
style1.font.color = Color.Blue;
excel.worksheets.get(0).cells.get("A1").setStyle(style1);

//First method is a fast and efficient way to change several cell-formatting properties on multiple cells at the same time.
//If you want to change a single cell's style properties, second method can be used.

Properties

Property	Type	Description
backgroundThemeColor	ThemeColor	Gets and sets the background theme color.
foregroundThemeColor	ThemeColor	Gets and sets the foreground theme color.
name	string	Gets or sets the name of the style.
pattern	BackgroundType	Gets or sets the cell background pattern type.
borders	BorderCollection	Readonly. Gets the BorderCollection of the style.
backgroundColor	Color	Gets or sets a style’s background color.
backgroundArgbColor	number	Gets and sets the background color with a 32-bit ARGB value.
foregroundColor	Color	Gets or sets a style’s foreground color.
foregroundArgbColor	number	Gets and sets the foreground color with a 32-bit ARGB value.
hasBorders	boolean	Readonly. Checks whether there are borders have been set for the style.
parentStyle	Style	Readonly. Gets the parent style of this style.
isNumberFormatApplied	boolean	Indicate whether the number formatting should be applied.
isFontApplied	boolean	Indicate whether the font formatting should be applied.
isAlignmentApplied	boolean	Indicate whether the alignment formatting should be applied.
isBorderApplied	boolean	Indicate whether the border formatting should be applied.
isFillApplied	boolean	Indicate whether the fill formatting should be applied.
isProtectionApplied	boolean	Indicate whether the protection formatting should be applied.
indentLevel	number	Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
font	Font	Readonly. Gets a Font object.
rotationAngle	number	Represents text rotation angle.
horizontalAlignment	TextAlignmentType	Gets or sets the horizontal alignment type of the text in a cell.
verticalAlignment	TextAlignmentType	Gets or sets the vertical alignment type of the text in a cell.
isTextWrapped	boolean	Gets or sets a value indicating whether the text within a cell is wrapped.
number	number	Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.
isLocked	boolean	Gets or sets a value indicating whether a cell can be modified or not.
custom	string	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.
cultureCustom	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.
invariantCustom	string	Readonly. 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	boolean	Represents if the formula will be hidden when the worksheet is protected.
shrinkToFit	boolean	Represents if text automatically shrinks to fit in the available column width.
textDirection	TextDirectionType	Represents text reading order.
isJustifyDistributed	boolean	Indicates if the cells justified or distributed alignment should be used on the last line of text.
quotePrefix	boolean	Indicates whether the cell’s value starts with single quote mark.
isGradient	boolean	Indicates whether the cell shading is a gradient pattern.
isPercent	boolean	Readonly. Indicates whether the number format is a percent format.
isDateTime	boolean	Readonly. Indicates whether the number format is a date format.

Methods

Method	Description
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.
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.
equals(VObject)	Determines whether two Style instances are equal.
getHashCode()	Serves as a hash function for a Style object.

backgroundThemeColor

Gets and sets the background theme color.

backgroundThemeColor : ThemeColor;

Remarks

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

foregroundThemeColor

Gets and sets the foreground theme color.

foregroundThemeColor : ThemeColor;

Remarks

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

name

Gets or sets the name of the style.

name : string;

pattern

Gets or sets the cell background pattern type.

pattern : BackgroundType;

borders

Readonly. Gets the BorderCollection of the style.

borders : BorderCollection;

backgroundColor

Gets or sets a style’s background color.

backgroundColor : 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.

backgroundArgbColor

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

backgroundArgbColor : number;

foregroundColor

Gets or sets a style’s foreground color.

foregroundColor : Color;

Remarks

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

foregroundArgbColor

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

foregroundArgbColor : number;

hasBorders

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

hasBorders : boolean;

parentStyle

Readonly. Gets the parent style of this style.

parentStyle : Style;

isNumberFormatApplied

Indicate whether the number formatting should be applied.

isNumberFormatApplied : boolean;

Remarks

Only for named style.

isFontApplied

Indicate whether the font formatting should be applied.

isFontApplied : boolean;

Remarks

Only for named style.

isAlignmentApplied

Indicate whether the alignment formatting should be applied.

isAlignmentApplied : boolean;

Remarks

Only for named style.

isBorderApplied

Indicate whether the border formatting should be applied.

isBorderApplied : boolean;

Remarks

Only for named style.

isFillApplied

Indicate whether the fill formatting should be applied.

isFillApplied : boolean;

Remarks

Only for named style.

isProtectionApplied

Indicate whether the protection formatting should be applied.

isProtectionApplied : boolean;

Remarks

Only for named style.

indentLevel

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

indentLevel : number;

Remarks

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

font

Readonly. Gets a Font object.

font : Font;

rotationAngle

Represents text rotation angle.

rotationAngle : number;

Remarks

0: Not rotated.

255: Top to Bottom.

-90: Downward.

90: Upward.

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

horizontalAlignment

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

horizontalAlignment : TextAlignmentType;

verticalAlignment

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

verticalAlignment : TextAlignmentType;

isTextWrapped

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

isTextWrapped : boolean;

number

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

number : 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 @ </list

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.

custom

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.

custom : string;

Remarks

The returned custom string is culture-independent.

cultureCustom

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.

cultureCustom : 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.

invariantCustom

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

invariantCustom : 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;

shrinkToFit

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

shrinkToFit : boolean;

textDirection

Represents text reading order.

textDirection : TextDirectionType;

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.

quotePrefix

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

quotePrefix : boolean;

isGradient

Indicates whether the cell shading is a gradient pattern.

isGradient : boolean;

isPercent

Readonly. Indicates whether the number format is a percent format.

isPercent : boolean;

isDateTime

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

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;

equals(VObject)

Determines whether two Style instances are equal.

equals(obj: VObject) : boolean;

Parameters:

Parameter	Type	Description
obj	VObject	The Style object to compare with the current Style object.

Returns

true if the specified Object is equal to the current Object; otherwise, false.

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.