GridControl Class

GridControl Class

Represents a Stingray Grid .NET grid control.

Inheritance Hierarchy

SystemObject
  SystemMarshalByRefObject
    System.ComponentModelComponent
      System.Windows.FormsControl
        System.Windows.FormsScrollableControl
          System.Windows.FormsContainerControl
            System.Windows.FormsUserControl
              Stingray.GridGridControl

Namespace: Stingray.Grid
Assembly: Stingray.GridControl (in Stingray.GridControl.dll) Version: [TAG_DECIMAL_VERSION]

Syntax

C++

Copy

[ToolboxBitmapAttribute(typeof(OGUtilities), "GridControl.ico")]
public class GridControl : UserControl, 
	ISupportInitialize

<ToolboxBitmapAttribute(GetType(OGUtilities), "GridControl.ico")>
Public Class GridControl
	Inherits UserControl
	Implements ISupportInitialize

[ToolboxBitmapAttribute(typeof(OGUtilities), L"GridControl.ico")]
public ref class GridControl : public UserControl, 
	ISupportInitialize

The GridControl type exposes the following members.

Constructors

	Name	Description
	GridControl	Constructs a new GridControl object.
	GridControl(String)	Constructs the grid from a specified OGL file.

Top

Methods

	Name	Description
	BeginInit	Implements ISupportInitialize.
	CalcClientColFromPt	Computes the column for the point.
	CalcClientRowFromPt	Computes the row for the point.
	CalcRectFromRowColEx(UInt32, UInt32)	Computes the window-area for the given range of cells.
	CalcRectFromRowColEx(UInt32, UInt32, UInt32, UInt32)	Computes the window-area for the given range of cells.
	CalcSumOfColWidths(UInt32, UInt32)	Computes the total width of the given columns.
	CalcSumOfColWidths(UInt32, UInt32, Int32)	Computes the total width of the given columns.
	CalcSumOfRowHeights(UInt32, UInt32)	Computes the total height of the given rows.
	CalcSumOfRowHeights(UInt32, UInt32, Int32)	Computes the total height of the given rows.
	CanClear	Checks if the currently selected range of cells can be cleared.
	CanCopy	Checks if the currently selected range of cells can be copied.
	CanCut	Checks if the currently selected range of cells can be cut.
	CanPaste	Checks if the currently selected range of cells can be pasted into the grid.
	CanSelectCurrentCell	Determines if the new current cell can be selected or the old current cell deselected.
	ClearCells(Range)	Clears a range of cells.
	ClearCells(Range, Boolean)	Clears a range of cells.
	ConvertClientCol	Converts the specified column index into a relative index.
	ConvertClientRow	Converts the specified row index into a relative index.
	ConvertCol	Converts the specified column index into an absolute index.
	ConvertRow	Converts the specified row index into an absolute index.
	CopyCells(Range, UInt32, UInt32)	Copies a range of cells to a specified location in the grid.
	CopyCells(Range, UInt32, UInt32, RedrawFlags)	Copies a range of cells to a specified location grid.
	CopyTextToFile	Writes the text values of the specified range of cells in tab-delimited format to a FileStream.
	DelayFloatCells	Recalculates floating cells on the entire grid.
	DelayFloatCells(Range)	Recalculates floating cells for a given range.
	DelayFloatCells(Range, UInt32)	Recalculates floating cells.
	DelayMergeCells	Recalculates all merge cells.
	DelayMergeCells(Range)	Recalculates the specified merge cells.
	DelayMergeCells(Range, UInt32, UInt32)	Recalculates merge cells.
	DesignTimeInitialize	Performs some specialized design-time grid initialization.
	EndInit	Implements ISupportInitialize.
	GetCellControl	Obtains the CellControl instance associated with a custom .NET cell editor control.
	GetColCount	Returns the number of columns in the grid.
	GetColWidth	Gets the width of the specified column.
	GetControlTextRowCol	Gets the text value stored in a cell.
	GetExpressionRowCol	Gets the expression stored in a given cell.
	GetFontHeight	Returns the height of the standard-style font in pixels.
	GetFontWidth	Returns the average width of the standard-style font in pixels.
	GetGridLineStyle	Gets the grid line style.
	GetGridRect	Returns the window area for the grid.
	GetRowCount	Returns the number of rows in the grid.
	GetRowHeight	Gets the height ot the specified row.
	GetSelectedCols	Returns an array containing the selected column indices.
	GetSelectedCols(Boolean)	Returns an array containing the selected column indices.
	GetSelectedCols(Boolean, Boolean)	Returns an array containing the selected column indices.
	GetSelectedRows	Returns an array containing the selected row indices.
	GetSelectedRows(Boolean)	Returns an array containing the selected row indices.
	GetSelectedRows(Boolean, Boolean)	Returns an array containing the selected row indices.
	GetValueRowCol	Gets the value stored in a cell.
	Height_DPtoLP	Divides the pixel-value by the value returned by GetFontHeight.
	Height_LPtoDP	Multiplies the logical value by the value returned by GetFontHeight.
	HideCols(UInt32, UInt32, Boolean)	Hides the specified columns.
	HideCols(UInt32, UInt32, Boolean, RedrawFlags)	Hides the specified columns.
	HideCols(UInt32, UInt32, Boolean, RedrawFlags, CmdType)	Hides the specified columns.
	HideRange	Hides a range of cells.
	HideRows(UInt32, UInt32, Boolean)	Hides the specified rows.
	HideRows(UInt32, UInt32, Boolean, RedrawFlags)	Hides the specified rows.
	HideRows(UInt32, UInt32, Boolean, RedrawFlags, CmdType)	Hides the specified rows.
	HitTest	Determines the type of information displayed at a given window coordinates.
	Initialize	Initializes a GridControl object state at runtime.
	InitParamObject	Initializes the grid parameter object.
	InsertCols(UInt32, Int32)	Inserts columns.
	InsertCols(UInt32, Int32, Int32)	Inserts columns.
	InsertCols(UInt32, Int32, Int32, RedrawFlags)	Inserts columns.
	InsertCols(UInt32, Int32, Int32, RedrawFlags, CmdType)	Inserts columns.
	InsertRows(UInt32, Int32)	Inserts rows.
	InsertRows(UInt32, Int32, Int32)	Inserts rows.
	InsertRows(UInt32, Int32, Int32, RedrawFlags)	Inserts rows.
	InsertRows(UInt32, Int32, Int32, RedrawFlags, CmdType)	Inserts rows.
	IsActiveCurrentCell	Indicates if the current cell is active.
	IsColHidden	Indicates if the specified column is hidden.
	IsCurrentCell	Determines if a current cell is selected.
	IsCurrentCell(UInt32)	Determines if a current cell is selected or is in the specified row.
	IsCurrentCell(UInt32, UInt32)	Determines if a current cell is selected or is the specified cell.
	IsCurrentCell(UInt32, UInt32, Boolean)	Determines if a current cell is selected or is the specified cell.
	IsRowHidden	Indicates if the specified row is hidden.
	LoadFromOGL	Loads the grid from a specified OGL file.
	LockUpdate	Prevents display of updates.
	LockUpdate(Boolean)	Prevents display of updates.
	MoveCells	Moves a range of cells.
	MoveCols(UInt32, UInt32, UInt32)	Moves the specified block of columns to another location.
	MoveCols(UInt32, UInt32, UInt32, RedrawFlags, CmdType)	Moves the specified block of columns to another location.
	MoveCurrentCell(DirectionType)	Selects a new current cell based on an offset from the existing current cell.
	MoveCurrentCell(DirectionType, Int32)	Selects a new current cell based on an offset from the existing current cell.
	MoveCurrentCell(DirectionType, Int32, Boolean)	Selects a new current cell based on an offset from the existing current cell.
	MoveRows(UInt32, UInt32, UInt32)	Moves the specified block of rows to another location.
	MoveRows(UInt32, UInt32, UInt32, RedrawFlags, CmdType)	Moves the specified block of rows to another location.
	OnCanceledEditing	Raises the CanceledEditing event.
	OnCancelEditing	Raises the CancelEditing event.
	OnClear	Raises the Clear event.
	OnClear(Boolean)	Raises the Clear event.
	OnClickedButtonRowCol	Raises the ClickedButtonRowCol event.
	OnCopy	Raises the Copy event.
	OnCut	Raises the Cut event.
	OnDeleteCell	Raises the DeleteCell event.
	OnDrawGridItem	Raises the DrawGridItem event.
	OnDrawTopLeftBottomRight	Raises the DrawTopLeftBottomRight event.
	OnEndEditing	Raises the EndEditing event.
	OnFind	Raises the Find event.
	OnFontChanged	Internal. (Overrides ContainerControlOnFontChanged(EventArgs).)
	OnForeColorChanged	Internal. (Overrides ControlOnForeColorChanged(EventArgs).)
	OnGetStyleRowCol	Raises the GetStyleRowCol event.
	OnGridBeginPrint	Raises the GridBeginPrint event.
	OnGridBeginPrintPreview	Raises the GridBeginPrintPreview event.
	OnGridDraw	Raises the GridDraw event.
	OnGridEndPrint	Raises the GridEndPrint event.
	OnGridEndPrintPreview	Raises the GridEndPrintPreview event.
	OnGridInitialized	Internal.
	OnGridInitialized(EventArgs)	Raises the GridInitialized event.
	OnGridPrintPage	Raises the GridPrintPage event.
	OnGridPrintPreviewPage	Raises the GridPrintPreviewPage event.
	OnHorizontalScroll	Raises the HorizontalScroll event.
	OnInitCurrentCell	Raises the InitCurrentCell event.
	OnLButtonClickedRowCol	Raises the LButtonClickedRowCol event.
	OnLButtonDblClkRowCol	Raises the LButtonDblClkRowCol event.
	OnLButtonHitRowCol	Raises the LButtonHitRowCol event.
	OnLeftCell	Raises the LeftCell event.
	OnMButtonClickedRowCol	Raises the MButtonClickedRowCol event.
	OnMButtonDblClkRowCol	Raises the MButtonDblClkRowCol event.
	OnMButtonHitRowCol	Raises the MButtonHitRowCol event.
	OnModifyCell	Raises the ModifyCell event.
	OnMovedCurrentCell	Raises the MovedCurrentCell event.
	OnPaint	Internal. (Overrides ControlOnPaint(PaintEventArgs).)
	OnPaste	Raises the Paste event.
	OnPrint	Raises the Print event.
	OnPrintPreview	Raises the PrintPreview event.
	OnPrintPreview(Boolean)	Raises the PrintPreview event.
	OnProcessKeys	Raises the ProcessKeys event.
	OnRButtonClickedRowCol	Raises the RButtonClickedRowCol event.
	OnRButtonDblClkRowCol	Raises the RButtonDblClkRowCol event.
	OnRButtonHitRowCol	Raises the RButtonHitRowCol event.
	OnRedo	Raises the Redo event.
	OnReplace	Raises the Replace event.
	OnStartEditing	Raises the StartEditing event.
	OnStoreColWidth	Raises the StoreColWidth event.
	OnStoreCopyCells	Raises the StoreCopyCells event.
	OnStoreDefaultColWidth	Raises the StoreDefaultColWidth event.
	OnStoreDefaultRowHeight	Raises the StoreDefaultRowHeight event.
	OnStoreFrozenCols	Raises the StoreFrozenCols event.
	OnStoreFrozenRows	Raises the StoreFrozenRows event.
	OnStoreHideCol	Raises the StoreHideCol event.
	OnStoreHideRow	Raises the StoreHideRow event.
	OnStoreInsertCols	Raises the StoreInsertCols event.
	OnStoreInsertRows	Raises the StoreInsertRows event.
	OnStoreMoveCols	Raises the StoreMoveCols event.
	OnStoreMoveRows	Raises the StoreMoveRows event.
	OnStoreReadOnly	Raises the StoreReadOnly event.
	OnStoreRemoveCols	Raises the StoreRemoveCols event.
	OnStoreRemoveRows	Raises the StoreRemoveRows event.
	OnStoreRowHeight	Raises the StoreRowHeight event.
	OnStoreStyleRowCol	Raises the StoreStyleRowCol event.
	OnStoreZoom	Raises the StoreZoom event.
	OnUndo	Raises the Undo event.
	OnValidateCell	Raises the ValidateCell event.
	OnVerticalScroll	Raises the VerticalScroll event.
	PasteTextFromBuffer	Pastes the text values from the specified buffer to the grid.
	ProcessCmdKey	Internal. (Overrides ContainerControlProcessCmdKey(Message, Keys).)
	RedrawGrid	Redraws the whole grid.
	RedrawGrid(RedrawFlags)	Redraws the whole grid.
	RedrawRowCol(Range)	Redraws the specified range of cells.
	RedrawRowCol(UInt32, UInt32)	Redraws the range of cells starting from the specified row and column up to the last row and column.
	RedrawRowCol(Range, RedrawFlags)	Redraws the specified range of cells.
	RedrawRowCol(UInt32, UInt32, RedrawFlags)	Redraws the range of cells starting from the specified row and column up to the last row and column
	RegisterControl(Control)	Registers a .NET control for use as a Stingray Grid .NET cell editor.
	RegisterControl(Control, Boolean)	Internal.
	RemoveCols(UInt32, UInt32)	Removes a block of columns.
	RemoveCols(UInt32, UInt32, RedrawFlags, CmdType)	Removes a block of columns.
	RemoveRows(UInt32, UInt32)	Removes a block of rows.
	RemoveRows(UInt32, UInt32, RedrawFlags, CmdType)	Removes a block of rows.
	ResetCurrentCell	Deactivates the current cell.
	ResetCurrentCell(Boolean)	Deactivates the current cell.
	ResizeColWidthsToFit(Range)	Automatically resizes the column widths for a given range of cells.
	ResizeColWidthsToFit(Range, Boolean)	Automatically resizes the column widths for a given range of cells.
	ResizeColWidthsToFit(Range, Boolean, RedrawFlags)	Automatically resizes the column widths for a given range of cells.
	ResizeRowHeightsToFit(Range)	Automatically resizes the row heights for a given range of cells.
	ResizeRowHeightsToFit(Range, Boolean)	Automatically resizes the row heights for a given range of cells.
	ResizeRowHeightsToFit(Range, Boolean, RedrawFlags)	Automatically resizes the row heights for a given range of cells.
	SaveToHTML	Saves the grid to the specified file in HTML format.
	ScrollCellInView(UInt32, UInt32)	Scrolls the cell into the view if it is outside the visible area.
	ScrollCellInView(UInt32, UInt32, RedrawFlags, Boolean)	Scrolls the cell into the view if it is outside the visible area.
	SelectRange(Range, Boolean)	Selects or deselects a range of cells.
	SelectRange(Range, Boolean, Boolean)	Selects or deselects a range of cells.
	SetColCount	Sets the number of columns in the grid.
	SetColWidth(UInt32, UInt32, Int32)	Sets the width of the specified column.
	SetColWidth(UInt32, UInt32, Int32, Int32)	Sets the width of the specified columns.
	SetColWidth(UInt32, UInt32, Int32, Int32, RedrawFlags)	Sets the width of the specified columns.
	SetColWidth(UInt32, UInt32, Int32, Int32, RedrawFlags, CmdType)	Sets the widths for specific columns.
	SetCoveredCellsRowCol(UInt32, UInt32, UInt32, UInt32)	Sets the covered cells-range for a cell.
	SetCoveredCellsRowCol(UInt32, UInt32, UInt32, UInt32, RedrawFlags)	Sets the covered cells-range for a cell.
	SetCoveredCellsRowCol(UInt32, UInt32, UInt32, UInt32, RedrawFlags, CmdType)	Sets the covered cells-range for a cell.
	SetCurrentCell	Resets the current cell.
	SetCurrentCell(UInt32, UInt32)	Makes a cell the current cell.
	SetExpressionRowCol(UInt32, UInt32, String)	Stores the expression in the specified cell.
	SetExpressionRowCol(UInt32, UInt32, String, RedrawFlags)	Stores the expression in the specified cell.
	SetFloatCellsMode	Turns on and off the calculation of floating cells in the grid.
	SetGridLineStyle	Sets the grid line style.
	SetGridRect(Boolean)	Sets the grid rectangle for the window.
	SetGridRect(Boolean, Rectangle)	Sets the grid rectangle for the window.
	SetMergeCellsMode	Turns on and off the calculation of merge cells in the grid.
	SetNewGridLineMode	Sets the old or new grid line drawing.
	SetNewGridLineMode(Boolean)	Sets the old or new grid line drawing.
	SetNewGridLineMode(Boolean, GridLineStyle)	Sets the old or new grid line drawing with a specific type.
	SetNewGridLineMode(Boolean, GridLineStyle, Boolean)	Sets the old or new grid line drawing with a specific type and borders settings.
	SetRowCount	Sets the number of rows in the grid.
	SetRowHeight(UInt32, UInt32, Int32)	Sets the height of the specified rows.
	SetRowHeight(UInt32, UInt32, Int32, Int32)	Sets the height of the specified rows.
	SetRowHeight(UInt32, UInt32, Int32, Int32, RedrawFlags)	Sets the height of the specified rows.
	SetRowHeight(UInt32, UInt32, Int32, Int32, RedrawFlags, CmdType)	Sets the height of the specified rows.
	SetScrollBarMode	Sets the visibility mode of one or both scroll bars.
	SetStyleRange(Range, Style)	Applies cell formattings to the specified range of cells.
	SetStyleRange(Range, Style, CellModifyType)	Applies cell formattings to the specified range of cells.
	SetValueRange(Range, Style)	Sets a range of cells to the specified value.
	SetValueRange(Range, String)	Sets a range of cells to the specified value.
	SetValueRange(Range, Style, ModifyType)	Sets a range of cells to the specified value.
	SetValueRange(Range, String, ModifyType)	Sets a range of cells to the specified value.
	SetValueRange(Range, Style, ModifyType, Int32)	Sets a range of cells to the specified value.
	SetValueRange(Range, String, ModifyType, Int32)	Sets a range of cells to the specified value.
	SetValueRange(Range, Style, ModifyType, Int32, RedrawFlags)	Sets a range of cells to the specified value.
	SetValueRange(Range, String, ModifyType, Int32, RedrawFlags)	Sets a range of cells to the specified value.
	TransferCurrentCell	Stores and deactivates the current cell or actualizes the current cell's contents.
	TransferCurrentCell(Boolean)	Stores and deactivates the current cell or refreshes the current cell's contents.
	TransferCurrentCell(Boolean, RedrawFlags)	Stores and deactivates the current cell or actualizes the current cell's contents.
	TransferCurrentCell(Boolean, RedrawFlags, Boolean)	Stores and deactivates the current cell or actualizes the current cell's contents.
	UpdateFrozenCols(UInt32, UInt32, RedrawFlags)	Updates the window after freezing columns.
	UpdateFrozenCols(UInt32, UInt32, RedrawFlags, Boolean)	Updates the window after freezing columns.
	UpdateFrozenRows(UInt32, UInt32, RedrawFlags)	Updates the window after freezing rows.
	UpdateFrozenRows(UInt32, UInt32, RedrawFlags, Boolean)	Updates the window after freezing rows.
	Width_DPtoLP	Divides the pixel-value by the value returned by GetFontWidth.
	Width_LPtoDP	Multiplies the logical value by the value returned by GetFontWidth.

