Controls.TControl Methods

From RAD Studio VCL Reference
Jump to: navigation, search

Delphi Information

procedure ActionChange(Sender: TObject; CheckDefaults: Boolean); dynamic;

Responds when the action associated with the control changes.

procedure AdjustSize dynamic;

Sets the size of the control as determined by the AutoSize property.

procedure BeginAutoDrag dynamic;

Begin automatic drag.

function CanResize(var NewWidth: Integer; var NewHeight: Integer): Boolean; virtual;

OnCanResize event dispatcher.

function CanAutoSize(var NewWidth: Integer; var NewHeight: Integer): Boolean; virtual;

Indicates whether the control can resize itself automatically to accommodate its contents.

procedure Changed

Sends a CM_CHANGED message to the control.

procedure ChangeScale(M: Integer; D: Integer); dynamic;

Rescaling event dispatcher.

procedure Click dynamic;

Respond to user click.

procedure ConstrainedResize(var MinWidth: Integer;

var MinHeight: Integer; var MaxWidth: Integer;

var MaxHeight: Integer); virtual;

Notify control of resize with constraints.

function CalcCursorPos(): TPoint;

Gives the coordinates of the cursor, with respect to the origin of the control.

procedure CreateTouchManager virtual;

Instantiates a touch manager.

procedure DblClick dynamic;

OnDblClick event dispatcher.

procedure DefaultDockImage(DragDockObject: TDragDockObject; Erase: Boolean); dynamic;

Handles the painting and erasing of a dock image.

procedure DockTrackNoTarget(Source: TDragDockObject; X: Integer; Y: Integer); dynamic;

Handles dragging of the control over an invalid docking target.

procedure DoContextPopup(MousePos: TPoint; var Handled: Boolean); dynamic;

Is an OnContextPopup event dispatcher.

procedure DoEndDock(Target: TObject; X: Integer; Y: Integer); dynamic;

Is an OnEndDock event dispatcher.

procedure DoDock(NewDockSite: TWinControl; var ARect: TRect); dynamic;

Docking event dispatcher.

procedure DoStartDock(var DragObject: TDragObject); dynamic;

Is an OnStartDockevent dispatcher.

function DoMouseWheel(Shift: TShiftState;

WheelDelta: Integer;

MousePos: TPoint): Boolean; dynamic;

Processes mouse wheel motion.

function DoMouseWheelDown(Shift: TShiftState; MousePos: TPoint): Boolean; dynamic;

Is an OnMouseWheelDown event dispatcher.

function DoMouseWheelUp(Shift: TShiftState; MousePos: TPoint): Boolean; dynamic;

Is an OnMouseWheelUp event dispatcher.

procedure DragCanceled dynamic;

Provides the interface for a method that responds to the cancellation of a drag.

procedure DragOver(Source: TObject;

X: Integer; Y: Integer; State: TDragState;

var Accept: Boolean); dynamic;

Is an OnDragOver event dispatcher.

procedure DoEndDrag(Target: TObject; X: Integer; Y: Integer); dynamic;

Is an OnEndDrag event dispatcher.

procedure DoStartDrag(var DragObject: TDragObject); dynamic;

Is an OnStartDrag event dispatcher.

procedure DoGesture(const EventInfo: TGestureEventInfo; var Handled: Boolean); virtual;

Processes the unhandled gesturing events.

procedure DoGetGestureOptions(var Gestures: TInteractiveGestures; var Options: TInteractiveGestureOptions); virtual;

Returns the interactive gestures and their options.

procedure DrawDragDockImage(DragDockObject: TDragDockObject); dynamic;

Draws the dock image for the control.

procedure EraseDragDockImage(DragDockObject: TDragDockObject); dynamic;

Erases the dock image for the control.

function GetAction(): TBasicAction; virtual;

Returns the value of the Action property.

function GetActionLinkClass(): TControlActionLinkClass; dynamic;

Returns the appropriate action link class that is associated with the control class.

function GetClientOrigin(): TPoint; virtual;

Returns the screen coordinates of the upper-left corner of the control's client area.

function GetClientRect(): TRect; virtual;

Returns a rectangle defining the client area of the control.

function GetDeviceContext(var WindowHandle: HWND): HDC; overload; virtual;

Returns a device context for the control.

