wx.GridCtrl.Grid Class Reference

Inheritance diagram for wx.GridCtrl.Grid:

wx.ScrolledWindow wx.Panel wx.Window wx.EvtHandler wx.Object

List of all members.

Public Member Functions

bool AppendCols (int numCols, bool updateLabels)
bool AppendCols (int numCols)
bool AppendCols ()
bool AppendRows (int numRows, bool updateLabels)
bool AppendRows (int numRows)
bool AppendRows ()
void AutoSize ()
void AutoSizeColumn (int col, bool setAsMin)
void AutoSizeColumns (bool setAsMin)
void AutoSizeColumns ()
void AutoSizeRow (int row, bool setAsMin)
void AutoSizeRows (bool setAsMin)
void AutoSizeRows ()
void BeginBatch ()
Rectangle BlockToDeviceRect (GridCellCoords topLeft, GridCellCoords bottomRight)
Rectangle CellToRect (int row, int col)
void ClearGrid ()
void ClearSelection ()
bool CreateGrid (int numRows, int numCols, GridSelectionMode selmode)
bool CreateGrid (int numRows, int numCols)
bool DeleteAllRows ()
bool DeleteCols (int pos, int numCols, bool updateLabels)
bool DeleteCols (int pos, int numRows)
bool DeleteCols (int pos)
bool DeleteCols ()
bool DeleteRows (int pos, int numRows, bool updateLabels)
bool DeleteRows (int pos, int numRows)
bool DeleteRows (int pos)
bool DeleteRows ()
void DeselectCell (int row, int col)
void DeselectCol (int col)
void DeselectRow (int row)
void DisableCellEditControl ()
void DisableDragColSize ()
void DisableDragGridSize ()
void DisableDragRowSize ()
void EndBatch ()
void ForceRefresh ()
void GetCellAlignment (int row, int col, ref int horiz, ref int vert)
Colour GetCellBackgroundColour (int row, int col)
object GetCellData (int row, int col)
DataType GetCellDataType (int row, int col)
Editors.GridCellEditor GetCellEditor (int row, int col)
 
Parameters:
row Row index of the cell.

Font GetCellFont (int row, int col)
bool GetCellOverflow (int row, int col)
Renderers.GridCellRenderer GetCellRenderer (int row, int col)
void GetCellSize (int row, int col, ref int num_rows, ref int num_cols)
Colour GetCellTextColour (int row, int col)
Font GetCellTextFont (int row, int col)
string GetCellValue (int row, int col)
Alignment[] GetColLabelAlignment ()
string GetColLabelValue (int col)
int GetColSize (int col)
int GetColumnWidth (int col)
void GetDefaultCellAlignment (ref int horiz, ref int vert)
Editors.GridCellEditor GetDefaultEditorForCell (int row, int col)
Editors.GridCellEditor GetDefaultEditorForType (string typeName)
Renderers.GridCellRenderer GetDefaultRendererForCell (int row, int col)
Renderers.GridCellRenderer GetDefaultRendererForType (string typeName)
int GetLabelAlignment (int orientation, int align)
int GetLabelSize (int orientation)
string GetLabelValue (int orientation, int pos)
DataType GetRegisteredDataType (Type type)
DataType GetRegisteredDataType (string typeName)
int GetRowHeight (int row)
Alignment[] GetRowLabelAlignment ()
string GetRowLabelValue (int row)
int GetRowSize (int row)
GridCellCoordsArray GetSelectedCells ()
ArrayInt GetSelectedCols ()
ArrayInt GetSelectedRows ()
GridCellCoordsArray GetSelectionBlockBottomRight ()
GridCellCoordsArray GetSelectionBlockTopLeft ()
 Grid (Window parent, Point pos, Size size, wx.WindowStyles style, string name)
 Grid (Window parent, Point pos, Size size, wx.WindowStyles style)
 Grid (Window parent, Point pos, Size size)
 Grid (Window parent, Point pos)
 Grid (Window parent)
 Grid (Window parent, int id, int posX, int posY, int width, int height, wx.WindowStyles style, wxString name)
 Grid (Window parent, int id, Point pos, Size size, wx.WindowStyles style, string name)
 Grid (Window parent, int id, Point pos, Size size, wx.WindowStyles style)
 Grid (Window parent, int id, Point pos, Size size)
 Grid (Window parent, int id, Point pos)
 Grid (Window parent, int id)
 Grid ()
 Grid (IntPtr wxObject)
void HideCellEditControl ()
bool InsertCols (int pos, int numCols, bool updateLabels)
bool InsertCols (int pos, int numRows)
bool InsertCols (int pos)
bool InsertCols ()
bool InsertRows (int pos, int numRows, bool updateLabels)
bool InsertRows (int pos, int numRows)
bool InsertRows (int pos)
bool InsertRows ()
bool IsInSelection (int row, int col)
bool IsReadOnly (int row, int col)
bool IsVisible (int row, int col, bool wholeCellVisible)
void MakeCellVisible (int row, int col)
bool MoveCursorDown (bool expandSelection)
bool MoveCursorDownBlock (bool expandSelection)
bool MoveCursorLeft (bool expandSelection)
bool MoveCursorLeftBlock (bool expandSelection)
bool MoveCursorRight (bool expandSelection)
bool MoveCursorRightBlock (bool expandSelection)
bool MoveCursorUp (bool expandSelection)
bool MoveCursorUpBlock (bool expandSelection)
bool MovePageDown ()
bool MovePageUp ()
bool ProcessTableMessage (GridTableMessage msg)
void RegisterDataType (DataType dataType)
void RegisterDataType (Type type, Renderers.GridCellRenderer renderer, Editors.GridCellEditor editor, DataType.ToStringConverter toString, DataType.FromStringConverter fromString)
void RegisterDataType (string typeName, Renderers.GridCellRenderer renderer, Editors.GridCellEditor editor, DataType.ToStringConverter toString, DataType.FromStringConverter fromString)
void RegisterDataType (string typeName, Renderers.GridCellRenderer renderer, Editors.GridCellEditor editor)
void SaveEditControlValue ()
void SelectAll ()
void SelectBlock (int topRow, int leftCol, int bottomRow, int rightCol, bool addToSelected)
void SelectCol (int col, bool addToSelected)
void SelectRow (int row, bool addToSelected)
void SetAttr (int row, int col, GridCellAttr attr)
void SetCellAlignment (int align, int row, int col)
void SetCellAlignment (int row, int col, Alignment horiz, Alignment vert)
void SetCellBackgroundColour (int row, int col, Colour colour)
void SetCellBitmap (Bitmap bitmap, int row, int col)
void SetCellData (int row, int col, object o)
void SetCellDataType (int row, int col, Type type)
void SetCellDataType (int row, int col, string typename)
void SetCellDataType (int row, int col, DataType t)
void SetCellEditor (int row, int col, Editors.GridCellEditor editor)
void SetCellFont (int row, int col, Font fnt)
void SetCellOverflow (int row, int col, bool allow)
void SetCellRenderer (int row, int col, Renderers.GridCellRenderer renderer)
void SetCellSize (int row, int col, int num_rows, int num_cols)
void SetCellTextColour (int row, int col, Colour val)
void SetCellTextFont (Font fnt, int row, int col)
void SetCellValue (int row, int col, string s)
void SetColAttr (int col, GridCellAttr attr)
void SetColDataType (int col, Type type)
void SetColDataType (int row, int col, string typename)
void SetColDataType (int col, DataType t)
void SetColFormatCustom (int col, string typeName)
void SetColFormatFloat (int col, int width, int precision)
void SetColFormatFloat (int col, int width)
void SetColFormatFloat (int col)
void SetColLabelAlignment (Alignment horiz, Alignment vert)
void SetColLabelValue (int col, string str)
void SetColMinimalWidth (int col, int width)
void SetColSize (int col, int width)
void SetColumnWidth (int col, int width)
void SetDefaultCellAlignment (int horiz, int vert)
void SetDefaultColSize (int width, bool resizeExistingCols)
void SetDefaultRowSize (int height, bool resizeExistingRows)
void SetGridCursor (int row, int col)
void SetLabelAlignment (int orientation, int align)
void SetLabelSize (int orientation, int sz)
void SetLabelValue (int orientation, string val, int pos)
void SetMargins (int extraWidth, int extraHeight)
void SetReadOnly (int row, int col, bool isReadOnly)
void SetReadOnly (int row, int col)
void SetRowAttr (int row, GridCellAttr attr)
void SetRowDataType (int row, Type type)
void SetRowDataType (int row, string typename)
void SetRowDataType (int row, DataType t)
void SetRowHeight (int row, int height)
void SetRowLabelAlignment (Alignment horiz, Alignment vert)
void SetRowLabelValue (int row, string str)
void SetRowMinimalHeight (int row, int width)
void SetRowSize (int row, int height)
bool SetTable (GridTableBase table, bool takeOwnership, GridSelectionMode select)
bool SetTable (GridTableBase table, bool takeOwnerShip)
bool SetTable (GridTableBase table)
void ShowCellEditControl ()
void UpdateDimensions ()
int XToCol (int x)
int XToEdgeOfCol (int x)
int YToEdgeOfRow (int y)
int YToRow (int y)

