# GC.Spread.Sheets.IWorksheetOptions

## Content

# Interface: IWorksheetOptions

[Spread](../modules/GC.Spread).[Sheets](../modules/GC.Spread.Sheets).IWorksheetOptions

## Table of contents

### Properties

- [addColumnButtonOption](GC.Spread.Sheets.IWorksheetOptions#addcolumnbuttonoption)
- [addRowButtonOption](GC.Spread.Sheets.IWorksheetOptions#addrowbuttonoption)
- [allowCellOverflow](GC.Spread.Sheets.IWorksheetOptions#allowcelloverflow)
- [clipBoardOptions](GC.Spread.Sheets.IWorksheetOptions#clipboardoptions)
- [colHeaderAutoText](GC.Spread.Sheets.IWorksheetOptions#colheaderautotext)
- [colHeaderAutoTextIndex](GC.Spread.Sheets.IWorksheetOptions#colheaderautotextindex)
- [colHeaderVisible](GC.Spread.Sheets.IWorksheetOptions#colheadervisible)
- [frozenlineColor](GC.Spread.Sheets.IWorksheetOptions#frozenlinecolor)
- [gridline](GC.Spread.Sheets.IWorksheetOptions#gridline)
- [isProtected](GC.Spread.Sheets.IWorksheetOptions#isprotected)
- [keepUnknownFormulas](GC.Spread.Sheets.IWorksheetOptions#keepunknownformulas)
- [protectionOptions](GC.Spread.Sheets.IWorksheetOptions#protectionoptions)
- [rightToLeft](GC.Spread.Sheets.IWorksheetOptions#righttoleft)
- [rowHeaderAutoText](GC.Spread.Sheets.IWorksheetOptions#rowheaderautotext)
- [rowHeaderAutoTextIndex](GC.Spread.Sheets.IWorksheetOptions#rowheaderautotextindex)
- [rowHeaderVisible](GC.Spread.Sheets.IWorksheetOptions#rowheadervisible)
- [selectionBackColor](GC.Spread.Sheets.IWorksheetOptions#selectionbackcolor)
- [selectionBorderColor](GC.Spread.Sheets.IWorksheetOptions#selectionbordercolor)
- [sheetAreaOffset](GC.Spread.Sheets.IWorksheetOptions#sheetareaoffset)
- [sheetTabColor](GC.Spread.Sheets.IWorksheetOptions#sheettabcolor)
- [showFormulas](GC.Spread.Sheets.IWorksheetOptions#showformulas)
- [showZeros](GC.Spread.Sheets.IWorksheetOptions#showzeros)

## Properties

### <a id="addcolumnbuttonoption" name="addcolumnbuttonoption"></a> addColumnButtonOption

• `Optional` **addColumnButtonOption**: [`IAddColumnButtonOption`](GC.Spread.Sheets.IAddColumnButtonOption)

The add column button's options.

___

### <a id="addrowbuttonoption" name="addrowbuttonoption"></a> addRowButtonOption

• `Optional` **addRowButtonOption**: [`IAddRowButtonOption`](GC.Spread.Sheets.IAddRowButtonOption)

The add row button's options.

___

### <a id="allowcelloverflow" name="allowcelloverflow"></a> allowCellOverflow

• **allowCellOverflow**: `boolean`

indicates whether data can overflow into adjacent empty cells.

___

### <a id="clipboardoptions" name="clipboardoptions"></a> clipBoardOptions

• **clipBoardOptions**: [`ClipboardPasteOptions`](../enums/GC.Spread.Sheets.ClipboardPasteOptions)

The clipboard option.

___

### <a id="colheaderautotext" name="colheaderautotext"></a> colHeaderAutoText

• **colHeaderAutoText**: [`HeaderAutoText`](../enums/GC.Spread.Sheets.HeaderAutoText)

Indicates whether the column header displays letters or numbers or is blank.

___

### <a id="colheaderautotextindex" name="colheaderautotextindex"></a> colHeaderAutoTextIndex

• **colHeaderAutoTextIndex**: [`HeaderAutoText`](../enums/GC.Spread.Sheets.HeaderAutoText)

Specifies which column header row displays the automatic text when there are multiple column header rows.

___

### <a id="colheadervisible" name="colheadervisible"></a> colHeaderVisible

• **colHeaderVisible**: `boolean`

Indicates whether the column header is visible.

___

### <a id="frozenlinecolor" name="frozenlinecolor"></a> frozenlineColor

• **frozenlineColor**: `string`

A color string used to represent the frozen line color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.

___

### <a id="gridline" name="gridline"></a> gridline

• **gridline**: [`IWorkSheetGridlineOption`](GC.Spread.Sheets.IWorkSheetGridlineOption)

The grid line's options.

___

### <a id="isprotected" name="isprotected"></a> isProtected

• **isProtected**: `boolean`

Indicates whether cells on this sheet that are marked as protected cannot be edited.

___

### <a id="keepunknownformulas" name="keepunknownformulas"></a> keepUnknownFormulas

• **keepUnknownFormulas**: `boolean`

Indicates whether the unknown formulas could be included in sheet json data.

___

### <a id="protectionoptions" name="protectionoptions"></a> protectionOptions

• **protectionOptions**: [`IProtectionOptions`](GC.Spread.Sheets.IProtectionOptions)

A value that indicates the elements that you want users to be able to change.

___

### <a id="righttoleft" name="righttoleft"></a> rightToLeft

• **rightToLeft**: `boolean`

Indicates whether the sheet is rendered from right to left.

___

### <a id="rowheaderautotext" name="rowheaderautotext"></a> rowHeaderAutoText

• **rowHeaderAutoText**: [`HeaderAutoText`](../enums/GC.Spread.Sheets.HeaderAutoText)

Indicates whether the row header displays letters or numbers or is blank.

___

### <a id="rowheaderautotextindex" name="rowheaderautotextindex"></a> rowHeaderAutoTextIndex

• **rowHeaderAutoTextIndex**: [`HeaderAutoText`](../enums/GC.Spread.Sheets.HeaderAutoText)

Specifies which row header column displays the automatic text when there are multiple row header columns.

___

### <a id="rowheadervisible" name="rowheadervisible"></a> rowHeaderVisible

• **rowHeaderVisible**: `boolean`

Indicates whether the row header is visible.

___

### <a id="selectionbackcolor" name="selectionbackcolor"></a> selectionBackColor

• **selectionBackColor**: `string`

The selection's background color for the sheet.

___

### <a id="selectionbordercolor" name="selectionbordercolor"></a> selectionBorderColor

• **selectionBorderColor**: `string`

The selection's border color for the sheet.

___

### <a id="sheetareaoffset" name="sheetareaoffset"></a> sheetAreaOffset

• **sheetAreaOffset**: [`IWorkSheetSheetAreaOffsetOption`](GC.Spread.Sheets.IWorkSheetSheetAreaOffsetOption)

The sheetAreaOffset's options.

___

### <a id="sheettabcolor" name="sheettabcolor"></a> sheetTabColor

• **sheetTabColor**: `string`

A color string used to represent the sheet tab color, such as "red", "#FFFF00", "rgb(255,0,0)", "Accent 5", and so on.

___

### <a id="showformulas" name="showformulas"></a> showFormulas

• **showFormulas**: `boolean`

indicates whether display the formulas string not the formula result.

___

### <a id="showzeros" name="showzeros"></a> showZeros

• **showZeros**: `boolean`

indicates whether display the 0 in cells containing zero value. Default is true.
