Skip to main content

TcxCustomGridView Members

The base class for all grid View classes.

Constructors

Name Description
Create(TComponent) Inherited from TComponent.
CreateCloned(TcxControl) Initializes a new instance of the TcxCustomGridView class with specified settings.
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.
Clones Represents the copies collection of the current View.
ComObject Inherited from TComponent.
ComponentCount Inherited from TComponent.
ComponentIndex Inherited from TComponent.
Components Inherited from TComponent.
ComponentState Inherited from TComponent.
ComponentStyle Inherited from TComponent.
Control Specifies the component’s parent control. Inherited from TcxControlChildComponent.
Controller Specifies a View controller.
DataController Specifies the data controller managing the current View’s data.
DesignInfo Inherited from TComponent.
DragMode Specifies the manner in which Views initiate drag-and-drop operations.
FakeComponentLink1 Inherited from TcxComponent.
FakeComponentLink2 Inherited from TcxComponent.
FakeComponentLink3 Inherited from TcxComponent.
Focused Determines whether the current View has focus.
Images protected Specifies the image list used as a source of icons for data item headers.
IsControlFocused Indicates whether the grid control owning the current View has focus.
IsControlLocked
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.
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.
IsPattern Indicates whether the current View is a “pattern“ View.
Level Returns the grid level that owns the current View.
LookAndFeel
LookAndFeelPainter
MasterDataController
MasterGridRecordIndex Returns the index of the master View record for which the current View is displayed as a detail View.
MasterGridView Returns a master View for the current View.
MasterRecordIndex Returns the index of the master dataset record corresponding to a master View record. The current View is displayed as a detail View.
Name Inherited from TComponent.
Observers Inherited from TComponent.
OptionsSelection protected Contains selection options for the current View.
OptionsView protected Contains View options for the current View.
Owner Inherited from TComponent.
Painter
PatternGridView Returns the View whose copy (clone) is the current View.
PopupMenu Specifies the popup menu associated with the current View.
Repository
Site Provides access to the control that holds the View.
StorageControl
StorageOptions
StoringName
Styles protected Provides access to styles that define the appearance of grid View elements.
Synchronization Determines whether all the “clone“ Views of the current detail View should be synchronized automatically with a “pattern“ View.
TabStop
Tag Inherited from TComponent.
VCLComObject Inherited from TComponent.
ViewData Specifies the object adapting values provided by a data controller for the grid View’s data representation.
ViewInfo Provides access to the ViewInfo object that contains information on how to draw the grid View.
ViewInfoCache
Visible Indicates whether the current View is displayed.

Methods

Name Description
Assign(TPersistent) Inherited from TPersistent.
AssignSettings(TcxCustomGridView)
AssignTo(TPersistent) Inherited from TPersistent.
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.
BeginUpdate(TcxGridShowLockedStateImageMode) Prevents the current View’s updates until the EndUpdate or CancelUpdate method is called.
BoundsChanged(Boolean,Boolean)
CancelUpdate Enables the current View’s updates after calling the BeginUpdate method.
Changed(TcxGridViewChangeKind)
Changed(TObject)
CheckSynchronizationAssignNeeded
CreateViewInfo
DestroyComponents Inherited from TComponent.
Destroying Inherited from TComponent.
EndFunctionInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke(IAsyncResult) Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult) Inherited from TComponent.
EndUpdate Enables the current View’s updates after calling the BeginUpdate method.
Equals(TObject) Inherited from TObject.
ExecuteAction(TBasicAction) Inherited from TComponent.
FindComponent(String) Inherited from TComponent.
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 that identifies the visual element at the inspected point.
GetHitTest(TPoint)
GetImages Returns the image list used as the source of icons for data item headers.
GetNamePath Inherited from TPersistent.
GetOwner Inherited from TPersistent.
GetParentComponent Inherited from TComponent.
HasAsClone(TcxCustomGridView)
HasAsMaster(TcxCustomGridView)
HasParent Inherited from TComponent.
HideHourglassCursor Suppresses the hourglass cursor.
InsertComponent(TComponent) Inherited from TComponent.
Invalidate(Boolean) Invalidates the grid View.
IsImplementorOf(IInterface) Inherited from TComponent.
IsSynchronization
IsUpdateLocked
LayoutChanged(Boolean) Updates the View in response to layout changes.
Loaded Inherited from TComponent.
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.
RestoreFromIniFile(string,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from an INI file.
RestoreFromRegistry(string,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from the registry.
RestoreFromStorage(string,TcxCustomReaderClass,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from a custom storage.
RestoreFromStream(TStream,Boolean,Boolean,TcxGridStorageOptions,string,string) Restores View-specific information from a stream.
SetParentComponent(TComponent) Inherited from TComponent.
SetSubComponent(Boolean) Inherited from TComponent.
ShowHourglassCursor Displays the hourglass cursor.
SizeChanged(Boolean,Boolean) Responds to View resizing.
StoreToIniFile(string,Boolean,TcxGridStorageOptions,string,string) Saves View-specific information to an INI file.
StoreToRegistry(string,Boolean,TcxGridStorageOptions,string,string) Stores View-specific information to the registry.
StoreToStorage(string,TcxCustomWriterClass,Boolean,TcxGridStorageOptions,string,string) Saves View-specific information to a custom storage.
StoreToStream(TStream,TcxGridStorageOptions,string,string) Saves the View-specific information to a stream.
ToString Inherited from TObject.
UpdateAction(TBasicAction) Inherited from TComponent.
UseRightToLeftAlignment
ViewChanged
ViewChanged(TcxRegion) Invalidates a View or View region.
ViewChanged(TRect)

Events

Name Description
DataControllerEvents
OnCustomization protected
OnDblClick Occurs when an end-user double-clicks within the current View.
OnDragDrop Occurs when a user drops the object being dragged within the current View.
OnDragOver Occurs when a user drags an object over the current View.
OnEndDrag Occurs when finishing dragging an object.
OnGetStoredProperties Occurs when the list of the current View’s properties that will be stored in external storage is produced.
OnGetStoredPropertyValue Occurs when the values of the current View’s properties are stored in external storage.
OnInitStoredObject protected Occurs when a non-existent View element that is present within storage is created within the View.
OnKeyDown
OnKeyPress
OnKeyUp
OnMouseDown Occurs when an end-user presses a mouse button and the mouse pointer is located over the current View.
OnMouseEnter Occurs when the mouse pointer moves over the current View.
OnMouseLeave Occurs when the mouse pointer leaves the current View.
OnMouseMove
OnMouseUp Occurs when an end-user releases a mouse button that was pressed and the mouse pointer is located over the current View.
OnMouseWheel
OnMouseWheelDown
OnMouseWheelUp
OnSetStoredPropertyValue Occurs when the values of the current View’s properties are restored from external storage.
OnStartDrag Occurs when a user starts dragging by left-clicking the current View.
StylesEvents
See Also