function GetDockEdge(MousePos: TPoint): TAlign; dynamic;

Returns the edge on which another control should be docked when it is dragged over the control.

function GetEnabled(): Boolean; virtual;

Returns the value of the Enabled property.

function GetFloating(): Boolean; virtual;

Returns the value of the Floating property.

function GetFloatingDockSiteClass(): TWinControlClass; virtual;

Returns the class used for the control when it is floating.

function GetPalette(): HPALETTE; dynamic;

Returns the handle to a palette for use by the control.

function GetPopupMenu(): TPopupMenu; dynamic;

Returns the pop-up menu associated with the control.

function GetDragMode(): TDragMode;

Returns the value of the DragMode property.

function IsTouchPropertyStored(AProperty: TTouchProperty): Boolean; dynamic;

Checks whether the associated touch manager stored any of the given options.

function MouseActivate(Button: TMouseButton;

Shift: TShiftState; X: Integer; Y: Integer;

HitTest: Integer): TMouseActivate; dynamic;

Triggers a TMouseActivateEvent event.

procedure MouseDown(Button: TMouseButton;

Shift: TShiftState; X: Integer;

Y: Integer); dynamic;

OnMouseDown event dispatcher.

procedure MouseMove(Shift: TShiftState; X: Integer; Y: Integer); dynamic;

Responds to mouse moving over control area.

procedure MouseUp(Button: TMouseButton;

Shift: TShiftState; X: Integer;

Y: Integer); dynamic;

Is an OnMouseUp event dispatcher.

procedure PositionDockRect(DragDockObject: TDragDockObject); dynamic;

Positions the docking rectangle according to the current drag-and-dock state.

function PaletteChanged(Foreground: Boolean): Boolean; dynamic;

Responds to changes in the system's palette by realizing the control's palette.

procedure RequestAlign virtual;

Instructs the parent of a control to reposition the control, enforcing its Align property.

procedure Resize dynamic;

Respond to control resize.

procedure ScaleConstraints(M: Integer; D: Integer);

Scales the values of the Constraints property to the given ratio.

procedure ScaleMargins(M: Integer; D: Integer);

Scales the values of the Margins property to the given ratio.

procedure SendCancelMode(Sender: TControl);

Cancels the modal state of the control.

procedure SendDockNotification(Msg: Cardinal; WParam: Cardinal; LParam: Cardinal);

Sends a Windows message to the control's host dock site.

procedure SetAutoSize(Value: Boolean); virtual;

Sets the value of the AutoSize property.

procedure SetDragMode(Value: TDragMode); virtual;

Sets the drag mode for the control.

procedure SetEnabled(Value: Boolean); virtual;

Sets the value of the Enabled property.

procedure SetParent(AParent: TWinControl); virtual;

Sets the parent of the control.

procedure SetParentBiDiMode(Value: Boolean); virtual;

Specifies whether the control uses its parent's BiDiMode.

procedure SetBiDiMode(Value: TBiDiMode); virtual;

Sets the control's bidirectional mode.

procedure SetZOrder(TopMost: Boolean); dynamic;

Repositions the control in its parent's control list, thereby changing position onscreen.

procedure SetCustomHint(Value: TCustomHint);

Sets the value of the CustomHint property.

procedure UpdateExplicitBounds

Attempts to update the values of the control's explicit bounds to those of its current bounds.

procedure UpdateBoundsRect(const R: TRect);

Changes the Top, Left, Width, and Height properties of the control, but does not update its screen image and bypasses all resize events.

procedure VisibleChanging dynamic;

Provides the interface for a method that responds to changes in the control's visibility.

procedure WndProc(var Message: TMessage); virtual;

Provides specific message responses for the control.

function DesignWndProc(var Message: TMessage): Boolean; dynamic;

Processes the given message and returns some Boolean information based on the message's content.

function GetDragImages(): TDragImageList; virtual;

Returns the control's image list containing the image to be displayed while dragging.

procedure BeginDrag(Immediate: Boolean; Threshold: Integer = $FFFFFFFF);

Starts the dragging of a control.

procedure BringToFront

Puts the control in front of all other controls in its parent control.

function ClientToScreen(const Point: TPoint): TPoint;

Translates a given point from client area coordinates to global screen coordinates.

