Back to Devexpress

TcxCustomGridView Members

vcl-cxgridcustomview-dot-tcxcustomgridview-dot-underscore-members.md

latest28.8 KB
Original Source

TcxCustomGridView Members

The base class for all grid Views.

Constructors

NameDescription
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

NameDescription
CloneCountReturns the total number of copies (clones) of the current View.
ClonesRepresents the copies collection of the current View.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
ControlSpecifies the component’s parent control. Inherited from TcxControlChildComponent.
ControllerSpecifies a View controller.
DataControllerSpecifies the data controller managing the current View’s data.
DesignInfoInherited from TComponent.
DragModeSpecifies the manner in which Views initiate drag-and-drop operations.
FakeComponentLink1Inherited from TcxComponent.
FakeComponentLink2Inherited from TcxComponent.
FakeComponentLink3Inherited from TcxComponent.
FocusedDetermines whether the current View has focus.
Images protectedSpecifies the image list used as a source of icons for data item headers.
IsControlFocusedIndicates whether the grid control owning the current View has focus.
IsControlLocked
IsDesigningInherited from TcxComponent.
IsDestroyingSpecifies whether the component is currently being destroyed. Inherited from TcxControlChildComponent.
IsDetailIndicates whether the current View is placed at a child grid level.
IsLoadingSpecifies whether the current component is being loaded. Inherited from TcxControlChildComponent.
IsMasterIndicates whether the current View level has child Views which can be displayed.
IsPatternIndicates whether the current View is a “pattern“ View.
LevelReturns the grid level that owns the current View.
LookAndFeel
LookAndFeelPainter
MasterDataController
MasterGridRecordIndexReturns the index of the master View record for which the current View is displayed as a detail View.
MasterGridViewReturns a master View for the current View.
MasterRecordIndexReturns the index of the master dataset record corresponding to a master View record. The current View is displayed as a detail View.
NameInherited from TComponent.
ObserversInherited from TComponent.
OptionsSelection protectedContains selection options for the current View.
OptionsView protectedContains View options for the current View.
OwnerInherited from TComponent.
Painter
PatternGridViewReturns the View whose copy (clone) is the current View.
PopupMenuSpecifies the popup menu associated with the current View.
Repository
SiteProvides access to the control that holds the View.
StorageControl
StorageOptions
StoringName
Styles protectedProvides access to styles that define the appearance of grid View elements.
SynchronizationDetermines whether all the “clone“ Views of the current detail View should be synchronized automatically with a “pattern“ View.
TabStop
TagInherited from TComponent.
VCLComObjectInherited from TComponent.
ViewDataSpecifies the object adapting values provided by a data controller for the grid View’s data representation.
ViewInfoProvides access to the ViewInfo object that contains information on how to draw the grid View.
ViewInfoCache
VisibleIndicates whether the current View is displayed.

Methods

NameDescription
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)
CancelUpdateEnables the current View’s updates after calling the BeginUpdate method.
Changed(TcxGridViewChangeKind)
Changed(TObject)
CheckSynchronizationAssignNeeded
CreateViewInfo
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndUpdateEnables 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.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetHashCodeInherited from TObject.
GetHitTest(Integer,Integer)Returns the HitTest object that identifies the visual element at the inspected point.
GetHitTest(TPoint)
GetImagesReturns the image list used as the source of icons for data item headers.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
HasAsClone(TcxCustomGridView)
HasAsMaster(TcxCustomGridView)
HasParentInherited from TComponent.
HideHourglassCursorSuppresses 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.
LoadedInherited from TComponent.
Notification(TComponent,TOperation)Inherited from TComponent.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RestoreDataViewState(TcxGridStorageOptions)Restores user interaction states stored in memory after a StoreDataViewState procedure call.
RestoreDataViewStateFromStream(TStream,TcxGridStorageOptions)Restores the previously saved data view state from a stream.
RestoreDefaultsRestores the default View settings.
RestoreFromIniFile(string,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from an INI file.
RestoreFromRegistry(string,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from the system registry.
RestoreFromStorage(string,TcxCustomReaderClass,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from a file in a custom data format.
RestoreFromStream(TStream,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from a stream.
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ShowHourglassCursorDisplays the hourglass cursor.
SizeChanged(Boolean,Boolean)Responds to View resizing.
StoreDataViewState(TcxGridStorageOptions)Stores specified user interaction states in memory.
StoreDataViewStateToStream(TStream,TcxGridStorageOptions)Saves specified user grid View interaction states to a stream.
StoreToIniFile(string,Boolean,TcxGridStorageOptions,string,string)Saves grid View state information to an INI file.
StoreToRegistry(string,Boolean,TcxGridStorageOptions,string,string)Saves specified View data structure and user interaction information to the system registry.
StoreToStorage(string,TcxCustomWriterClass,Boolean,TcxGridStorageOptions,string,string)Saves grid View data layout and user interaction states to a file in a custom data format.
StoreToStream(TStream,TcxGridStorageOptions,string,string)Saves specified View data structure and user interaction information to a stream.
ToStringInherited from TObject.
UpdateAction(TBasicAction)Inherited from TComponent.
UseRightToLeftAlignment
ViewChanged
ViewChanged(TcxRegion)Invalidates a View or View region.
ViewChanged(TRect)

Events

NameDescription
DataControllerEvents
OnCustomization protected
OnDblClickOccurs when an end-user double-clicks within the current View.
OnDragDropOccurs when a user drops the object being dragged within the current View.
OnDragOverOccurs when a user drags an object over the current View.
OnEndDragOccurs when finishing dragging an object.
OnGetStoredPropertiesOccurs when the list of the current View’s properties that will be stored in external storage is produced.
OnGetStoredPropertyValueOccurs when the values of the current View’s properties are stored in external storage.
OnInitStoredObject protectedOccurs when a non-existent View element that is present within storage is created within the View.
OnKeyDown
OnKeyPress
OnKeyUp
OnMouseDownOccurs when an end-user presses a mouse button and the mouse pointer is located over the current View.
OnMouseEnterOccurs when the mouse pointer moves over the current View.
OnMouseLeaveOccurs when the mouse pointer leaves the current View.
OnMouseMove
OnMouseUpOccurs when an end-user releases a mouse button that was pressed and the mouse pointer is located over the current View.
OnMouseWheel
OnMouseWheelDown
OnMouseWheelUp
OnSetStoredPropertyValueOccurs when the values of the current View’s properties are restored from external storage.
OnStartDragOccurs when a user starts dragging by left-clicking the current View.
StylesEvents

See Also

TcxCustomGridView Class

cxGridCustomView Unit