ComponentOne True DBGrid for .NET (2.0) Search HelpCentral 

C1TrueDBGrid Members

C1TrueDBGrid overview

Public Constructors

C1TrueDBGrid Constructor

The C1TrueDBGrid control.

Public Properties

AddNewMode

Gets a value that describes the current AddNew state.

AllowAddNew

Gets or sets a value indicating the ability to add new rows.

AllowArrows

Gets or sets a value indicating whether arrow keys can be used to navigate around the grid.

AllowColMove

Gets or sets a value indicating the ability to move columns in the grid.

AllowColSelect

Gets or sets a value indicating the ability to select columns in the grid.

AllowDelete

Gets or sets a value indicating the ability to delete records from the grid.

AllowDrag

Gets or sets a value indicating the ability to drag from the grid.

AllowFilter

Gets or sets a value indicating the ability of the grid to automatically filter data.

AllowHorizontalSplit

Gets or sets a value indicating whether a user is allowed to create horizontal splits.

AllowRowSelect

Gets or sets a value indicating the ability to select rows in the grid.

AllowRowSizing

Gets or sets how interactive row resizing is performed.

AllowSort

Gets or sets a value indicating the ability of the grid to automatically sort data when a column header is clicked.

AllowUpdate

Gets or sets a value indicating the ability of a user to modify data.

AllowUpdateOnBlur

Gets or sets a value indicating how the grid updates modifed data when the grid loses focus.

AllowVerticalSplit

Gets or sets a value indicating whether a user is allowed to create vertical splits.

AlternatingRows

Gets or sets a value indicating whether the grid or split uses the OddRowStyle for odd-numbered rows and EvenRowStyle for even-numbered rows.

Bands

Gets the number of levels within a hierarchical grid.

Bookmark

Gets or sets the current row position of the underlying CurrencyManager.

Caption

Gets or sets the grid's caption.

CaptionHeight

Gets or sets the height of the grid's caption.

CaptionStyle

Gets or sets the Style object that controls the appearance of the caption area.

CellTips

Gets or sets whether the grid displays a pop-up text window when the cursor is idle.

CellTipsDelay

Gets or sets the amount of time in milliseconds before the cell tip window is displayed.

CellTipsWidth

Gets or sets the width of the cell tip window.

ChildGrid

Gets or sets the C1TrueDBGrid control used as a child grid in a hierarchical presentation.

Col

Gets or sets the column position of the current cell in the current split.

CollapseColor

Gets or sets the color of the collapse icon.

ColumnFooters

Gets or sets a value indicating the visibility of column footers.

ColumnHeaders

Gets or sets a value indicating the visibility of column headers.

Columns

Gets the collection of C1DataColumn objects.

CurrentCellVisible

Gets or sets a value indicating the visibility of the current cell in a split.

DataChanged

Gets or sets a value indicating the modification status of the current row.

DataMember

Gets or sets the specific data member in a multimember data source that the grid binds to.

DataSource

Gets or sets the source containing a list of values used to populate the items within the control.

DataView

Gets or sets the layout by which the grid will display data.

DefColWidth

Gets or sets the default width for all grid columns.

DestinationCol

Gets the column which will be current after cell movement.

DestinationRow

Gets the row which will be current after cell movement.

DestinationSplit

Gets the split index which will be current after cell movement.

DirectionAfterEnter

Gets or sets a value that determines the relative position of the next cell when the user presses the Enter key.

DoubleBuffer

Gets or sets a value indicating whether the control should use an off-screen buffer when painting to redue flicker.

EditActive

Gets or sets a value indicating the editing status of the current cell.

EditDropDown

Gets or sets a value indicating whether editing will take place in a popup window or within cell boundaries.

EditorStyle

Gets or sets the Style object that controls the appearance of the cell editor within a grid.

EmptyRows

Gets or sets a value that determines how the grid displays rows below the last data row.

ErrorImage

Gets or sets the image used for ErrorProvider.

EvenRowStyle

Gets or sets the Style object that controls the appearance of an even-numbered row when using AlternatingRows.

ExpandColor

Gets or sets the color of the expand icon in hierarchical grids.

ExposeCellMode

Gets or sets how the rightmost column reacts when clicked by the user.

ExtendRightColumn

Gets or sets a value that determines how the last column will extend to fill the dead area of the grid.

FetchRowStyles

