Link Search Menu Expand Document

Properties

The following properties are defined in the SSpread class.

Name Access &= Type Initial Value Description
AcceptDrop CRW   integer 0 Type that accepts drag and drop
ActiveCellHighlightStyle CRW   integer $ActiveCellHighlightStyleNormal Highlight active cell
ActiveCol R   integer 1 Active cell column number
ActiveRow R   integer 1 Active cell row number
AllowCellOverflow CRW   boolean $FALSE Displayed in the next cell
AllowColMove CRW   boolean $FALSE Allow drag and drop to move columns
AllowDragDrop CRW   boolean $FALSE Allow drag and drop of cell blocks
AllowEditOverflow CRW   boolean $FALSE In the input mode, it is displayed so that it extends beyond the adjacent cell.
AllowMultiBlocks CRW   boolean $FALSE Allow multiple selection of cell blocks
AllowRowMove CRW   boolean $FALSE Allow drag and drop to move rows
AllowUserFormulas CRW   boolean $FALSE Allow entry of formulas
Appearance CRW   integer $AppearanceFlat Borders across the spreadsheet
AppearanceStyle CRW   integer $AppearanceStyleEnhanced Overall spreadsheet design
ArrowsExitEditMode CRW   boolean $FALSE Operation of arrow keys in input mode
AutoCalc CRW   boolean $TRUE Automatically recalculate each formula in related cells
AutoClipboard CRW   boolean $TRUE Enable shortcut keys to operate the clipboard
BackColor CRW × integer
UString
$WHITE Background color for rows, columns, cells, cell blocks
BackColorStyle CRW   integer $BackColorStyleOverGrid Display background color above grid lines
BgColor CRW × integer
UString
$WHITE Background color for rows, columns, cells, cell blocks
BlockMode CRW × boolean $FALSE Enable the value of each property for the cell block
Border CRW   boolean $FALSE Display of border
BorderStyle CRW × boolean $FALSE Display of border
ButtonDrawMode CRW   integer $ButtonDrawModeAlways Button type, combo box type cell button display range
CellNote CRW × UString ”” Cell comment settings
Added since Version 5.0.2
CellTag CRW × UString ”” User-defined tags for cells, columns and rows
CellType CRW × integer $CellTypeEdit Data types of cells in rows, columns, cells, cell blocks
ChangeMade CRW × boolean $FALSE Whether the cell value has changed
Clip CRW × UString - Set the value in the cell block
ClipboardOptions CRW   integer $ClipboardOptionsCopyPasteAllHeaders Handling of headers when copying and pasting
ClipValue CRW × UString - Set the value in the cell block
Col CRW × integer -1 Columns to be processed
Col2 CRW × integer 0 The last column of the cell block to be processed
ColHeadersAutoText CRW   integer $DispLetters Display format of column header
ColHeadersShow CRW   boolean $TRUE Show / hide column headers
ColHidden CRW × boolean $FALSE Show / hide columns
ColID CRW × UString ”” A string that identifies the column
ColMerge CRW × integer $MergeNone Group cells with the same content in a particular column
ColsFrozen CRW   integer 0 Number of columns to be fixedly displayed without scrolling
ColUserSortIndicator × integer $ColUserSortIndicatorNone Show / hide sort indicator
ColWidth × integer 64 Column width
CursorIcon CRW × String
Object Reference
- User-defined mouse cursor
CursorStyle CRW × integer $CursorStyleDefault Mouse cursor shape to use
CursorType CRW × integer $CursorTypeDefault Target to set the mouse cursor
DataColCnt R   integer 0 Column number of the last cell where the value is entered
DataRowCnt R   integer 0 Row number of the last cell where the value is entered
EditEnterAction CRW   integer $EditEnterActionNone Enter key behavior
EditMode CRW × boolean $FALSE Input mode status
EditModePermanent CRW   boolean $FALSE Input mode is always ON
EditModeReplace CRW   boolean $FALSE Replace with original value in input mode
FgColor CRW × integer
UString
$BLACK Text color of rows, columns, cells, cell blocks
FontBold CRW × boolean $FALSE Bold font for rows, columns, cells, and cell blocks
FontFace CRW × integer $STD Row, column, cell, cell block font styles
FontItalic CRW × boolean $FALSE Font italics for rows, columns, cells and cell blocks
FontKind CRW × integer
UString
$STD Row, column, cell, cell block font types
FontName CRW × UString “MS PGothic” Font names for rows, columns, cells, and cell blocks
FontSize CRW × integer 10 Row, column, cell, cell block font size
FontStrikethru CRW × boolean $FALSE Font strikethrough for rows, columns, cells, and cell blocks
FontUnderline CRW × boolean $FALSE Underline fonts for rows, columns, cells, and cell blocks
ForeColor CRW × integer
UString
$BLACK Text color of rows, columns, cells, cell blocks
Formula CRW × UString ”” Cell formula
FormulaSync CRW   boolean $TRUE Automatically update cell references in formulas
GrayAreaBackColor CRW   integer
UString
$STD Background color of gray area
GridColor CRW   integer
UString
$STD Display color of grid lines
GridShowHoriz CRW   boolean $TRUE Show / hide horizontal grid lines
GridShowVert CRW   boolean $TRUE Show / hide vertical grid lines
GridSolid CRW   boolean $TRUE Grid line type
IsBlockSelected R   boolean $FALSE Whether cell block is selected
LeftCol CRW   integer 1 Column number to display in the leftmost column
Lock CRW × boolean $FALSE Lock rows, columns, cells, cell blocks
LockBackColor CRW   integer
UString
$STD Background color of locked cells
LockForeColor CRW   integer
UString
$STD Text color of locked cell
MaxCols CRW   integer 500 Total number of columns
MaxRows CRW   integer 500 Total number of rows
MaxTextCellHeight R × integer - Height required to display the text set in the cell
MaxTextCellWidth R × integer - The width required to display the text set in the cell
MaxTextColWidth × integer - The width required to display the text set in the column
MaxTextRowHeight × integer - The height required to display the text set on the line
MoveActiveOnFocus CRW   boolean $TRUE Activates the cell pointed to by the mouse pointer when getting focus
NoBeep CRW   boolean $FALSE Beep when you make a mistake or make a mistake
NoBorder CRW   boolean $FALSE Show / Hide Borders at Right and Bottom Edges of Spreadsheets
OperationMode CRW   integer $OperationModeNormal Operation mode
ProcessDelete CRW   Integer $DeleteNone Delete the data and formula in the selected cell with the Delete key.
Added since Version 5.0.2
ProcessTab CRW   boolean $FALSE Move the active cell with the Tab key
Protect CRW   boolean $TRUE Prohibit writing of locked cells
ReDraw CRW   boolean $TRUE Allow redraw
Added since Version 5.0.2
RestrictCols CRW   boolean $FALSE Prohibit entering a value if no value has been entered in the column to the left
RestrictRows CRW   boolean $FALSE Prohibit entering a value if no value has been entered in the next line above
RetainSelBlock CRW   boolean $FALSE Leave selection highlighted when out of focus
Row CRW × integer -1 Line to be processed
Row2 CRW × integer 0 The last row of the cell block to be processed
RowHeadersAutoText CRW   integer $DispNumbers Line header display format
RowHeadersShow CRW   boolean $TRUE Show / hide line headers
RowHeight × integer 15 Row height
RowHidden CRW × boolean $FALSE Show / hide rows
RowMerge CRW × integer $MergeNone Group cells with the same content within a particular row
RowsFrozen CRW   integer 0 Number of lines to be fixedly displayed without scrolling
ScrollBarExtMode CRW   boolean $FALSE Automatically show / hide scrollbars
ScrollBarHColor CRW   integer
UString
$STD Horizontal scrollbar color
ScrollBarHeight CRW   integer -1 Horizontal scroll bar height
ScrollBarMaxAlign CRW   boolean $TRUE Display position of the last cell when scrolling to the end
ScrollBars CRW   integer $ScrollBarsBoth Show / hide scrollbar
ScrollBarShowMax CRW   boolean $TRUE Scroll range (until the last data, up to the last cell)
ScrollBarStyle CRW   integer $ScrollBarStyleInherit Scroll bar design
ScrollBarTrack CRW   integer $ScrollBarTrackOff Show spreadsheet contents while scrolling
ScrollBarVColor CRW   integer
UString
$STD Vertical scrollbar color
ScrollBarWidth CRW   integer -1 Vertical scrollbar width
SelBackColor CRW   integer
UString
$STD Background color of the selected cell or cell block
SelBlockCol R   integer 0 Leftmost column number of the selected cell block
SelBlockCol2 R   integer 0 Rightmost column number of the selected cell block
SelBlockRow R   integer 0 Row number at the top of the selected cell block
SelBlockRow2 R   integer 0 Row number at the bottom of the selected cell block
SelectBlockOptions CRW × integer 15 Options when selecting cell blocks
SelectionCount R   integer 0 Number of selected cell blocks or number of rows when multiple rows are selected
SelForeColor CRW   integer
UString
$STD Text color of the selected cell or cell block
SelLength CRW × integer - Number of characters for character selection in input mode
SelModeIndex CRW × integer - Line number to select in single selection mode
SelModeSelected CRW × boolean - Select the row indicated by the Row property in multiple selection mode
SelStart CRW × integer - Start position of character selection in input mode
SelText CRW × UString - Character string for character selection in input mode
ShadowColor CRW   integer
UString
$STD Row and column headers, and label cell background color
ShadowDark CRW   integer
UStrig
$STD Row and column headers, and the color of the shadow side of the unevenness of the label type cell
ShadowLight CRW   integer
UString
$STD Light side color of row and column headers and unevenness of label type cells
Added since Version 5.0.1
ShadowText CRW   integer
UString
$STD Text color for row and column headers and label cells
SortKey × integer - Sort key
SortKeyOrder × integer $SortKeyOrderAscending Sort order
StartingColNumber CRW   integer 1 Column display start number
StartingRowNumber CRW   integer 1 Line display start number
Text CRW × UString ”” Cell value
ToolTip CRW   String ”” Value to display in tooltip
ToolTipDelayTime CRW   integer 0 Time to display tooltips
TopRow CRW   integer 1 The number of the line to be displayed on the top line
TwoDigitYearMax CRW   integer 2059 Base year for converting a 2-digit year to a 4-digit year
TypeButtonAlign CRW × integer $TypeButtonAlignBottom Arrangement of characters in button cell
TypeButtonColor CRW × integer
UString
(OS settings) Button cell background color
TypeButtonDarkColor CRW × integer
UString
(OS settings) The color of the shadow side of the unevenness of the button cell
TypeButtonLightColor CRW × integer
UString
(OS settings) The color of the unevenness of the button cell on the light side
TypeButtonPicture CRW × String
Object Reference
- Image of button cell not pressed
TypeButtonPictureDown CRW × String
Object Reference
- Image of the pressed state of the button cell
TypeButtonShadowSize CRW × integer 1 Depth of unevenness of button cell
TypeButtonText CRW × UString ”” Button cell text
TypeButtonTextColor CRW × integer
UString
(OS settings) Text color of button cell
TypeButtonType CRW × integer $TypeButtonTypeNormal Button type of button cell
TypeCheckCenter CRW × boolean $FALSE Check box type cell check box is placed in the center
TypeCheckPicture × String
Object Reference
- Check box image of check box type cell
TypeCheckText CRW × UString ”” Checkbox cell text
TypeCheckTextAlign CRW × integer $TypeCheckTextAlignRight Arrangement of characters in check box type cells
TypeCheckType CRW × integer $TypeCheckTypeNormal Check box type of check box type cell
TypeComboBoxAutoSearch CRW × integer $TypeComboBoxAutoSearchSingleChar Combo box cell search type
TypeComboBoxCount R × integer 0 Number of items in combo box type cell
TypeComboBoxCurSel CRW × integer -1 Selected item number of combo box type cell
TypeComboBoxEditable CRW × boolean $FALSE Make the item name of the combo box type cell editable
TypeComboBoxIndex CRW × integer 0 Item number to be processed by combo box type cell
TypeComboBoxList CRW × UString ”” List of item names for combo box cell
TypeComboBoxMaxDrop CRW × integer 6 Number of rows to display in the drop-down list of combo box cells
TypeComboBoxString CRW × UString - Item name of combo box type cell
TypeComboBoxWidth CRW × integer 0 Combo box cell drop-down list width
TypeCurrencyDecimal CRW × UString ”” Decimal point symbol for currency cell
TypeCurrencyDecPlaces CRW × integer 2 Number of digits to display after the decimal point in the currency cell
TypeCurrencyLeadingZero CRW × integer $TypeLeadingZeroIntl Show leading zeros in currency cells
TypeCurrencyMax CRW × Number 9999999.99 Upper limit that can be entered in currency cell
TypeCurrencyMin CRW × Number –9999999.99 Lower limit that can be entered in currency cell
TypeCurrencyNegStyle CRW × integer $TypeCurrencyNegStyleIntl Negative number format for currency cells
TypeCurrencyPosStyle CRW × integer $TypeCurrencyPosStyleIntl Positive format of currency cell
TypeCurrencySeparator CRW × UString ”” Delimiter for every 3 digits of currency cell
TypeCurrencyShowSep CRW × boolean $FALSE Display the delimiter for every 3 digits of the currency type cell
TypeCurrencyShowSymbol CRW × boolean $TRUE Display currency symbol of currency type cell
TypeCurrencySymbol CRW × UString ”” Currency symbol of currency type cell
TypeDateCentury CRW × boolean (OS settings) 4-digit year display of date cell
TypeDateFormat CRW × integer (OS settings) Date cell display format
TypeDateMax CRW × UString “20991231” Upper limit of the date that can be entered in the date cell
TypeDateMin CRW × UString “19000101” Lower limit of the date that can be entered in the date cell
TypeDateSeparator CRW × integer (OS settings) Date cell date separator
TypeEditCharCase CRW × integer $TypeEditCharCaseSetNone Automatically convert uppercase and lowercase letters in character cells
TypeEditCharSet CRW × integer $TypeEditCharSetASCII Character types that can be entered in character cell
TypeEditMultiLine CRW × boolean $FALSE Allow multi-line input for character cells
TypeEditPassword CRW × boolean $FALSE Display * instead of the entered character in the character cell
TypeEllipses CRW × boolean $FALSE Display ellipsis in cells that do not fit
TypeHAlign CRW × integer Currency, numbers, percentages, exponential cells
$TypeHAlignRight
Cell type other than the above
$TypeHAlignLeft
Horizontal placement of cells
TypeMaxEditLen CRW × integer Character cell
32000
Combo box type cell
150
Maximum number of characters that can be entered in a cell
TypeNegRed CRW × boolean $FALSE Negative numbers in cells are displayed in red
TypeNumberDecimal CRW × UString ”” Decimal point symbol for numeric cells
TypeNumberDecPlaces CRW × integer 2 Number of digits to display after the decimal point in a numeric cell
TypeNumberLeadingZero CRW × integer $TypeLeadingZeroIntl Show leading zeros in numeric cells
TypeNumberMax CRW × Number 9999999.99 Upper limit that can be entered in a numeric cell
TypeNumberMin CRW × Number –9999999.99 Lower limit that can be entered in a numeric cell
TypeNumberNegStyle CRW × integer $TypeNumberNegStyleIntl Negative number format for numeric cells
TypeNumberSeparator CRW × UString ”” Delimiter for every 3 digits of a numeric cell
TypeNumberShowSep CRW × boolean $FALSE Display the delimiter for every 3 digits of the numeric cell
TypePercentDecimal CRW × UString ”” Decimal point symbol for percent cell
TypePercentDecPlaces CRW × integer 2 Number of digits to display after the decimal point in the percentage cell
TypePercentLeadingZero CRW × integer $TypeLeadingZeroIntl Show leading zeros for percentage cells
TypePercentMax CRW × Number 9999.99 Upper limit that can be entered for percentage cells
TypePercentMin CRW × Number -9999.99 Lower limit that can be entered for percentage cells
TypePercentNegStyle CRW × integer $TypePercentNegStyleIntl Negative number format for percentage cells
TypePicDefaultText CRW × UString ”” Character string to be displayed instead of the edit definition character of the mask type cell
TypePicMask CRW × UString ”” Mask cell format
TypePictCenter CRW × boolean $FALSE Center the image of the image type cell
TypePictMaintainScale CRW × boolean $FALSE Preserves the aspect ratio of the image in the image type cell
TypePictPicture CRW × String
Object Reference
- Image type cell image
TypePictStretch CRW × boolean $FALSE Enlarging / reducing the image in the image type cell
TypeScientificDecimal CRW × UString ”” Decimal point symbol for exponential cells
TypeScientificDecPlaces CRW × integer 0 Number of digits after the decimal point in the exponential cell
TypeScientificMax CRW × Number 1.7E+308 Valid maximum value for exponential cells
TypeScientificMin CRW × Number -1.7E+308 Valid minimum of exponential cells
TypeSpin CRW × boolean $FALSE Show spin button in cell
TypeSpinInc CRW × Number 1.1 Amount of change due to one click of the spin button on the cell
TypeSpinWrap CRW × boolean $FALSE Operation at the upper and lower limits of the spin button in the cell
TypeTextOrient CRW × integer $TypeTextOrientHorizontal Display direction of cell characters
TypeTextPrefix CRW × boolean $FALSE Handling of & characters contained in the value of label type cell
TypeTextShadow CRW × boolean $FALSE Convex display of label type cells
TypeTextShadowIn CRW × boolean $FALSE Concave display of label type cell
TypeTextWordWrap CRW × boolean $FALSE Label type cell word wrap
TypeTime24Hour CRW × integer (OS settings) 12-hour / 24-hour clock cell
TypeTimeMax CRW × UString “235959” Upper limit of time that can be entered in the time cell
TypeTimeMin CRW × UString “000000” Lower limit of time that can be entered in the time cell
TypeTimeSeconds CRW × boolean $FALSE Display seconds in time cell
TypeTimeSeparator CRW × integer (OS settings) Delimiter between hours, minutes, and seconds in a time cell
TypeVAlign CRW × integer Check box type cell
$TypeVAlignCenter
Cell type other than the above
$TypeVAlignTop
Vertical placement of cells
UseChange CRW   boolean - Specifying a value is invalid for this class
UserColAction CRW   integer $UserColActionDefault The action to take when you click on the column header
UserResize CRW   integer $UserResizeBoth Allow mouse to change column width and row height
UserResizeCol CRW × integer $UserResizeDefault Allow the mouse to change the width of the column
UserResizeRow CRW × integer $UserResizeDefault Allow mouse to change row height
UseVisualStyles CRW   integer $UseVisualStylesInherit Design of buttons, checkboxes, etc. placed in cells
Value CRW × UString ”” Cell value

Access
R: Readable W: Writable C: Initializable