TShape Members

The following tables list the members exposed by TShape.

	Name	Description
	OnCanResize	Occurs when an attempt is made to resize the control.
	OnClick	Occurs when the user clicks the control.
	OnConstrainedResize	Adjust resize constraints.
	OnDblClick	Occurs when the user double-clicks the left mouse button when the mouse pointer is over the control.
	OnMouseWheel	Occurs when the mouse wheel is rotated.
	OnMouseWheelDown	Occurs when the mouse wheel is rotated downward.
	OnMouseWheelUp	Occurs when the mouse wheel is rotated upward.
	OnResize	Occurs immediately after the control is resized.

Protected Fields

	Name	Description
	FAnchorMove	Specifies whether the control must keep its dimensions when it is moved, while being anchored to the form.
	FAnchorOrigin	Specifies the coordinates of the anchor associated with the control.
	FAnchorRules	Specifies the original coordinates of the anchor associated with the control.
	FComponentStyle	FComponentStyle is the field of the ComponentStyle read-only property.
	FExplicitHeight	Specifies the explicit vertical size of the control in pixels.
	FExplicitLeft	Specifies the explicit horizontal pixel coordinate of the left edge of a component. The coordinate is relative to the component’s parent.
	FExplicitTop	Specifies the explicit vertical pixel coordinate of the top edge of a component. The coordinate is relative to the component's parent.
	FExplicitWidth	Specifies the explicit horizontal size of the control in pixels.
	FOriginalParentSize	Specifies the original size of the parent to which the control is anchored.
	FReserved	FReserved is an internal Delphi variable and should not be used.

