SIMPOL Documentation

This method displays the edit control for the currently selected cell if the parameter passed is true, and hides the edit control (if currently displayed) if the parameter is false.

wxformgridvar.enablecelleditcontrol ( boolean enabled )

Retrieves the current alignment for the desired cell as a string in the form described for setting the alignment.

wxformgridvar.getcellalignment ( integer row, integer col )

Retrieves the current background color for a specific grid cell.

wxformgridvar.getcellbackgroundrgb ( integer row, integer col )

Retrieves the value of the choice for the desired cell and index value or .nul if the cell is not a choice cell or if the index value is too large.

wxformgridvar.getcellchoice ( integer row, integer col, integer item )

Retrieves .true if the desired cell allows other entries than the ones from its list of choices, .false if it does not, or .nul if the cell is not a choice cell.

wxformgridvar.getcellchoiceallowothers ( integer row, integer col )

Retrieves the number of choices for the desired cell or .nul if the cell is not a choice cell.

wxformgridvar.getcellchoicecount ( integer row, integer col )

Retrieves the current font for the desired cell as a wxfont object, or .nul if no font is assigned to the cell or as the default for the grid.

wxformgridvar.getcellfont ( integer row, integer col )

Retrieves the current text color for a specific grid cell.

wxformgridvar.getcelltextrgb ( integer row, integer col )

Retrieves the value for the desired cell.

wxformgridvar.getcellvalue ( integer row, integer col )

Retrieves the column label for the desired column.

wxformgridvar.getcollabel ( integer col )

Gets the width of the designated column.

wxformgridvar.getcolwidth ( integer col )

Retrieves the col where the grid cursor is currently located.

wxformgridvar.getcursorcol ()

None

Retrieves the row where the grid cursor is currently located.

wxformgridvar.getcursorrow ()

None

Gets the height of the designated row.

wxformgridvar.getrowheight ( integer row )

Retrieves the row label for the desired row.

wxformgridvar.getrowlabel ( integer row )

Retrieves the next selected column following or equal to the start column. If not supplied it defaults to 1. This only works if the form has been placed into a container. Otherwise it always returns 0. To find all of the selected columns, start at 1 and continue until you get a return value of 0. There is a known issue with the wxWidgets component. If you are Ctrl-clicking labels, any label preceding an earlier one does not appear in the internal list of selected labels.

wxformgridvar.getselectedcol ( integer selectedcol, integer startcol )

Retrieves the next selected row following or equal to the start row. If not supplied it defaults to 1. This only works if the form has been placed into a container. Otherwise it always returns 0. To find all of the selected rows, start at 1 and continue until you get a return value of 0. There is a known issue with the wxWidgets component. If you are Ctrl-clicking labels, any label preceding an earlier one does not appear in the internal list of selected labels.

wxformgridvar.getselectedrow ( integer selectedrow, integer startrow )

Retrieves whether or not the desired cell is read only.

wxformgridvar.iscellreadonly ( integer row, integer col )

Removes the control from the form. If any object has a reference to the control, those references will no longer be valid. It is not safe to attempt to use a control after this method has been called.

wxformgridvar.remove ()

None

This method assigns the alignments for the row and column labels and the default cell alignment. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. The alignment is for both horizontal and vertical alignment. The string can be made up of two comma separated string values. The valid values are: left, right, top, and bottom. Providing two values for the same vector of alignment is an error, such as "left,right". If an element is not supplied, it is assumed to be middle (in either direction). Supplying an empty string would create an alignment both horizontally and vertically centered.

wxformgridvar.setalignments ( string rowlabelalignment, string collabelalignment, string alignment )

This method is used to determine whether the events for the control can be captured and passed to the form or not. By default, events can be captured.

wxformgridvar.setcaptureable ( boolean captureable )

Sets the alignment for the cell or cells (if used with a range). The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. It is not possible to set a cell back to being controlled by the default grid alignment setting. This limitation is part of the underlying grid control used for the implementation.

wxformgridvar.setcellalignment ( integer row, integer col, string alignment, integer startrow, integer endrow, integer startcol, integer endcol )

Sets the background color for the cell or cells (if used with a range). The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. It is not possible to set a cell back to being controlled by the default grid background color setting. This limitation is part of the underlying grid control used for the implementation.

wxformgridvar.setcellbackgroundrgb ( integer row, integer col, integer rgb, integer startrow, integer endrow, integer startcol, integer endcol )