Top

Properties

	Name	Description
	AccelerateArrowKey	Sets scrolling speed of arrow keys.
	AccelerateScrollBars	Sets scrolling speed of scrollbar buttons.
	default	Grid cell indexer, which allows to access grid cell objects.
	ColCount	Gets or sets the number of columns for this grid.
	CurrentCell	Gets or sets the current cell for this grid.
	DefaultColWidth	Gets or sets the default value for the column width, in pixels.
	DefaultRowHeight	Gets or sets the default value for the row height, in pixels.
	EnableUndo	Gets or sets a value indicating whether the undo feature is enabled.
	Features	Gets a reference to the GridFeatures object associated with this GridControl object.
	FloatCells	Gets or sets the setting of floating cells.
	FrozenCols	Gets or sets the number of frozen columns in the grid.
	FrozenRows	Gets or sets the number of frozen rows in the grid.
	HeaderCols	Gets or sets the number of columns to be used as row headers.
	HeaderRows	Gets or sets the number of rows to be used as row headers.
	LeftCol	Gets the leftmost non-frozen column of the view.
	MergeCells	Gets or sets the setting for merging cells: enabled or disabled.
	NavigateInGrid	Indicates how navigation keys are handled.
	Param	Returns a reference to the Param object associated with this GridControl object.
	Properties	Gets a reference to the OGProperties object associated with this GridControl object.
	ReadOnly	Gets or sets a value that indicates if this grid is read-only.
	RowCount	Gets or sets the number of rows for this grid.
	TopRow	Gets the index of the topmost scrollable row.
	Zoom	Gets or sets the zooming factor of this grid as a percentage.

