Skip to main content

TcxCustomGridTableView Members

The base class for all table-based grid View classes in the VCL Data Grid.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.
CreateCloned(TcxControl) Initializes a new instance of the TcxCustomGridView class with specified settings. Inherited from TcxCustomGridView.
CreateEx(TcxControl,Boolean) Creates a new child component instance. Inherited from TcxControlChildComponent.

Properties

Name Description
CloneCount Returns the total number of copies (clones) of the current View. Inherited from TcxCustomGridView.
Clones Represents the copies collection of the current View. Inherited from TcxCustomGridView.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
ConditionalFormatting Provides access to the View’s conditional formatting controller.
Control Specifies the component’s parent control. Inherited from TcxControlChildComponent.
Controller Provides access to the controller associated with the View.
DataController Specifies the data controller managing the current View’s data. Inherited from TcxCustomGridView.
DateTimeHandling Provides a set of options to control the manner in which date/time values are handled in the current View.
DesignInfo Inherited from TComponent.
DragMode Specifies the manner in which Views initiate drag-and-drop operations. Inherited from TcxCustomGridView.
FakeComponentLink1 Inherited from TcxComponent.
FakeComponentLink2 Inherited from TcxComponent.
FakeComponentLink3 Inherited from TcxComponent.
FilterBox Contains settings that determine the appearance aspects of the grid View’s filter box.
Filtering
FindPanel Specifies settings that define the appearance and behavior of the View’s Find Panel.
Focused Determines whether the current View has focus. Inherited from TcxCustomGridView.
GroupedItemCount Returns the number of grouping items within the current View.
GroupedItems Provides zero-based indexed access to the View’s grouping items.
Images protected Specifies the collection of images that are used as icons for column headers. Inherited from TcxCustomGridView.
InDataControlFocusing
IsControlFocused Indicates whether the grid control owning the current View has focus. Inherited from TcxCustomGridView.
IsControlLocked Inherited from TcxCustomGridView.
IsDesigning Inherited from TcxComponent.
IsDestroying Specifies whether the component is currently being destroyed. Inherited from TcxControlChildComponent.
IsDetail Indicates whether the current View is placed at a child grid level. Inherited from TcxCustomGridView.
IsLoading Specifies whether the current component is being loaded. Inherited from TcxControlChildComponent.
IsMaster Indicates whether the current View level has child Views which can be displayed. Inherited from TcxCustomGridView.
IsPattern Indicates whether the current View is a “pattern“ View. Inherited from TcxCustomGridView.
ItemCount Returns the total number of items created within the View.
Items Provides zero-based indexed access to the items created within the View.
Level Returns the grid level that owns the current View. Inherited from TcxCustomGridView.
LookAndFeel Inherited from TcxCustomGridView.
LookAndFeelPainter Inherited from TcxCustomGridView.
MasterDataController Inherited from TcxCustomGridView.
MasterGridRecord Returns the master View record displaying the current View as a detail.
MasterGridRecordIndex Returns the index of the master View record for which the current View is displayed as a detail View. Inherited from TcxCustomGridView.
MasterGridView Returns a master View for the current View. Inherited from TcxCustomGridView.
MasterRecordIndex Returns the index of the master dataset record corresponding to a master View record. The current View is displayed as a detail View. Inherited from TcxCustomGridView.
Name Inherited from TComponent.
Navigator Provides access to the View navigator’s settings.
NavigatorButtons Provides access to the View navigator’s settings.
Observers Inherited from TComponent.
OptionsBehavior Contains settings that determine the grid View’s response to user actions.
OptionsCustomize Contains settings that determine the availability of runtime operations on the View’s items.
OptionsData Contains settings that determine the functionality of a data-aware View.
OptionsSelection Contains settings that affect the selection within a View.
OptionsView Provides access to the grid View’s appearance settings.
Owner Inherited from TComponent.
Painter
PatternGridView
PopupMenu Specifies the popup menu associated with the current View. Inherited from TcxCustomGridView.
Repository Inherited from TcxCustomGridView.
ScrollbarAnnotations Provides access to the View’s scrollbar annotation settings.
Site Provides access to the control that holds the View. Inherited from TcxCustomGridView.
SortedItemCount Returns the total number of sorted items within the current View.
SortedItems Provides indexed access to the sorted items within a View.
StorageControl Inherited from TcxCustomGridView.
StorageOptions Inherited from TcxCustomGridView.
StoringName Inherited from TcxCustomGridView.
Styles Specifies a set of styles that define the appearance of the View’s elements.
Synchronization Determines whether all the “clone“ Views of the current detail View should be synchronized automatically with a “pattern“ View. Inherited from TcxCustomGridView.
TabStop Inherited from TcxCustomGridView.
Tag Inherited from TComponent.
VCLComObject Inherited from TComponent.
ViewData Identifies an object that adapts the values provided by a data controller for grid View data representation.
ViewInfo
ViewInfoCache Inherited from TcxCustomGridView.
Visible Indicates whether the current View is displayed. Inherited from TcxCustomGridView.
VisibleItemCount Returns the total number of items that are currently visible within the View.
VisibleItems Provides zero-based indexed access to the items that are currently visible within the View.