Protected Member Functions

override void Dispose (bool disposing)

Properties

int BatchCount [get]
bool CanEnableCellControl [get]
int CellAlignment [set]
Colour CellBackgroundColour [set]
bool CellEditControlEnabled [get, set]
Colour CellHighlightColour [get, set]
int CellHighlightPenWidth [get, set]
int CellHighlightROPenWidth [get, set]
Colour CellTextColour [set]
Font CellTextFont [get, set]
int ColFormatBool [set]
int ColFormatNumber [set]
int ColLabelSize [get, set]
int ColMinimalAcceptableWidth [get, set]
int Cols [get]
int CursorColumn [get]
int CursorRow [get]
Colour DefaultCellBackgroundColour [get, set]
Font DefaultCellFont [get, set]
bool DefaultCellOverflow [get, set]
Colour DefaultCellTextColour [get, set]
int DefaultColLabelSize [get]
int DefaultColSize [get, set]
Editors.GridCellEditor DefaultEditor [get, set]
Renderers.GridCellRenderer DefaultRenderer [get, set]
int DefaultRowLabelSize [get]
int DefaultRowSize [get, set]
Pen DividerPen [get, set]
bool DragColSizeEnabled [get, set]
bool DragGridSizeEnabled [get, set]
bool DragRowSizeEnabled [get, set]
bool Editable [get, set]
bool EditInPlace [get]
Window GridColLabelWindow [get]
Window GridCornerLabelWindow [get]
int GridCursorCol [get]
int GridCursorRow [get]
Colour GridLineColour [get, set]
bool GridLinesEnabled [get, set]
Window GridRowLabelWindow [get]
Window GridWindow [get]
bool IsCellEditControlShown [get]
bool IsCurrentCellReadOnly [get]
bool IsEditable [get, set]
bool IsSelection [get]
Colour LabelBackgroundColour [get, set]
Font LabelFont [get, set]
Colour LabelTextColour [get, set]
int NumberCols [get]
int NumberRows [get]
int RowLabelSize [get, set]
int RowMinimalAcceptableHeight [get, set]
int Rows [get]
int ScrollPosX [get, set]
int ScrollPosY [get, set]
Colour SelectionBackground [get, set]
Colour SelectionForeground [get, set]
GridSelectionMode SelectionMode [get, set]
GridTableBase Table [get, set]
int ViewHeight [get]
int ViewWidth [get]

Events

event EventListener CellChange [add, remove]
event EventListener CellLeftClick [add, remove]
event EventListener CellLeftDoubleClick [add, remove]
event EventListener CellRightClick [add, remove]
event EventListener CellRightDoubleClick [add, remove]
event EventListener ColumnSize [add, remove]
event EventListener EditorCreate [add, remove]
event EventListener EditorHidden [add, remove]
event EventListener EditorShown [add, remove]
event EventListener LabelLeftClick [add, remove]
event EventListener LabelLeftDoubleClick [add, remove]
event EventListener LabelRightClick [add, remove]
event EventListener LabelRightDoubleClick [add, remove]
event EventListener RangeSelect [add, remove]
event EventListener RowSize [add, remove]
event EventListener SelectCell [add, remove]

Classes

class  DataType


Detailed Description

wxGrid and its related classes are used for displaying and editing tabular data.

grid.png
Getting started: a simple example For simple applications you need only refer to the wxGrid class in your code. This example shows how you might create a grid in a frame or dialog constructor and illustrates some of the formatting functions.

Create a wx.Grid object

        grid = new wx.Grid( this,
                            -1,
                            wxPoint( 0, 0 ),
                            wxSize( 400, 300 ) );
        
         // Then we call CreateGrid to set the dimensions of the grid
         // (100 rows and 10 columns in this example)
        grid.CreateGrid( 100, 10 );
         
         // We can set the sizes of individual rows and columns
         // in pixels
        grid.SetRowSize( 0, 60 );
        grid.SetColSize( 0, 120 );
        
         // And set grid cell contents as strings
        grid.SetCellValue( 0, 0, "wxGrid is good" );
        
         // We can specify that some cells are read-only
        grid.SetCellValue( 0, 3, "This is read-only" );
        grid.SetReadOnly( 0, 3 );
        
         // Colours can be specified for grid cell contents
        grid.SetCellValue(3, 3, "green on grey");
        grid.SetCellTextColour(3, 3, wx.Colour.wxGREEN);
        grid.SetCellBackgroundColour(3, 3, wx.Colour.wxLIGHT_GREY);
        
         // We can specify the some cells will store numeric 
         // values rather than strings. Here we set grid column 5 
         // to hold floating point values displayed with width of 6 
         // and precision of 2
        grid.SetColFormatFloat(5, 6, 2);
        grid.SetCellValue(0, 6, "3.1415");

Constructor & Destructor Documentation

wx.GridCtrl.Grid.Grid ( IntPtr  wxObject  ) 

wx.GridCtrl.Grid.Grid (  ) 

Creates a new grid control.

