aspose.cells

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:

$workbook = new cells\Workbook();
$cell = $workbook->getWorksheets()->get(0)->getCells()->get("A1");
$style1 = $cell->getStyle();
$style1->getFont()->setName("Times New Roman");
$style1->getFont()->setColor(cells\Color::getBlue());
$cell->setStyle($style1);

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

getIndentLevel/setIndentLevel : Number
```
function getIndentLevel() / function 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
```
function getFont()
```
Gets a Font object.

getRotationAngle/setRotationAngle : Number
```
function getRotationAngle() / function 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 : Number
```
function getHorizontalAlignment() / function 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 : Number
```
function getVerticalAlignment() / function 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
```
function isTextWrapped() / function setTextWrapped(value)
```
Gets or sets a value indicating whether the text within a cell is wrapped.

getNumber/setNumber : Number

function getNumber() / function 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
```
function isLocked() / function 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
```
function getCustom() / function 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
```
function getCultureCustom() / function 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
```
function 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
```
function isFormulaHidden() / function setFormulaHidden(value)
```
Represents if the formula will be hidden when the worksheet is protected.

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

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

isJustifyDistributed/setJustifyDistributed : boolean
```
function isJustifyDistributed() / function 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
```
function getQuotePrefix() / function setQuotePrefix(value)
```
Indicates whether the cell's value starts with single quote mark.

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

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

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

Method Detail
- setTwoColorGradient
```
function 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: Number - A GradientStyleType value. 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.
- getTwoColorGradient
```
function 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
```
function getTwoColorGradientSetting()
```
  Get the two-color gradient setting.
- toJson
```
function toJson()
```
  Convert Style to JSON struct data.
  Returns:
- setPatternColor
```
function setPatternColor(pattern, color1, color2)
```
  Sets the background color.
  Parameters:
  pattern: Number - 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
```
function 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
```
function 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
```
function 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: Number - A StyleModifyFlag value. Style modified flags
  Returns:
  true if the specified properties have been modified
- equals
```
function 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
```
function 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
```
function setBorder(borderType, borderStyle, borderColor)
```
  Sets the borders of the style.
  Parameters:
  borderType: Number - A BorderType value. The border(s) to be set, can be combination of BorderType.
  borderStyle: Number - A CellBorderType value. The style of the border.
  borderColor: Color - The color of the border.
  Returns:
  Whether current border settings have been changed.
- setBorder
```
function setBorder(borderType, borderStyle, borderColor)
```
  Sets the borders of the style.
  Parameters:
  borderType: Number - A BorderType value. The border(s) to be set, can be combination of BorderType.
  borderStyle: Number - A CellBorderType value. The style of the border.
  borderColor: CellsColor - The color of the border.
  Returns:
  Whether current border settings have been changed.
- setCustom
```
function 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.

aspose.cells

Classes

Constants

Class Style

Constructor Detail

Style

Property Getters/Setters Detail

getBackgroundThemeColor/setBackgroundThemeColor : ThemeColor

getForegroundThemeColor/setForegroundThemeColor : ThemeColor

getName/setName : String

getPattern/setPattern : Number

getBorders : BorderCollection

getBackgroundColor/setBackgroundColor : Color

getBackgroundArgbColor/setBackgroundArgbColor : Number

getForegroundColor/setForegroundColor : Color

getForegroundArgbColor/setForegroundArgbColor : Number

hasBorders : boolean

getParentStyle : Style

isNumberFormatApplied/setNumberFormatApplied : boolean

isFontApplied/setFontApplied : boolean

isAlignmentApplied/setAlignmentApplied : boolean

isBorderApplied/setBorderApplied : boolean

isFillApplied/setFillApplied : boolean

isProtectionApplied/setProtectionApplied : boolean

getIndentLevel/setIndentLevel : Number

getFont : Font

getRotationAngle/setRotationAngle : Number

getHorizontalAlignment/setHorizontalAlignment : Number

getVerticalAlignment/setVerticalAlignment : Number

isTextWrapped/setTextWrapped : boolean

getNumber/setNumber : Number

isLocked/setLocked : boolean

getCustom/setCustom : String

getCultureCustom/setCultureCustom : String

getInvariantCustom : String

isFormulaHidden/setFormulaHidden : boolean

getShrinkToFit/setShrinkToFit : boolean

getTextDirection/setTextDirection : Number

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