Gets or sets a value indicating whether the FetchRowStyle event will be raised.

FilterActive

Gets or sets a value indicating whether the filter bar has focus.

FilterBar

Gets or sets a value indicating the visibility of the FilterBar.

FilterBarStyle

Gets or sets the Style object that controls the appearance of the FilterBar.

FirstRow

Gets or sets the row index for the first visible row in a grid or split.

FlatStyle

Gets or sets the general appearance of 3D elements for the entire grid.

FocusedSplit

Gets the Split that has focus.

FooterStyle

Gets or sets the Style object that controls the appearance of column footers.

GroupByAreaVisible

Gets or sets a value indicating the visibility of the Grouping area of the grid when the DataView property is set to GroupBy.

GroupByCaption

Gets or sets the text displayed in the grouping area when no columns have been grouped.

GroupByRectangle

Gets the rectangle occupied by the grouping area.

GroupedColumns

Gets the collection of columns that are grouped.

GroupStyle

Gets or sets the Style object that controls the appearance of grouping area.

HeadingStyle

Gets or sets the Style object that controls the appearance of the grids column headers.

HighLightRowStyle

Gets or sets the Style object that controls the current row/cell when the MarqueeStyle is set to Highlight Row/Cell.

HScrollBar

Gets the HBar object that controls the appearance of the horizontal scrollbar.

InactiveStyle

Gets or sets the Style object that controls the grids caption when it doesn't have focus.

Item

Overloaded. Gets the row object associated with the given row.

LeftCol

Gets or sets the zero-based index of the leftmost column in a grid or split.

LinesPerRow

Gets or sets the number of subrows of the grid when the DataView property is set to MutlipleLinesFixed.

MaintainRowCurrency

Gets or sets a value indicating the behavior of the grid and row currency when the grid's datasource is sorted.

MarqueeStyle

Gets or sets the MarqueeStyle for a grid.

MatchEntryTimeOut

Gets or sets the time (milliseconds) in which the incremental search string will reset for a drop-down when the C1DisplayColumn.DropDownList property is True.

MultiSelect

Gets or sets the selection state of the grid.

OddRowStyle

Gets or sets the Style object that controls the appearance of an odd-numbered row when using AlternatingRows.

PictureAddnewRow

Gets or sets the Image used in the record selector to indicate the AddNew row.

PictureCurrentRow

Gets or sets the Image used in the record selector to indicate the Current row.

PictureFilterBar

Gets or sets the Image used in the record selector to indicate the FilterBar row.

PictureFooterRow

Gets or sets the Image used in the record selector to indicate the Footer row.

PictureHeaderRow

Gets or sets the Image used in the record selector to indicate the Header row.

PictureModifiedRow

Gets or sets the Image used in the record selector to indicate the Modified row.

PictureStandardRow

Gets or sets the Image used in the record selector to indicate the Standard row.

PreviewInfo

Gets the PrintPreviewWinSettings object.

PrintInfo

Gets the PrintInfo object.

RecordSelectors

Gets or sets a value indicating the visibility of row headers for a grid or split.

RecordSelectorStyle

Gets or sets the Style object that controls the appearance of the RecordSelectors.

RecordSelectorWidth

Gets or sets the width of the row headers.

Row

Gets or sets the the current row.

RowDivider

Gets or sets the style of the border drawn between grid rows.

RowHeight

Gets or sets the height of grid rows.

RowSubDividerColor

Gets or sets the color of the subrow divider in a multi-line grid.

ScrollTips

Gets or sets a value that determines whether the grid displays a pop-up text window when the scrollbar thumb is dragged.

ScrollTrack

Gets or sets a value that controls how the grid scrolls when the scroll thumb is moved.

SelectedCols

Gets the collection of columns that are currently selected.

SelectedRows

Gets the collection of rows that are currently selected.

SelectedStyle

Gets or sets the Style object that controls the appearance of selected rows and columns.

SelectedText

Gets or sets the string containing the currently selected text within the grid's editing window.

SelectionLength

Gets or sets the number of characters selected within the grid's editing window.

SelectionStart

Gets or sets the starting point of the text selection within the grid's editing window.

SelRange

Gets a value indicating whether a range of cells has been selected.

SplitDividerSize

Controls the height and width of Split Borders.

SplitIndex

Gets or sets the index of the current Split within the SplitCollection.

Splits