wx.GridCtrl.Grid.Grid ( Window  parent,
int  id 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
id ID of the new control. This ID may be useful for searching subwindows with wx.Window.FindWindow(). Use -1 as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
int  id,
Point  pos 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
id ID of the new control. This ID may be useful for searching subwindows with wx.Window.FindWindow(). Use -1 as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
int  id,
Point  pos,
Size  size 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
size The size of the window. Use wxDefaultSize (-1, -1) as an undefined value.
id ID of the new control. This ID may be useful for searching subwindows with wx.Window.FindWindow(). Use -1 as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
size The size of the window. Use wxDefaultSize (-1, -1) as an undefined value.
style The style of the window.
id ID of the new control. This ID may be useful for searching subwindows with wx.Window.FindWindow(). Use -1 as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
int  id,
Point  pos,
Size  size,
wx.WindowStyles  style,
string  name 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
size The size of the window. Use wxDefaultSize (-1, -1) as an undefined value.
style The style of the window.
name A name for the window. This name may be useful to search for particular subwindows.
id ID of the new control. This ID may be useful for searching subwindows with wx.Window.FindWindow(). Use -1 as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
int  id,
int  posX,
int  posY,
int  width,
int  height,
wx.WindowStyles  style,
wxString  name 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
style The style of the window.
name A name for the window. This name may be useful to search for particular subwindows.
id ID of the new control. This ID may be useful for searching subwindows with wx.Window.FindWindow(). Use -1 as an undefined value.
height height of teh new control.
posX X-position of the new control.
posY Y-position of the new control.
width Width of the new control.

wx.GridCtrl.Grid.Grid ( Window  parent  ) 

Creates a new grid control.

Parameters:
parent The parent window. This may be null.

wx.GridCtrl.Grid.Grid ( Window  parent,
Point  pos 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
Point  pos,
Size  size 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
size The size of the window. Use wxDefaultSize (-1, -1) as an undefined value.

wx.GridCtrl.Grid.Grid ( Window  parent,
Point  pos,
Size  size,
wx.WindowStyles  style 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
size The size of the window. Use wxDefaultSize (-1, -1) as an undefined value.
style The style of the window.

wx.GridCtrl.Grid.Grid ( Window  parent,
Point  pos,
Size  size,
wx.WindowStyles  style,
string  name 
)

Creates a new grid control.

Parameters:
parent The parent window. This may be null.
pos The position of the window. Use wxDefaultProsition (-1,-1) as an undefined value.
size The size of the window. Use wxDefaultSize (-1, -1) as an undefined value.
style The style of the window.
name A name for the window. This name may be useful to search for particular subwindows.


Member Function Documentation

bool wx.GridCtrl.Grid.AppendCols ( int  numCols,
bool  updateLabels 
)

Appends one or more new columns to the right of the grid and returns true if successful.

If you are using a derived grid table class you will need to override wx.GridCtrl.GridTableBase.AppendCols. See wx.GridCtrl.Grid.InsertCols for further information.

InsertCols

Parameters:
numCols Number of columns to add.
updateLabels Currently not used.
Returns:

bool wx.GridCtrl.Grid.AppendCols ( int  numCols  ) 

Appends one or more new columns to the right of the grid and returns true if successful.

If you are using a derived grid table class you will need to override wx.GridCtrl.GridTableBase.AppendCols. See wx.GridCtrl.Grid.InsertCols for further information.

InsertCols

Parameters:
numCols Number of columns to add.
Returns:

bool wx.GridCtrl.Grid.AppendCols (  ) 

Appends one or more new columns to the right of the grid and returns true if successful.

If you are using a derived grid table class you will need to override wx.GridCtrl.GridTableBase.AppendCols. See wx.GridCtrl.Grid.InsertCols for further information.

InsertCols

Returns:

bool wx.GridCtrl.Grid.AppendRows ( int  numRows,
bool  updateLabels 
)

Appends one or more new rows to the bottom of the grid and returns true if successful.

If you are using a derived grid table class you will need to override wx.GridCtrl.GridTableBase.AppendRows. See InsertRows for further information.

InsertRows

Returns:
Parameters:
numRows Number of Rows to insert.
updateLabels Not used at present.

bool wx.GridCtrl.Grid.AppendRows ( int  numRows  ) 

Appends one or more new rows to the bottom of the grid and returns true if successful.

If you are using a derived grid table class you will need to override wx.GridCtrl.GridTableBase.AppendRows. See InsertRows for further information.

InsertRows

Parameters:
numRows Number of Rows to insert.
Returns:

bool wx.GridCtrl.Grid.AppendRows (  ) 

Appends one or more new rows to the bottom of the grid and returns true if successful.

If you are using a derived grid table class you will need to override wx.GridCtrl.GridTableBase.AppendRows. See InsertRows for further information.

InsertRows

Returns:

void wx.GridCtrl.Grid.AutoSize (  ) 

Automatically sets the height and width of all rows and columns to fit their contents.

Note:: wx.Grid sets up arrays to store individual row and column sizes when non-default sizes are used. The memory requirements for this could become prohibitive if your grid is very large.

void wx.GridCtrl.Grid.AutoSizeColumn ( int  col,
bool  setAsMin 
)

void wx.GridCtrl.Grid.AutoSizeColumns ( bool  setAsMin  ) 

Automatically sizes all columns to fit their contents.

Note: wx.Grid sets up arrays to store individual row and column sizes when non-default sizes are used. The memory requirements for this could become prohibitive if your grid is very large.

Parameters:
setAsMin If this argument is true the calculated widths will also be set as the minimal widths for the columns.

void wx.GridCtrl.Grid.AutoSizeColumns (  ) 

Automatically sizes all columns to fit their contents. The computed column widths will also be saved as minimal column widths.

Note: wx.Grid sets up arrays to store individual row and column sizes when non-default sizes are used. The memory requirements for this could become prohibitive if your grid is very large.

void wx.GridCtrl.Grid.AutoSizeRow ( int  row,
bool  setAsMin 
)

void wx.GridCtrl.Grid.AutoSizeRows ( bool  setAsMin  ) 

Automatically sizes the row to fit its contents. If setAsMin is true the calculated height will also be set as the minimal height for the row.

Note: wx.Grid sets up arrays to store individual row and column sizes when non-default sizes are used. The memory requirements for this could become prohibitive if your grid is very large.

Parameters:
setAsMin 

void wx.GridCtrl.Grid.AutoSizeRows (  ) 

Automatically sizes all rows to fit their contents. If setAsMin is true the calculated heights will also be set as the minimal heights for the rows.

Note: wx.Grid sets up arrays to store individual row and column sizes when non-default sizes are used. The memory requirements for this could become prohibitive if your grid is very large.

void wx.GridCtrl.Grid.BeginBatch (  ) 

Rectangle wx.GridCtrl.Grid.BlockToDeviceRect ( GridCellCoords  topLeft,
GridCellCoords  bottomRight 
)

Rectangle wx.GridCtrl.Grid.CellToRect ( int  row,
int  col 
)

void wx.GridCtrl.Grid.ClearGrid (  ) 

void wx.GridCtrl.Grid.ClearSelection (  ) 

bool wx.GridCtrl.Grid.CreateGrid ( int  numRows,
int  numCols,
GridSelectionMode  selmode 
)

Creates a grid with the specified initial number of rows and columns. Call this directly after the grid constructor. When you use this function wx.Grid will create and manage a simple table of string values for you. All of the grid data will be stored in memory.

For applications with more complex data types or relationships, or for dealing with very large datasets, you should derive your own grid table class and pass a table object to the grid with wx.Grid.SetTable.

Parameters:
numRows Number of rows
selmode Choice between cell or row selection.
numCols Number of columns
See also:
SetTable

bool wx.GridCtrl.Grid.CreateGrid ( int  numRows,
int  numCols 
)

Creates a grid with the specified initial number of rows and columns. Call this directly after the grid constructor. When you use this function wx.Grid will create and manage a simple table of string values for you. All of the grid data will be stored in memory.

For applications with more complex data types or relationships, or for dealing with very large datasets, you should derive your own grid table class and pass a table object to the grid with wx.Grid.SetTable.

Parameters:
numRows Number of rows
numCols Number of columns
See also:
SetTable

bool wx.GridCtrl.Grid.DeleteAllRows (  ) 

Deletes all rows.

bool wx.GridCtrl.Grid.DeleteCols ( int  pos,
int  numCols,
bool  updateLabels 
)

bool wx.GridCtrl.Grid.DeleteCols ( int  pos,
int  numRows 
)

bool wx.GridCtrl.Grid.DeleteCols ( int  pos  ) 

bool wx.GridCtrl.Grid.DeleteCols (  ) 

bool wx.GridCtrl.Grid.DeleteRows ( int  pos,
int  numRows,
bool  updateLabels 
)

bool wx.GridCtrl.Grid.DeleteRows ( int  pos,
int  numRows 
)

bool wx.GridCtrl.Grid.DeleteRows ( int  pos  ) 

Deletes row at pos pos.

bool wx.GridCtrl.Grid.DeleteRows (  ) 

Deletes row 0.

void wx.GridCtrl.Grid.DeselectCell ( int  row,
int  col 
)

void wx.GridCtrl.Grid.DeselectCol ( int  col  ) 

void wx.GridCtrl.Grid.DeselectRow ( int  row  ) 

void wx.GridCtrl.Grid.DisableCellEditControl (  ) 

void wx.GridCtrl.Grid.DisableDragColSize (  ) 

void wx.GridCtrl.Grid.DisableDragGridSize (  ) 

void wx.GridCtrl.Grid.DisableDragRowSize (  ) 

override void wx.GridCtrl.Grid.Dispose ( bool  disposing  )  [protected, virtual]

Overriden disposition. Even if we do not own the memory, we have to delete the window, since this is apparently intended by the user calling this method.

Reimplemented from wx.Window.

void wx.GridCtrl.Grid.EndBatch (  ) 

void wx.GridCtrl.Grid.ForceRefresh (  ) 

void wx.GridCtrl.Grid.GetCellAlignment ( int  row,
int  col,
ref int  horiz,
ref int  vert 
)

Colour wx.GridCtrl.Grid.GetCellBackgroundColour ( int  row,
int  col 
)

object wx.GridCtrl.Grid.GetCellData ( int  row,
int  col 
)

This will deserialize the result of GetCellValue() according to the data type that has been associated with this cell.

Parameters:
row Row index of the cell.
col Columns index of the cell.
Returns:
See also:
GetCellValue, SetCellData, GetCellDataType

DataType wx.GridCtrl.Grid.GetCellDataType ( int  row,
int  col 
)

Returns the data type that have been associated with the designated cell. If the cell has not been associated with a type, this method will search for a type associated with the column. If the search for a column type also fails, this will search for a type associated with the row. If nothing can be found, the result will be null.

Parameters:
row The row index.
col The column index.
Returns:
See also:
SetCellDataType, SetRowDataType, SetColDataType

Editors.GridCellEditor wx.GridCtrl.Grid.GetCellEditor ( int  row,
int  col 
)

Parameters:
row Row index of the cell.

Parameters:
col Columns index of the cell.

Font wx.GridCtrl.Grid.GetCellFont ( int  row,
int  col 
)

bool wx.GridCtrl.Grid.GetCellOverflow ( int  row,
int  col 
)

Renderers.GridCellRenderer wx.GridCtrl.Grid.GetCellRenderer ( int  row,
int  col 
)

void wx.GridCtrl.Grid.GetCellSize ( int  row,
int  col,
ref int  num_rows,
ref int  num_cols 
)

Colour wx.GridCtrl.Grid.GetCellTextColour ( int  row,
int  col 
)

Font wx.GridCtrl.Grid.GetCellTextFont ( int  row,
int  col 
)

string wx.GridCtrl.Grid.GetCellValue ( int  row,
int  col 
)

Returns the string value of the designated cell.

Parameters:
row Row index of the cell.
col Columns index of the cell.
See also:
SetCellValue, GetCellData

Alignment [] wx.GridCtrl.Grid.GetColLabelAlignment (  ) 

Returns the alignment information on column labels as an array of flags. The first element of the array will be on the horizontal alignment, the second on the vertical alignment.

Returns:
An array containing 2 alignment flags

string wx.GridCtrl.Grid.GetColLabelValue ( int  col  ) 

int wx.GridCtrl.Grid.GetColSize ( int  col  ) 

int wx.GridCtrl.Grid.GetColumnWidth ( int  col  ) 

void wx.GridCtrl.Grid.GetDefaultCellAlignment ( ref int  horiz,
ref int  vert 
)

Editors.GridCellEditor wx.GridCtrl.Grid.GetDefaultEditorForCell ( int  row,
int  col 
)

Editors.GridCellEditor wx.GridCtrl.Grid.GetDefaultEditorForType ( string  typeName  ) 

Renderers.GridCellRenderer wx.GridCtrl.Grid.GetDefaultRendererForCell ( int  row,
int  col 
)

Renderers.GridCellRenderer wx.GridCtrl.Grid.GetDefaultRendererForType ( string  typeName  ) 

int wx.GridCtrl.Grid.GetLabelAlignment ( int  orientation,
int  align 
)

int wx.GridCtrl.Grid.GetLabelSize ( int  orientation  ) 

string wx.GridCtrl.Grid.GetLabelValue ( int  orientation,
int  pos 
)

DataType wx.GridCtrl.Grid.GetRegisteredDataType ( Type  type  ) 

Returns the data type registered under the provided name if such a type has been defined using RegisterDataType. Otherwise, the result will be null. If this method cannot find a registered type for the argument, it will look for a registration of the base type. This method will not return the properties of the predefined types "string", "bool", "long", "double", and "choice", but, "System.Boolean", "System.Int32", "System.Double", "System.DateTime", "System.Drawing.Point", and "System.String" will be returned.

Parameters:
typeName Name of the desired registered type.
Returns:
The properties of the registered type or null if nothing has been registered under the provided type name.
RegisterDataType

DataType wx.GridCtrl.Grid.GetRegisteredDataType ( string  typeName  ) 

Returns the data type registered under the provided name if such a type has been defined using RegisterDataType. Otherwise, the result will be null. This method will not return the properties of the predefined types "string", "bool", "long", "double", and "choice", but, "System.Boolean", "System.Int32", "System.Double", "System.DateTime", "System.Drawing.Point", and "System.String" will be returned.

Parameters:
typeName Name of the desired registered type.
Returns:
The properties of the registered type or null if nothing has been registered under the provided type name.
RegisterDataType

int wx.GridCtrl.Grid.GetRowHeight ( int  row  ) 

Alignment [] wx.GridCtrl.Grid.GetRowLabelAlignment (  ) 

Returns the alignment information on row labels as an array of flags. The first element of the array will be on the horizontal alignment, the second on the vertical alignment.

Returns:
An array containing 2 alignment flags

string wx.GridCtrl.Grid.GetRowLabelValue ( int  row  ) 

int wx.GridCtrl.Grid.GetRowSize ( int  row  ) 

GridCellCoordsArray wx.GridCtrl.Grid.GetSelectedCells (  ) 

ArrayInt wx.GridCtrl.Grid.GetSelectedCols (  ) 

ArrayInt wx.GridCtrl.Grid.GetSelectedRows (  ) 

GridCellCoordsArray wx.GridCtrl.Grid.GetSelectionBlockBottomRight (  ) 

GridCellCoordsArray wx.GridCtrl.Grid.GetSelectionBlockTopLeft (  ) 

void wx.GridCtrl.Grid.HideCellEditControl (  ) 

bool wx.GridCtrl.Grid.InsertCols ( int  pos,
int  numCols,
bool  updateLabels 
)

Inserts one or more new columns into a grid with the first new column at the specified position and returns true if successful.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new columns. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called wxGrid.CreateGrid) this process is automatic. If you are using a custom grid table (specified with wxGrid.SetTable) then you must override wx.GridCtrl.GridTableBase.InsertCols in your derived table class.

Parameters:
pos Columns index where to insert the new columns.
numCols Number of columns to add.
updateLabels Currently not used.

bool wx.GridCtrl.Grid.InsertCols ( int  pos,
int  numRows 
)

Inserts one or more new columns into a grid with the first new column at the specified position and returns true if successful.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new columns. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called wxGrid.CreateGrid) this process is automatic. If you are using a custom grid table (specified with wxGrid.SetTable) then you must override wx.GridCtrl.GridTableBase.InsertCols in your derived table class.

Parameters:
pos Columns index where to insert the new columns.
numCols Number of columns to add.

bool wx.GridCtrl.Grid.InsertCols ( int  pos  ) 

Inserts one or more new columns into a grid with the first new column at the specified position and returns true if successful.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new columns. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called wxGrid.CreateGrid) this process is automatic. If you are using a custom grid table (specified with wxGrid.SetTable) then you must override wx.GridCtrl.GridTableBase.InsertCols in your derived table class.

