asposecells.api

Classes

Constants

Class Style

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.

Example:

# First method
excel = Workbook()
style = excel.createStyle()
style.getFont().setName("Times New Roman")
style.getFont().setColor(Color.getBlue())
for i in range(0, 100):
    excel.getWorksheets().get(0).getCells().get(0, i).setStyle(style)

# Second method
style1 = excel.getWorksheets().get(0).getCells().get("A1").getStyle()
style1.getFont().setName("Times New Roman")
style1.getFont().setColor(Color.getBlue())
excel.getWorksheets().get(0).getCells().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.

Constructor Summary
`Style()` Initializes a new instance of the Style class.

Property Getters/Setters Summary
`method`	`getBackgroundArgbColor()`
`method`	`setBackgroundArgbColor(value)`
	Gets and sets the background color with a 32-bit ARGB value.
`method`	`getBackgroundColor()`
`method`	`setBackgroundColor(value)`
	Gets or sets a style's background color.
`method`	`getBackgroundThemeColor()`
`method`	`setBackgroundThemeColor(value)`
	Gets and sets the background theme color.
`method`	`getBorders()`
	Gets the BorderCollection of the style.
`method`	`getCultureCustom()`
`method`	`setCultureCustom(value)`
	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.
`method`	`getCustom()`
`method`	`setCustom(value)`
	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.
`method`	`getFont()`
	Gets a Font object.
`method`	`getForegroundArgbColor()`
`method`	`setForegroundArgbColor(value)`
	Gets and sets the foreground color with a 32-bit ARGB value.
`method`	`getForegroundColor()`
`method`	`setForegroundColor(value)`
	Gets or sets a style's foreground color.
`method`	`getForegroundThemeColor()`
`method`	`setForegroundThemeColor(value)`
	Gets and sets the foreground theme color.
`method`	`hasBorders()`
	Checks whether there are borders have been set for the style.
`method`	`getHorizontalAlignment()`
`method`	`setHorizontalAlignment(value)`
	Gets or sets the horizontal alignment type of the text in a cell. The value of the property is TextAlignmentType integer constant.
`method`	`getIndentLevel()`
`method`	`setIndentLevel(value)`
	Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
