Back to Devexpress

TdxCustomLayoutControl Members

vcl-dxlayoutcontrol-dot-tdxcustomlayoutcontrol-dot-underscore-members.md

latest81.8 KB
Original Source

TdxCustomLayoutControl Members

The base class for the Layout control.

Constructors

NameDescription
Create(TComponent)Inherited from TComponent.
CreateParented(HWND)Inherited from TWinControl.

Properties

NameDescription
AbsoluteItemCountReturns the total number of layout control elements.
AbsoluteItemsProvides indexed access to the layout control’s elements.
ActionInherited from TControl.
ActiveCanvasProvides access to the control’s GDI-based canvas. Inherited from TcxControl.
AlignInherited from TControl.
AlignDisabledInherited from TWinControl.
AlignmentConstraintCountReturns the number of alignment constraints defined within the layout control.
AlignmentConstraintsProvides zero-based indexed access to alignment constraints defined within the layout control.
AlignWithMarginsInherited from TControl.
AnchorsInherited from TControl.
AutoContentSizesDeprecated. This property exists for backward compatibility only. Instead, use AlignHorz and AlignVert properties at the level of individual layout items.
AutoControlAlignmentDeprecated. This property exists for backward compatibility only. Use the OptionsItem.AutoControlAreaAlignment property instead.
AutoControlTabOrdersDeprecated. This property exists for backward compatibility only. Use the OptionsItem.AutoControlTabOrders property instead.
Automation protectedProvides access to layout control UI Automation and accessibility-related settings.
AutoSizeInherited from TControl.
AutoSizeMode protectedInherited from TcxScrollingControl.
AvailableItemCountReturns the number of elements temporarily hidden from view.
AvailableItemsProvides indexed access to the layout control’s temporarily hidden elements.
BevelEdgesInherited from TWinControl.
BevelInnerInherited from TWinControl.
BevelKindInherited from TWinControl.
BevelOuterInherited from TWinControl.
BevelWidthInherited from TWinControl.
BiDiModeInherited from TControl.
BorderSize protectedInherited from TcxControl.
BorderStyle protectedSpecifies the control’s border style. Inherited from TcxControl.
BorderWidthInherited from TWinControl.
BoundsReturns the control’s boundaries. Inherited from TcxControl.
BoundsRectInherited from TControl.
BrushInherited from TWinControl.
CanvasProvides access to the control’s GDI-based canvas. Inherited from TcxControl.
CaptionInherited from TControl.
ClientBoundsReturns the control’s client area. Inherited from TcxControl.
ClientHeightInherited from TControl.
ClientOriginInherited from TControl.
ClientRectInherited from TControl.
ClientWidthInherited from TControl.
ColorInherited from TControl.
ComObjectInherited from TComponent.
ComponentCountInherited from TComponent.
ComponentIndexInherited from TComponent.
ComponentsInherited from TComponent.
ComponentStateInherited from TComponent.
ComponentStyleInherited from TComponent.
ConstraintsInherited from TControl.
ContainerProvides access to the layout container.
ContentBoundsReturns the bounding rectangle of the layout control’s client area, in layout control coordinates.
ControlCountInherited from TWinControl.
ControlsInherited from TWinControl.
ControlStateInherited from TControl.
ControlStyleInherited from TControl.
Ctl3DInherited from TWinControl.
CurrentPPIInherited from TControl.
CursorInherited from TControl.
CustomHintInherited from TControl.
CustomizationSpecifies whether the ExpressLayout Control is in customization mode.
CustomizeAvailableItemsViewKindSpecifies the manner in which layout items are displayed in the Customization Form‘s Available Items pane.
CustomizeFormProvides access to the Customization Form.
CustomizeFormBoundsSpecifies the bound rectangle of the Customization Form in pixels.
CustomizeFormClassSpecifies the class which represents the Customization Form.
CustomizeFormTabbedViewSpecifies how the Layout Tree View and Available Items panes are arranged in the Customization Form.
DefaultUseGlobalSkinSpecifies if all Layout controls in the application automatically update their appearance from application-wide skin and palette settings.
DesignInfoInherited from TComponent.
DockClientCountInherited from TWinControl.
DockClientsInherited from TWinControl.
DockManagerInherited from TWinControl.
DockOrientationInherited from TControl.
DockSiteInherited from TWinControl.
DoubleBufferedInherited from TWinControl.
DragAndDropObjectInherited from TcxControl.
DragAndDropObjectClassInherited from TcxControl.
DragAndDropStateInherited from TcxControl.
DragCursorInherited from TControl.
DragDropMode protectedDeprecated. This property exists for backward compatibility only. The layout control now uses a unified indication style for drag-and-drop operations.
DragKindInherited from TControl.
DragModeInherited from TControl.
EnabledInherited from TControl.
ExplicitHeightInherited from TControl.
ExplicitLeftInherited from TControl.
ExplicitTopInherited from TControl.
ExplicitWidthInherited from TControl.
FloatingInherited from TControl.
FloatingDockSiteClassInherited from TControl.
FocusOnClick protectedSpecifies if clicking the control focuses it. Inherited from TcxControl.
FontInherited from TControl.
HandleInherited from TWinControl.
HeightInherited from TControl.
HelpContextInherited from TControl.
HelpKeywordInherited from TControl.
HelpTypeInherited from TControl.
HighlightRoot
HintSpecifies a hint message for the control. Inherited from TcxControl.
HostDockSiteInherited from TControl.
HScrollBar protectedInherited from TcxControl.
HScrollBarVisible protectedInherited from TcxControl.
ImeModeInherited from TWinControl.
ImeNameInherited from TWinControl.
IniFileNameDeprecated. This property exists for backward compatibility only. Use the OptionsStoring.IniFileName property instead.
IsDesigningIdentifies if the control is being modified by the form designer. Inherited from TcxControl.
IsDestroyingIdentifies if the control is about to be destroyed. Inherited from TcxCustomControl.
IsDrawingLockedInherited from TWinControl.
IsFocusedIdentifies if the control has focus. Inherited from TcxControl.
IsLoadingIdentifies if the control is being loaded. Inherited from TcxControl.
ItemsProvides access to the root group and its child groups/items.
Keys protectedInherited from TcxControl.
LayoutDirectionSpecifies the direction in which the ExpressLayout Control root group items are placed.
LayoutLookAndFeelAssociates the Layout control with a dedicated look & feel storage component.
LeftInherited from TControl.
LeftPosDetermines the horizontal offset of the currently visible left border relative to the real left border of the TdxCustomLayoutControl object.
LookAndFeelDeprecated. This property exists for backward compatibility only. Use the LayoutLookAndFeel property instead.
LookAndFeelPainter protectedInherited from TcxControl.
LRDockWidthInherited from TControl.
MarginsInherited from TControl.
MenuItems protectedSpecifies which customization context menu items are visible.
MouseCaptureInherited from TControl.
MouseCaptureObjectProvides access to the dragged object during a drag-and-drop operation. Inherited from TcxControl.
MouseDownPosSpecifies the mouse pointer position when an OnMouseDown event occurs. Inherited from TcxControl.
MouseInClientInherited from TWinControl.
NameInherited from TComponent.
ObserversInherited from TComponent.
OccupiedClientHeightReturns the layout control client area’s height, in pixels.
OccupiedClientWidthReturns the layout control client area’s width, in pixels.
OptionsImageSpecifies image options for the layout control.
OptionsItemProvides access to layout element behavior settings at the layout control level.
OptionsStoringSpecifies layout persistence settings for the ExpressLayout Control.
OwnerInherited from TComponent.
PaddingInherited from TWinControl.
ParentInherited from TControl.
ParentBackground protectedInherited from TcxControl.
ParentBiDiModeInherited from TControl.
ParentColorInherited from TControl.
ParentCtl3DInherited from TWinControl.
ParentCustomHintInherited from TControl.
ParentDoubleBufferedInherited from TWinControl.
ParentFontInherited from TControl.
ParentShowHintInherited from TControl.
ParentWindowInherited from TWinControl.
PixelsPerInchInherited from TWinControl.
PopupMenu protectedSpecifies the popup menu associated with the control. Inherited from TcxControl.
RaiseOnNonMainThreadUsageInherited from TControl.
RedrawDisabledInherited from TWinControl.
RedrawOnResizeSpecifies if the Layout control redraws content during resize operations.
RegistryPathDeprecated. This property exists for backward compatibility only. Use the OptionsStoring.RegistryPath property instead.
ScaleFactorInherited from TControl.
ScrollBars protectedInherited from TcxControl.
ShowDesignSelectors
ShowHintInherited from TControl.
ShowingInherited from TWinControl.
StoreInIniFileDeprecated. This property exists for backward compatibility only. Use the OptionsStoring.StoreToIniFile property instead.
StoreInRegistryDeprecated. This property exists for backward compatibility only. Use the OptionsStoring.StoreToRegistry property instead.
StyleElementsInherited from TControl.
StyleNameInherited from TControl.
TabOrderInherited from TWinControl.
TabStopInherited from TcxControl.
TagInherited from TComponent.
TBDockHeightInherited from TControl.
TextInherited from TControl.
TipModeInherited from TWinControl.
TopInherited from TControl.
TopPosInherited from TcxScrollingControl.
TouchInherited from TControl.
Transparent protectedSpecifies if the control is transparent in GDI render mode. Inherited from TcxControl.
UndockHeightInherited from TControl.
UndockWidthInherited from TControl.
UndoRedoManagerProvides access to the TdxUndoRedoManager instance.
UseDockManagerInherited from TWinControl.
UseGlobalSkinSpecifies if the Layout control automatically updates appearance from the skin and palette defined application-wide.
VCLComObjectInherited from TComponent.
VisibleInherited from TControl.
VisibleDockClientCountInherited from TWinControl.
VScrollBar protectedInherited from TcxControl.
VScrollBarVisible protectedInherited from TcxControl.
WidthInherited from TControl.
WindowProcInherited from TControl.