Parameters:
pos Columns index where to insert the new columns.

bool wx.GridCtrl.Grid.InsertCols (  ) 

Inserts one or more new columns into a grid with the first new column at the specified position and returns true if successful.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new columns. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called wxGrid.CreateGrid) this process is automatic. If you are using a custom grid table (specified with wxGrid.SetTable) then you must override wx.GridCtrl.GridTableBase.InsertCols in your derived table class.

bool wx.GridCtrl.Grid.InsertRows ( int  pos,
int  numRows,
bool  updateLabels 
)

Use this to insert new rows at position 0 when using the standard grid model.

Parameters:
pos The row position where to insert. Use -1 to insert after the last row and -2 to insert before the last row and so on.
numRows The number of rows to insert.
updateLabels Not used at present.
See also:
M:wx.GridCtrl.Grid.SetTable(), M:wx.GridCtrl.Grid.CreateGrid()

Inserts one or more new rows into a grid with the first new row at the specified position and returns true if successful. The updateLabels argument is not used at present.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new rows. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called CreateGrid) this process is automatic. If you are using a custom grid table (specified with SetTable) then you must override wx.GridCtrl.GridTableBase.InsertRows() in your derived table class.

Returns:

bool wx.GridCtrl.Grid.InsertRows ( int  pos,
int  numRows 
)