Methods

Name Description
ApplyBestFit(TcxCustomGridTableItem,Boolean,Boolean) Adjusts the width of the View’s items to display their content in full.
Assign(TPersistent) Inherited from TPersistent.
AssignSettings(TcxCustomGridView) Inherited from TcxCustomGridView.
AssignTo(TPersistent) Inherited from TPersistent.
BeginBestFitUpdate Disables updates to the View, and displays a “Locked View” image with the hourglass cursor.
BeginFilteringUpdate Disables updates to the View, and displays a “Locked View” image with the hourglass cursor.
BeginGroupingUpdate Disables updates to the View, and displays a “Locked View” image with the hourglass cursor.
BeginInvoke(TAsyncConstArrayFunctionEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProc,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncConstArrayProcedureEvent,Untyped[],TObject) Inherited from TComponent.
BeginInvoke(TAsyncFunctionEvent,TObject) Inherited from TComponent.
BeginInvoke(TAsyncProcedureEvent,TObject) Inherited from TComponent.
BeginInvoke(TProc,TObject) Inherited from TComponent.
BeginInvoke<TResult>(TAsyncConstArrayFunc<TResult>,Untyped[],TObject) Inherited from TComponent.
BeginInvoke<TResult>(TFunc<TResult>,TObject) Inherited from TComponent.
BeginSortingUpdate Disables updates to the View, and displays a “Locked View” image with the hourglass cursor.
BeginUpdate(TcxGridShowLockedStateImageMode) Prevents the current View’s updates until the EndUpdate or CancelUpdate method is called. Inherited from TcxCustomGridView.
BoundsChanged(Boolean,Boolean) Inherited from TcxCustomGridView.
CanBeLookupList
CancelUpdate Enables the current View’s updates after calling the BeginUpdate method. Inherited from TcxCustomGridView.
Changed(TcxGridViewChangeKind) Inherited from TcxCustomGridView.
Changed(TObject) Inherited from TcxCustomGridView.
CheckSynchronizationAssignNeeded Inherited from TcxCustomGridView.
ClearItems Removes all items from the View.
CopyToClipboard(Boolean) Copies the View content to the clipboard as text.
CreateItem Creates an item and adds it to the current View.
CreateViewInfo Inherited from TcxCustomGridView.
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
EndBestFitUpdate Enables updates to the View.
EndFilteringUpdate Enables updates to the View.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndGroupingUpdate Enables updates to the View.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
EndSortingUpdate Enables updates to the View.
EndUpdate Enables the current View’s updates after calling the BeginUpdate method. Inherited from TcxCustomGridView.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
FindComponent(String) Inherited from TComponent.
FindItemByID(Integer) Locates an item within the current View according to the item Item.ID property’s value.
FindItemByName(string) Locates an item with the specified name.
FindItemByTag(TcxTag) Locates an item with the specified tag value.
FreeNotification(TComponent) Inherited from TComponent.
FreeOnRelease Inherited from TComponent.
GetChildren(TGetChildProc,TComponent) Inherited from TComponent.
GetHashCode Inherited from TObject.
GetHitTest(Integer,Integer) Returns the HitTest object identifying the View’s element located at a particular point (called test or inspected point). Inherited from TcxCustomGridView.
GetHitTest(TPoint) Inherited from TcxCustomGridView.
GetImages Returns the collection of images that are used as icons for column headers. Inherited from TcxCustomGridView.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Inherited from TComponent.
GoToNextScrollbarAnnotation(TdxScrollbarAnnotationKinds,Boolean,Boolean) Moves focus to the nearest record marked with a scrollbar annotation.
HasAsClone(TcxCustomGridView) Inherited from TcxCustomGridView.
HasAsMaster(TcxCustomGridView) Inherited from TcxCustomGridView.
HasParent Inherited from TComponent.
HideHourglassCursor Suppresses the hourglass cursor. Inherited from TcxCustomGridView.
IndexOfItem(TcxCustomGridTableItem) Returns the index of the first entry within the Items collection with the specified value.
InsertComponent(TComponent) Inherited from TComponent.
Invalidate(Boolean) Invalidates the current View. Inherited from TcxCustomGridView.
IsEqualHeightRecords
IsImplementorOf(IInterface) Inherited from TComponent.
IsSynchronization Inherited from TcxCustomGridView.
IsUpdateLocked Inherited from TcxCustomGridView.
LayoutChanged(Boolean) Updates the View in response to layout changes. Inherited from TcxCustomGridView.
Loaded Inherited from TComponent.
MakeMasterGridRecordVisible Makes the master View record owning the current View visible.
Notification(TComponent,TOperation) Inherited from TComponent.
ReferenceInterface(IInterface,TOperation) Inherited from TComponent.
RemoveComponent(TComponent) Inherited from TComponent.
RemoveFreeNotification(TComponent) Inherited from TComponent.
RestoreDefaults Restores the default View settings. Inherited from TcxCustomGridView.
RestoreFromIniFile(string,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from an INI file. Inherited from TcxCustomGridView.
RestoreFromRegistry(string,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from the registry. Inherited from TcxCustomGridView.
RestoreFromStorage(string,TcxCustomReaderClass,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from a custom storage. Inherited from TcxCustomGridView.
RestoreFromStream(TStream,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from a stream. Inherited from TcxCustomGridView.
SetParentComponent(TComponent) Inherited from TComponent.
SetSubComponent(Boolean) Inherited from TComponent.
ShowHourglassCursor Displays the hourglass cursor. Inherited from TcxCustomGridView.
SizeChanged(Boolean,Boolean) Responds to View resizing. Inherited from TcxCustomGridView.
StoreToIniFile(string,Boolean,TcxGridStorageOptions,string,string) Saves View-specific information to an INI file. Inherited from TcxCustomGridView.
StoreToRegistry(string,Boolean,TcxGridStorageOptions,string,string) Stores View-specific information to the registry. Inherited from TcxCustomGridView.
StoreToStorage(string,TcxCustomWriterClass,Boolean,TcxGridStorageOptions,string,string) Saves View-specific information to a custom storage. Inherited from TcxCustomGridView.
StoreToStream(TStream,TcxGridStorageOptions,string,string) Saves the View-specific information to a stream. Inherited from TcxCustomGridView.
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.
UseRightToLeftAlignment Inherited from TcxCustomGridView.
ViewChanged Inherited from TcxCustomGridView.
ViewChanged(TcxRegion) Invalidates a View or View region. Inherited from TcxCustomGridView.
ViewChanged(TRect) Inherited from TcxCustomGridView.

Events

Name Description
DataControllerEvents Inherited from TcxCustomGridView.
NavigatorEvents
OnCanFocusRecord Occurs before focusing a grid record.
OnCanSelectRecord Occurs before selecting a grid record.
OnCellClick Occurs when an end-user clicks a cell within a View.
OnCellDblClick Occurs when an end-user double-clicks on a cell within a View.
OnCustomDrawCell Occurs when a cell within a Table View needs to be painted.
OnCustomDrawPartBackground Enables you to custom paint a View element‘s background.
OnCustomization protected Inherited from TcxCustomGridView.
OnDblClick Occurs when an end-user double-clicks within the current View. Inherited from TcxCustomGridView.
OnDragDrop Occurs when a user drops the object being dragged within the current View. Inherited from TcxCustomGridView.
OnDragOver Occurs when a user drags an object over the current View. Inherited from TcxCustomGridView.
OnEditChanged Occurs when a cell is edited within the current View.
OnEditDblClick Enables you to perform specific actions when an end-user double-clicks within an active cell editor.
OnEditing Occurs before activating a grid cell’s editor.
OnEditKeyDown Occurs when an end-user presses a key while a cell editor is active.
OnEditKeyPress Occurs when an alphanumeric key is pressed to change a cell editor‘s value.
OnEditKeyUp Occurs when an end-user releases a key while a cell editor is active.
OnEditValueChanged Occurs when changing the edit value of the active cell editor.
OnEndDrag Occurs when finishing dragging an object. Inherited from TcxCustomGridView.
OnFilterControlDialogShow Enables you to customize the Filter Builder dialog before showing it.
OnFilterCustomization Enables you to prevent the Filter Builder dialog from being displayed or substitute it with your own dialog.
OnFilterDialogShow Enables you to prevent filter dialogs from being displayed or substitute them with your own filter dialog(s).
OnFindPanelVisibilityChanged Enables you to track Find Panel visibility changes.
OnFocusedItemChanged Occurs when focus is changed to a different View item.
OnFocusedRecordChanged Occurs after focus is moved to a different record.
OnGetCellHeight Enables you to adjust the height of any visible cell in the grid Table View.
OnGetDragDropText Enables you to customize the text which is displayed during a drag operation.
OnGetScrollbarAnnotationHint Enables you to show hints for scrollbar annotations.
OnGetStoredProperties Occurs when the list of the current View’s properties that will be stored in external storage is produced. Inherited from TcxCustomGridView.
OnGetStoredPropertyValue Occurs when the values of the current View’s properties are stored in external storage. Inherited from TcxCustomGridView.
OnInitEdit Enables you to customize an in-place cell editor.
OnInitEditValue Allows you to initialize the activated cell editor’s edit value for a particular cell.
OnInitFilteringDateRanges Enables you to customize a collection of filter date ranges that are common to all View items.
OnInitGroupingDateRanges protected Enables you to customize a collection of grouping date ranges that are common to all View items.
OnInitStoredObject Occurs when a non-existent View element that is present within storage is created within the View. Inherited from TcxCustomGridView.
OnKeyDown Inherited from TcxCustomGridView.
OnKeyPress Inherited from TcxCustomGridView.
OnKeyUp Inherited from TcxCustomGridView.
OnMouseDown Occurs when an end-user presses a mouse button and the mouse pointer is located over the current View. Inherited from TcxCustomGridView.
OnMouseEnter Occurs when the mouse pointer moves over the current View. Inherited from TcxCustomGridView.
OnMouseLeave Occurs when the mouse pointer leaves the current View. Inherited from TcxCustomGridView.
OnMouseMove Inherited from TcxCustomGridView.
OnMouseUp Occurs when an end-user releases a mouse button that was pressed and the mouse pointer is located over the current View. Inherited from TcxCustomGridView.
OnMouseWheel Inherited from TcxCustomGridView.
OnMouseWheelDown Inherited from TcxCustomGridView.
OnMouseWheelUp Inherited from TcxCustomGridView.
OnPopulateCustomScrollbarAnnotationRowIndexList Enables you to display custom scrollbar annotations.
OnSelectionChanged Occurs after moving the selection to another grid record or column (its cells).
OnSetStoredPropertyValue Occurs when the values of the current View’s properties are restored from external storage. Inherited from TcxCustomGridView.
OnStartDrag Occurs when a user starts dragging by left-clicking the current View. Inherited from TcxCustomGridView.
OnTopRecordIndexChanged Occurs when a View is scrolled vertically.
OnUpdateEdit Enables you to respond to switching the edit mode for the grid or updates to the record being edited with a cell’s in-place editor.
StylesEvents Inherited from TcxCustomGridView.
See Also