Property | Type | Description | |
---|---|---|---|
m_MouseCellPosition | |||
m_MouseDownPosition |
Property | Type | Description | |
---|---|---|---|
GetVisibleRegion | IEnumerable |
||
PerformStretch | void | ||
SetScrollArea | void |
Method | Description | |
---|---|---|
ArrangeLinkedControls ( ) : void |
Refresh the linked controls bounds
|
|
AutoSizeCells ( ) : void |
Auto size all the columns and all the rows with the required width and height
|
|
AutoSizeCells ( Range p_RangeToAutoSize ) : void |
Auto size the columns and the rows speified
|
|
ChangeDragCell ( |
Fired when the cell in the drag events change. For internal use only.
|
|
ChangeMouseCell ( |
Fired when the cell under the mouse change. For internal use only.
|
|
ChangeMouseDownCell ( |
Change the cell currently under the mouse
|
|
ChangeMouseSelectionCorner ( |
Fired when the corner of the mouse selection change. For internal use only.
|
|
CheckPositions ( ) : void |
Check if the positions saved are still valid, for example if all the selected cells are still valid positions, if not the selection are removed without calling any other methods.
|
|
ClearValues ( |
Clear all the selected cells with a valid Model.
|
|
GetCell ( |
Return the Cell at the specified Row and Col position. This method is called for sort operations and for Move operations. If position is Empty return null. This method calls GetCell(int p_iRow, int p_iCol)
|
|
GetCell ( int p_iRow, int p_iCol ) : Cells.ICellVirtual |
Return the Cell at the specified Row and Col position. Abstract, must be implemented in the derived class.
|
|
GetCellsAtColumn ( int p_ColumnIndex ) : Cells.ICellVirtual[] |
Returns all the cells at specified column position
|
|
GetCellsAtRow ( int p_RowIndex ) : Cells.ICellVirtual[] |
Returns all the cells at specified row position
|
|
GetFixedLeftArea ( ) : |
||
GetFixedTopArea ( ) : |
||
GetFixedTopLeftArea ( ) : |
||
GetPositionType ( |
Returns the type of a cell position
|
|
GetScrollableArea ( ) : |
||
GetVisibleColumns ( |
||
GetVisibleColumns ( bool returnsPartial ) : List |
||
GetVisibleRows ( |
||
GetVisibleRows ( bool returnsPartial ) : List |
||
GridVirtual ( ) : System |
Grid constructor
|
|
InvalidateCell ( |
Force a cell to redraw.
|
|
InvalidateRange ( Range range ) : void |
Force a range of cells to redraw.
|
|
IsCellVisible ( |
Indicates if the specified cell is visible.
|
|
MouseSelectionFinish ( ) : void |
Fired when the mouse selection finish. See also MouseSelectionRange.
|
|
OnCellsAreaChanged ( ) : void |
Force to recalculate scrollbars and panels location. Used usually after changing width and height of the columns / rows, or after adding or removing rows and columns.
|
|
OnUserException ( ExceptionEventArgs e ) : void |
Event fired when an exception is throw in some method that require a notification to the user. If not handled by the user (Handled property = false) a MessageBox is used to display the exception.
|
|
PositionAtPoint ( Point point ) : |
Returns the cell at the specified grid view relative point (the point must be relative to the grid display region), SearchInFixedCells = true. Return Position.Empty if no valid cells are found.
|
|
PositionToCellRange ( |
This method converts a Position to the real range of the cell. This is usefull when RowSpan or ColumnSpan is greater than 1. For example suppose to have at grid[0,0] a cell with ColumnSpan equal to 2. If you call this method with the position 0,0 returns 0,0-0,1 and if you call this method with 0,1 return again 0,0-0,1.
|
|
PositionToRectangle ( |
Get the rectangle of the cell respect to the client area visible, the grid DisplayRectangle. Returns Rectangle.Empty if the Position is empty or if is not valid.
|
|
PositionToStartPosition ( |
This method converts a Position to the real start position of cell. This is usefull when RowSpan or ColumnSPan is greater than 1. For example suppose to have at grid[0,0] a cell with ColumnSpan equal to 2. If you call this method with the position 0,0 returns 0,0 and if you call this method with 0,1 return again 0,0. Get the real position for the specified position. For example when p_Position is a merged cell this method returns the starting position of the merged cells. Usually this method returns the same cell specified as parameter. This method is used for processing arrow keys, to find a valid cell when the focus is in a merged cell. For this class returns always p_Position.
|
|
ProcessSpecialGridKey ( |
Process Delete, Ctrl+C, Ctrl+V, Up, Down, Left, Right, Tab keys
|
|
RangeAtArea ( CellPositionType areaType ) : Range |
Get the range of cells at the specified dispaly area. This method consider only the visible cells using the current scroll position. Returns a single Range for the specified grid area (scrollable, fixedtop, fixedleft, fixedtopleft). Returns Range.Empty if there isn't a valid range in the specified area.
|
|
RangeToRectangle ( Range range ) : |
Returns the relative rectangle to the current scrollable area of the specified Range. Returns a Rectangle.Empty if the Range is not valid.
|
|
RangeToSize ( Range range ) : |
||
ScrollOnPoint ( Point mousePoint ) : void |
Move the scrollbars to the direction specified by the point specified. Method used by the Mouse multi selection (MouseSelection.cs)
|
|
ShowCell ( |
Scroll the view to show the cell passed. Ensure that if the cell if invisible or partial visible it will be totally visible
|
|
SortRangeRows ( IRangeLoader p_RangeToSort, int keyColumn, bool p_bAsc, IComparer p_CellComparer ) : void |
Sort a range of the grid
|
|
SortRangeRows ( Range p_Range, int keyColumn, bool p_bAscending, IComparer p_CellComparer ) : void |
Sort a range of the grid.
|
Method | Description | |
---|---|---|
CreateColumnsObject ( ) : SourceGrid.ColumnsBase |
Abstract method used to create the columns object.
|
|
CreateRowsObject ( ) : SourceGrid.RowsBase |
Abstract method used to create the rows object.
|
|
CreateSelectionObject ( ) : |
Virtual factory method used to create the SelectionBase derived object. The base method create a different object based on the value of SelectionMode property.
|
|
Dispose ( bool disposing ) : void |
Clean up any resources being used.
|
|
GetScrollColumns ( int displayWidth ) : int |
Calculate the number of columns to scroll. 0 to disable the scrollbar. The returned value is independent from the current scrolling position, must be a fixed value calculated based on the total number of columns and the available area.
|
|
GetScrollPositionToShowCell ( |
Indicates if the specified range is visible Return the scroll position that must be set to show a specific cell.
|
|
GetScrollRows ( int displayHeight ) : int |
Returns the logical scroll size (usually Rows and Columns) for the specified display area. Returns true if the vertical scrollbar is required Returns true if the horizontal scrollbar is required Calculate the number of rows to scroll. 0 to disable the scrollbar. The returned value is independent from the current scrolling position, must be a fixed value calculated based on the total number of rows and the available area.
|
|
InvalidateScrollableArea ( ) : void |
Invalidate the cells
|
|
IsInputChar ( char charCode ) : bool |
IsInputChar method.
|
|
IsInputKey ( Keys keyData ) : bool |
Allow the grid to handle specials keys like Arrows and Tab. See also Grid.SpecialKeys
|
|
OnApplyMouseSelection ( |
Fired when the mouse selection is succesfully finished. See also MouseSelectionRange.
|
|
OnEnter ( |
||
OnHScrollPositionChanged ( |
OnHScrollPositionChanged
|
|
OnKeyDown ( |
||
OnKeyPress ( |
||
OnKeyUp ( |
||
OnMouseClick ( MouseEventArgs e ) : void | ||
OnMouseDoubleClick ( MouseEventArgs e ) : void | ||
OnMouseDown ( MouseEventArgs e ) : void | ||
OnMouseLeave ( |
||
OnMouseMove ( MouseEventArgs e ) : void | ||
OnMouseSelectionChange ( |
Fired when the mouse selection change. See also MouseSelectionRange.
|
|
OnMouseSelectionFinish ( |
Fired when the selection eith the mouse is finished
|
|
OnMouseUp ( MouseEventArgs e ) : void | ||
OnMouseWheel ( MouseEventArgs e ) : void |
Fired when a user scroll with the mouse wheel
|
|
OnPaint ( PaintEventArgs e ) : void | ||
OnRangePaint ( |
||
OnResize ( |
||
OnSortedRangeRows ( |
Fired after calling SortRangeRows method
|
|
OnSortingRangeRows ( |
Fired when calling SortRangeRows method
|
|
OnUndoMouseSelection ( |
Fired when the mouse selection must be canceled. See also MouseSelectionRange.
|
|
OnVScrollPositionChanged ( |
OnVScrollPositionChanged
|
|
OnValidated ( |
||
PaintCell ( DevAge graphics, |
Draw the specified Cell
|
|
ProcessCmdKey ( |
Processes a command key.
|
Method | Description | |
---|---|---|
GetVisibleRegion ( ) : IEnumerable |
Get the range for the specific area type and rectangle Get the visible ranges. Returns a list of Range, one for each area.
|
|
PerformStretch ( ) : void |
Recalculate the scrollbar position and value based on the current cells, scroll client area, linked controls and more. If redraw == false this method has not effect. This method is called when you put Redraw = true;
|
|
SetScrollArea ( ) : void |
public AutoSizeCells ( Range p_RangeToAutoSize ) : void | ||
p_RangeToAutoSize | Range | |
return | void |
public ChangeDragCell ( |
||
cell | ||
pDragEventArgs | ||
return | void |
public ChangeMouseCell ( |
||
p_Cell | ||
return | void |
public ChangeMouseDownCell ( |
||
p_MouseDownCell | ||
p_MouseCell | ||
return | void |
public ChangeMouseSelectionCorner ( |
||
p_Corner | ||
return | void |
public ClearValues ( |
||
region | ||
return | void |
protected abstract CreateColumnsObject ( ) : SourceGrid.ColumnsBase | ||
return | SourceGrid.ColumnsBase |
protected abstract CreateRowsObject ( ) : SourceGrid.RowsBase | ||
return | SourceGrid.RowsBase |
protected CreateSelectionObject ( ) : |
||
return |
public GetCell ( |
||
p_Position | ||
return | Cells.ICellVirtual |
public abstract GetCell ( int p_iRow, int p_iCol ) : Cells.ICellVirtual | ||
p_iRow | int | |
p_iCol | int | |
return | Cells.ICellVirtual |
public GetCellsAtColumn ( int p_ColumnIndex ) : Cells.ICellVirtual[] | ||
p_ColumnIndex | int | |
return | Cells.ICellVirtual[] |
public GetCellsAtRow ( int p_RowIndex ) : Cells.ICellVirtual[] | ||
p_RowIndex | int | |
return | Cells.ICellVirtual[] |
public GetFixedLeftArea ( ) : |
||
return |
public GetFixedTopArea ( ) : |
||
return |
public GetFixedTopLeftArea ( ) : |
||
return |
public GetPositionType ( |
||
position | ||
return | CellPositionType |
protected GetScrollColumns ( int displayWidth ) : int | ||
displayWidth | int | |
return | int |
protected GetScrollPositionToShowCell ( |
||
position | ||
partial | bool | True to return also partial visible cells |
newScrollPosition | Point | |
return | bool |
protected GetScrollRows ( int displayHeight ) : int | ||
displayHeight | int | |
return | int |
public GetScrollableArea ( ) : |
||
return |
public GetVisibleColumns ( |
||
displayRectangle | ||
returnsPartial | bool | |
return | List |
public GetVisibleColumns ( bool returnsPartial ) : List |
||
returnsPartial | bool | |
return | List |
public GetVisibleRows ( |
||
displayRectangle | ||
returnsPartial | bool | |
return | List |
public GetVisibleRows ( bool returnsPartial ) : List |
||
returnsPartial | bool | |
return | List |
public InvalidateCell ( |
||
position | ||
return | void |
public InvalidateRange ( Range range ) : void | ||
range | Range | |
return | void |
protected InvalidateScrollableArea ( ) : void | ||
return | void |
public IsCellVisible ( |
||
position | ||
partial | bool | True to returns also partial visible cells |
return | bool |
protected IsInputChar ( char charCode ) : bool | ||
charCode | char | |
return | bool |
protected OnApplyMouseSelection ( |
||
e | ||
return | void |
protected OnHScrollPositionChanged ( |
||
e | ||
return | void |
protected OnKeyDown ( |
||
e | ||
return | void |
protected OnKeyPress ( |
||
e | ||
return | void |
protected OnKeyUp ( |
||
e | ||
return | void |
protected OnMouseClick ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseDoubleClick ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseDown ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseLeave ( |
||
e | ||
return | void |
protected OnMouseMove ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseSelectionChange ( |
||
e | ||
return | void |
protected OnMouseSelectionFinish ( |
||
e | ||
return | void |
protected OnMouseUp ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnMouseWheel ( MouseEventArgs e ) : void | ||
e | MouseEventArgs | |
return | void |
protected OnPaint ( PaintEventArgs e ) : void | ||
e | PaintEventArgs | |
return | void |
protected OnRangePaint ( |
||
e | ||
return | void |
protected OnResize ( |
||
e | ||
return | void |
protected OnSortedRangeRows ( |
||
e | ||
return | void |
protected OnSortingRangeRows ( |
||
e | ||
return | void |
protected OnUndoMouseSelection ( |
||
e | ||
return | void |
public OnUserException ( ExceptionEventArgs e ) : void | ||
e | ExceptionEventArgs | |
return | void |
protected OnVScrollPositionChanged ( |
||
e | ||
return | void |
protected OnValidated ( |
||
e | ||
return | void |
protected PaintCell ( DevAge graphics, |
||
graphics | DevAge | |
cellContext | ||
drawRectangle | ||
return | void |
public PositionAtPoint ( Point point ) : |
||
point | Point | Point relative to the DisplayRectangle area. |
return |
public PositionToCellRange ( |
||
pPosition | ||
return | Range |
public PositionToRectangle ( |
||
position | ||
return |
public PositionToStartPosition ( |
||
p_Position | ||
return |
protected ProcessCmdKey ( |
||
msg | ||
keyData | Keys | |
return | bool |
public ProcessSpecialGridKey ( |
||
e | ||
return | void |
public RangeAtArea ( CellPositionType areaType ) : Range | ||
areaType | CellPositionType | |
return | Range |
public RangeToRectangle ( Range range ) : |
||
range | Range | |
return |
public RangeToSize ( Range range ) : |
||
range | Range | |
return |
public ScrollOnPoint ( Point mousePoint ) : void | ||
mousePoint | Point | |
return | void |
public ShowCell ( |
||
p_Position | ||
ignorePartial | bool | true to ignore and consider already visible partial visible cells |
return | bool |
public SortRangeRows ( IRangeLoader p_RangeToSort, int keyColumn, bool p_bAsc, IComparer p_CellComparer ) : void | ||
p_RangeToSort | IRangeLoader | Range to sort |
keyColumn | int | Index of the column relative to the grid to use as sort keys, must be between start and end col of the range |
p_bAsc | bool | Ascending true, Descending false |
p_CellComparer | IComparer | CellComparer, if null the default comparer will be used |
return | void |
public SortRangeRows ( Range p_Range, int keyColumn, bool p_bAscending, IComparer p_CellComparer ) : void | ||
p_Range | Range | |
keyColumn | int | Index of the column relative to the grid to use as sort keys, must be between start and end col |
p_bAscending | bool | Ascending true, Descending false |
p_CellComparer | IComparer | CellComparer, if null the default ValueCellComparer comparer will be used |
return | void |
protected Position,SourceGrid m_MouseCellPosition | ||
return |