Methods

NameDescription
AcceptMousePosForClick(Integer,Integer)Inherited from TcxControl.
AddFontListener(IcxFontListener)Inherited from TcxControl.
ApplyBestFitSpecifies whether the layout control editor is resized to entirely display its content.
Assign(TPersistent)Inherited from TPersistent.
AssignTo(TPersistent)Inherited from TPersistent.
BeginDrag(Boolean,Integer)Inherited from TControl.
BeginDragAndDropInherited from TcxControl.
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.
BeginTranslationEnables the translation mode for the layout element captions.
BeginUpdateDisables ExpressLayout Control refresh operations.
BringToFrontInherited from TControl.
Broadcast(Untyped)Inherited from TWinControl.
CancelUpdateEnables updates to the layout control’s View.
CanFocusInherited from TWinControl.
CanFocusExInherited from TcxControl.
CanRestore
ChangeScale(Integer,Integer)Inherited from TControl.
CheckNonMainThreadUsageInherited from TControl.
ClearRemoves all absolute items (layout items and groups) and destroys all external controls associated with the items via the Control property.
ClickInherited from TControl.
ClientToParent(TPoint,TWinControl)Inherited from TControl.
ClientToScreen(TPoint)Inherited from TControl.
ClientToScreen(TRect)Inherited from TControl.
ConstrainedResize(Integer,Integer,Integer,Integer)Inherited from TControl.
ContainsControl(TControl)Inherited from TWinControl.
ControlAtPos(TPoint,Boolean,Boolean,Boolean)Inherited from TWinControl.
CreateAlignmentConstraintCreates an instance of the TdxLayoutAlignmentConstraint object.
CreateGroup
CreateGroup(TdxLayoutGroupClass,TdxCustomLayoutGroup)Creates a new group within the ExpressLayout Control and returns it.
CreateItem(TdxCustomLayoutItemClass,TdxCustomLayoutGroup)Creates a new item within the ExpressLayout Control and returns it.
CreateItemForControl(TControl,TdxCustomLayoutGroup)Creates a new item for an existing control, places it within a specific group and returns the newly created item.
CreateParentedControl(HWND)Inherited from TWinControl.
DestroyComponentsInherited from TComponent.
DestroyingInherited from TComponent.
DisableAlignInherited from TWinControl.
Dock(TWinControl,TRect)Inherited from TControl.
DockDrop(TDragDockObject,Integer,Integer)Inherited from TWinControl.
DragDrop(TObject,Integer,Integer)Inherited from TControl.
DraggingInherited from TControl.
DrawTextBiDiModeFlags(Longint)Inherited from TControl.
DrawTextBiDiModeFlagsReadingOnlyInherited from TControl.
EnableAlignInherited from TWinControl.
EndDrag(Boolean)Inherited from TControl.
EndFunctionInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke(IAsyncResult)Inherited from TComponent.
EndInvoke<TResult>(IAsyncResult)Inherited from TComponent.
EndTranslationDisables the translation mode for the layout elementcaptions.
EndUpdate(Boolean)Enables refresh operations on the layout control, and invalidates the control.
Equals(TObject)Inherited from TObject.
ExecuteAction(TBasicAction)Inherited from TComponent.
FindChildControl(String)Inherited from TWinControl.
FindComponent(String)Inherited from TComponent.
FindItem(string)Finds an item by its name or by a specific control (or its handle) associated with the item.
FindItem(THandle)
FindItem(TControl)
FinishDragAndDrop(Boolean)Inherited from TcxControl.
FlipChildren(Boolean)Inherited from TWinControl.
FocusedInherited from TWinControl.
FreeNotification(TComponent)Inherited from TComponent.
FreeOnReleaseInherited from TComponent.
GetChildren(TGetChildProc,TComponent)Inherited from TComponent.
GetControlsAlignmentInherited from TControl.
GetDragImagesInherited from TControl.
GetHashCodeInherited from TObject.
GetHitTest(Integer,Integer)Returns the HitTest object that identifies a visual element at a specified point.
GetHitTest(TPoint)
GetNamePathInherited from TPersistent.
GetOwnerInherited from TPersistent.
GetParentComponentInherited from TComponent.
GetStyleNameInherited from TControl.
GetSystemMetrics(Integer)Inherited from TControl.
GetTabControlList(TList)Inherited from TWinControl.
GetTabOrderList(TList)Inherited from TWinControl.
GetTextBuf(PChar,Integer)Inherited from TControl.
GetTextLenInherited from TControl.
HandleAllocatedInherited from TWinControl.
HandleNeededInherited from TWinControl.
HasParentInherited from TComponent.
HideInherited from TControl.
InitiateActionInherited from TControl.
InsertComponent(TComponent)Inherited from TComponent.
InsertControl(TControl)Inherited from TWinControl.
InvalidateInherited from TControl.
InvalidateRect(TRect,Boolean)Adds a specified portion of the control’s client area to the window update region. Inherited from TcxControl.
InvalidateRgn(TcxRegion,Boolean)Inherited from TcxControl.
InvalidateWithChildrenInherited from TcxControl.
IsCustomStyleActiveInherited from TControl.
IsImplementorOf(IInterface)Inherited from TComponent.
IsLightStyleColor(TColor)Inherited from TControl.
IsMouseInPressedArea(Integer,Integer)Inherited from TcxControl.
IsRightToLeftInherited from TControl.
IsScrollDataValid protectedInherited from TcxScrollingControl.
LoadedInherited from TComponent.
LoadFromIniFile(string)Loads a previously saved Layout control state from an INI file.
LoadFromRegistry(string)Loads a previously saved Layout control state from the system registry.
LoadFromStream(TStream)Loads a previously saved Layout control state from a stream.
LockDrawingInherited from TWinControl.
LockScrollBarsInherited from TcxControl.
ManualDock(TWinControl,TControl,TAlign)Inherited from TControl.
ManualFloat(TRect)Inherited from TControl.
MouseDown(TMouseButton,TShiftState,Integer,Integer)Inherited from TControl.
MouseMove(TShiftState,Integer,Integer)Inherited from TControl.
MouseUp(TMouseButton,TShiftState,Integer,Integer)Inherited from TControl.
MouseWheelHandler(TMessage)Inherited from TControl.
Notification(TComponent,TOperation)Inherited from TComponent.
PaintTo(HDC,Integer,Integer)Inherited from TWinControl.
PaintTo(TCanvas,Integer,Integer)Inherited from TWinControl.
ParentToClient(TPoint,TWinControl)Inherited from TControl.
Perform(Cardinal,WPARAM,LPARAM)Inherited from TControl.
Perform(Cardinal,WPARAM,PChar)Inherited from TControl.
Perform(Cardinal,WPARAM,TRect)Inherited from TControl.
PostMouseMoveInherited from TcxControl.
PostMouseMove(TPoint)Inherited from TcxControl.
PreProcessMessage(TMsg)Inherited from TWinControl.
RealignInherited from TWinControl.
ReferenceInterface(IInterface,TOperation)Inherited from TComponent.
RefreshInherited from TControl.
RemoveComponent(TComponent)Inherited from TComponent.
RemoveControl(TControl)Inherited from TWinControl.
RemoveFontListener(IcxFontListener)Inherited from TcxControl.
RemoveFreeNotification(TComponent)Inherited from TComponent.
RepaintInherited from TControl.
ReplaceDockedControl(TControl,TWinControl,TControl,TAlign)Inherited from TControl.
RestoreRestores layout group and item settings from assigned external data stores.
SaveToIniFile(string,Boolean)Saves layout group/item settings to an INI file.
SaveToRegistry(string,Boolean)Saves ExpressLayout Control group/item settings to the Registry.
SaveToStream(TStream)Saves layout group/item settings to a stream.
ScaleBy(Integer,Integer)Inherited from TWinControl.
ScaleForPPI(Integer)Inherited from TControl.
ScaleRectSize(TRect)Inherited from TControl.
ScaleValue(Double)Inherited from TControl.
ScaleValue(Integer)Inherited from TControl.
ScaleValue(TPoint)Inherited from TControl.
ScaleValue(TRect)Inherited from TControl.
ScaleValue(TSize)Inherited from TControl.
ScreenToClient(TPoint)Inherited from TControl.
ScreenToClient(TRect)Inherited from TControl.
ScrollBy(Integer,Integer)Inherited from TWinControl.
ScrollContent(TcxDirection)Inherited from TcxControl.
ScrollWindow(Integer,Integer,TRect)Inherited from TcxControl.
SendToBackInherited from TControl.
SetBounds(Integer,Integer,Integer,Integer)Inherited from TControl.
SetDesignVisible(Boolean)Inherited from TControl.
SetFocusInherited from TWinControl.
SetParentComponent(TComponent)Inherited from TComponent.
SetScrollBarInfo(TScrollBarKind,Integer,Integer,Integer,Integer,Integer,Boolean,Boolean)Inherited from TcxControl.
SetSubComponent(Boolean)Inherited from TComponent.
SetTextBuf(PChar)Inherited from TControl.
ShowInherited from TControl.
SmartPaste(string)Inserts the specified string or current clipboard content into all configured layout items using the AI-powered Smart Paste functionality.
StartDrag(TDragObject)Inherited from TcxControl.
StoreSaves layout group and item settings to assigned external storages.
SupportsUIAutomation protectedInherited from TcxCustomControl.
SystemInfoChanged(Cardinal)Inherited from TcxControl.
ToStringInherited from TObject.
TranslationChangedInherited from TcxControl.
UnlockDrawingInherited from TWinControl.
UnlockScrollBarsInherited from TcxControl.
UpdateInherited from TControl.
UpdateAction(TBasicAction)Inherited from TComponent.
UpdateControlStateInherited from TWinControl.
UpdateWithChildrenInherited from TcxControl.
UseRightToLeftAlignmentInherited from TControl.
UseRightToLeftReadingInherited from TControl.
UseRightToLeftScrollBarInherited from TControl.
WndProc(TMessage)Inherited from TControl.