`method`	`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.
`method`	`isAlignmentApplied()`
`method`	`setAlignmentApplied(value)`
	Indicate whether the alignment formatting should be applied.
`method`	`isBorderApplied()`
`method`	`setBorderApplied(value)`
	Indicate whether the border formatting should be applied.
`method`	`isDateTime()`
	Indicates whether the number format is a date format.
`method`	`isFillApplied()`
`method`	`setFillApplied(value)`
	Indicate whether the fill formatting should be applied.
`method`	`isFontApplied()`
`method`	`setFontApplied(value)`
	Indicate whether the font formatting should be applied.
`method`	`isFormulaHidden()`
`method`	`setFormulaHidden(value)`
	Represents if the formula will be hidden when the worksheet is protected.
`method`	`isGradient()`
`method`	`setGradient(value)`
	Indicates whether the cell shading is a gradient pattern.
`method`	`isJustifyDistributed()`
`method`	`setJustifyDistributed(value)`
	Indicates if the cells justified or distributed alignment should be used on the last line of text.
`method`	`isLocked()`
`method`	`setLocked(value)`
	Gets or sets a value indicating whether a cell can be modified or not.
`method`	`isNumberFormatApplied()`
`method`	`setNumberFormatApplied(value)`
	Indicate whether the number formatting should be applied.
`method`	`isPercent()`
	Indicates whether the number format is a percent format.
`method`	`isProtectionApplied()`
`method`	`setProtectionApplied(value)`
	Indicate whether the protection formatting should be applied.
`method`	`isTextWrapped()`
`method`	`setTextWrapped(value)`
	Gets or sets a value indicating whether the text within a cell is wrapped.
`method`	`getName()`
`method`	`setName(value)`
	Gets or sets the name of the style.
`method`	`getNumber()`
`method`	`setNumber(value)`
	Gets or sets the display format of numbers and dates. The formatting patterns are different for different regions.
`method`	`getParentStyle()`
	Gets the parent style of this style.
`method`	`getPattern()`
`method`	`setPattern(value)`
	Gets or sets the cell background pattern type. The value of the property is BackgroundType integer constant.
`method`	`getQuotePrefix()`
`method`	`setQuotePrefix(value)`
	Indicates whether the cell's value starts with single quote mark.
`method`	`getRotationAngle()`
`method`	`setRotationAngle(value)`
	Represents text rotation angle.
`method`	`getShrinkToFit()`
`method`	`setShrinkToFit(value)`
	Represents if text automatically shrinks to fit in the available column width.
`method`	`getTextDirection()`
`method`	`setTextDirection(value)`
	Represents text reading order. The value of the property is TextDirectionType integer constant.
`method`	`getVerticalAlignment()`
`method`	`setVerticalAlignment(value)`
	Gets or sets the vertical alignment type of the text in a cell. The value of the property is TextAlignmentType integer constant.

Method Summary
`method`	`copy(style)`
`method`	Copies data from another style object
`method`	`equals(obj)`
`method`	Determines whether two Style instances are equal.
`method`	`getTwoColorGradient()`
`method`	Get the two-color gradient setting.
`method`	`getTwoColorGradientSetting()`
`method`	Get the two-color gradient setting.
`method`	`hashCode()`
`method`	Serves as a hash function for a Style object.
`method`	`isModified(modifyFlag)`
`method`	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.
`method`	`setBorder(borderType, borderStyle, borderColor)`
`method`	Sets the borders of the style.
`method`	`setBorder(borderType, borderStyle, borderColor)`
`method`	Sets the borders of the style.
`method`	`setCustom(custom, builtinPreference)`
`method`	Sets the Custom number format string of a cell.
`method`	`setPatternColor(pattern, color1, color2)`
`method`	Sets the background color.
`method`	`setTwoColorGradient(color1, color2, gradientStyleType, variant)`
`method`	Sets the specified fill to a two-color gradient.
`method`	`toJson()`
`method`	Convert Style to JSON struct data.
`method`	`update()`
`method`	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.

Constructor Detail
- Style
```
Style()
```
  Initializes a new instance of the Style class.
  NOTE: This constructor is now obsolete. Instead, please use CellsFactory.CreateStyle() method. This property will be removed 6 months later since October 2016. Aspose apologizes for any inconvenience you may have experienced.

Property Getters/Setters Detail

getBackgroundThemeColor/setBackgroundThemeColor : ThemeColor
```
ThemeColor getBackgroundThemeColor() / setBackgroundThemeColor(value)
```
Gets and sets the background theme color.
If the background color is not a theme color, NULL will be returned.

getForegroundThemeColor/setForegroundThemeColor : ThemeColor
```
ThemeColor getForegroundThemeColor() / setForegroundThemeColor(value)
```
Gets and sets the foreground theme color.
If the foreground color is not a theme color, NULL will be returned.

getName/setName : String
```
String getName() / setName(value)
```
Gets or sets the name of the style.

getPattern/setPattern : int
```
int getPattern() / setPattern(value)
```
Gets or sets the cell background pattern type. The value of the property is BackgroundType integer constant.

getBorders : BorderCollection
```
BorderCollection getBorders()
```
Gets the BorderCollection of the style.

getBackgroundColor/setBackgroundColor : Color
```
Color getBackgroundColor() / setBackgroundColor(value)
```
Gets or sets a style's background color.
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/setBackgroundArgbColor : int
```
int getBackgroundArgbColor() / setBackgroundArgbColor(value)
```
Gets and sets the background color with a 32-bit ARGB value.

getForegroundColor/setForegroundColor : Color
```
Color getForegroundColor() / setForegroundColor(value)
```
Gets or sets a style's foreground color.
It means no color setting if Color.Empty is returned.

getForegroundArgbColor/setForegroundArgbColor : int
```
int getForegroundArgbColor() / setForegroundArgbColor(value)
```
Gets and sets the foreground color with a 32-bit ARGB value.

hasBorders : boolean
```
boolean hasBorders()
```
Checks whether there are borders have been set for the style.

getParentStyle : Style
```
Style getParentStyle()
```
Gets the parent style of this style.

isNumberFormatApplied/setNumberFormatApplied : boolean
```
boolean isNumberFormatApplied() / setNumberFormatApplied(value)
```
Indicate whether the number formatting should be applied.
Only for named style.

isFontApplied/setFontApplied : boolean
```
boolean isFontApplied() / setFontApplied(value)
```
Indicate whether the font formatting should be applied.
Only for named style.

isAlignmentApplied/setAlignmentApplied : boolean
```
boolean isAlignmentApplied() / setAlignmentApplied(value)
```
Indicate whether the alignment formatting should be applied.
Only for named style.

isBorderApplied/setBorderApplied : boolean
```
boolean isBorderApplied() / setBorderApplied(value)
```
Indicate whether the border formatting should be applied.
Only for named style.

isFillApplied/setFillApplied : boolean
```
boolean isFillApplied() / setFillApplied(value)
```
Indicate whether the fill formatting should be applied.
Only for named style.

isProtectionApplied/setProtectionApplied : boolean
```
boolean isProtectionApplied() / setProtectionApplied(value)
```
Indicate whether the protection formatting should be applied.
Only for named style.

getIndentLevel/setIndentLevel : int
```
int getIndentLevel() / setIndentLevel(value)
```
Represents the indent level for the cell or range. Can only be an integer from 0 to 250.
If text horizontal alignment type is set to value other than left or right, indent level will be reset to zero.

getFont : Font
```
Font getFont()
```
Gets a Font object.

getRotationAngle/setRotationAngle : int
```
int getRotationAngle() / setRotationAngle(value)
```
Represents text rotation angle.
0: Not rotated.
255: Top to Bottom.
-90: Downward.
90: Upward.
You can set 255 or value ranged from -90 to 90.

getHorizontalAlignment/setHorizontalAlignment : int
```
int getHorizontalAlignment() / setHorizontalAlignment(value)
```
Gets or sets the horizontal alignment type of the text in a cell. The value of the property is TextAlignmentType integer constant.

getVerticalAlignment/setVerticalAlignment : int
```
int getVerticalAlignment() / setVerticalAlignment(value)
```
Gets or sets the vertical alignment type of the text in a cell. The value of the property is TextAlignmentType integer constant.

isTextWrapped/setTextWrapped : boolean
```
boolean isTextWrapped() / setTextWrapped(value)
```
Gets or sets a value indicating whether the text within a cell is wrapped.

getNumber/setNumber : int

int getNumber() / setNumber(value)

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

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]($#,##0)`
7	Currency	`$#,##0.00_);($#,##0.00)`
8	Currency	`$#,##0.00_);[Red]($#,##0.00)`
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](#,##0)`
39	Accounting	`#,##0.00_);(#,##0.00)`
40	Accounting	`#,##0.00_);[Red](#,##0.00)`
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	`@`

isLocked/setLocked : boolean
```
boolean isLocked() / setLocked(value)
```
Gets or sets a value indicating whether a cell can be modified or not.
Locking cells has no effect unless the worksheet is protected.

getCustom/setCustom : String
```
String getCustom() / setCustom(value)
```
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.
The returned custom string is culture-independent.

getCultureCustom/setCultureCustom : String
```
String getCultureCustom() / setCultureCustom(value)
```
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.
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.

getInvariantCustom : String
```
String 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.
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/setFormulaHidden : boolean
```
boolean isFormulaHidden() / setFormulaHidden(value)
```
Represents if the formula will be hidden when the worksheet is protected.

getShrinkToFit/setShrinkToFit : boolean
```
boolean getShrinkToFit() / setShrinkToFit(value)
```
Represents if text automatically shrinks to fit in the available column width.

getTextDirection/setTextDirection : int
```
int getTextDirection() / setTextDirection(value)
```
Represents text reading order. The value of the property is TextDirectionType integer constant.

isJustifyDistributed/setJustifyDistributed : boolean
```
boolean isJustifyDistributed() / setJustifyDistributed(value)
```
Indicates if the cells justified or distributed alignment should be used on the last line of text.
This is typical for East Asian alignments but not typical in other contexts.

getQuotePrefix/setQuotePrefix : boolean
```
boolean getQuotePrefix() / setQuotePrefix(value)
```
Indicates whether the cell's value starts with single quote mark.

isGradient/setGradient : boolean
```
boolean isGradient() / setGradient(value)
```
Indicates whether the cell shading is a gradient pattern.

isPercent : boolean
```
boolean isPercent()
```
Indicates whether the number format is a percent format.

isDateTime : boolean
```
boolean isDateTime()
```
Indicates whether the number format is a date format.

Method Detail
- setTwoColorGradient
```
 setTwoColorGradient(color1, color2, gradientStyleType, variant)
```
  Sets the specified fill to a two-color gradient.
  Parameters:
  color1: Color - One gradient color.
  color2: Color - Two gradient color.
  gradientStyleType: int - A GradientStyleType value. Gradient shading style.
  variant: int - 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.
- getTwoColorGradient
```
Object[] getTwoColorGradient()
```
  Get the two-color gradient setting.
  If this is not gradient fill,return null; NOTE: This method is now obsolete. Instead, please use Style.GetTwoColorGradientSetting() method. This property will be removed 12 months later since December 2022. Aspose apologizes for any inconvenience you may have experienced.
  Returns:
  Returns all setting about two-color gradient [0] : Color1 [1] : Color2 [2] : GradientStyleType [3] : Variant
- getTwoColorGradientSetting
```
TwoColorGradient getTwoColorGradientSetting()
```
  Get the two-color gradient setting.
- toJson
```
String toJson()
```
  Convert Style to JSON struct data.
  Returns:
- setPatternColor
```
 setPatternColor(pattern, color1, color2)
```
  Sets the background color.
  Parameters:
  pattern: int - A BackgroundType value. The pattern.
  color1: Color - The foreground color.
  color2: Color - The background color. Only works when pattern is not BackgroundType.None and BackgroundType.Solid.
- copy
```
 copy(style)
```
  Copies data from another style object
  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.
  Parameters:
  style: Style - Source Style object
- update
```
 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
```
boolean isModified(modifyFlag)
```
  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.
  Parameters:
  modifyFlag: int - A StyleModifyFlag value. Style modified flags
  Returns:
  true if the specified properties have been modified
- equals
```
boolean equals(obj)
```
  Determines whether two Style instances are equal.
  Parameters:
  obj: Object - The Style object to compare with the current Style object.
  Returns:
  true if the specified Object is equal to the current Object; otherwise, false.
- hashCode
```
int hashCode()
```
  Serves as a hash function for a Style object.
  This method is only for internal use.
  Returns:
  A hash code for the current Object.
- setBorder
```
boolean setBorder(borderType, borderStyle, borderColor)
```
  Sets the borders of the style.
  Parameters:
  borderType: int - A BorderType value. The border(s) to be set, can be combination of BorderType.
  borderStyle: int - A CellBorderType value. The style of the border.
  borderColor: Color - The color of the border.
  Returns:
  Whether current border settings have been changed.
- setBorder
```
boolean setBorder(borderType, borderStyle, borderColor)
```
  Sets the borders of the style.
  Parameters:
  borderType: int - A BorderType value. The border(s) to be set, can be combination of BorderType.
  borderStyle: int - A CellBorderType value. The style of the border.
  borderColor: CellsColor - The color of the border.
  Returns:
  Whether current border settings have been changed.
- setCustom
```
 setCustom(custom, builtinPreference)
```
  Sets the Custom number format string of a cell.
  Parameters:
  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.

asposecells.api

Classes

Constants

Class Style

Constructor Detail

Style

Property Getters/Setters Detail

getBackgroundThemeColor/setBackgroundThemeColor : ThemeColor

getForegroundThemeColor/setForegroundThemeColor : ThemeColor

getName/setName : String

getPattern/setPattern : int

getBorders : BorderCollection

getBackgroundColor/setBackgroundColor : Color

getBackgroundArgbColor/setBackgroundArgbColor : int

getForegroundColor/setForegroundColor : Color

getForegroundArgbColor/setForegroundArgbColor : int

hasBorders : boolean

getParentStyle : Style

isNumberFormatApplied/setNumberFormatApplied : boolean

isFontApplied/setFontApplied : boolean

isAlignmentApplied/setAlignmentApplied : boolean

isBorderApplied/setBorderApplied : boolean

isFillApplied/setFillApplied : boolean

isProtectionApplied/setProtectionApplied : boolean

getIndentLevel/setIndentLevel : int

getFont : Font

getRotationAngle/setRotationAngle : int

getHorizontalAlignment/setHorizontalAlignment : int

getVerticalAlignment/setVerticalAlignment : int

isTextWrapped/setTextWrapped : boolean

getNumber/setNumber : int

isLocked/setLocked : boolean

getCustom/setCustom : String

getCultureCustom/setCultureCustom : String

getInvariantCustom : String

isFormulaHidden/setFormulaHidden : boolean

getShrinkToFit/setShrinkToFit : boolean

getTextDirection/setTextDirection : int

isJustifyDistributed/setJustifyDistributed : boolean

getQuotePrefix/setQuotePrefix : boolean

isGradient/setGradient : boolean

isPercent : boolean

isDateTime : boolean

Method Detail

setTwoColorGradient

getTwoColorGradient

getTwoColorGradientSetting

toJson

setPatternColor

copy

update

isModified

equals

hashCode

setBorder

setBorder

setCustom