Protected Methods

	Name	Description
	_AddRef	Called when an application uses a component interface.
	_Release	Called when an application releases a component interface.
	ActionChange	Responds when the action associated with the control changes.
	AdjustSize	Sets the size of the control as determined by the AutoSize property.
	AssignTo	Copies the properties of an object to a destination object.
	AssignTo	Overrides the inherited AssignTo function to enable assignments to TAction objects.
	BeginAutoDrag	Begin Automatic Drag.
	CalcCursorPos	Gives the coordinates of the cursor, with respect to the origin of the control.
	CanAutoSize	Indicates whether the control can resize itself automatically to accommodate its contents.
	CanResize	OnCanResize event dispatcher.
	Changed	Sends a CM_CHANGED message to the control.
	ChangeName	Sets the private, internal storage for the Name property to the string passed in NewName.
	ChangeScale	Rescaling event dispatcher.
	Click	Respond to user click.
	ConstrainedResize	Notify control of resize with constraints.
	DblClick	OnDblClick event dispatcher.
	DefaultDockImage	Handles the painting and erasing of a dock image.
	DefineProperties	Designates methods for storing an object's unpublished data on a stream such as a form file.
	DefineProperties	Provides an interface for a method that reads and writes otherwise unpublished data.
	DefineProperties	Provides methods to read and write the IsControl property to a stream such as a form file.
	DesignWndProc	Processes the given message and returns some Boolean information based on the message's content.
	DockTrackNoTarget	Handles dragging of the control over an invalid docking target.
	DoContextPopup	OnContextPopup event dispatcher.
	DoDock	Docking event dispatcher.
	DoEndDock	OnEndDock event dispatcher.
	DoEndDrag	OnEndDrag event dispatcher.
	DoMouseWheel	Processes mouse wheel motion.
	DoMouseWheelDown	OnMouseWheelDown event dispatcher.
	DoMouseWheelUp	OnMouseWheelUp event dispatcher.
	DoStartDock	OnStartDock event dispatcher.
	DoStartDrag	OnStartDrag event dispatcher.
	DragCanceled	Provides the interface for a method that responds to the cancellation of a drag.
	DragOver	OnDragOver event dispatcher.
	DrawDragDockImage	Draws the dock image for the control.
	EraseDragDockImage	Erases the dock image for the control.
	GetAction	Returns the value of the Action property.
	GetActionLinkClass	Returns the appropriate action link class that is associated with the control class.
	GetChildOwner	Returns the owner of a child component being read from a stream.
	GetChildParent	Returns the parent, or if there is no parent, returns the owner of a child component being read from a stream.
	GetChildren	Enumerates all child components.
	GetClientOrigin	Returns the screen coordinates of the top-left corner of the control's client area.
	GetClientRect	Returns a rectangle defining the client area of the control.
	GetDeviceContext	Returns a device context for the control.
	GetDockEdge	Returns the edge on which another control should be docked when it is dragged over the control.
	GetDragImages	Returns the control's image list containing the image to be displayed while dragging.
	GetDragMode	Returns the value of the DragMode property.
	GetEnabled	Returns the value of the Enabled property.
	GetFloating	Returns the value of the Floating property.
	GetFloatingDockSiteClass	Returns the class used for the control when it is floating.
	GetIDsOfNames	Maps a single member and an optional set of argument names to a corresponding set of integer dispatch identifiers (dispIDs).
	GetOwner	Returns the owner of a component.
	GetOwner	Returns the owner of an object.
	GetPalette	Returns the handle to a palette for use by the control.
	GetPopupMenu	Returns the pop-up menu associated with the control.
	GetTypeInfo	Retrieves the type information for an object.
	GetTypeInfoCount	Returns the number of type information interfaces that an object provides (either 0 or 1).
	Invoke	Provides access to Automation properties and methods when the component wraps an Automation object.
	Loaded	Initializes the component after the form file has been read into memory.
	Loaded	Initializes the control after it is loaded from a stream.
	MouseActivate	Triggers a TMouseActivateEvent event.
	MouseDown	OnMouseDown event dispatcher.
	MouseMove	Respond to mouse moving over control area..
	MouseUp	OnMouseUp event dispatcher.
	Notification	Forwards notification messages to all owned components.
	Notification	Responds to notifications that components are being created or destroyed.
	Paint	Render control surface.
	PaletteChanged	Responds to changes in the system's palette by realizing the control's palette.
	PaletteCreated	Responds when the component is created from the component palette.
	PositionDockRect	Positions the docking rectangle according to the current drag-and-dock state.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReadState	Reads the state of the component.
	ReadState	Prepares the control for having its properties assigned values read from a stream.
	RequestAlign	Instructs the parent of a control to reposition the control, enforcing its Align property.
	Resize	Respond to control resize.
	ScaleConstraints	Scales the values of the Constraints property to the given ratio.
	ScaleMargins	Scales the values of the Margins property to the given ratio.
	SendCancelMode	Cancels the modal state of the control.
	SendDockNotification	Sends a Windows message to the control's host dock site.
	SetAncestor	Clears or sets csAncestor state in the component's ComponentState property.
	SetAutoSize	Sets the value of the AutoSize property.
	SetBiDiMode	Sets the control's bi-directional mode.
	SetChildOrder	Sets the visual ordering of a child control.
	SetCustomHint	Sets the value of the CustomHint property.
	SetDesigning	Ensures that components inserted at design time have their design-mode flag set.
	SetDesignInstance	Ensures that components inserted at design time have their design-mode flag set.
	SetDragMode	Sets the drag mode for the control.
	SetEnabled	Sets the value of the Enabled property.
	SetInline	Sets the csInline bit of the component's ComponentState property
	SetName	Sets the value of the Name property.
	SetName	Sets the name of the control.
	SetParent	Sets the parent of the control.
	SetParentBiDiMode	Specifies whether the control uses its parent's BiDiMode.
	SetParentComponent	Sets the parent component.
	SetZOrder	Repositions the control in its parent's control list, thereby changing position onscreen.
	UpdateBoundsRect	Changes the Top, Left, Width, and Height properties of the control, but doesn't update its screen image and bypasses all resize events.
	Updated	Clears the csUpdating state in the component's ComponentState property when the component finishes updating.
	UpdateExplicitBounds	Attempts to update the values of the explicit bounds of the control to those of its current bounds.
	UpdateRegistry	Provides the interface for a method that adds type library and version information to the Registry on components that implement COM interfaces.
	Updating	Sets the csUpdating state in the component's ComponentState property.
	ValidateContainer	Determines whether an object can be inserted into a container.
	ValidateInsert	Provides the interface for a method that validates an child component before it is inserted.
	ValidateRename	Ensures that renaming an owned component does not create name conflict.
	VisibleChanging	Provides the interface for a method that responds to changes in the control's visibility.
	WndProc	Provides specific message responses for the control.
	WriteState	Writes the state of the component.