Events

NameDescription
OnAlignInsertBeforeInherited from TWinControl.
OnAlignPositionInherited from TWinControl.
OnCanResizeInherited from TControl.
OnClickInherited from TControl.
OnConstrainedResizeInherited from TControl.
OnContextPopupInherited from TControl.
OnCustomizationOccurs when activating/deactivating customization mode.
OnDblClickInherited from TControl.
OnDockDropInherited from TWinControl.
OnDockOverInherited from TWinControl.
OnDragDropInherited from TControl.
OnDragOverInherited from TControl.
OnEndDockInherited from TControl.
OnEndDragInherited from TControl.
OnEnterInherited from TWinControl.
OnExitInherited from TWinControl.
OnFocusChanged protectedInherited from TcxControl.
OnGestureInherited from TControl.
OnGetCustomizationMenuItemsEnables you to customize context menu contents in customization mode.
OnGetItemStoredPropertiesEnables you to customize the list of layout element settings that will be stored in external storage.
OnGetItemStoredPropertyValueEnables you to specify the layout element custom setting’s value.
OnGetSiteInfoInherited from TWinControl.
OnGetStoredPropertiesEnables you to customize the list of layout control settings that will be stored in external storage.
OnGetStoredPropertyValueEnables you to specify the layout control custom setting’s value.
OnHyperlinkClickAllows you to respond to a click on a hyperlink in a layout item caption or prevent hyperlink activation.
OnHyperlinkMouseEnterAllows you to execute custom code when the mouse pointer moves into a hyperlink area within a layout item caption.
OnHyperlinkMouseLeaveAllows you to execute custom code when the mouse pointer leaves a hyperlink within a layout item caption.
OnKeyDownInherited from TWinControl.
OnKeyPressInherited from TWinControl.
OnKeyUpInherited from TWinControl.
OnMouseActivateInherited from TControl.
OnMouseDownInherited from TControl.
OnMouseEnter protectedOccurs when the mouse pointer enters into the control. Inherited from TcxControl.
OnMouseLeave protectedOccurs when the mouse pointer leaves the control. Inherited from TcxControl.
OnMouseMoveInherited from TControl.
OnMouseUpInherited from TControl.
OnMouseWheelInherited from TControl.
OnMouseWheelDownInherited from TControl.
OnMouseWheelUpInherited from TControl.
OnResizeInherited from TControl.
OnSetItemStoredPropertyValueEnables you to restore a layout element‘s custom setting that was previously stored by the OnGetItemStoredProperties and OnGetItemStoredPropertyValue event handlers.
OnSetStoredPropertyValueEnables you to restore a layout control’s custom setting that was previously stored by the OnGetStoredProperties and OnGetStoredPropertyValue event handlers.
OnShowHyperlinkHintAllows you to change a hyperlink hint before it appears.
OnStartDockInherited from TControl.
OnStartDragInherited from TControl.
OnUnDockInherited from TWinControl.

See Also

TdxCustomLayoutControl Class

dxLayoutControl Unit