Use this to insert new rows at position 0 when using the standard grid model.

Parameters:
pos The row position where to insert. Use -1 to insert after the last row and -2 to insert before the last row and so on.
numRows The number of rows to insert.
See also:
M:wx.GridCtrl.Grid.SetTable(), M:wx.GridCtrl.Grid.CreateGrid()

Inserts one or more new rows into a grid with the first new row at the specified position and returns true if successful. The updateLabels argument is not used at present.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new rows. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called CreateGrid) this process is automatic. If you are using a custom grid table (specified with SetTable) then you must override wx.GridCtrl.GridTableBase.InsertRows() in your derived table class.

Returns:

bool wx.GridCtrl.Grid.InsertRows ( int  pos  ) 

Use this to insert new rows at position 0 when using the standard grid model.

Parameters:
pos The row position where to insert. Use -1 to refer to the last row and -2 to denote the row before the last one etc.
See also:
M:wx.GridCtrl.Grid.SetTable(), M:wx.GridCtrl.Grid.CreateGrid()

Inserts one or more new rows into a grid with the first new row at the specified position and returns true if successful. The updateLabels argument is not used at present.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new rows. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called CreateGrid) this process is automatic. If you are using a custom grid table (specified with SetTable) then you must override wx.GridCtrl.GridTableBase.InsertRows() in your derived table class.

Returns:

bool wx.GridCtrl.Grid.InsertRows (  ) 

Use this to insert new rows at position 0 when using the standard grid model.

See also:
M:wx.GridCtrl.Grid.SetTable(), M:wx.GridCtrl.Grid.CreateGrid()

Inserts one or more new rows into a grid with the first new row at the specified position and returns true if successful. The updateLabels argument is not used at present.

The sequence of actions begins with the grid object requesting the underlying grid table to insert new rows. If this is successful the table notifies the grid and the grid updates the display. For a default grid (one where you have called CreateGrid) this process is automatic. If you are using a custom grid table (specified with SetTable) then you must override wx.GridCtrl.GridTableBase.InsertRows() in your derived table class.

bool wx.GridCtrl.Grid.IsInSelection ( int  row,
int  col 
)

bool wx.GridCtrl.Grid.IsReadOnly ( int  row,
int  col 
)

Returns true iff the designated cell is in readonly mode.

Parameters:
row Row index of the cell.
col Columns index of the cell.

bool wx.GridCtrl.Grid.IsVisible ( int  row,
int  col,
bool  wholeCellVisible 
)

void wx.GridCtrl.Grid.MakeCellVisible ( int  row,
int  col 
)

bool wx.GridCtrl.Grid.MoveCursorDown ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorDownBlock ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorLeft ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorLeftBlock ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorRight ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorRightBlock ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorUp ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MoveCursorUpBlock ( bool  expandSelection  ) 

bool wx.GridCtrl.Grid.MovePageDown (  ) 

bool wx.GridCtrl.Grid.MovePageUp (  ) 

bool wx.GridCtrl.Grid.ProcessTableMessage ( GridTableMessage  msg  ) 

Method for instances of GridTableBase to inform displaying grid controls of any changes. This method implements an often vital directions of passing information in data binding that is often missing: The data model can use this method to inform displaying controls of changes.

void wx.GridCtrl.Grid.RegisterDataType ( DataType  dataType  ) 

Defines a new data type. A data type has a name and is associated with a renderer (to render the data) and an editor (to put in or remove data). Data types may be used by GridTableBase to assign renderers and editors to cells. You can register data types to create a base of reuseable renderers and editors. The system predefines "string", "bool", "long", "double", and "choice". These predefined types may be referred by instances of GridTableBase. They cannot be used by SetValue() and GetRegisteredDataType().

Parameters:
dataType The properties of the new data type.
See also:
GridTableBase, GetRegisteredDataType

void wx.GridCtrl.Grid.RegisterDataType ( Type  type,
Renderers.GridCellRenderer  renderer,
Editors.GridCellEditor  editor,
DataType.ToStringConverter  toString,
DataType.FromStringConverter  fromString 
)