Top

Events

	Name	Description
	CanceledEditing	Canceled Editing Item event.
	CancelEditing	Cancel Editing Item event.
	Clear	Clear event.
	ClickedButtonRowCol	Clicked Button Row/Column event.
	Copy	Copy event.
	Cut	Cut event.
	DeleteCell	Delete Cell event.
	DrawGridItem	Draw Grid Item event.
	DrawTopLeftBottomRight	Draw Top, Left, Botton, Right event.
	EndEditing	End Editing event.
	Find	Find event.
	GetStyleRowCol	Get Style Row Col event.
	GridBeginPrint	Invoked when printing begins.
	GridBeginPrintPreview	Invoked when print preview begins.
	GridDraw	Grid Draw event.
	GridEndPrint	Invoked when printing ends.
	GridEndPrintPreview	Invoked when print preview completes.
	GridInitialized	Grid Initialized event.
	GridPrintPage	Invoked as each page is printed.
	GridPrintPreviewPage	Invoked as each page is about to be prepared and drawn to the print preview.
	HorizontalScroll	Occurs when the grid is scrolled horizontally.
	InitCurrentCell	Init Current Cell event.
	LButtonClickedRowCol	Left Button Clicked Row Column event.
	LButtonDblClkRowCol	Left Button Double Clicked Row Column event.
	LButtonHitRowCol	Left Button Hit Row Column event.
	LeftCell	Left Cell event.
	MButtonClickedRowCol	Middle Button Clicked Row Column event.
	MButtonDblClkRowCol	Middle Button Double Clicked Row Column event.
	MButtonHitRowCol	Middle Button Hit Row Column event.
	ModifyCell	Modify Cell event.
	MovedCurrentCell	Moved Current Cell event.
	Paint	Occurs when the control is redrawn.
	Paste	Paste event.
	Print	Print event.
	PrintPreview	PrintPreview event.
	ProcessKeys	Process Keys event.
	RButtonClickedRowCol	Right Button Clicked Row Column event.
	RButtonDblClkRowCol	Right Button Double Clicked Row Column event.
	RButtonHitRowCol	Right Button Hit Row Column event.
	Redo	Redo event.
	Replace	Replace event.
	StartEditing	Start Editing Item event.
	StoreColWidth	Store Column Width event.
	StoreCopyCells	Store Copy Cells event.
	StoreCurrentCell	Store Current Cell event.
	StoreDefaultColWidth	Store Default Column Width event.
	StoreDefaultRowHeight	Store Default Row Height event.
	StoreFrozenCols	Store Frozen Columns event.
	StoreFrozenRows	Store Frozen Rows event.
	StoreHideCol	Store Hide Column event.
	StoreHideRow	Store Hide Row event.
	StoreInsertCols	Store Insert Columns event.
	StoreInsertRows	Store Insert Rows event.
	StoreMoveCols	Store Move Columns event.
	StoreMoveRows	Store Move Rows event.
	StoreReadOnly	Store ReadOnly event.
	StoreRemoveCols	Store Remove Columns event.
	StoreRemoveRows	Store Remove Rows event.
	StoreRowHeight	Store Row Height event.
	StoreStyleRowCol	Store Style Row Column event.
	StoreZoom	Store Zoom event.
	Undo	Undo event.
	ValidateCell	Validate Cell event.
	VerticalScroll	Occurs when the grid is scrolled vertically.

Top

Remarks

The GridControl class represents and embodies a Grid .NET grid control. This custom control is added to the Visual Studio .NET toolbox when Grid. NET is installed. When a GridControl is dragged onto a Windows Form, an instance of the GridControl class is created.

Reference

Stingray.Grid Namespace