Back to Devexpress

TcxGridLayoutView Members

vcl-cxgridlayoutview-dot-tcxgridlayoutview-dot-underscore-members.md

latest55.0 KB
Original Source

TcxGridLayoutView Members

An unbound Layout grid View.

Constructors

NameDescription
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

NameDescription
CloneCountReturns the total number of copies (clones) of the current View. Inherited from TcxCustomGridView.
ClonesRepresents the copies collection of the current View. Inherited from TcxCustomGridView.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
ConditionalFormattingProvides access to the conditional formatting controller. Inherited from TcxCustomGridTableView.
ContainerProvides access to the View’s layout container.
ControlProvides access to the grid that owns the View.
ControllerProvides access to the View controller.
DataControllerSpecifies the data controller for a View.
DateTimeHandlingSpecifies the View’s date/time settings.
DesignInfoInherited from TComponent.
DragModeSpecifies the manner in which Views initiate drag-and-drop operations. Inherited from TcxCustomGridView.
FakeComponentLink1Inherited from TcxComponent.
FakeComponentLink2Inherited from TcxComponent.
FakeComponentLink3Inherited from TcxComponent.
FilterBoxContains settings that determine the appearance aspects of the grid View’s filter box. Inherited from TcxCustomGridTableView.
FilteringSpecifies the View’s filtering settings.
FindPanelSpecifies settings that define the appearance and behavior of the View’s Find Panel. Inherited from TcxCustomGridTableView.
FocusedDetermines whether the current View has focus. Inherited from TcxCustomGridView.
GroupedItemCountReturns the number of grouping items within the current View. Inherited from TcxCustomGridTableView.
GroupedItemsProvides zero-based indexed access to the View’s grouping items. Inherited from TcxCustomGridTableView.
ImagesSpecifies the image list used as a source of icons for data item headers. Inherited from TcxCustomGridView.
InDataControlFocusingInherited from TcxCustomGridTableView.
IsControlFocusedIndicates whether the grid control owning the current View has focus. Inherited from TcxCustomGridView.
IsControlLockedInherited from TcxCustomGridView.
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. Inherited from TcxCustomGridView.
IsLoadingSpecifies whether the current component is being loaded. Inherited from TcxControlChildComponent.
IsMasterIndicates whether the current View level has child Views which can be displayed. Inherited from TcxCustomGridView.
IsPatternIndicates whether the current View is a “pattern“ View. Inherited from TcxCustomGridView.
ItemCountReturns the total number of data items in the grid View. Inherited from TcxCustomGridTableView.
ItemsProvides indexed access to the View’s data items.
LayoutLookAndFeelProvides access to the look & feel style settings applied to the Layout View’s layout container.
LevelReturns the grid level that owns the current View. Inherited from TcxCustomGridView.
LookAndFeelInherited from TcxCustomGridView.
LookAndFeelPainterInherited from TcxCustomGridView.
MasterDataControllerInherited from TcxCustomGridView.
MasterGridRecordReturns the master View record displaying the current View as a detail. Inherited from TcxCustomGridTableView.
MasterGridRecordIndexReturns the index of the master View record for which the current View is displayed as a detail View. Inherited from TcxCustomGridView.
MasterGridViewReturns a master View for the current View. Inherited from TcxCustomGridView.
MasterRecordIndexReturns 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.
NameInherited from TComponent.
NavigatorProvides access to the View navigator’s settings. Inherited from TcxCustomGridTableView.
NavigatorButtonsDeprecated. This property exists for backward compatibility only. Use the Navigator property instead. Inherited from TcxCustomGridTableView.
ObserversInherited from TComponent.
OptionsBehaviorSpecifies the View’s behavior settings.
OptionsCustomizeSpecifies the View’s customization settings.
OptionsDataSpecifies the View’s data settings.
OptionsSelectionSpecifies the View’s selection settings.
OptionsViewSpecifies the View’s display settings.
OwnerInherited from TComponent.
PainterInherited from TcxCustomGridTableView.
PatternGridViewInherited from TcxCustomGridTableView.
PopupMenuSpecifies the popup menu associated with the current View. Inherited from TcxCustomGridView.
RepositoryInherited from TcxCustomGridView.
ScrollbarAnnotationsProvides access to the View’s scrollbar annotation settings. Inherited from TcxCustomGridTableView.
SiteProvides access to the control that holds the View. Inherited from TcxCustomGridView.
SortedItemCountReturns the number of sorted data items in the grid View. Inherited from TcxCustomGridTableView.
SortedItemsProvides indexed access to all sorted data items. Inherited from TcxCustomGridTableView.
StorageControlInherited from TcxCustomGridView.
StorageOptionsInherited from TcxCustomGridView.
StoringNameInherited from TcxCustomGridView.
StylesSpecifies the View’s style settings.
StylesAdapter
SynchronizationDetermines whether all the “clone“ Views of the current detail View should be synchronized automatically with a “pattern“ View. Inherited from TcxCustomGridView.
TabStopInherited from TcxCustomGridView.
TagInherited from TComponent.
VCLComObjectInherited from TComponent.
ViewDataIdentifies an object that adapts the values provided by a data controller for grid View data representation. Inherited from TcxCustomGridTableView.
ViewInfoProvides access to the ViewInfo object that contains information on how to draw the Layout View.
ViewInfoCacheInherited from TcxCustomGridView.
VisibleIndicates whether the current View is displayed. Inherited from TcxCustomGridView.
VisibleItemCountReturns the total number of items that are currently visible within the View. Inherited from TcxCustomGridTableView.
VisibleItemsProvides indexed access to the data items visible within a View.