Protected Properties

	Name	Description
	ActionLink	Contains the action link object associated with the control.
	AutoSize	Specifies whether the control sizes itself automatically to accommodate its contents.
	Canvas	Provides the drawing surface used by the graphic control.
	Caption	Specifies a text string that identifies the control to the user.
	Color	Specifies the background color of the control.
	DesktopFont	Specifies whether the control uses the Windows icon font when writing text.
	Font	Controls the attributes of text written on or in the control.
	IsControl	Determines whether a form stores its form-specific properties to a stream.
	MouseCapture	Indicates whether the control has "captured" mouse events.
	ParentBiDiMode	Specifies whether the control uses its parent's BiDiMode.
	ParentColor	Determines where a control looks for its color information.
	ParentFont	Determines where a control looks for its font information.
	PopupMenu	Identifies the pop-up menu associated with the control.
	ScalingFlags	Reflects which attributes of the control have been scaled.
	Text	Contains a text string associated with the control.
	WheelAccumulator	Accumulates mouse wheel rotations.
	WindowText	Contains the text string of the control.

Public Events

	Name	Description
	WindowProc	Points to the window procedure that responds to messages sent to the control.

Public Methods

	Name	Description
	_AddRef	Increments the reference count for this interface.
	_Release	Decrements the reference count for this interface.
	AfterConstruction	Responds after the last constructor has executed.
	Assign	Copies the contents of another, similar object.
	BeforeDestruction	Performs any necessary actions before the first destructor is called.
	BeforeDestruction	Responds before the first destructor executes.
	BeginDrag	Starts the dragging of a control.
	BringToFront	Puts the control in front of all other controls in its parent control.
	ClassInfo	Returns a pointer to the runtime type information (RTTI) table for the object type.
	ClassName	Returns a string indicating the type of the object instance (as opposed to the type of the variable passed as an argument).
	ClassNameIs	Determines whether an object is of a specific type.
	ClassParent	Returns the type of the immediate ancestor of a class.
	ClassType	Returns the class reference for the object's class.
	CleanupInstance	Performs finalization on long strings, variants, and interface variables within a class.
	ClientToParent	Translates client coordinates to parent coordinates.
	ClientToScreen	Translates a given point from client area coordinates to global screen coordinates.
	Create	Creates an instance of TShape.
	DefaultHandler	Provides message handling for all messages that do not have specific handlers.
	DefaultHandler	Provides the interface for a method that processes message records.
	Destroy	Destroys of an instance of TShape.
	DestroyComponents	Destroys all owned components.
	Destroying	Indicates that the component and its owned components are about to be destroyed.
	Dispatch	Calls message-handling methods for the object, based on the contents of the Message parameter.
	Dock	Used internally to dock the control.
	DragDrop	OnDragDrop event dispatcher.
	Dragging	Indicates whether a control is being dragged.
	DrawTextBiDiModeFlags	Returns the text flags that reflect the current setting of the BiDiMode property.
	DrawTextBiDiModeFlagsReadingOnly	Returns the text flag to add that indicates whether the control's text should read from right to left.
	EndDrag	Stops a control from being dragged any further.
	Equals	Checks if the current instance and the parameter are equal.
	ExecuteAction	Executes an action.
	FieldAddress	This is the overview for the FieldAddress method overload.
	FindComponent	Indicates whether a given component is owned by the component.
	Free	Destroys an object and frees its associated memory, if necessary.
	FreeInstance	Deallocates memory allocated by a previous call to the System::TObject::NewInstance method.
	FreeNotification	Ensures that AComponent is notified that the component is going to be destroyed.
	FreeOnRelease	Frees the interface reference for components that were created from COM classes.
	GetComponent	Returns a reference to the component associated by the implementing class.
	GetControlsAlignment	Indicates how text is aligned within the control.
	GetEnumerator	Returns a TComponent enumerator.
	GetHashCode	Returns an integer containing the hash code.
	GetInterface	Retrieves a specified interface.
	GetInterfaceEntry	Returns the entry for a specific interface implemented in a class.
	GetInterfaceTable	Returns a pointer to a structure containing all of the interfaces implemented by a given class.
	GetNamePath	Returns a string used by the Object Inspector.
	GetNamePath	Returns the name of the object as it appears in the Object Inspector.
	GetParentComponent	Returns the containing Component.
	GetParentComponent	Returns the parent of the control.
	GetTextBuf	Retrieves the control's text, copies it into a buffer, and returns the number of characters copied.
	GetTextLen	Returns the length of the control's text.
	HasParent	Verifies whether the component has a parent.
	HasParent	Indicates whether the control has a parent.
	Hide	Makes the control invisible.
	InheritsFrom	Determines the relationship of two object types.
	InitiateAction	Calls the action link's Update method if the control is associated with an action link.
	InitInstance	Initializes a newly allocated object instance to all zeros and initializes the instance's virtual method table pointer.
	InsertComponent	Establishes the component as the owner of a specified component.
	InstanceSize	Returns the size in bytes of each instance of the object type.
	Invalidate	Completely repaint control.
	IsImplementorOf	Indicates whether the component implements a specified interface.
	IsRightToLeft	Indicates whether the control should be reversed right to left.
	ManualDock	Docks the control.
	ManualFloat	Undocks the control.
	MethodAddress	This is the overview for the MethodAddress method overload.
	MethodName	Returns the name of a class method by address.
	MouseWheelHandler	Dispatches messages received from a mouse wheel.
	NewInstance	Allocates memory for an instance of an object type and returns a pointer to that new instance.
	ParentToClient	Translate parent coordinates to client coordinates.
	Perform	This is the overview for the Perform method overload.
	QueryInterface	Returns a reference to a specified interface if the object supports that interface.
	ReferenceInterface	Establishes or removes internal links that cause this component to be notified when the implementer of a specified interface is destroyed.
	Refresh	Repaints the control on the screen.
	RemoveComponent	Removes a specified component specified from the component's Components list.
	RemoveFreeNotification	Disables destruction notification that was enabled by FreeNotification
	Repaint	Forces the control to repaint its image on the screen.
	ReplaceDockedControl	Docks the control in the place where another control is already docked.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	SafeCallException	Handles exceptions in methods declared using the safecall calling convention.
	ScreenToClient	Converts the screen coordinates of a specified point on the screen to client coordinates.
	SendToBack	Puts a windowed control behind all other windowed controls, or puts a non-windowed control behind all other non-windowed controls.
	SetBounds	Sets the Left, Top, Width, and Height properties all at once.
	SetDesignVisible	Makes a control visible at design time.
	SetParentComponent	Sets the parent for the control.
	SetSubComponent	Identifies whether the component is a subcomponent.
	SetTextBuf	Sets the text of the control.
	Show	Makes a control visible.
	ToString	Returns a string containing the class name.
	UnitName	Returns a string containing the unit name.
	Update	Processes any pending paint messages immediately.
	UpdateAction	Updates the state of an action.
	UseRightToLeftAlignment	Specifies whether the control's alignment should be reversed right-to-left.
	UseRightToLeftReading	Specifies whether the control is using a right-to-left reading order.
	UseRightToLeftScrollBar	Specifies whether the vertical scroll bar appears on the left side of the control.