Defines a new data type. A data type has a name and is associated with a renderer (to render the data) and an editor (to put in or remove data). Data types may be used by GridTableBase to assign renderers and editors to cells. You can register data types to create a base of reuseable renderers and editors. The system predefines "string", "bool", "long", "double", and "choice". These predefined types may be referred by instances of GridTableBase. They cannot be used by SetValue() and GetRegisteredDataType().

Parameters:
type The name of the data type will be derived from the namespace and the name of this type.
renderer The renderer that shall be used to render cells of this type.
editor The editor that shall be used to change values of this type.
fromString Create an object of this type from a string.
toString Create a string serializing an object of this type.
See also:
GridTableBase, GetRegisteredDataType

void wx.GridCtrl.Grid.RegisterDataType ( string  typeName,
Renderers.GridCellRenderer  renderer,
Editors.GridCellEditor  editor,
DataType.ToStringConverter  toString,
DataType.FromStringConverter  fromString 
)

Defines a new data type. A data type has a name and is associated with a renderer (to render the data) and an editor (to put in or remove data). Data types may be used by GridTableBase to assign renderers and editors to cells. You can register data types to create a base of reuseable renderers and editors. The system predefines "string", "bool", "long", "double", and "choice". These predefined types may be referred by instances of GridTableBase. They cannot be used by SetValue() and GetRegisteredDataType().

Parameters:
typeName The name of the data type.
renderer The renderer that shall be used to render cells of this type.
editor The editor that shall be used to change values of this type.
fromString Create an object of this type from a string.
toString Create a string serializing an object of this type.
See also:
GridTableBase, GetRegisteredDataType

void wx.GridCtrl.Grid.RegisterDataType ( string  typeName,
Renderers.GridCellRenderer  renderer,
Editors.GridCellEditor  editor 
)

Defines a new data type. A data type has a name and is associated with a renderer (to render the data) and an editor (to put in or remove data). Data types may be used by GridTableBase to assign renderers and editors to cells. You can register data types to create a base of reuseable renderers and editors. The system predefines "string", "bool", "long", "double", and "choice". These predefined types may be referred by instances of GridTableBase. They cannot be used by SetValue() and GetRegisteredDataType().

Parameters:
typeName The name of the data type.
renderer The renderer that shall be used to render cells of this type.
editor The editor that shall be used to change values of this type.
See also:
GridTableBase, GetRegisteredDataType

void wx.GridCtrl.Grid.SaveEditControlValue (  ) 

void wx.GridCtrl.Grid.SelectAll (  ) 

void wx.GridCtrl.Grid.SelectBlock ( int  topRow,
int  leftCol,
int  bottomRow,
int  rightCol,
bool  addToSelected 
)

void wx.GridCtrl.Grid.SelectCol ( int  col,
bool  addToSelected 
)

void wx.GridCtrl.Grid.SelectRow ( int  row,
bool  addToSelected 
)

void wx.GridCtrl.Grid.SetAttr ( int  row,
int  col,
GridCellAttr  attr 
)

Assigns display attributes to a cell.

Parameters:
row Row of the cell whose appearance will be defined by this method
col Row of the row whose appearance will be defined by this method
attr Defines the appearance of the cell.

void wx.GridCtrl.Grid.SetCellAlignment ( int  align,
int  row,
int  col 
)

void wx.GridCtrl.Grid.SetCellAlignment ( int  row,
int  col,
Alignment  horiz,
Alignment  vert 
)

Defines the alignment of text in the cell.

Parameters:
row The row index of the cell.
col The columns index of the cell.
horiz Specifies the horizontal alignment
vert Specified the vertical alignment

void wx.GridCtrl.Grid.SetCellBackgroundColour ( int  row,
int  col,
Colour  colour 
)

void wx.GridCtrl.Grid.SetCellBitmap ( Bitmap  bitmap,
int  row,
int  col 
)

void wx.GridCtrl.Grid.SetCellData ( int  row,
int  col,
object  o 
)

The provided object will be serialized and written into the designated grid cell. This method will use the serialization as provided by the data type that has been associated with this cell.

Parameters:
row Row index of the cell.
col Columns index of the cell.
o The object that will be serialized and written into the grid cell.
See also:
SetCellValue, GetCellData, GetCellDataType

void wx.GridCtrl.Grid.SetCellDataType ( int  row,
int  col,
Type  type 
)

This will set the data type that is associated with the designated cell. editor and renderer will be set according to the data type. Additionally, this

Parameters:
row Index of the row containing the cell whose data type will be set.
col Index of the column containing the cell whose data type will be set.
type The data type that will be set. GetregisteredDataType() will be used to read the data type to set.
See also:
GetRegisteredDataType

void wx.GridCtrl.Grid.SetCellDataType ( int  row,
int  col,
string  typename 
)

This will set the data type that is associated with the designated cell. editor and renderer will be set according to the data type. Additionally, this

Parameters:
row Index of the row containing the cell whose data type will be set.
col Index of the column containing the cell whose data type will be set.
typename The data type that will be set. GetregisteredDataType() will be used to read the data type to set.
See also:
GetRegisteredDataType

void wx.GridCtrl.Grid.SetCellDataType ( int  row,
int  col,
DataType  t 
)

This will set the data type that is associated with the designated cell. editor and renderer will be set according to the data type. Additionally, this

Parameters:
row Index of the row containing the cell whose data type will be set.
col Index of the column containing the cell whose data type will be set.
t The data type that will be set. If this is null, this method will do nothing.

void wx.GridCtrl.Grid.SetCellEditor ( int  row,
int  col,
Editors.GridCellEditor  editor 
)

Sets the editor of a particular cell. If the editor os null, this will call SetReadOnly.

Parameters:
row Row index of the cell.
col Columns index of the cell.
editor The editor that will be opened to edit the designated cell.
SetReadOnly

void wx.GridCtrl.Grid.SetCellFont ( int  row,
int  col,
Font  fnt 
)

void wx.GridCtrl.Grid.SetCellOverflow ( int  row,
int  col,
bool  allow 
)

Defines whether the content of a cell might span over neighbours if it is too large for the size of ots own cell.

Parameters:
row The row index of the cell.
col The columns index of the cell.
allow Parameter that defines whether to allow or forbid cell overflow.

void wx.GridCtrl.Grid.SetCellRenderer ( int  row,
int  col,
Renderers.GridCellRenderer  renderer 
)

This will set the editor for a particular cell. Alternatively, you may set the editor to be used by a wx.GridCellAttr or you may assign a value to property wx.Grid.DefaultEditor.

void wx.GridCtrl.Grid.SetCellSize ( int  row,
int  col,
int  num_rows,
int  num_cols 
)

Call this to make a cell span over other cells in the neighbourhood. Use this method before setting attributes like alignment or colour of the cells. Do not use wx.Grid.SetColAttr() if this defines a column range larger 1 and avoid wx.GridSetRowAttr() if this defines a row range larger 1.

Parameters:
row The row index of the cell to be expanded.
col The columns index of the cell to be expanded.
num_rows The number of rows that will be hidden behind this cell.
num_cols The number of cells that will be hidden behind this cell.

void wx.GridCtrl.Grid.SetCellTextColour ( int  row,
int  col,
Colour  val 
)

void wx.GridCtrl.Grid.SetCellTextFont ( Font  fnt,
int  row,
int  col 
)

void wx.GridCtrl.Grid.SetCellValue ( int  row,
int  col,
string  s 
)

Sets the string value of the designated cell.