function ClientToParent(const Point: TPoint; AParent: TWinControl = nil): TPoint;

Translates client coordinates to parent coordinates.

procedure Dock(NewDockSite: TWinControl; ARect: TRect); dynamic;

Used internally to dock the control.

function Dragging(): Boolean;

Indicates whether a control is being dragged.

procedure DragDrop(Source: TObject; X: Integer; Y: Integer); dynamic;

Is an OnDragDrop event dispatcher.

function DrawTextBiDiModeFlags(Flags: Integer): Integer;

Returns the text flags that reflect the current setting of the BiDiMode property.

function DrawTextBiDiModeFlagsReadingOnly(): Integer;

Returns the text flag to add that indicates whether the control's text should read from right to left.

procedure EndDrag(Drop: Boolean);

Stops a control from being dragged any further.

function GetControlsAlignment(): TAlignment; dynamic;

Indicates how text is aligned within the control.

procedure Hide

Makes the control invisible.

procedure InitiateAction virtual;

Calls the action link's Update method if the control is associated with an action link.

procedure Invalidate virtual;

Completely repaint control.

procedure MouseWheelHandler(var Message: TMessage); dynamic;

Dispatches messages received from a mouse wheel.

function IsRightToLeft(): Boolean;

Indicates whether the control should be reversed right to left.

function ManualDock(NewDockSite: TWinControl;

DropControl: TControl = nil;

ControlSide: TAlign = alNone): Boolean;

Docks the control.

function ManualFloat(ScreenPos: TRect): Boolean;

Undocks the control.

function Perform(Msg: Cardinal;

WParam: Integer;

LParam: Integer): Integer; overload;

Responds as if the control received a specified Windows message.

procedure Refresh

Repaints the control on the screen.

procedure Repaint virtual;

Forces the control to repaint its image on the screen.

function ReplaceDockedControl(Control: TControl;

NewDockSite: TWinControl; DropControl: TControl;

ControlSide: TAlign): Boolean;

Docks the control in the place where another control is already docked.

function ScreenToClient(const Point: TPoint): TPoint;

Converts the screen coordinates of a specified point on the screen to client coordinates.

function ParentToClient(const Point: TPoint; AParent: TWinControl = nil): TPoint;

Translate parent coordinates to client coordinates.

procedure SendToBack

Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

procedure SetBounds(ALeft: Integer;

ATop: Integer; AWidth: Integer;

AHeight: Integer); virtual;

Sets the Left, Top, Width, and Height properties all at once.

procedure SetDesignVisible(Value: Boolean); dynamic;

Makes a control visible at design time.

procedure Show

Makes a control visible.

procedure Update virtual;

Processes any pending paint messages immediately.

function UseRightToLeftAlignment(): Boolean; dynamic;

Specifies whether the control's alignment should be reversed right-to-left.

function UseRightToLeftReading(): Boolean;

Specifies whether the control is using a right-to-left reading order.

function UseRightToLeftScrollBar(): Boolean;

Specifies whether the vertical scroll bar appears on the left side of the control.

function GetTextBuf(Buffer: PWideChar; BufSize: Integer): Integer;

Retrieves the control's text, copies it into a buffer, and returns the number of characters copied.

function GetTextLen(): Integer;

Returns the length of the control's text.

function Perform(Msg: Cardinal;

WParam: Integer;

LParam: PWideChar): Integer; overload;

Responds as if the control received a specified Windows message.

function Perform(Msg: Cardinal;

WParam: Integer;

var LParam: TRect): Integer; overload;

Responds as if the control received a specified Windows message.

procedure SetTextBuf(Buffer: PWideChar);

Sets the text of the control.


Unit: Controls

Type: method

Visibility: public

Member Of: TControl

C++ Information

dynamic virtual void __fastcall ActionChange(System::TObject * Sender, bool CheckDefaults);

Responds when the action associated with the control changes.

dynamic virtual void __fastcall AdjustSize(void);

Sets the size of the control as determined by the AutoSize property.

dynamic virtual void __fastcall BeginAutoDrag(void);

Begin automatic drag.

virtual bool __fastcall CanResize(int & NewWidth, int & NewHeight);

OnCanResize event dispatcher.

virtual bool __fastcall CanAutoSize(int & NewWidth, int & NewHeight);