Public Properties

	Name	Description
	Action	Designates the action associated with the control.
	BiDiMode	Specifies the bi-directional mode for the control.
	BoundsRect	Specifies the bounding rectangle of the control, expressed in the coordinate system of the parent control.
	ClientHeight	Specifies the height of the control's client area in pixels.
	ClientOrigin	Specifies the screen coordinates (in pixels) of the top left corner of a control's client area.
	ClientRect	Specifies the size (in pixels) of a control's client area.
	ClientWidth	Specifies the horizontal size of the control's client area in pixels.
	ComObject	Specifies the interface reference implemented by the component.
	ComponentCount	Indicates the number of components owned by the component.
	ComponentIndex	Indicates the position of the component in its owner's Components property array.
	Components	Lists all components owned by the component.
	ComponentState	Describes the current state of the component, indicating when a component needs to avoid certain actions.
	ComponentStyle	Governs the behavior of the component.
	ControlState	Indicates the current state of a control at runtime.
	ControlStyle	Determines style characteristics of the control.
	DesignInfo	Contains information used by the Form designer.
	DockOrientation	Specifies how the control is docked relative to other controls docked in the same parent.
	ExplicitHeight	Specifies the explicit vertical size of the control in pixels.
	ExplicitLeft	Specifies the explicit horizontal pixel coordinate of the left edge of a component relative to its parent.
	ExplicitTop	Specifies the explicit vertical pixel coordinate of the top edge of a component relative to its parent.
	ExplicitWidth	Specifies the explicit horizontal size of the control in pixels.
	Floating	Indicates whether the control is floating.
	FloatingDockSiteClass	Specifies the class of the temporary control that hosts the control when it is floating.
	HostDockSite	Specifies the control in which the control is docked.
	LRDockWidth	Specifies the width of the control when it is docked horizontally.
	Owner	Indicates the component that is responsible for streaming and freeing this component.
	Parent	Indicates the parent of the control.
	TBDockHeight	Specifies the height of the control when it is docked vertically.
	UndockHeight	Specifies the height of the control when it is floating.
	UndockWidth	Specifies the width of the control when it is floating.
	VCLComObject	Represents information used internally by components that support COM.