Parameters:
row Row index of the cell.
col Columns index of the cell.
See also:
GetCellValue, SetCellData

void wx.GridCtrl.Grid.SetColAttr ( int  col,
GridCellAttr  attr 
)

Assigns display attributes to a cell.

Parameters:
row Row of the cell whose appearance will be defined by this method
col Row of the row whose appearance will be defined by this method
attr Defines the appearance of the cell.

void wx.GridCtrl.Grid.SetColDataType ( int  col,
Type  type 
)

This will set the data type that is associated with the designated column. editor and renderer will be set according to the data type. Additionally, this

Parameters:
col Index of the column containing the cell whose data type will be set.
type The data type that will be set. GetregisteredDataType() will be used to read the data type to set.
See also:
GetRegisteredDataType

void wx.GridCtrl.Grid.SetColDataType ( int  row,
int  col,
string  typename 
)

This will set the data type that is associated with the designated column. editor and renderer will be set according to the data type. Additionally, this

Parameters:
col Index of the column containing the cell whose data type will be set.
typename The data type that will be set. GetregisteredDataType() will be used to read the data type to set.
See also:
GetRegisteredDataType

void wx.GridCtrl.Grid.SetColDataType ( int  col,
DataType  t 
)

This will set the data type that is associated with the designated column. editor and renderer will be set according to the data type. Additionally, this

Parameters:
col Index of the column containing the cell whose data type will be set.
t The data type that will be set.

void wx.GridCtrl.Grid.SetColFormatCustom ( int  col,
string  typeName 
)

void wx.GridCtrl.Grid.SetColFormatFloat ( int  col,
int  width,
int  precision 
)

void wx.GridCtrl.Grid.SetColFormatFloat ( int  col,
int  width 
)

void wx.GridCtrl.Grid.SetColFormatFloat ( int  col  ) 

void wx.GridCtrl.Grid.SetColLabelAlignment ( Alignment  horiz,
Alignment  vert 
)

Sets the horizontal and vertical alignment of column label text.

Parameters:
horiz Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT.
vert Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.

void wx.GridCtrl.Grid.SetColLabelValue ( int  col,
string  str 
)

void wx.GridCtrl.Grid.SetColMinimalWidth ( int  col,
int  width 
)

void wx.GridCtrl.Grid.SetColSize ( int  col,
int  width 
)

void wx.GridCtrl.Grid.SetColumnWidth ( int  col,
int  width 
)

void wx.GridCtrl.Grid.SetDefaultCellAlignment ( int  horiz,
int  vert 
)

void wx.GridCtrl.Grid.SetDefaultColSize ( int  width,
bool  resizeExistingCols 
)

void wx.GridCtrl.Grid.SetDefaultRowSize ( int  height,
bool  resizeExistingRows 
)

void wx.GridCtrl.Grid.SetGridCursor ( int  row,
int  col 
)

void wx.GridCtrl.Grid.SetLabelAlignment ( int  orientation,
int  align 
)

void wx.GridCtrl.Grid.SetLabelSize ( int  orientation,
int  sz 
)

void wx.GridCtrl.Grid.SetLabelValue ( int  orientation,
string  val,
int  pos 
)

void wx.GridCtrl.Grid.SetMargins ( int  extraWidth,
int  extraHeight 
)

void wx.GridCtrl.Grid.SetReadOnly ( int  row,
int  col,
bool  isReadOnly 
)

Use this to turn a particular cell into readonly mode (editors will not open) or to make them editable again.

Parameters:
row Row index of the cell.
col Columns index of the cell.
isReadOnly Turns with true the cell into readonly mode. Makes with false the cell editable again.
See also:
IsReadOnly

void wx.GridCtrl.Grid.SetReadOnly ( int  row,
int  col 
)

Use this to turn a particular cell into readonly mode (editors will not open).

Parameters:
row Row index of the cell.
col Columns index of the cell.
See also:
IsReadOnly

void wx.GridCtrl.Grid.SetRowAttr ( int  row,
GridCellAttr  attr 
)

Assigns display attributes to a cell.

Parameters:
row Row of the cell whose appearance will be defined by this method
col Row of the row whose appearance will be defined by this method
attr Defines the appearance of the cell.

void wx.GridCtrl.Grid.SetRowDataType ( int  row,
Type  type 
)

This will set the data type that is associated with the designated cell. editor and renderer will be set according to the data type. Additionally, this

Parameters:
row Index of the row containing the cell whose data type will be set.
type The data type that will be set. GetregisteredDataType() will be used to read the data type to set.
See also:
GetRegisteredDataType

void wx.GridCtrl.Grid.SetRowDataType ( int  row,
string  typename 
)

This will set the data type that is associated with the designated row. editor and renderer will be set according to the data type. Additionally, this

Parameters:
row Index of the row containing the cell whose data type will be set.
typename The data type that will be set. GetregisteredDataType() will be used to read the data type to set.
See also:
GetRegisteredDataType

void wx.GridCtrl.Grid.SetRowDataType ( int  row,
DataType  t 
)

This will set the data type that is associated with the designated row. editor and renderer will be set according to the data type. Additionally, this

Parameters:
row Index of the row containing the cell whose data type will be set.
t The data type that will be set.

void wx.GridCtrl.Grid.SetRowHeight ( int  row,
int  height 
)

void wx.GridCtrl.Grid.SetRowLabelAlignment ( Alignment  horiz,
Alignment  vert 
)

Sets the horizontal and vertical alignment of column label text.

Parameters:
horiz Horizontal alignment should be one of wxALIGN_LEFT, wxALIGN_CENTRE or wxALIGN_RIGHT.
vert Vertical alignment should be one of wxALIGN_TOP, wxALIGN_CENTRE or wxALIGN_BOTTOM.

void wx.GridCtrl.Grid.SetRowLabelValue ( int  row,
string  str 
)

void wx.GridCtrl.Grid.SetRowMinimalHeight ( int  row,
int  width 
)

void wx.GridCtrl.Grid.SetRowSize ( int  row,
int  height 
)

bool wx.GridCtrl.Grid.SetTable ( GridTableBase  table,
bool  takeOwnership,
GridSelectionMode  select 
)

Set the provided table as table model in cell selection mode without taking ownership.

Parameters:
table The table model
takeOwnerShip If true then this grid will take ownership of the grid model
select Defines the selection mode.
Returns:

bool wx.GridCtrl.Grid.SetTable ( GridTableBase  table,
bool  takeOwnerShip 
)

Set the provided table as table model in cell selection mode without taking ownership.

Parameters:
table The table model
takeOwnerShip If true then this grid will take ownership of the grid model
Returns:

bool wx.GridCtrl.Grid.SetTable ( GridTableBase  table  ) 

Set the provided table as table model in cell selection mode without taking ownership.

Parameters:
table The table model
Returns:

void wx.GridCtrl.Grid.ShowCellEditControl (  ) 

void wx.GridCtrl.Grid.UpdateDimensions (  ) 

int wx.GridCtrl.Grid.XToCol ( int  x  ) 

int wx.GridCtrl.Grid.XToEdgeOfCol ( int  x  ) 

int wx.GridCtrl.Grid.YToEdgeOfRow ( int  y  ) 

int wx.GridCtrl.Grid.YToRow ( int  y  ) 


Property Documentation

int wx.GridCtrl.Grid.BatchCount [get]