Gets the collection of Split objects.

SpringMode

Gets or sets a value that determines how columns will resize when the grid is resized.

Style

Gets or sets the root Style object.

Styles

Gets the collection of named Style objects.

TabAcrossSplits

Gets or sets a value indicating the behavior of the tab and arrow keys at split borders.

TabAction

Gets or sets the behavior of the tab key.

UseColumnStyles

Gets or sets a value indicating whether Style information is applied from the datasource.

ViewCaptionWidth

Gets or sets the width of the column caption when the DataView is set to Inverted or Form.

ViewColumnWidth

Gets or sets the width of a column when the DataView is set to Inverted or Form.

VisibleCols

Gets the number of visible columns in the current Split.

VisibleRows

Gets the number of visible rows in the current Split.

VScrollBar

Gets the VBar object that controls the appearance of the vertical scrollbar.

WrapCellPointer

Gets or sets a value indicating the behavior of Tab and arrow keys at row boundaries.

Public Methods

AddCellStyle

Controls the Style used to change the appearance for cells meeting the specified condition.

AddRegexCellStyle

Controls the Style used to change the appearance of cells according to their contents.

AddRow

Overloaded. Overridden. Adds a row to an unbound grid.

AddRows

Overridden. Adds the number of given rows to an unbound grid.

CellContaining

Returns the cell position for a set of coordinates.

ClearCellStyle

Removes a cell condition established with a previous call to the AddCellStyle method.

ClearFields

Restores the default grid layout.

ClearRegexCellStyle

Overloaded. Removes a cell condition established with a previous call to the AddRegexCellStyle method.

ColContaining

Returns the column index for the column containing the specified X coordinate.

CollapseBand

Collapses a gvien band in a hierarchical grid.

CollapseChild

Closes the Child Grid.

CollapseGroupRow

Collapses a grouped row.

Delete

Overloaded. Overridden. Deletes the current row.

ExpandBand

Expand the given band in a hierarchical grid.

ExpandChild

Displays the Child grid.

ExpandGroupRow

Expands the given row in GroupBy DataView.

ExportTo

Overloaded. Opens a dialog in which the user can select the export format.

ExportToDelimitedFile

Overloaded. Exports the specified rows from the grid to the specified file as delimited text.

ExportToExcel

Overloaded. Exports the grid to a XLS file.

ExportToHTML

Exports the grid to an HTML file.

ExportToPDF

Exports the grid to a PDF file.

ExportToRTF

Exports the grid to an RTF file.

GetBand

Obtains the band given a column index.

GetBandRow

Obtains the underlying row object for the given band and row.

InsertHorizontalSplit

Inserts new horizontal splits at the given position.

InsertVerticalSplit

Inserts vertical splits at the given position.

LoadLayout

Overloaded. Loads a saved layout from the given stream.

MoveFirst

Positions to the first row of the datasource.

MoveLast

Positions to the last row of the datasource.

MoveNext

Positions to the next row of the datasource.

MovePrevious

Positions to the previous row of the datasource.

MoveRelative

Overloaded. Moves the current row positions of the grid by the given offset.

PointAt

Overloaded. Returns one of the PointAtEnum enumerations, which indicates the kind of grid element beneath the specified coordinate.

Rebind

Overloaded. Reinitializes grid with data from its data source.

RefetchRow

Overloaded. Retreives data from the datasource for the current row and refreshes the row.

Refresh

Overridden. Clears any cached styles and forces the grid to repaint.

RefreshCol

Overloaded. Invalidates the current column.

RefreshRow

Overloaded. Invalidates the current row.

RemoveHorizontalSplit

Removes all the horizontal splits at the given index.

RemoveVerticalSplit

Removes all vertical splits at the given index.

ResumeBinding

Resumes IBindingList.ListChange notifications from the data source to the grid.

RowBookmark

Returns the row index of the DataSource for a display row index.

RowContaining

Returns the zero-based index of the display row containing the Y specified coordinate.

RowExpanded

Obtains the expanded state of a band for a hierarchical grid.

RowTop

Returns the Y coordinate of the top of a visible row.

SaveLayout

Overloaded. Saves the grid's layout.

ScrollGrid

Scrolls the grid data area by the specified number of rows and columns.

SplitContaining

Returns the SplitIndex of the split containing the specified coordinate.

SuspendBinding