Published Events

	Name	Description
	OnContextPopup	Occurs when the user right-clicks the control or otherwise invokes the popup menu (such as using the keyboard).
	OnDragDrop	Occurs when the user drops an object being dragged.
	OnDragOver	Occurs when the user drags an object over a control.
	OnEndDock	Occurs when the dragging of an object ends, either by docking the object or by canceling the dragging.
	OnEndDrag	Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging.
	OnMouseActivate	Occurs when the user presses a mouse button with the mouse pointer over a control and the parent form is not active.
	OnMouseDown	Occurs when the user presses a mouse button with the mouse pointer over a control.
	OnMouseEnter	Occurs when the user moves the mouse into a control.
	OnMouseLeave	Occurs when the user moves the mouse outside of a control.
	OnMouseMove	Occurs when the user moves the mouse pointer while the mouse pointer is over a control.
	OnMouseUp	Occurs when the user releases a mouse button that was pressed with the mouse pointer over a component.
	OnStartDock	Occurs when the user begins to drag a control with a DragKind of dkDock.
	OnStartDrag	Occurs when the user begins to drag the control or an object it contains by left-clicking on the control and holding the mouse button down.

Published Methods

	Name	Description
	StyleChanged	This is StyleChanged, a member of class TShape.

Published Properties

	Name	Description
	Align	Determines how the control aligns within its container (parent control).
	AlignWithMargins	Indicates whether a control should be constrained by margins.
	Anchors	Specifies how the control is anchored to its parent.
	Brush	Specifies the color and pattern used for filling the shape control.
	Constraints	Specifies the size constraints for the control.
	Cursor	Specifies the image used to represent the mouse pointer when it passes into the region covered by the control.
	CustomHint	Custom hint for control.
	DragCursor	Indicates the image used to represent the mouse pointer when the control is being dragged.
	DragKind	Specifies whether the control is being dragged normally or for docking.
	DragMode	Determines how the control initiates drag-and-drop or drag-and-dock operations.
	Enabled	Controls whether the control responds to mouse, keyboard, and timer events.
	Height	Specifies the vertical size of the control in pixels.
	HelpContext	Numeric ID for control's context-sensitive help topic
	HelpKeyword	Keyword for control's context-sensitive help topic
	HelpType	Indicates whether the control's context sensitive help topic is identified by context ID or by keyword.
	Hint	Contains the text string that can appear when the user moves the mouse over the control.
	Left	Specifies the horizontal coordinate of the left edge of a component relative to its parent.
	Margins	Specifies the margins for the control.
	Name	Specifies the name of the component as referenced in code.
	ParentCustomHint	Determines where a control looks for its custom hint.
	ParentShowHint	Determines where a control looks to find out if its Help Hint should be shown.
	Pen	Specifies the pen used to outline the shape control.
	Shape	Specifies the shape of the control.
	ShowHint	Determines whether the control displays a Help Hint when the mouse pointer rests momentarily on the control.
	Tag	Stores an integer value as part of a component.
	Top	Specifies the Y coordinate of the top left corner of a control, relative to its parent or containing control in pixels.
	Visible	Determines whether the component appears onscreen.
	Width	Specifies the horizontal size of the control or form in pixels.

What do you think about this topic? Send feedback!