Indicates whether the control can resize itself automatically to accommodate its contents.

void __fastcall Changed(void);

Sends a CM_CHANGED message to the control.

dynamic virtual void __fastcall ChangeScale(int M, int D);

Rescaling event dispatcher.

dynamic virtual void __fastcall Click(void);

Respond to user click.

virtual void __fastcall ConstrainedResize(int & MinWidth,

int & MinHeight, int & MaxWidth,

int & MaxHeight);

Notify control of resize with constraints.

Types::TPoint __fastcall CalcCursorPos(void);

Gives the coordinates of the cursor, with respect to the origin of the control.

virtual void __fastcall CreateTouchManager(void);

Instantiates a touch manager.

dynamic virtual void __fastcall DblClick(void);

OnDblClick event dispatcher.

dynamic virtual void __fastcall DefaultDockImage(Controls::TDragDockObject * DragDockObject, bool Erase);

Handles the painting and erasing of a dock image.

dynamic virtual void __fastcall DockTrackNoTarget(Controls::TDragDockObject * Source, int X, int Y);

Handles dragging of the control over an invalid docking target.

dynamic virtual void __fastcall DoContextPopup(const Types::TPoint & MousePos, bool & Handled);

Is an OnContextPopup event dispatcher.

dynamic virtual void __fastcall DoEndDock(System::TObject * Target, int X, int Y);

Is an OnEndDock event dispatcher.

dynamic virtual void __fastcall DoDock(Controls::TWinControl * NewDockSite, Types::TRect & ARect);

Docking event dispatcher.

dynamic virtual void __fastcall DoStartDock(Controls::TDragObject * & DragObject);

Is an OnStartDockevent dispatcher.

dynamic virtual bool __fastcall DoMouseWheel(System::Set<Classes::Classes__1,0,8> Shift, int WheelDelta, const Types::TPoint & MousePos);

Processes mouse wheel motion.

dynamic virtual bool __fastcall DoMouseWheelDown(System::Set<Classes::Classes__1,0,8> Shift, const Types::TPoint & MousePos);

Is an OnMouseWheelDown event dispatcher.

dynamic virtual bool __fastcall DoMouseWheelUp(System::Set<Classes::Classes__1,0,8> Shift, const Types::TPoint & MousePos);

Is an OnMouseWheelUp event dispatcher.

dynamic virtual void __fastcall DragCanceled(void);

Provides the interface for a method that responds to the cancellation of a drag.

dynamic virtual void __fastcall DragOver(System::TObject * Source,

int X, int Y, Controls::TDragState State,

bool & Accept);

Is an OnDragOver event dispatcher.

dynamic virtual void __fastcall DoEndDrag(System::TObject * Target, int X, int Y);

Is an OnEndDrag event dispatcher.

dynamic virtual void __fastcall DoStartDrag(Controls::TDragObject * & DragObject);

Is an OnStartDrag event dispatcher.

virtual void __fastcall DoGesture(const Controls::TGestureEventInfo & EventInfo, bool & Handled);

Processes the unhandled gesturing events.

virtual void __fastcall DoGetGestureOptions(System::Set<Controls::TInteractiveGesture,0,4> & Gestures, System::Set<Controls::TInteractiveGestureOption,0,4> & Options);

Returns the interactive gestures and their options.

dynamic virtual void __fastcall DrawDragDockImage(Controls::TDragDockObject * DragDockObject);

Draws the dock image for the control.

dynamic virtual void __fastcall EraseDragDockImage(Controls::TDragDockObject * DragDockObject);

Erases the dock image for the control.

virtual Classes::TBasicAction * __fastcall GetAction(void);

Returns the value of the Action property.

dynamic virtual System::TMetaClass * __fastcall GetActionLinkClass(void);

Returns the appropriate action link class that is associated with the control class.

virtual Types::TPoint __fastcall GetClientOrigin(void);

Returns the screen coordinates of the upper-left corner of the control's client area.

virtual Types::TRect __fastcall GetClientRect(void);

Returns a rectangle defining the client area of the control.

virtual HDC__ * __fastcall GetDeviceContext(HWND__ * & WindowHandle);

Returns a device context for the control.

dynamic virtual Controls::TAlign __fastcall GetDockEdge(const Types::TPoint & MousePos);

