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

```javascript
class Style;
```


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

## Methods

| Method | Description |
| --- | --- |
| [setPatternColor(BackgroundType, Color, Color)](#setPatternColor-backgroundtype-color-color-)| Sets the background color. |
| [copy(Style)](#copy-style-)| Copies data from another 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(StyleModifyFlag)](#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)](#setBorder-bordertype-cellbordertype-color-)| Sets the borders of the style. |
| [setBorder(BorderType, CellBorderType, CellsColor)](#setBorder-bordertype-cellbordertype-cellscolor-)| Sets the borders of the style. |
| [setOutlineBorders(CellBorderType, Color)](#setOutlineBorders-cellbordertype-color-)| Set the outline borders |
| [setOutlineBorders(CellBorderType, CellsColor)](#setOutlineBorders-cellbordertype-cellscolor-)| Set the outline borders |
| [setCustom(string, boolean)](#setCustom-string-boolean-)| Sets the Custom number format string of a cell. |
| [setTwoColorGradient(Color, Color, GradientStyleType, number)](#setTwoColorGradient-color-color-gradientstyletype-number-)| Sets the specified fill to a two-color gradient. |
| [getTwoColorGradientSetting()](#getTwoColorGradientSetting--)| Get the two-color gradient setting. |
| [toJson()](#toJson--)| Convert [Style](../style/) to JSON struct data. |
| [equals(VObject)](#equals-vobject-)| Determines whether two Style instances are equal. |
| [getHashCode()](#getHashCode--)| Serves as a hash function for a Style object. |


### backgroundThemeColor {#backgroundThemeColor--}

Gets and sets the background theme color.

```javascript
backgroundThemeColor : ThemeColor;
```


**Remarks**

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

### foregroundThemeColor {#foregroundThemeColor--}

Gets and sets the foreground theme color.

```javascript
foregroundThemeColor : ThemeColor;
```


**Remarks**

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

### name {#name--}

Gets or sets the name of the style.

```javascript
name : string;
```


### pattern {#pattern--}

Gets or sets the cell background pattern type.

```javascript
pattern : BackgroundType;
```


### borders {#borders--}

Readonly. Gets the [BorderCollection](../bordercollection/) of the style.

```javascript
borders : BorderCollection;
```


### backgroundColor {#backgroundColor--}

Gets or sets a style's background color.

```javascript
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 {#backgroundArgbColor--}

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

```javascript
backgroundArgbColor : number;
```


### foregroundColor {#foregroundColor--}

Gets or sets a style's foreground color.

```javascript
foregroundColor : Color;
```


**Remarks**

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

### foregroundArgbColor {#foregroundArgbColor--}

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

```javascript
foregroundArgbColor : number;
```


### hasBorders {#hasBorders--}

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

```javascript
hasBorders : boolean;
```


### parentStyle {#parentStyle--}

Readonly. Gets the parent style of this style.

```javascript
parentStyle : Style;
```


### isNumberFormatApplied {#isNumberFormatApplied--}

Indicate whether the number formatting should be applied.

```javascript
isNumberFormatApplied : boolean;
```


**Remarks**

Only for named style.

### isFontApplied {#isFontApplied--}

Indicate whether the font formatting should be applied.

```javascript
isFontApplied : boolean;
```


**Remarks**

Only for named style.

### isAlignmentApplied {#isAlignmentApplied--}

Indicate whether the alignment formatting should be applied.

```javascript
isAlignmentApplied : boolean;
```


**Remarks**

Only for named style.

### isBorderApplied {#isBorderApplied--}

Indicate whether the border formatting should be applied.

```javascript
isBorderApplied : boolean;
```


**Remarks**

Only for named style.

### isFillApplied {#isFillApplied--}

Indicate whether the fill formatting should be applied.

```javascript
isFillApplied : boolean;
```


**Remarks**

Only for named style.

### isProtectionApplied {#isProtectionApplied--}

Indicate whether the protection formatting should be applied.

```javascript
isProtectionApplied : boolean;
```


**Remarks**

Only for named style.

### indentLevel {#indentLevel--}

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

```javascript
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 {#font--}

Readonly. Gets a [Font](../font/) object.

```javascript
font : Font;
```


### rotationAngle {#rotationAngle--}

Represents text rotation angle.

```javascript
rotationAngle : number;
```


**Remarks**

0: Not rotated.</p> <p>255: Top to Bottom.</p> <p>-90: Downward.</p> <p>90: Upward.</p> You can set 255 or value ranged from -90 to 90.

### horizontalAlignment {#horizontalAlignment--}

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

```javascript
horizontalAlignment : TextAlignmentType;
```


### verticalAlignment {#verticalAlignment--}

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

```javascript
verticalAlignment : TextAlignmentType;
```


### isTextWrapped {#isTextWrapped--}

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

```javascript
isTextWrapped : boolean;
```


### number {#number--}

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

```javascript
number : number;
```


**Remarks**

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

### isLocked {#isLocked--}

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

```javascript
isLocked : boolean;
```


**Remarks**

Locking cells has no effect unless the worksheet is protected.

### custom {#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.

```javascript
custom : string;
```


**Remarks**

The returned custom string is culture-independent.

### cultureCustom {#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.

```javascript
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 {#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.

```javascript
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](../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 {#isFormulaHidden--}

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

```javascript
isFormulaHidden : boolean;
```


### shrinkToFit {#shrinkToFit--}

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

```javascript
shrinkToFit : boolean;
```


### textDirection {#textDirection--}

Represents text reading order.

```javascript
textDirection : TextDirectionType;
```


### isJustifyDistributed {#isJustifyDistributed--}

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

```javascript
isJustifyDistributed : boolean;
```


**Remarks**

This is typical for East Asian alignments but not typical in other contexts. Only works when distributed dorizontal alignment.

### quotePrefix {#quotePrefix--}

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

```javascript
quotePrefix : boolean;
```


### isGradient {#isGradient--}

Indicates whether the cell shading is a gradient pattern.

```javascript
isGradient : boolean;
```


### isPercent {#isPercent--}

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

```javascript
isPercent : boolean;
```


### isDateTime {#isDateTime--}

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

```javascript
isDateTime : boolean;
```


### isCheckBox {#isCheckBox--}

Indicates whether it's a style of check box

```javascript
isCheckBox : boolean;
```


### leftBorder {#leftBorder--}

Readonly. Gets the left border.

```javascript
leftBorder : Border;
```


### rightBorder {#rightBorder--}

Readonly. Gets the right border.

```javascript
rightBorder : Border;
```


### topBorder {#topBorder--}

Readonly. Gets the top border.

```javascript
topBorder : Border;
```


### bottomBorder {#bottomBorder--}

Readonly. Gets the bottom border.

```javascript
bottomBorder : Border;
```


### setPatternColor(BackgroundType, Color, Color) {#setPatternColor-backgroundtype-color-color-}

Sets the background color.

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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| pattern | [BackgroundType](../backgroundtype/) | The pattern. |
| color1 | [Color](../color/) | The foreground color. |
| color2 | [Color](../color/) | The background color. Only works when pattern is not BackgroundType.None and BackgroundType.Solid. |

### copy(Style) {#copy-style-}

Copies data from another style object

```javascript
copy(style: Style) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| style | [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() {#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.

```javascript
update() : void;
```


### isModified(StyleModifyFlag) {#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.

```javascript
isModified(modifyFlag: StyleModifyFlag) : boolean;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| modifyFlag | [StyleModifyFlag](../stylemodifyflag/) | Style modified flags |

**Returns**

true if the specified properties have been modified

### setBorder(BorderType, CellBorderType, Color) {#setBorder-bordertype-cellbordertype-color-}

Sets the borders of the style.

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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| borderType | [BorderType](../bordertype/) | The border(s) to be set, can be combination of [BorderType](../bordertype/). |
| borderStyle | [CellBorderType](../cellbordertype/) | The style of the border. |
| borderColor | [Color](../color/) | The color of the border. |

**Returns**

Whether current border settings have been changed.

### setBorder(BorderType, CellBorderType, CellsColor) {#setBorder-bordertype-cellbordertype-cellscolor-}

Sets the borders of the style.

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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| borderType | [BorderType](../bordertype/) | The border(s) to be set, can be combination of [BorderType](../bordertype/). |
| borderStyle | [CellBorderType](../cellbordertype/) | The style of the border. |
| borderColor | [CellsColor](../cellscolor/) | The color of the border. |

**Returns**

Whether current border settings have been changed.

### setOutlineBorders(CellBorderType, Color) {#setOutlineBorders-cellbordertype-color-}

Set the outline borders

```javascript
setOutlineBorders(borderStyle: CellBorderType, borderColor: Color) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| borderStyle | [CellBorderType](../cellbordertype/) | The type of borders. |
| borderColor | [Color](../color/) | The color of the borders |

### setOutlineBorders(CellBorderType, CellsColor) {#setOutlineBorders-cellbordertype-cellscolor-}

Set the outline borders

```javascript
setOutlineBorders(borderStyle: CellBorderType, borderColor: CellsColor) : void;
```

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| borderStyle | [CellBorderType](../cellbordertype/) | The type of borders. |
| borderColor | [CellsColor](../cellscolor/) | The color of the borders |

### setCustom(string, boolean) {#setCustom-string-boolean-}

Sets the Custom number format string of a cell.

```javascript
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) {#setTwoColorGradient-color-color-gradientstyletype-number-}

Sets the specified fill to a two-color gradient.

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

**Parameters:**
| Parameter | Type | Description |
| --- | --- | --- |
| color1 | [Color](../color/) | One gradient color. |
| color2 | [Color](../color/) | Two gradient color. |
| gradientStyleType | [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() {#getTwoColorGradientSetting--}

Get the two-color gradient setting.

```javascript
getTwoColorGradientSetting() : TwoColorGradient;
```


**Returns**

[TwoColorGradient](../twocolorgradient/)

### toJson() {#toJson--}

Convert [Style](../style/) to JSON struct data.

```javascript
toJson() : string;
```


### equals(VObject) {#equals-vobject-}

Determines whether two Style instances are equal.

```javascript
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() {#getHashCode--}

Serves as a hash function for a Style object.

```javascript
getHashCode() : number;
```


**Returns**

A hash code for the current Object.

**Remarks**

This method is only for internal use.