Methods

NameDescription
ApplyBestFit(TcxCustomGridTableItem,Boolean,Boolean)Adjusts the width of the View’s items to display their content in full. Inherited from TcxCustomGridTableView.
Assign(TPersistent)Inherited from TPersistent.
AssignSettings(TcxCustomGridView)Inherited from TcxCustomGridView.
AssignTo(TPersistent)Inherited from TPersistent.
BeginBestFitUpdateDisables updates to the View, and displays a “Locked View” image with the hourglass cursor. Inherited from TcxCustomGridTableView.
BeginFilteringUpdateDisables updates to the View, and displays a “Locked View” image with the hourglass cursor. Inherited from TcxCustomGridTableView.
BeginGroupingUpdateDisables updates to the View, and displays a “Locked View” image with the hourglass cursor. Inherited from TcxCustomGridTableView.
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.
BeginSortingUpdateDisables updates to the View, and displays a “Locked View” image with the hourglass cursor. Inherited from TcxCustomGridTableView.
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.
CanBeLookupListInherited from TcxCustomGridTableView.
CancelUpdateEnables the current View’s updates after calling the BeginUpdate method. Inherited from TcxCustomGridView.
Changed(TcxGridViewChangeKind)Inherited from TcxCustomGridView.
Changed(TObject)Inherited from TcxCustomGridView.
CheckSynchronizationAssignNeededInherited from TcxCustomGridView.
ClearItemsRemoves all items from the View. Inherited from TcxCustomGridTableView.
CopyToClipboard(Boolean)Copies the View content to the clipboard as text. Inherited from TcxCustomGridTableView.
CreateItemCreates a data item and adds it to the View.
CreateViewInfoInherited from TcxCustomGridView.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
EndBestFitUpdateEnables updates to the View. Inherited from TcxCustomGridTableView.
EndFilteringUpdateEnables updates to the View. Inherited from TcxCustomGridTableView.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndGroupingUpdateEnables updates to the View. Inherited from TcxCustomGridTableView.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndSortingUpdateEnables updates to the View. Inherited from TcxCustomGridTableView.
EndUpdateEnables 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. Inherited from TcxCustomGridTableView.
FindItemByName(string)Locates an item with the specified name. Inherited from TcxCustomGridTableView.
FindItemByTag(TcxTag)Locates an item with the specified tag value. Inherited from TcxCustomGridTableView.
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. Inherited from TcxCustomGridView.
GetHitTest(TPoint)Inherited from TcxCustomGridView.
GetImagesReturns the image list used as the source of icons for data item headers. Inherited from TcxCustomGridView.
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GoToNextScrollbarAnnotation(TdxScrollbarAnnotationKinds,Boolean,Boolean)Moves focus to the nearest record marked with a scrollbar annotation. Inherited from TcxCustomGridTableView.
HasAsClone(TcxCustomGridView)Inherited from TcxCustomGridView.
HasAsMaster(TcxCustomGridView)Inherited from TcxCustomGridView.
HasParentInherited from TComponent.
HideHourglassCursorSuppresses the hourglass cursor. Inherited from TcxCustomGridView.
IndexOfItem(TcxCustomGridTableItem)Returns the index of the first entry within the Items collection with the specified value. Inherited from TcxCustomGridTableView.
InsertComponent(TComponent)Inherited from TComponent.
Invalidate(Boolean)Invalidates the grid View. Inherited from TcxCustomGridView.
IsEqualHeightRecordsInherited from TcxCustomGridTableView.
IsImplementorOf(IInterface)Inherited from TComponent.
IsSynchronizationInherited from TcxCustomGridView.
IsUpdateLockedInherited from TcxCustomGridView.
LayoutChanged(Boolean)Updates the View in response to layout changes. Inherited from TcxCustomGridView.
LoadedInherited from TComponent.
MakeMasterGridRecordVisibleMakes the master View record owning the current View visible. Inherited from TcxCustomGridTableView.
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. Inherited from TcxCustomGridView.
RestoreDataViewStateFromStream(TStream,TcxGridStorageOptions)Restores the previously saved data view state from a stream. Inherited from TcxCustomGridView.
RestoreDefaultsRestores the default View settings. Inherited from TcxCustomGridView.
RestoreFromIniFile(string,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from an INI file. Inherited from TcxCustomGridView.
RestoreFromRegistry(string,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from the system registry. Inherited from TcxCustomGridView.
RestoreFromStorage(string,TcxCustomReaderClass,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from a file in a custom data format. Inherited from TcxCustomGridView.
RestoreFromStream(TStream,Boolean,Boolean,TcxGridStorageOptions,string,string)Restores previously saved grid View state information from a stream. Inherited from TcxCustomGridView.
SetParentComponent(TComponent)Inherited from TComponent.
SetSubComponent(Boolean)Inherited from TComponent.
ShowHourglassCursorDisplays the hourglass cursor. Inherited from TcxCustomGridView.
SizeChanged(Boolean,Boolean)Responds to View resizing. Inherited from TcxCustomGridView.
SmartPaste(string)Inserts the specified string or current clipboard content into all configured data items using the AI-powered Smart Paste functionality. Inherited from TcxCustomGridTableView.
StoreDataViewState(TcxGridStorageOptions)Stores specified user interaction states in memory. Inherited from TcxCustomGridView.
StoreDataViewStateToStream(TStream,TcxGridStorageOptions)Saves specified user grid View interaction states to a stream. Inherited from TcxCustomGridView.
StoreToIniFile(string,Boolean,TcxGridStorageOptions,string,string)Saves grid View state information to an INI file. Inherited from TcxCustomGridView.
StoreToRegistry(string,Boolean,TcxGridStorageOptions,string,string)Saves specified View data structure and user interaction information to the system registry. Inherited from TcxCustomGridView.
StoreToStorage(string,TcxCustomWriterClass,Boolean,TcxGridStorageOptions,string,string)Saves grid View data layout and user interaction states to a file in a custom data format. Inherited from TcxCustomGridView.
StoreToStream(TStream,TcxGridStorageOptions,string,string)Saves specified View data structure and user interaction information to a stream. Inherited from TcxCustomGridView.
ToStringInherited from TObject.
UpdateAction(TBasicAction)Inherited from TComponent.
UseRightToLeftAlignmentInherited from TcxCustomGridView.
ViewChangedInherited from TcxCustomGridView.
ViewChanged(TcxRegion)Invalidates a View or View region. Inherited from TcxCustomGridView.
ViewChanged(TRect)Inherited from TcxCustomGridView.

Events

NameDescription
DataControllerEventsInherited from TcxCustomGridView.
NavigatorEventsInherited from TcxCustomGridTableView.
OnCanFocusRecordAllows you to prevent a record from being focused. Inherited from TcxCustomGridTableView.
OnCanSelectRecordAllows you to prevent a record from being selected. Inherited from TcxCustomGridTableView.
OnCellClickOccurs every time a user clicks a cell. Inherited from TcxCustomGridTableView.
OnCellDblClickOccurs every time a user double-clicks a cell. Inherited from TcxCustomGridTableView.
OnCustomDrawCellAllows you to override or complement built-in cell draw routines. Inherited from TcxCustomGridTableView.
OnCustomDrawPartBackgroundAllows you to custom draw a View element background. Inherited from TcxCustomGridTableView.
OnCustomDrawRecordCaptionAllows you to override or complement the predefined card caption draw routine.
OnCustomizationInherited from TcxCustomGridView.
OnDblClickOccurs when an end-user double-clicks within the current View. Inherited from TcxCustomGridView.
OnDragDropOccurs when a user drops the object being dragged within the current View. Inherited from TcxCustomGridView.
OnDragOverOccurs when a user drags an object over the current View. Inherited from TcxCustomGridView.
OnEditChangedOccurs when a cell is edited within the current View. Inherited from TcxCustomGridTableView.
OnEditDblClickEnables you to perform specific actions when an end-user double-clicks within an active cell editor. Inherited from TcxCustomGridTableView.
OnEditingOccurs before activating a grid cell’s editor. Inherited from TcxCustomGridTableView.
OnEditKeyDownAllows you to respond to keystrokes in an active in-place cell editor. Inherited from TcxCustomGridTableView.
OnEditKeyPressOccurs when an alphanumeric key is pressed to change a cell editor‘s value. Inherited from TcxCustomGridTableView.
OnEditKeyUpOccurs when an end-user releases a key while a cell editor is active. Inherited from TcxCustomGridTableView.
OnEditValueChangedOccurs when changing the edit value of the active cell editor. Inherited from TcxCustomGridTableView.
OnEndDragOccurs when finishing dragging an object. Inherited from TcxCustomGridView.
OnFilterControlDialogShowAllows you to respond to a filter customization dialog display operation and modify the dialog’s appearance. Inherited from TcxCustomGridTableView.
OnFilterCustomizationEnables you to prevent the Filter Builder dialog from being displayed or substitute it with your own dialog. Inherited from TcxCustomGridTableView.
OnFilterDialogShowEnables you to prevent filter dialogs from being displayed or substitute them with your own filter dialog(s). Inherited from TcxCustomGridTableView.
OnFindPanelVisibilityChangedEnables you to track Find Panel visibility changes. Inherited from TcxCustomGridTableView.
OnFocusedItemChangedOccurs when focus moves to a different data item. Inherited from TcxCustomGridTableView.
OnFocusedRecordChangedAllows you to respond to navigation between records. Inherited from TcxCustomGridTableView.
OnGetCellHeightAllows you to adjust the height of any visible cell in the grid Table View. Inherited from TcxCustomGridTableView.
OnGetDragDropTextAllows you to modify display text during a drag-and-drop operation. Inherited from TcxCustomGridTableView.
OnGetScrollbarAnnotationHintEnables you to show hints for scrollbar annotations. Inherited from TcxCustomGridTableView.
OnGetStoredPropertiesOccurs when the list of the current View’s properties that will be stored in external storage is produced. Inherited from TcxCustomGridView.
OnGetStoredPropertyValueOccurs when the values of the current View’s properties are stored in external storage. Inherited from TcxCustomGridView.
OnInitEditAllows you to configure an in-place cell editor before it is displayed. Inherited from TcxCustomGridTableView.
OnInitEditValueAllows you to initialize the activated in-place editor value for a particular cell. Inherited from TcxCustomGridTableView.
OnInitFilteringDateRangesEnables you to customize a collection of filter date ranges that are common to all View items. Inherited from TcxCustomGridTableView.
OnInitGroupingDateRanges protectedEnables you to customize a collection of grouping date ranges that are common to all View items. Inherited from TcxCustomGridTableView.
OnInitStoredObjectOccurs when a non-existent View element that is present within storage is created within the View. Inherited from TcxCustomGridView.
OnKeyDownInherited from TcxCustomGridView.
OnKeyPressInherited from TcxCustomGridView.
OnKeyUpInherited from TcxCustomGridView.
OnMouseDownOccurs when an end-user presses a mouse button and the mouse pointer is located over the current View. Inherited from TcxCustomGridView.
OnMouseEnterOccurs when the mouse pointer moves over the current View. Inherited from TcxCustomGridView.
OnMouseLeaveOccurs when the mouse pointer leaves the current View. Inherited from TcxCustomGridView.
OnMouseMoveInherited from TcxCustomGridView.
OnMouseUpOccurs when an end-user releases a mouse button that was pressed and the mouse pointer is located over the current View. Inherited from TcxCustomGridView.
OnMouseWheelInherited from TcxCustomGridView.
OnMouseWheelDownInherited from TcxCustomGridView.
OnMouseWheelUpInherited from TcxCustomGridView.
OnPopulateCustomScrollbarAnnotationRowIndexListEnables you to display custom scrollbar annotations. Inherited from TcxCustomGridTableView.
OnSelectionChangedOccurs after moving the selection to another grid record or column (its cells). Inherited from TcxCustomGridTableView.
OnSetStoredPropertyValueOccurs when the values of the current View’s properties are restored from external storage. Inherited from TcxCustomGridView.
OnStartDragOccurs when a user starts dragging by left-clicking the current View. Inherited from TcxCustomGridView.
OnTopRecordIndexChangedOccurs when a View is scrolled vertically. Inherited from TcxCustomGridTableView.
OnUpdateEditEnables 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. Inherited from TcxCustomGridTableView.
StylesEventsInherited from TcxCustomGridView.

See Also

TcxGridLayoutView Class

cxGridLayoutView Unit