bool wx.GridCtrl.Grid.CanEnableCellControl [get]

int wx.GridCtrl.Grid.CellAlignment [set]

Colour wx.GridCtrl.Grid.CellBackgroundColour [set]

bool wx.GridCtrl.Grid.CellEditControlEnabled [get, set]

Colour wx.GridCtrl.Grid.CellHighlightColour [get, set]

int wx.GridCtrl.Grid.CellHighlightPenWidth [get, set]

int wx.GridCtrl.Grid.CellHighlightROPenWidth [get, set]

Colour wx.GridCtrl.Grid.CellTextColour [set]

Font wx.GridCtrl.Grid.CellTextFont [get, set]

int wx.GridCtrl.Grid.ColFormatBool [set]

int wx.GridCtrl.Grid.ColFormatNumber [set]

int wx.GridCtrl.Grid.ColLabelSize [get, set]

Defines the size of the column labels. Set this to 0 to disable column labels.

See also:
DefaultColLabelSize

int wx.GridCtrl.Grid.ColMinimalAcceptableWidth [get, set]

int wx.GridCtrl.Grid.Cols [get]

Use this to read the number of columns.

int wx.GridCtrl.Grid.CursorColumn [get]

The column index of the cell that can be edited.

int wx.GridCtrl.Grid.CursorRow [get]

The row comprising the cell that can be edited.

Colour wx.GridCtrl.Grid.DefaultCellBackgroundColour [get, set]

Font wx.GridCtrl.Grid.DefaultCellFont [get, set]

bool wx.GridCtrl.Grid.DefaultCellOverflow [get, set]

Colour wx.GridCtrl.Grid.DefaultCellTextColour [get, set]

int wx.GridCtrl.Grid.DefaultColLabelSize [get]

The default size of column labels. Assign this value to ColLabelSize in order to re-enable column labels.

See also:
ColLabelSize

int wx.GridCtrl.Grid.DefaultColSize [get, set]

Gets or sets the default column size. Setting a value to this property always disables resizing (also the default in wxWidgets). Use SetDefaultColSize() to enable resizing of rows.

Editors.GridCellEditor wx.GridCtrl.Grid.DefaultEditor [get, set]

Get or set the default editor. Please note, that the grid will gain ownership of the wrapped C++ instance of the editor. This will raise an exception, if you try to set an editor that is already in use.

Renderers.GridCellRenderer wx.GridCtrl.Grid.DefaultRenderer [get, set]

Get or set the default renderer. Please note, that the grid will gain ownership of the wrapped C++ instance of the editor. This will raise an exception, if you try to set an editor that is already in use.

int wx.GridCtrl.Grid.DefaultRowLabelSize [get]

The default size of row labels. Assign this value to RowLabelSize in order to re-enable row labels.

See also:
RowLabelSize

int wx.GridCtrl.Grid.DefaultRowSize [get, set]

Gets or sets the default row size. Setting a value to this property always disables resizing (also the default in wxWidgets). Use SetDefaultRowSize() to enable resizing of rows.

Pen wx.GridCtrl.Grid.DividerPen [get, set]

bool wx.GridCtrl.Grid.DragColSizeEnabled [get, set]

bool wx.GridCtrl.Grid.DragGridSizeEnabled [get, set]

bool wx.GridCtrl.Grid.DragRowSizeEnabled [get, set]

bool wx.GridCtrl.Grid.Editable [get, set]

bool wx.GridCtrl.Grid.EditInPlace [get]

Window wx.GridCtrl.Grid.GridColLabelWindow [get]

Window wx.GridCtrl.Grid.GridCornerLabelWindow [get]

int wx.GridCtrl.Grid.GridCursorCol [get]

int wx.GridCtrl.Grid.GridCursorRow [get]

Colour wx.GridCtrl.Grid.GridLineColour [get, set]

bool wx.GridCtrl.Grid.GridLinesEnabled [get, set]

Window wx.GridCtrl.Grid.GridRowLabelWindow [get]

Window wx.GridCtrl.Grid.GridWindow [get]

bool wx.GridCtrl.Grid.IsCellEditControlShown [get]

bool wx.GridCtrl.Grid.IsCurrentCellReadOnly [get]

bool wx.GridCtrl.Grid.IsEditable [get, set]

bool wx.GridCtrl.Grid.IsSelection [get]

Colour wx.GridCtrl.Grid.LabelBackgroundColour [get, set]

Font wx.GridCtrl.Grid.LabelFont [get, set]

Colour wx.GridCtrl.Grid.LabelTextColour [get, set]

int wx.GridCtrl.Grid.NumberCols [get]

Gets the number of columns.

int wx.GridCtrl.Grid.NumberRows [get]

Gets the number of rows.

int wx.GridCtrl.Grid.RowLabelSize [get, set]

Defines the size of the row labels. Set this to 0 to disable row labels.

See also:
DefaultRowLabelSize

int wx.GridCtrl.Grid.RowMinimalAcceptableHeight [get, set]

int wx.GridCtrl.Grid.Rows [get]

Use this to read the number of rows.

int wx.GridCtrl.Grid.ScrollPosX [get, set]

int wx.GridCtrl.Grid.ScrollPosY [get, set]

Colour wx.GridCtrl.Grid.SelectionBackground [get, set]

Colour wx.GridCtrl.Grid.SelectionForeground [get, set]

GridSelectionMode wx.GridCtrl.Grid.SelectionMode [get, set]

Gets the selection mode, whether cells, or rows, or columns will be selected.

GridTableBase wx.GridCtrl.Grid.Table [get, set]

Get or set the table. This will use SetTable(value) for setting the table model, i.e. this operations does not take ownership of the table model and the selection mode will be cell selection.

int wx.GridCtrl.Grid.ViewHeight [get]

Returned number of whole rows visible.

int wx.GridCtrl.Grid.ViewWidth [get]

Returned number of whole cols visible.


Event Documentation

event EventListener wx.GridCtrl.Grid.CellChange [add, remove]

event EventListener wx.GridCtrl.Grid.CellLeftClick [add, remove]

event EventListener wx.GridCtrl.Grid.CellLeftDoubleClick [add, remove]

event EventListener wx.GridCtrl.Grid.CellRightClick [add, remove]

event EventListener wx.GridCtrl.Grid.CellRightDoubleClick [add, remove]

event EventListener wx.GridCtrl.Grid.ColumnSize [add, remove]

event EventListener wx.GridCtrl.Grid.EditorCreate [add, remove]

event EventListener wx.GridCtrl.Grid.EditorHidden [add, remove]

event EventListener wx.GridCtrl.Grid.EditorShown [add, remove]

event EventListener wx.GridCtrl.Grid.LabelLeftClick [add, remove]

event EventListener wx.GridCtrl.Grid.LabelLeftDoubleClick [add, remove]

event EventListener wx.GridCtrl.Grid.LabelRightClick [add, remove]

event EventListener wx.GridCtrl.Grid.LabelRightDoubleClick [add, remove]

event EventListener wx.GridCtrl.Grid.RangeSelect [add, remove]

event EventListener wx.GridCtrl.Grid.RowSize [add, remove]

event EventListener wx.GridCtrl.Grid.SelectCell [add, remove]


Manual of the wx.NET   (c) 2003-2011 the wx.NET project at   Get wx.NET at SourceForge.net. Fast, secure and Free Open Source software downloads