SetWorksheetOptions

Set options to control the appearance and behavior of one or all worksheets.

Overloads

Overload Name Description
FreezePanes Set FreezePanesCell for one or all worksheets.
General Set options for one or all worksheets.
Scroll Set Scroll row/column for one or all worksheets.
Splitters Set Splitters for one or all worksheets.
UnFreezePanes Turn off FreezePanes for one or all worksheets.


FreezePanes

Set FreezePanesCell for one or all worksheets.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
FreezePanesCell The address of the cell to use as the freeze point.

General

Set options for one or all worksheets.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
DisplayFormulas Whether to display formulas.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
DisplayGridlines Whether to display gridlines.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
DisplayRowColumnHeaders Whether to display row and column headers.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
DisplayZeroValues Whether to display zero values.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
FreezePanesCell The address of the cell to use as the freeze point.
GridlineColorRGB (8.0) Select a color to use for the grid line color. GridlineColorRGB is used if GridlineColor and GridlineColorRGB are both specified.
GridlineColor Excel color palette index to use for grid lines color. The value is zero-based from 0 to 55.
Specify one of the following values or an arbitrary value: <blank>012345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
SheetName The name of the sheet.
Note: Changing the worksheet name in an event that fires after the BeforeCommentsSetup event may break comment functionality in the view instance.
TabColorRGB (8.0) Select a color to use for the tab color. TabColorRGB is used if TabColor and TabColorRGB are both specified.
TabColor Excel color palette index to use for the sheet tab color. The value is zero-based from 0 to 55.
Specify one of the following values or an arbitrary value: <blank>012345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455
ZoomMagnification The zoom factor.

Scroll

Set Scroll row/column for one or all worksheets.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
ScrollColumn The column to scroll to.
ScrollRow The row to scroll to.

Splitters

Set Splitters for one or all worksheets.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
SplitColumns The number of columns to set the vertical splitter at.
SplitRows The number of rows to set the horizontal splitter.

UnFreezePanes

Turn off FreezePanes for one or all worksheets.

Argument Description
SpecifySheetBy Select how to specify which worksheet to select while the method is being executed.
Specify one of the following values or an arbitrary value: <blank>SheetNameSheetNumberAllSheets
SheetSpec Specify the sheet-name or sheet-number, depending on SpecifySheetBy. If SpecifySheetBy is AllSheets then SheetSpec can be left empty.
Address The address of a range to select for the execution of the method.
CellByCell Whether to execute the method on a cell-by-cell basis, or on the range specified by the address.
ReverseOrder Whether to loop through the rows and columns from highest to lowest. Only applies when CellByCell is true.
MethodCondition If the result of method-condition expression resolves to FALSE, then the method is not executed.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE
CellCondition If the result of the condition expression resolves to FALSE, then the current cell is skipped.
Specify one of the following values or an arbitrary value: <blank>FALSETRUE