Returns the edge on which another control should be docked when it is dragged over the control.

virtual bool __fastcall GetEnabled(void);

Returns the value of the Enabled property.

virtual bool __fastcall GetFloating(void);

Returns the value of the Floating property.

virtual System::TMetaClass * __fastcall GetFloatingDockSiteClass(void);

Returns the class used for the control when it is floating.

dynamic virtual HPALETTE__ * __fastcall GetPalette(void);

Returns the handle to a palette for use by the control.

dynamic virtual Menus::TPopupMenu * __fastcall GetPopupMenu(void);

Returns the pop-up menu associated with the control.

Controls::TDragMode __fastcall GetDragMode(void);

Returns the value of the DragMode property.

dynamic virtual bool __fastcall IsTouchPropertyStored(Controls::TTouchProperty AProperty);

Checks whether the associated touch manager stored any of the given options.

dynamic virtual Controls::TMouseActivate __fastcall MouseActivate(Controls::TMouseButton Button,

System::Set<Classes::Classes__1,0,8> Shift, int X, int Y,

int HitTest);

Triggers a TMouseActivateEvent event.

dynamic virtual void __fastcall MouseDown(Controls::TMouseButton Button,

System::Set<Classes::Classes__1,0,8> Shift, int X,

int Y);

OnMouseDown event dispatcher.

dynamic virtual void __fastcall MouseMove(System::Set<Classes::Classes__1,0,8> Shift, int X, int Y);

Responds to mouse moving over control area.

dynamic virtual void __fastcall MouseUp(Controls::TMouseButton Button,

System::Set<Classes::Classes__1,0,8> Shift, int X,

int Y);

Is an OnMouseUp event dispatcher.

dynamic virtual void __fastcall PositionDockRect(Controls::TDragDockObject * DragDockObject);

Positions the docking rectangle according to the current drag-and-dock state.

dynamic virtual bool __fastcall PaletteChanged(bool Foreground);

Responds to changes in the system's palette by realizing the control's palette.

virtual void __fastcall RequestAlign(void);

Instructs the parent of a control to reposition the control, enforcing its Align property.

dynamic virtual void __fastcall Resize(void);

Respond to control resize.

void __fastcall ScaleConstraints(int M, int D);

Scales the values of the Constraints property to the given ratio.

void __fastcall ScaleMargins(int M, int D);

Scales the values of the Margins property to the given ratio.

void __fastcall SendCancelMode(Controls::TControl * Sender);

Cancels the modal state of the control.

void __fastcall SendDockNotification(unsigned int Msg, unsigned int WParam, unsigned int LParam);

Sends a Windows message to the control's host dock site.

virtual void __fastcall SetAutoSize(bool Value);

Sets the value of the AutoSize property.

virtual void __fastcall SetDragMode(Controls::TDragMode Value);

Sets the drag mode for the control.

virtual void __fastcall SetEnabled(bool Value);

Sets the value of the Enabled property.

virtual void __fastcall SetParent(Controls::TWinControl * AParent);

Sets the parent of the control.

virtual void __fastcall SetParentBiDiMode(bool Value);

Specifies whether the control uses its parent's BiDiMode.

virtual void __fastcall SetBiDiMode(Classes::TBiDiMode Value);

Sets the control's bidirectional mode.

dynamic virtual void __fastcall SetZOrder(bool TopMost);

Repositions the control in its parent's control list, thereby changing position onscreen.

void __fastcall SetCustomHint(Controls::TCustomHint * Value);

Sets the value of the CustomHint property.

void __fastcall UpdateExplicitBounds(void);

Attempts to update the values of the control's explicit bounds to those of its current bounds.

void __fastcall UpdateBoundsRect(const Types::TRect & R);

Changes the Top, Left, Width, and Height properties of the control, but does not update its screen image and bypasses all resize events.

dynamic virtual void __fastcall VisibleChanging(void);

Provides the interface for a method that responds to changes in the control's visibility.

virtual void __fastcall WndProc(Messages::TMessage & Message);

Provides specific message responses for the control.

dynamic virtual bool __fastcall DesignWndProc(Messages::TMessage & Message);

Processes the given message and returns some Boolean information based on the message's content.

virtual Controls::TDragImageList * __fastcall GetDragImages(void);

