Vcl.Controls.TCustomControl Methods

• Up to Parent: TCustomControl

InheritedProtected

_AddRef	protected	Called when an application uses a component interface.
_Release	protected	Called when an application releases a component interface.
ActionChange	protected	Updates the control to reflect changes in its associated action.
AddBiDiModeExStyle	protected	Sets control's window style according to its bi-directional support.
AdjustClientRect	protected	Provides the interface that adjusts the ClientRect property for idiosyncrasies of the window.
AdjustSize	protected	Adjusts the control's size according to its contents and constraints.
AfterConstruction	public	Responds after the last constructor has executed.
AlignControls	protected	Aligns any controls for which the control is the parent within a specified area of the control.
ArrangeControl	protected	Aligns the given control with the specified alignment options.
Assign	public	Copies the contents of another similar object.
AssignTo	protected	Copies the properties of the windowed control to another object.
AsyncSchedule	protected
BeforeDestruction	public	Performs any necessary actions before the first destructor is called.
BeginAutoDrag	protected	Begins automatic drag.
BeginDrag	public	Starts the dragging of a control.
BeginInvoke	public	Performs an asynchronous call to the method specified by either AProc or AFunc.
BringToFront	public	Puts the control in front of all other controls in its parent control.
Broadcast	public	Sends a message to each of the child controls.
CalcCursorPos	protected	Gives the coordinates of the cursor, with respect to the origin of the control.
CanAutoSize	protected	Indicates how the control can be resized.
CanEnumerateControl	public	Indicates whether a control can be enumerated by GetControls enumerator. CanEnumerateControl returns True when AControl may be enumerated by GetControls enumerator. Internally, CanEnumerateControl calls OnEnumerateControl event handler if assigned.
CanFocus	public	Indicates whether a control can receive focus.
CanObserve	protected	Checks if a component can be observed by a particular observer.
CanResize	protected	Indicates how the control can respond to a resize attempt.
CanUseDoubleBuffering	protected	Method used for the DoubleBuffered property.
Changed	protected	Sends a CM_CHANGED message to the control.
ChangeName	protected	Sets the private, internal storage for the Name property to the string passed in NewName.
ChangeScale	protected	Resize and reposition children and self.
CheckDisposed	protected	This method is deprecated.
CheckNonMainThreadUsage	public	Raised an EInvalidOperation exception when called on a non-main thread and RaiseOnNonMainThreadUsage is set to True.
ChildHandlesNeeded	public	ChildHandlesNeeded method forces the creation of the child control handles.
ClassInfo	public	Returns a pointer to the run-time type information (RTTI) table for the object type.
ClassName	public	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
ClassNameIs	public	Determines whether an object is of a specific type.
ClassParent	public	Returns the type of the immediate ancestor of a class.
ClassType	public	Returns the class reference for the object's class.
CleanupInstance	public	Performs finalization on long strings, variants, and interface variables within a class.
Click	protected	Respond to user click.
ClientToParent	public	Translates client coordinates to parent coordinates.
ClientToScreen	public	Translates a given point from client area coordinates to global screen coordinates.
ConstrainedResize	protected	Generates an OnConstrainedResize event.
ContainsControl	public	Indicates whether a specified control exists within the control.
ControlAtPos	public	Returns the child control located at a specified position within the control.
ControlsAligned	protected	ControlsAligned automatically executes after a call to AlignControls.
Create	public	Creates an instance of TCustomControl.
CreateDockManager	protected	Creates the dock manager for the control.
CreateHandle	protected	Creates underlying screen object.
CreateMessageHandler	protected
CreateParams	protected	Initializes a window-creation parameter data structure.
CreateParented	public	Creates and initializes a control as the child of a specified non-VCL container.
CreateParentedControl	public	Creates and initializes a control as the child of a specified non-VCL window.
CreateSubClass	protected	Creates a windowed control derived from an existing Windows window class.
CreateTouchManager	protected	Instantiates a touch manager.
CreateWindowHandle	protected	Creates a Windows control to represent the control.
CreateWnd	protected	Creates the underlying window.
CustomAlignInsertBefore	protected	Returns placement order of custom-aligned child control.
CustomAlignPosition	protected	Returns aligned position of custom-aligned child control.
DblClick	protected	OnDblClick event dispatcher.
DefaultDockImage	protected	Handles the painting and erasing of a dock image.
DefaultHandler	public	Provides message handling for all messages that the control does not fully process by itself.
DefaultScalingFlags	protected
DefineProperties	protected
DesignWndProc	protected	Processes the given message and returns some Boolean information based on the message's content.
Destroy	public	Destroys an instance of TCustomControl.
DestroyComponents	public	Destroys all owned components.
DestroyHandle	protected	Destroys the control's window without destroying the control.
Destroying	public	Indicates that the component and its owned components are about to be destroyed.
DestroyWindowHandle	protected	Destroys the window created in the CreateWindowHandle method.
DestroyWnd	protected	Destroys the control's window.
DisableAlign	public	Disables the realignment of child controls.
Dispatch	public	Calls message-handling methods for the object, based on the contents of the Message parameter.
DisposeOf (deprecated)	public	DisposeOf forces the execution of the destructor code in an object.
DoAddDockClient	protected	Performs actions when a control is docked to the windowed control.
Dock	public	Used internally to dock the control.
DockDrop	public	Generates an OnDockDrop event.
DockOver	protected	Responds when a docking client is dragged over the windowed control.
DockReplaceDockClient	protected	Invalidates the first dock site in the list of child controls.
DockTrackNoTarget	protected	Handles dragging of the control over an invalid docking target.
DoContextPopup	protected	Is an OnContextPopup event dispatcher.
DoDock	protected	Docking event dispatcher.
DoDockOver	protected	Generates an OnDockOver event.
DoEndDock	protected	Is an OnEndDock event dispatcher.
DoEndDrag	protected	Is an OnEndDrag event dispatcher.
DoEnter	protected	Respond to receiving input focus.
DoExit	protected	Responds to losing input focus.
DoFlipChildren	protected	Flips the control's children.
DoGesture	protected	Processes the unhandled gesturing events.
DoGetGestureOptions	protected	Returns the interactive gestures and their options.
DoHandleStyleMessage	protected
DoKeyDown	protected	Performs some preprocessing before generating an OnKeyDown event.
DoKeyPress	protected	Performs some preprocessing before generating an OnKeyPress event.
DoKeyUp	protected	Performs some preprocessing before generating an OnKeyUp event.
DoMouseWheel	protected	Processes mouse wheel motion.
DoMouseWheelDown	protected	Is an OnMouseWheelDown event dispatcher.
DoMouseWheelUp	protected	Is an OnMouseWheelUp event dispatcher.
DoRemoveDockClient	protected	Responds when a control is undocked from the windowed control.
DoStartDock	protected	Is an OnStartDockevent dispatcher.
DoStartDrag	protected	Is an OnStartDrag event dispatcher.
DoStyleElementsChanged	protected
DoUnDock	protected	Undocks a control that is currently docked to the windowed control.
DoWritePixelsPerInch	protected
DragCanceled	protected	Provides the interface for a method that responds to the cancellation of a drag.
DragDrop	public	Is an OnDragDrop event dispatcher.
Dragging	public	Indicates whether a control is being dragged.
DragOver	protected	Is an OnDragOver event dispatcher.
DrawDragDockImage	protected	Draws the dock image for the control.
DrawTextBiDiModeFlags	public	Returns the text flags that reflect the current setting of the BiDiMode property.
DrawTextBiDiModeFlagsReadingOnly	public	Returns the text flag to add that indicates whether the control's text should read from right to left.
EnableAlign	public	Decrements the reference count incremented by the DisableAlign method, eventually realigning the child controls.
EndDrag	public	Stops a control from being dragged any further.
EndFunctionInvoke	public	Blocks the caller until the specified ASyncResult completes.
EndInvoke	public	Blocks the caller until the specified ASyncResult completes.
Equals	public	Checks whether the current instance and the Obj parameter are equal.
EraseDragDockImage	protected	Erases the dock image for the control.
ExecuteAction	public	Executes an action.
FieldAddress	public	Returns the address of a published object field.
FindChildControl	public	Returns a child control given its name.
FindComponent	public	Indicates whether a given component is owned by the component.
FindNextControl	protected	Returns the control's next child in the tab order after the specified control.
FixupTabList	protected	Sorts the child controls by their tab order.
FlipChildren	public	Reverses the positions of child controls.
Focused	public	Determines whether the control has input focus.
Free	public	Destroys an object and frees its associated memory, if necessary.
FreeInstance	public	Deallocates memory allocated by a previous call to the NewInstance method.
FreeNotification	public	Ensures that AComponent is notified that the component is going to be destroyed.
FreeOnRelease	public	Frees the interface reference for components that were created from COM classes.
GetAction	protected	Returns the value of the Action property.
GetActionLinkClass	protected	Returns the associated action link class.
GetAllocatedWindowHandle	protected
GetChildOwner	protected	Returns the owner of a child component being read from a stream.
GetChildParent	protected	Returns the parent or, if there is no parent, returns the owner of a child component being read from a stream.
GetChildren	public	Calls a specified method for each child of the control.
GetClientOrigin	protected	Returns the value of the ClientOrigin property.
GetClientRect	protected	Returns the value of the ClientRect property.
GetControlExtents	protected	Returns the smallest rectangle in which all the control's children fit.
GetControls	public	GetControls returns the control of the TControlList.
GetControlsAlignment	public	Indicates how text is aligned within the control.
GetCurrentPPI	protected
GetCurrentPPIScreen	protected
GetDeltaStreams	protected	Retrieves a list of streams representing the differences (deltas) between the current state of a component and a previously saved state.
GetDesignDpi	protected	Obtains the design Dpi for the form where the control was designed.
GetDeviceContext	protected	Provides access to a device context for the control.
GetDisposed	protected	Getter for the Disposed property.
GetDockEdge	protected	Returns the edge on which another control should be docked when it is dragged over the control.
GetDoubleBuffered	protected
GetDPIForDesigner	protected
GetDragImages	protected	Returns the control's image list containing the image to be displayed while dragging.
GetDragMode	protected	Returns the value of the DragMode property.
GetEnabled	protected	Returns the value of the Enabled property.
GetEnumerator	public	Returns a TComponent enumerator.
GetFloating	protected	Returns the value of the Floating property.
GetFloatingDockSiteClass	protected	Returns the class used for the control when it is floating.
GetHashCode	public	Returns an integer containing the hash code.
GetIDsOfNames	protected	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
GetInterface	public	Retrieves a specified interface.
GetInterfaceEntry	public	Returns the entry for a specific interface implemented in a class.
GetInterfaceTable	public	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
GetInternalStyleElements	public	Indicates the name of this component's internal elements style returning a TStyleElements enumerator.
GetNamePath	public	Returns a string used by the Object Inspector.
GetObservers	protected	Getter of Observers.
GetOwner	protected	Returns the owner of a component.
GetPalette	protected	Returns the handle to a palette for use by the control.
GetParentComponent	public	Returns the parent of the control.
GetParentCurrentDpi	protected	Obtains the current Dpi for parent control, or the current control Dpi if there is no parent.
GetParentHandle	protected	Returns the window handle for the window of the control's parent.
GetPixelsPerInch	protected
GetPopupMenu	protected	Returns the pop-up menu associated with the control.
GetSiteInfo	protected	Generates an OnGetSiteInfo event.
GetStyleElements	protected
GetStyleName	public	Returns a string specifying the name of this component style.
GetSystemMetrics	public	Returns Windows metrics for a control.
GetTabControlList	public	Builds a list of owned controls.
GetTabOrderList	public	Builds a list of controls in tab order.
GetTextBuf	public	Retrieves the control's text, copies it into a buffer, and returns the number of characters copied.
GetTextLen	public	Returns the length of the control's text.
GetTopParentHandle	protected	Returns the window handle of the first window not associated with a VCL control that contains the windowed control.
GetTypeInfo	protected	Retrieves the type information for an object.
GetTypeInfoCount	protected	Returns the number of type information interfaces that an object provides (either 0 or 1).
HandleAllocated	public	Reports whether a screen object handle exists for the control.
HandleNeeded	public	Creates a screen object for the control if it doesn't already exist.
HasParent	public	Indicates whether the control has a parent.
Hide	public	Makes the control invisible.
InheritsFrom	public	Determines the relationship of two object types.
InitiateAction	public	Calls the action link's Update method if the control is associated with an action link.
InitInstance	public	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
InitMessageHandler	public	Initializes a message handler.
InsertComponent	public	Establishes the component as the owner of a specified component.
InsertControl	public	Inserts a control into the Controls array property.
InstanceSize	public	Returns the size in bytes of each instance of the object type.
Invalidate	public	Schedules a control repaint.
InvalidateDockHostSite	protected	Invalidates the first dock site that appears in the list of child controls.
Invoke	protected	Provides access to Automation properties and methods when the component wraps an Automation object.
InvokeAsyncCalls	protected	Processes pending asynchronous method calls listed in FAsyncList.
IsControlActivateMsg	protected	Indicates whether a specified mouse activation message is directed to the given child control.
IsControlMouseMsg	protected	Indicates whether a specified mouse message is directed to one of the windowed control's child controls.
IsCustomStyleActive	public	Indicates whether the active style is a custom style.
IsDPIScalingRequired	protected
IsImplementorOf	public	Indicates whether the component implements a specified interface.
IsLightStyleColor	public	Returns True when AColor is a light color.
IsQualifyingSite	protected	Checks whether the control is docked inside another control or has at least two docked controls.
IsRightToLeft	public	Indicates whether the control should be reversed right to left.
IsTouchPropertyStored	protected	Checks whether the associated touch manager stored any of the given options.
KeyDown	protected	Responds to key press events.
KeyPress	protected	Responds to keyboard input.
KeyUp	protected	Respond to released key.
Loaded	protected	Initializes the control after it is loaded from a stream.
LockDrawing	public	Call LockDrawing method to prevent changes in that control from being redrawn.
MainWndProc	protected	Receives Windows messages for the control.
ManualDock	public	Docks the control.
ManualFloat	public	Undocks the control.
MethodAddress	public	Returns the address of a class method by name.
MethodName	public	Returns the name of a class method by address.
MouseActivate	protected	Triggers a TMouseActivateEvent event.
MouseDown	protected	OnMouseDown event dispatcher.
MouseMove	protected	Responds to mouse moving over control area.
MouseUp	protected	Is an OnMouseUp event dispatcher.
MouseWheelHandler	public	Dispatches messages received from a mouse wheel.
NewInstance	public	Allocates memory for an instance of an object type and returns a pointer to that new instance.
Notification	protected
NotifyControls	protected	Sends a message to all the child controls.
ObserverAdded	protected	Allows the component to handle the addition of an observer.
operator ()	public	C++ conversion of a TComponent into a System.Classes.IInterfaceComponentReference or a System.IInterface, depending on casting.
Paint	protected	Renders the image of a custom control.
PaintControls	protected	Paints each of the child controls in a windowed control using the specified device context.
PaintHandler	protected	Responds to WM_PAINT messages.
PaintTo	public	Draws the windowed control to a device context.
PaintWindow	protected	Renders the image of the control on a specified device context.
PaletteChanged	protected	Responds to changes in the system's palette by realizing the control's palette and the palette for each child control.
ParentToClient	public	Translate parent coordinates to client coordinates.
Perform	public	Responds as if the control received a specified Windows message.
PositionDockRect	protected	Positions the docking rectangle according to the current drag-and-dock state.
PreProcessMessage	public	Returns False, no matter the value of Msg.
QualifiedClassName	public	Returns the qualified name of the class.
QueryInterface	protected	Returns a reference to a specified interface if the current component supports that interface.
ReadState	protected	Prepares the control for having its properties assigned values from a stream.
Realign	public	Forces the control to realign children.
RecreateWnd	public	Recreate underlying Windows screen object.
ReferenceInterface	public	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
Refresh	public	Repaints the control on the screen.
ReleaseMessageHandler	public	Frees the memory of a message handler
ReloadDockedControl	protected	Reloads a docked control.
RemoveComponent	public	Removes a specified component specified from the component's Components list.
RemoveControl	public	Removes a specified control from the Controls array.
RemoveFreeNotification	public	Disables the destruction notification that was enabled by FreeNotification.
RemoveFreeNotifications	protected	Notifies all owned components of the owner component's imminent destruction.
RemoveWindowProps	protected	Removes the ControlAtom and WindowAtom properties of the control.
Repaint	public	Repaints the entire control.
ReplaceDockedControl	public	Docks the control in the place where another control is already docked.
RequestAlign	protected
RequestDPIScaling	protected
ResetIme	protected	Restores the input method editor (IME) that was active when the application started.
ResetImeComposition	protected	Directs the composition window of the input method editor (IME) to perform a specific action.
Resize	protected	Respond to control resize.
SafeCallException	public	Handles exceptions in methods declared using the safecall calling convention.
ScaleBy	public	Rescale control and its children.
ScaleConstraints	protected	Scales the values of the Constraints property to the given ratio.
ScaleControls	protected	Rescale child controls only.
ScaleControlsForDpi	protected	Scales all the contained controls to the NewPPI value.
ScaleForPPI	public	Adjusts the scaling of the current control and its children for the specified Pixels Per Inch (PPI).
ScaleMargins	protected	Scales the values of the Margins property to the given ratio.
ScalePadding	protected	Scales the control padding to the given ratio.
ScaleRectSize	public	Scales Value rectangle size using the current ScaleFactor.
ScaleValue	public	The overloaded ScaleValue methods return a measure passed as parameter scaled by the current scale factor for the control (the value of the ScaleFactor read-only property).
ScreenToClient	public	Converts the screen coordinates of a specified point on the screen to client coordinates.
ScrollBy	public	Scroll control contents.
SelectFirst	protected	Locates first selectable child control.
SelectNext	protected	Moves the input focus from the current child control to the next one in the tab order.
SendCancelMode	protected	Cancels the modal state of the control.
SendDockNotification	protected	Sends a Windows message to the control's host dock site.
SendToBack	public	Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
SetAncestor	protected	Clears or sets csAncestor state in the component's ComponentState property.
SetAutoSize	protected	Sets the value of the AutoSize property.
SetBiDiMode	protected	Sets the control's bidirectional mode.
SetBounds	public	Sets the windowed control's boundary properties all at once.
SetChildOrder	protected	Changes the order in which the child component appears in the list of child components returned by the GetChildren method.
SetCustomHint	protected	Sets the value of the CustomHint property.
SetDesigning	protected	Ensures that components inserted at design time have their design-mode flag set.
SetDesignInstance	protected	Ensures that components inserted at design time have their design-mode flag set.
SetDesignVisible	public	Makes this control visible at design time.
SetDragMode	protected	Sets the drag mode for the control.
SetEnabled	protected	Sets the value of the Enabled property.
SetFocus	public	Gives the input focus to the control.
SetIme	protected	Activates an input method editor (IME) using the values specified by the ImeMode and ImeName properties.
SetImeCompositionWindow	protected	Sets the position and font of the composition window.
SetInline	protected	Sets the csInline bit of the component's ComponentState property.
SetName	protected	Sets the name of the control.
SetParent	protected
SetParentBackground	protected	Sets the ParentBackground property.
SetParentBiDiMode	protected	Specifies whether the control uses its parent's BiDiMode.
SetParentComponent	public	Sets the parent for the control.
SetParentDoubleBuffered	protected	Sets the ParentBackground property.
SetPixelsPerInch	protected
SetStyleElements	protected
SetStyleName	protected
SetSubComponent	public	Identifies whether the component is a subcomponent.
SetTextBuf	public	Sets the text of the control.
SetZOrder	protected	Moves the control to the top or bottom of the parent control's (or screen's) list of TWinControl controls.
Show	public	Makes a control visible.
ShowControl	protected	Ensures that a specified child control is visible.
ToString	public	Returns a string containing the class name.
UnitName	public	Returns the name of the unit where the class is defined.
UnitScope	public	Returns the class's unit scope.
UnlockDrawing	public	Call UnlockDrawing method to allow changes in that control to be redrawn.
Update	public	Forces the control to update.
UpdateAction	public	Updates the state of an action.
UpdateBounds	protected	Updates the bounds of the control.
UpdateBoundsRect	protected	Changes the Top, Left, Width, and Height properties of the control, but does not update its screen image and bypasses all resize events.
UpdateControlOriginalParentSize	protected	Updates the original size of the parent control.
UpdateControlState	public	Respond to state change.
Updated	protected	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
UpdateExplicitBounds	protected	Attempts to update the values of the control's explicit bounds to those of its current bounds.
UpdateRecreatingFlag	protected	Toggles the csRecreating flag in the ControlState property.
UpdateRegistry	protected	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
UpdateStyleElements	protected
UpdateTIPStatus	protected
UpdateUIState	protected	Updates form User Interface State as needed
Updating	protected	Sets the csUpdating state in the component's ComponentState property.
UseRightToLeftAlignment	public	Specifies whether the control's alignment should be reversed right-to-left.
UseRightToLeftReading	public	Specifies whether the control is using a right-to-left reading order.
UseRightToLeftScrollBar	public	Specifies whether the vertical scroll bar appears on the left side of the control.
ValidateContainer	protected	Determines whether an object can be inserted into a container.
ValidateInsert	protected	Provides the interface for a method that validates a child component before it is inserted.
ValidateRename	protected	Ensures that renaming an owned component does not create a name conflict.
VisibleChanging	protected	Provides the interface for a method that responds to changes in the control's visibility.
WndProc	protected	Provides specific message responses for the control.
WriteState	protected	Writes the state of the component.