Sets the currently selected value plus the list of choices for the desired cell or range. The choices are not named parameters, they are simply listed as separate string parameters for as many as there are choices. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. Calling this method with no choices values and the allowothers parameter set to .true will set the cell back to being a normal string cell. Calling this method with no choices values and the allowothers parameter set to .false will result in an error. To set or get a choice (or other value if allowed) for a choice cell using the setcellvalue() and getcellvalue() methods.

	Note
	Any unnamed parameter used when calling this method will be considered to be a choice! It is essential that the row and col parameters or the startrow/endrow and startcol/endcol parameters are specified by name when calling this method!

wxformgridvar.setcellchoices ( integer row, integer col, string value, boolean allowothers, integer startrow, integer endrow, integer startcol, integer endcol, string choices, string , … )

Sets the font to be used for the cell or cells (if using a range) in the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setcellfont ( integer row, integer col, wxfont font, integer startrow, integer endrow, integer startcol, integer endcol )

Sets the desired cell or range to read only. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. Calling this method with no parameters will clear all values from the grid.

wxformgridvar.setcellreadonly ( integer row, integer col, boolean readonly, integer startrow, integer endrow, integer startcol, integer endcol )

Sets the text color for the cell or cells (if used with a range). The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. It is not possible to set a cell back to being controlled by the default grid text color setting. This limitation is part of the underlying grid control used for the implementation.

wxformgridvar.setcelltextrgb ( integer row, integer col, integer rgb, integer startrow, integer endrow, integer startcol, integer endcol )

Sets the value for the desired cell or range. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression. Calling this method with no parameters will clear all values from the grid.

wxformgridvar.setcellvalue ( integer row, integer col, string value, array valuearray, integer startrow, integer endrow, integer startcol, integer endcol )

Sets the height of the column labels. By setting this to 1, the column labels can be hidden. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setcollabelheight ( integer collabelheight )

Assigns labels to the columns in a grid control. The starting column is used to determine where the assignments begin. Multiple labels can be assigned in one call and each one will follow the next sequentially. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setcollabels ( integer startcol, string , … )

Sets the width of the designated column or columns. If the col parameter is specified, then the startcol and endcol parameters cannot be specified and only one width value can be specified, either named or unnamed. If the colwidth parameter is specified, then no unnamed parameters can be used. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setcolwidths ( integer col, integer colwidth, integer startcol, integer endcol, integer , … )

Sets the position of the grid cursor. The position must be within the defined rows and columns of the grid.

wxformgridvar.setcursorposition ( integer row, integer col )

Determines whether the row heights and/or column widths can be modified by the user. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setdraggability ( boolean rowheightdraggable, boolean colwidthdraggable )

Sets the enabled state of the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setenabled ( boolean enabled )

Sets focus to the control, provided that it is not invisible or disabled. If this is called for a form that is not yet in a container, then nothing will happen except that the focuscontrol of the wxform object will be set. Once the form is placed in a container, the control will get focus and the ongotfocus event will fire.

wxformgridvar.setfocus ()

None

Sets the default font to be used for the text in the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setfont ( wxfont font )

Sets the font to be used for the row and column labels in the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setlabelfont ( wxfont font )

Sets the name of the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setname ( string name )

Sets the position of the control in the z-order and tab order.

wxformgridvar.setnext ( type(wxformcontrol) next )

Sets the size and/or position of the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setposition ( integer left, integer top, integer width, integer height )

Sets the height of the designated row or rows. If the row parameter is specified, then the startrow and endrow parameters cannot be specified and only one height value can be specified, either named or unnamed. If the rowheight parameter is specified, then no unnamed parameters can be used. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setrowheights ( integer row, integer rowheight, integer startrow, integer endrow, integer )

Assigns labels to the rows in a grid control. The starting row is used to determine where the assignments begin. Multiple labels can be assigned in one call and each one will follow the next sequentially. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setrowlabels ( integer startrow, string , … )

Sets the width of the row labels. By setting this to 1, the row labels can be hidden. The wxformgrid object itself is returned, to allow multiple methods to be put into one expression.

wxformgridvar.setrowlabelwidth ( integer rowlabelwidth )

Sets the text for the tooltip associated with the control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.settooltip ( string tooltip )

Sets the visibility of the grid control. The wxformgrid object itself is returned, to allow multiple setting methods to be put into one expression.

wxformgridvar.setvisible ( boolean visible )