Returns the control's image list containing the image to be displayed while dragging.

void __fastcall BeginDrag(bool Immediate, int Threshold);

Starts the dragging of a control.

void __fastcall BringToFront(void);

Puts the control in front of all other controls in its parent control.

Types::TPoint __fastcall ClientToScreen(const Types::TPoint & Point);

Translates a given point from client area coordinates to global screen coordinates.

Types::TPoint __fastcall ClientToParent(const Types::TPoint & Point, Controls::TWinControl * AParent);

Translates client coordinates to parent coordinates.

dynamic virtual void __fastcall Dock(Controls::TWinControl * NewDockSite, const Types::TRect & ARect);

Used internally to dock the control.

bool __fastcall Dragging(void);

Indicates whether a control is being dragged.

dynamic virtual void __fastcall DragDrop(System::TObject * Source, int X, int Y);

Is an OnDragDrop event dispatcher.

int __fastcall DrawTextBiDiModeFlags(int Flags);

Returns the text flags that reflect the current setting of the BiDiMode property.

int __fastcall DrawTextBiDiModeFlagsReadingOnly(void);

Returns the text flag to add that indicates whether the control's text should read from right to left.

void __fastcall EndDrag(bool Drop);

Stops a control from being dragged any further.

dynamic virtual Classes::TAlignment __fastcall GetControlsAlignment(void);

Indicates how text is aligned within the control.

void __fastcall Hide(void);

Makes the control invisible.

virtual void __fastcall InitiateAction(void);

Calls the action link's Update method if the control is associated with an action link.

virtual void __fastcall Invalidate(void);

Completely repaint control.

dynamic virtual void __fastcall MouseWheelHandler(Messages::TMessage & Message);

Dispatches messages received from a mouse wheel.

bool __fastcall IsRightToLeft(void);

Indicates whether the control should be reversed right to left.

bool __fastcall ManualDock(Controls::TWinControl * NewDockSite, Controls::TControl * DropControl, Controls::TAlign ControlSide);

Docks the control.

bool __fastcall ManualFloat(const Types::TRect & ScreenPos);

Undocks the control.

int __fastcall Perform(unsigned int Msg, int WParam, int LParam);

Responds as if the control received a specified Windows message.

void __fastcall Refresh(void);

Repaints the control on the screen.

virtual void __fastcall Repaint(void);

Forces the control to repaint its image on the screen.

bool __fastcall ReplaceDockedControl(Controls::TControl * Control,

Controls::TWinControl * NewDockSite, Controls::TControl * DropControl,

Controls::TAlign ControlSide);

Docks the control in the place where another control is already docked.

Types::TPoint __fastcall ScreenToClient(const Types::TPoint & Point);

Converts the screen coordinates of a specified point on the screen to client coordinates.

Types::TPoint __fastcall ParentToClient(const Types::TPoint & Point, Controls::TWinControl * AParent);

Translate parent coordinates to client coordinates.

void __fastcall SendToBack(void);

Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.

virtual void __fastcall SetBounds(int ALeft,

int ATop, int AWidth,

int AHeight);

Sets the Left, Top, Width, and Height properties all at once.

dynamic virtual void __fastcall SetDesignVisible(bool Value);

Makes a control visible at design time.

void __fastcall Show(void);

Makes a control visible.

virtual void __fastcall Update(void);

Processes any pending paint messages immediately.

dynamic virtual bool __fastcall UseRightToLeftAlignment(void);

Specifies whether the control's alignment should be reversed right-to-left.

bool __fastcall UseRightToLeftReading(void);

Specifies whether the control is using a right-to-left reading order.

bool __fastcall UseRightToLeftScrollBar(void);

Specifies whether the vertical scroll bar appears on the left side of the control.

int __fastcall GetTextBuf(wchar_t * Buffer, int BufSize);

Retrieves the control's text, copies it into a buffer, and returns the number of characters copied.

int __fastcall GetTextLen(void);

Returns the length of the control's text.

void __fastcall SetTextBuf(wchar_t * Buffer);

Sets the text of the control.


Unit: Controls

Type: method

Visibility: public

Member Of: TControl


Description

Embarcadero Technologies does not currently have any additional information. Please help us document this topic by using the Discussion page!

Personal tools
Translations
Newest Version