Instructs the grid to temporarily ignore IBindingList.ListChange notifications from the data source.

UpdateData

Updates any changes on the current row to the data source.

SetDataBinding

Binds the grid at run time.

Public Events

AfterColEdit

Occurs after editing is completed.

AfterColUpdate

Occurs after a cell has been updated.

AfterDelete

Occurs after a row has been deleted.

AfterFilter

Occurs after the datasource has been filtered.

AfterInsert

Occurs after a row has been added.

AfterSort

Occurs after a column has been sorted.

AfterUpdate

Occurs after a row has been updated.

BeforeClose

Occurs when the user attempts to close a child grid.

BeforeColEdit

Occurs before a cell enters edit mode.

BeforeColUpdate

Occurs before a cell is updated to the datasource.

BeforeDelete

Occurs before a row is deleted.

BeforeInsert

Occurs before a new row is added to the datasource.

BeforeOpen

Occurs when the user attempts to open a child grid.

BeforeRowColChange

Occurs prior to focus moving to another cell.

BeforeUpdate

Occurs before a row is updated to the datasource.

ButtonClick

Occurs whenever a button is clicked in a cell.

Change

Occurs whenever the user changes the value of a cell.

ColEdit

Occurs whenever a cell first enters edit mode.

Collapse

Occurs whenever a hierarchical row is collapsed.

ColMove

Occurs whenever the user has finished moving a column.

ColResize

Occurs whenever a column is resized.

ComboSelect

Occurs whenever a selection has been made to the built-in combo or TrueDBDropdown.

DataSourceChanged

Occurs whenever the datasource changes.

Error

Occurs whenever an exception is thrown during end user interaction.

Expand

Occurs whenever a hierarchical row is expanded.

FetchCellStyle

Occurs whenever a cell is to be rendered and the C1DisplayColumn.FetchStyle is true.

FetchCellTips

Occurs when the grid needs to display CellTips.

FetchGroupCellStyle

Occurs whenever a grouped cell that contains an aggregate is to be rendered and C1DisplayColumn.FetchStyle is true.

FetchRowStyle

Occurs whenever the grid renders a row and the FetchRowStyles property has been set.

FetchScrollTips

Occurs whenever the grid has focus and the scrollbar thumb is moved using the mouse.

Filter

Occurs when the user types in the filterbar and the AllowFilter property is false.

FilterButtonClick

Occurs when a button is clicked in the filterbar.

FilterChange

Occurs when the contents of a cell in the filterbar changes.

FirstRowChange

Occurs whenever the first row changes.

FootClick

Occurs whenever a column footer is clicked.

FormatText

Occurs whenever a cell is about to be rendered and whose C1DataColumn.NumberFormat property has been set to FormatTextEvent.

GroupAggregate

Occurs when the C1DataColumn.Aggregate is set to Custom for a grouped row.

GroupColMove

Occurs whenever a column is moved into or out of the grouping area.

GroupHeadClick

Occurs whenever a column in the grouping area is clicked.

GroupInterval

Occurs whenever a row is being grouped and a custom interval has been specified.

GroupText

Occurs when the GroupInfo.HeaderText property is set to custom.

HeadClick

Occrus whenever a column header is clicked.

LeftColChange

Occurs whenever the left column changes.

OnAddNew

Occurs whenever an AddNew operation has been initiated.

OnInit

Occurs after the grid has been initialized.

OwnerDrawCell

Occurs before a cell is rendered and the C1DisplayColumn.OwnerDraw is true.

OwnerDrawCellPrint

Occurs before a cell is to be printed and the C1DisplayColumn.OwnerDraw is true.

OwnerDrawPageFooter

Occurs before the page footer is to be printed.

OwnerDrawPageHeader

Occurs before the page header is to be printed.

RowColChange

Occurs when the focus moves to a different cell.

RowResize

Occrus whenever the user resizes a row.

Scroll

Occurs whenever the user scrolls the grid.

SelChange

Occurs whenever the user selected a different range of rows or columns.

Sort

Occurs when the user drags a column into the grouping area.

SplitChange

Occurs whenever a Split changes focus.

UnboundColumnFetch

Occurs when the grid needs to access the value of an unbound column.

UnboundColumnUpdated

Occurs when the value of an unbound column has been updated.

ValueItemError

Occurs whenever a user attempts to enter invalid data into a column that is using valueitems.

Protected Methods

