SSGetBool, SSSetBool Functions
Applies To
fpSpread DLL control
Description
Set or return the value of one of the control's booleans.
Syntax
BOOL SSGetBool(HWND hWnd, short nIndex);
BOOL SSSetBool(HWND hWnd, short nIndex, BOOL bNewVal);
BOOL TSpread::GetBool(short nIndex);
BOOL TSpread::SetBool(short nIndex, BOOL bNewVal);
Parameters
The SSGetBool function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| nIndex | Index of the boolean value to return |
The SSSetBool function has the following parameters:
| Parameter | Description |
|---|---|
| hWnd | Window handle of the fpSpread control |
| nIndex | Index of the boolean value to set from the list of booleans in the "Remarks" section |
| bNewVal | New value for the boolean |
Remarks
This function is applied to the entire workbook, including all sheets in the control.
The following booleans are available. Setting a boolean to TRUE turns the particular option off; setting a boolean to FALSE turns the option on.
| Boolean | Description | Default Value |
|---|---|---|
| SSB_ALLOWCELLOVERFLOW | Lets text overflow cell boundaries to the right or left. This setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_ALLOWCOLMOVE | Lets the user drag and move columns within the sheet.If the user presses the Esc key while in the middle of moving a column or row the action is canceled.This setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. | FALSE |
| SSB_ALLOWDRAGDROP | Lets the user drag and drop selected cell blocks.This setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_ALLOWEDITOVERFLOW |
Lets text overflow cell boundaries to the right or left while edit mode is on in a cell.
Note: Cell overflow is not performed if you span or merge cells. This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_ALLOWMULTIBLOCKS | Lets the user select multiple blocks of cells (Use the mouse or provide code using the SSAddMultiSelBlocks function.)]This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_ALLOWROWMOVE | Lets the user drag and move rows within the sheet.If the user presses the Esc key while in the middle of moving a column or row the action is canceled.This setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. | FALSE |
| SSB_ALLOWUSERFORMULAS | Lets the user add formulas (Add formulas by pressing the equal sign (=) key, which displays a formula to edit. Formulas are available for currency, number, and percent cell types.)This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_ARROWSEXITEDITMODE | Specifies whether pressing the arrow keys leaves edit mode (Once out of edit mode, the user can move between cells by pressing the arrow keys.)This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_AUTOCALC | Automatically recalculates formulas when the contents of the dependent cells change. (Use the SSReCalc function to force a recalculation of all formulas or the SSReCalcCell function for individual formulas.)This setting is applied to the entire workbook, including all sheets in the control. |
TRUE |
| SSB_AUTOCLIPBOARD | Specifies whether the user can use default Clipboard edit keys (For example, the default Clipboard edit keys include Ctrl+C to copy selections.)This setting is applied to the entire workbook, including all sheets in the control. |
TRUE |
| SSB_AUTOSIZE | Automatically resizes the control to the number of specified columns and rows (The SSSetAutoSizeVisible function specifies the number of columns and rows to be visible when the control resizes.)This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_CHANGEMADE | Indicates whether the user made changes to data in the control (Automatically set to TRUE whenever user types new data into control.)This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_EDITMODEPERMANENT | Permanently places the control in edit modeThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_EDITMODEREPLACE | Selects existing text in an edit cell when it becomes the active cell and the control is in edit mode (Set to TRUE to select existing text; set to FALSE to place the cursor at the end of the existing text.)This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_FORMULASYNC | Updates formulas when the user adds or deletes a column or row, or moves or swaps a block of cells (Does not change how the control treats cell references in formulas when you use the SSSort function to sort blocks of cells)This setting is applied to the entire workbook, including all sheets in the control. |
TRUE |
| SSB_HORZSCROLLBAR | Displays a horizontal scroll barThis setting is applied to the entire workbook, including all sheets in the control. | TRUE |
| SSB_HSCROLLBARTRACK | Rows move as the user drags scroll box on vertical scroll barThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_MOVEACTIVEONFOCUS | Moves the active cell to the mouse pointer location when the user clicks the control, moving the focus to itThis setting is applied to the entire workbook, including all sheets in the control. | TRUE |
| SSB_NOBEEP | Lets the control beep when the user makes an error (Set to TRUE to prevent beeps. Set to FALSE to allow beeps.)This setting is applied to the entire workbook, including all sheets in the control. |
FALSE |
| SSB_NOBORDER | Determines whether the sheets in the control display a border between the last column or row and the gray area in the controlThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_PROCESSTAB | Lets the user press the Tab key to move to the next cell and Shift+Tab to move to the previous cellThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_PROTECT | Prevents the user from editing cells marked as locked (Mark a cell as locked by setting the SSSetLock Lock parameter to TRUE.)This setting is applied to the entire workbook, including all sheets in the control. |
TRUE |
| SSB_REDRAW | Automatically redraws the control (Use this boolean to delay updating the screen until all changes have been made. Using this boolean greatly increases speed when you are performing multiple operations that affect the display. Set this value to FALSE, perform the operations, then set this value back to TRUE.)This setting is applied to the entire workbook, including all sheets in the control. |
TRUE |
| SSB_RESTRICTCOLS | Prevents the user from typing data more than one column beyond the last column containing data (You might want to use this capability with bound fpSpread controls to restrict users to adding data for one record at a time.)This setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. |
FALSE |
| SSB_RESTRICTROWS | Prevents the user from typing data more than one row beyond the last row containing data (You might want to use this capability with bound fpSpread controls to restrict users to adding data for one record at a time.)This setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. |
FALSE |
| SSB_RETAINSELBLOCK | Lets selected blocks display highlighting when the focus is not on the controlThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_SCROLLBAREXTMODE | Displays a scroll bar only when the maximum rows or columns exceed the size of the controlThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
| SSB_SCROLLBARMAXALIGN | Aligns the last row and column to the lower right when set to TRUE and aligns the last row and column to the top left when set to FALSEThis setting is applied to the entire workbook, including all sheets in the control. | TRUE |
| SSB_SCROLLBARSHOWMAX | Changes scroll box position to reflect the maximum rows and columnsThis setting is applied to the entire workbook, including all sheets in the control. | TRUE |
| SSB_SHOWCOLHEADERS | Displays column headersThis setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. | TRUE |
| SSB_SHOWROWHEADERS | Displays row headersThis setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. | TRUE |
| SSB_VERTSCROLLBAR | Displays a vertical scroll barThis setting is applied to the entire workbook, including all sheets in the control. | TRUE |
| SSB_VIRTUALMODE | Turns virtual mode on Use virtual mode to store only a specified number of rows of data in memory at a time.This setting is applied to the current sheet setting unless you first call the SSSetSheet function to specify the sheet. |
FALSE |
| SSB_VSCROLLBARTRACK | Columns move as the user drags scroll box on horizontal scroll barThis setting is applied to the entire workbook, including all sheets in the control. | FALSE |
If you set the SSB_MOVEACTIVEONFOCUS boolean to FALSE and you move focus back to the control by clicking the left mouse button, the SSM_CLICK message is not sent and the active cell does not move.
When the SSSetOperationMode function's wMode parameter is set to SS_OPMODE_ROWMODE, if you set the SSB_ALLOWDRAGDROP boolean to TRUE and you drag and drop a cell or block of cells, the entire row or rows containing the selected cell or block of cells are dragged and dropped.
If you set the SSSetCellNoteIndicator function's Value parameter to either 0 (SS_CELLNOTEINDICATOR_SHOWANDFIREEVENT) or 1 (SS_CELLNOTEINDICATOR_SHOWANDDONOTFIREEVENT) and the SSSetBool function's SS_ALLOWCELLOVERFLOW boolean to TRUE, the cell note indicator will appear in the cell that contains the original text.
Return Value
SSGetBool: The value of the boolean being returned. A value of TRUE indicates the option is enabled; a value of FALSE indicates the option is disabled.
SSSetBool: Previous value of the boolean.
See Also
Allowing Cells to Overflow
Allowing Text to Overflow in Edit Mode
Allowing Users to Drag and Drop Cells
Locking the Sheet
Preventing Active Cell Change on Focus
Unlocking the Sheet
Selecting Multiple Blocks of Cells
Using Edit Mode
Using the Tab Key to Move Between Cells
Hiding the Column and Row Headers
Turning Off the Control's Beep
Displaying a Specified Number of Columns and Rows
Hiding Selections When Not in Focus
Hiding Sheet Borders
Preventing Flickering
Using Arrow Keys to Move Between Cells
Displaying Scroll Bars Only When Needed
Limiting the Scroll Box Range
Specifying Whether Scroll Bars Are Displayed
Synchronizing the Scroll Box with Columns and Rows
Displaying the Special Vertical Scroll Bar
Specifying Where the Last Column and Row Stop Scrolling
Allowing Users to Enter Formulas
Automatically Recalculating and Updating Formulas
Turning Off the Clipboard Shortcut Keys
Using Virtual Mode
SSAddMultiSelBlocks, SSGetEditMode, SSReCalc, SSReCalcCell, SSSetAutoSizeVisible, SSSetCellNoteIndicator, SSSetEditMode, SSSetLock, SSSetOperationMode, SSSort functions
SSM_CLICK, SSM_EDITMODEOFF, SSM_EDITMODEON messages