Dispose

Overloaded. Overridden. Called when the class is being disposed.

On_AddNew

Overridden. Raises the OnAddNew event.

On_Init

Overridden. Raises the OnInit event.

On_Scroll

Overridden. Raises the Scroll event.

OnAfterColEdit

Overridden. Raises the AfterColEdit event.

OnAfterColUpdate

Overridden. Raises the AfterColUpdate event.

OnAfterDelete

Overridden. Raises the AfterDelete event.

OnAfterFilter

Overridden. Raises the AfterFilter event.

OnAfterInsert

Overridden. Raises the AfterInsert event.

OnAfterSort

Overridden. Raises the AfterSort event.

OnAfterUpdate

Overridden. Raises the AfterUpdate event.

OnBeforeClose

Overridden. Raises the BeforeClose event.

OnBeforeColEdit

Overridden. Raises the BeforeColEdit event.

OnBeforeColUpdate

Overridden. Raises the BeforeColUpdate event.

OnBeforeDelete

Overridden. Raises the BeforeDelete event.

OnBeforeInsert

Overridden. Raises the BeforeInsert event.

OnBeforeOpen

Overridden. Raises the BeforeOpen event.

OnBeforeRowColChange

Overridden. Raises the BeforeRowColChange event.

OnBeforeUpdate

Overridden. Raises the BeforeUpdate event.

OnButtonClick

Overridden. Raises the ButtonClick event.

OnChange

Overridden. Raises the Change event.

OnColEdit

Overridden. Raises the ColEdit event.

OnCollapse

Overridden. Raises the Collapse event.

OnColMove

Overridden. Raises the ColMove event.

OnColResize

Overridden. Raises the ColResize event.

OnComboSelect

Overridden. Raises the ComboSelect event.

OnDataSourceChanged

Overridden. Raises the DataSourceChanged event.

OnError

Overridden. Raises the Error event

OnExpand

Overridden. Raises the Expand event.

OnFetchCellStyle

Overridden. Raises the FetchCellStyle event.

OnFetchCellTips

Overridden. Raises the FetchCellTips event.

OnFetchGroupCellStyle

Overridden. Raises the FetchGroupCellStyle event.

OnFetchRowStyle

Overridden. Raises the FetchRowStyle event.

OnFetchScrollTips

Overridden. Raises the FetchScrollTips event.

OnFilter

Overridden. Raises the Filter event.

OnFilterButtonClick

Overridden. Raises the FilterButtonClick event.

OnFilterChange

Overridden. Raises the FilterChange event.

OnFirstRowChange

Overridden. Raises the FirstRowChange event.

OnFootClick

Overridden. Raises the FootClick event.

OnFormatText

Overridden. Raises the FormatText event.

OnGroupAggregate

Overridden. Raises the GroupAggregate event.

OnGroupColMove

Overridden. Raises the GroupColMove event.

OnGroupHeadClick

Overridden. Raises the GroupHeadClick event.

OnGroupInterval

Overridden. Raises the GroupInterval event.

OnGroupText

Overridden. Raises the GroupText event.

OnHeadClick

Overridden. Raises the HeadClick event.

OnLeftColChange

Overridden. Raises the LeftColChange event.

OnOwnerDrawCell

Overridden. Raises the OwnerDrawCell event.

OnOwnerDrawCellPrint

Overridden. Raises the OwnerDrawCellPrint event.

OnOwnerDrawPageFooter

Overridden. Raises the OwnerDrawPageFooter event.

OnOwnerDrawPageHeader

Overridden. Raises the OwnerDrawPageHeader event.

OnRowColChange

Overridden. Raises the RowColChange event.

OnRowResize

Overridden. Raises the RowResize event.

OnSelChange

Overridden. Raises the SelChange event.

OnSort

Overridden. Raises the Sort event.

OnSplitChange

Overridden. Raises the SplitChange event.

OnUnboundColumnFetch

Overridden. Raises the UnboundColumnFetch event.

OnUnboundColumnUpdated

Overridden. Raises the UnboundColumnUpdated event.

OnValueItemError

Overridden. Raises the ValueItemError event.

WndProc

Overridden. Processes Windows messages.

See Also

C1TrueDBGrid Class | C1.Win.C1TrueDBGrid Namespace


Send comments about this topic to ComponentOne.
Copyright © ComponentOne LLC. All rights reserved.