TClrCustomControl Class
TClrCustomControl is the base class for all .Net controls in Delphi.
CNClrLib.Control.Base.TClrCustomControl
CNClrLib.Control.ButtonBase.TCnButtonBase
CNClrLib.Control.ClrContainer.TClrContainer
CNClrLib.Control.DataGridView.TCnDataGridView
CNClrLib.Control.DateTimePicker.TCnDateTimePicker
CNClrLib.Control.LabelA.TCnLabel
CNClrLib.Control.ListControl.TCnListControl
CNClrLib.Control.ListView.TCnListView
CNClrLib.Control.MonthCalendar.TCnMonthCalendar
CNClrLib.Control.PictureBox.TCnPictureBox
CNClrLib.Control.PrintPreviewControl.TCnPrintPreviewControl
CNClrLib.Control.ProgressBar.TCnProgressBar
CNClrLib.Control.ScrollableControl.TCnScrollableControl
CNClrLib.Control.TextBoxBase.TCnTextBoxBase
CNClrLib.Control.TrackBar.TCnTrackBar
CNClrLib.Control.TreeView.TCnTreeView
CNClrLib.Control.WebBrowser.TCnWebBrowser
type TClrCustomControl = class(TCustomControl, IClrBaseComponent, IUnknown) end;
The TClrCustomControl type exposes the following members.
| Name | Description | |
|---|---|---|
 | Create(TComponent) | Creates and initializes a TClrCustomControl instance. |
| Destroy | Frees the resources allocated with a TClrCustomControl instance. |
| Name | Description | |
|---|---|---|
 | AccessibleDescription | Gets or sets the description of the control used by accessibility client applications. |
| AccessibleName | Gets or sets the name of the control used by accessibility client applications. |
| AccessibleRole | Gets or sets the accessible role of the control |
| Align | Determines how the control aligns within its container (parent control). |
| Anchors | Specifies how the control is anchored to its parent. |
 | AutoScrollOffset | Gets or sets where this control is scrolled to in ScrollControlIntoView(Control). |
| AutoSize | Specifies whether the control sizes itself automatically to accommodate its contents. |
| BackColor | Gets or sets the background color for the control. |
| BackgroundImage | Gets or sets the background image displayed in the control. |
| BackgroundImageLayout | Gets or sets the background image layout as defined in the ImageLayout enumeration. |
| BindingContext | Gets or sets the BindingContext for the control. |
| BorderStyle | Specifies the appearance and behavior of the form border. |
| Bottom | Gets the distance, in pixels, between the bottom edge of the control and the top edge of its container's client area. |
| Bounds | Gets or sets the size and location of the control including its nonclient elements, in pixels, relative to the parent control. |
| CanSelect | Gets a value indicating whether the control can be selected. |
| Capture | Gets or sets a value indicating whether the control has captured the mouse. |
| CausesValidation | Gets or sets a value indicating whether the control causes validation to be performed on any controls that require validation when it receives focus. |
| CnDock | Gets or sets which control borders are docked to its parent control and determines how a control is resized with its parent. |
| CompanyName | Gets the name of the company or creator of the application containing the control. |
| Constraints | Specifies the size constraints for the control. |
| ContainsFocus | Gets a value indicating whether the control, or one of its child controls, currently has the input focus. |
| ControlIntf | Get .Net Control object as interface. |
| Controls | Gets the collection of controls contained within the control. |
| Created | Gets a value indicating whether the control has been created. |
| DataBindings | Gets the data bindings for the control. |
 | DefaultBackColor | Gets the default background color of the control. |
| DefaultClrObject | Gets the common language runtime object from this control. |
| DefaultFont | Gets the default font of the control. |
| DefaultForeColor | Gets the default foreground color of the control. |
| DotNetHandle | Gets the window handle that the .Net control is bound to. |
| DragCursor | Specifies the image used to represent the mouse pointer when the control is being dragged. |
| DragMode | Specifies how the control initiates drag-and-drop or drag-and-dock operations. |
| Enabled | Gets or sets a value indicating whether the control can respond to user interaction. |
| Font | Gets or sets the font of the text displayed by the control. |
| ForeColor | Gets or sets the foreground color of the control. |
| HasChildren | Gets a value indicating whether the control contains one or more child controls. |
| IsAccessible | Gets or sets a value indicating whether the control is visible to accessibility applications. |
| IsHandleCreated | Gets a value indicating whether the control has a handle associated with it. |
| IsMirrored | Gets a value indicating whether the control is mirrored. |
| Location | Gets or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container. |
| MaximumSize | Gets or sets the size that is the upper limit that GetPreferredSize(Size) of the .Net control can specify. |
| MinimumSize | Gets or sets the size that is the lower limit that GetPreferredSize(Size) of the .Net control can specify. |
| ModifierKeys | Gets a value indicating which of the modifier keys (SHIFT, CTRL, and ALT) is in a pressed state. |
| MouseButtons | Gets a value indicating which of the mouse buttons is in a pressed state. |
| MousePosition | Gets the position of the mouse cursor in screen coordinates. |
| OnDragDrop | Occurs when a drag-and-drop operation is completed. |
| OnDragOver | Occurs when an object is dragged over the control's bounds. |
| OnEndDrag | Occurs when the dragging of an object ends, either by dropping the object or by canceling the dragging. |
| OnPropertyChange | Occurs when the published property of the control changes. |
| PopupMenu | Specifies the pop-up menu associated with the control. |
| ProductName | Gets the product name of the assembly containing the control. |
| ProductVersion | Gets the version of the assembly containing the control. |
| Right | Gets the distance, in pixels, between the right edge of the control and the left edge of its container's client area. |
| Size | Gets or sets the height and width of the control. |
| TabOrder | Indicates the position of the control in its parent's tab order. |
| TabStop | Gets or sets a value indicating whether the user can give the focus to this control using the TAB key. |
| Text | Gets or sets the text associated with this control. |
| ToolTip | Associates ToolTip control with this control. |
| TooltipText | The ToolTip text to display when the pointer is on the control. |
| UseWaitCursor | Gets or sets a value indicating whether to use the wait cursor for the current control and all child controls. |
| Visible | Gets or sets a value indicating whether the control and all its child controls are displayed. |
| Name | Description | |
|---|---|---|
 | AdjustSize | Adjusts the control's size according to its contents and constraints. |
| CanAutoSize(Integer,Integer) | Indicates how the control can be resized. |
| CanFocus | Indicates whether a control can receive focus. |
| CanResize(Integer,Integer) | Indicates how the control can respond to a resize attempt |
| ChangeScale(Integer,Integer) | Repositions and resizes the form by the ratio M/D, adjusting its client area and font size as needed. |
| CreateControl | Forces the creation of the visible control, including the creation of the handle and any visible child controls. |
| CreateGraphics | Creates the Graphics for the control. |
| CreateHandle | Creates a handle for the control. |
| CreateParams(TCreateParams) | Initializes the window-creation parameter record when the form window is created. |
| DblClick | OnDblClick event dispatcher. |
| DoAddDockClient(TControl,TRect) | Performs actions when a control is docked to the windowed control. |
| DoBackColorChange(TObject) | Performs actions when a control BackColor changes. |
| DoBackgroundImageChange(TObject) | Performs actions when a control BackgroundImage changes. |
| DockOver(TDragDockObject,Integer,Integer,TDragState,Boolean) | Responds when a docking client is dragged over the windowed control. |
| DockReplaceDockClient(TControl,TWinControl,TControl,TAlign,TControl) | Invalidates the first dock site in the list of child controls. |
| DoDockOver(TDragDockObject,Integer,Integer,TDragState,Boolean) | Generates an OnDockOver event. |
| DoEnter | Respond to receiving input focus. |
| DoExit | Responds to losing input focus. |
| DoFontChange(TObject) | Performs actions when a control Font changes. |
| DoForeColorChange(TObject) | Performs actions when a control ForeColor changes. |
| DoGetControlClientRectangle | Gets the rectangle that represents the client area of the control. |
| DoGetDefaultBorderStyle | Gets the default border type of the control. |
| DoGetDotNetBaseControl | Gets the base .Net control. |
| DoGetDotNetControlDefaultHeight | Gets the default height of the control. |
| DoGetDotNetControlDefaultWidth | Gets the default Width of the control. |
| DoGetDotNetControlHandle | Gets the window handle that the control is bound to. |
| DoInitializeDotNetControl | Creates and initializes the .Net control. |
| DoLocationChange(TObject) | Performs actions when a control Location changes. |
| DoMaximumSizeChange(TObject) | Performs actions when a control MaximumSize changes. |
| DoMinimumSizeChange(TObject) | Performs actions when a control MinimumSize changes. |
| DoMouseWheel(TShiftState,Integer,TPoint) | Processes mouse wheel motion. |
| DoMouseWheelDown(TShiftState,TPoint) | Is an OnMouseWheelDown event dispatcher. |
| DoMouseWheelUp(TShiftState,TPoint) | Is an OnMouseWheelUp event dispatcher. |
| DoSetControlBorderStyle(TBorderStyle_) | Sets the border type of the control. |
| DoSetControlStyles(TControlStyles_Set,Boolean) | Set the style of the control. |
| DoSetDotNetControlParent | Specifies the parent of the control. |
| DoShowContextMenu(TPoint) | Represents method |
| DoSizeChange(TObject) | Performs actions when a control Size changes. |
| DoSupportTextProperty | Check if the Text property is supported by the control. |
| DoUseClrContainer | Specify whether to use the common language runtime usercontrol container to host the .Net control. |
| DrawToBitmap(TBitmap,TRect) | Supports rendering to the specified bitmap. |
| Focus | Sets input focus to the control. |
| Focused | Determines whether the control has input focus. |
| GetClrObject | Get the common language runtime object from the internal control interface. |
| Invalidate | Overloaded. Invalidates the entire surface of the control and causes the control to be redrawn. |
| Invalidate(Boolean) | Overloaded. Invalidates a specific region of the control and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. |
| Invalidate(TRect) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. |
| Invalidate(TRect,Boolean) | Overloaded. Invalidates the specified region of the control (adds it to the control's update region, which is the area that will be repainted at the next paint operation), and causes a paint message to be sent to the control. Optionally, invalidates the child controls assigned to the control. |
| IsKeyLocked(TKeys_Set) | Determines whether the CAPS LOCK, NUM LOCK, or SCROLL LOCK key is in effect. |
| IsMnemonic(WCHAR,String) | Determines if the specified character is the mnemonic character assigned to the control in the specified string. |
| KeyDown(Word,TShiftState) | Responds to key press events. |
| KeyPress(Char) | Responds to keyboard input. |
| KeyUp(Word,TShiftState) | Respond to released key. |
| MouseDown(TMouseButton,TShiftState,Integer,Integer) | OnMouseDown event dispatcher. |
| MouseMove(TShiftState,Integer,Integer) | Responds to mouse moving over control area. |
| MouseUp(TMouseButton,TShiftState,Integer,Integer) | Is an OnMouseUp event dispatcher. |
| Notification(TComponent,TOperation) | Represents method |
| Paint | Renders the image of a windowed control. |
| PerformLayout | Overloaded. Forces the control to apply layout logic to all its child controls. |
| PropertyChanged | Responds to change in the published properties of the control. |
| QueryInterface(TGUID,Void) | Returns a reference to a specified interface if that interface is supported by the control. |
| Refresh | Forces the control to invalidate its client area and immediately redraw itself and any child controls. |
| RegisterEventCallBack(ClrWString,Pointer) | Add an event to the instance using the specified event name and function pointer which is the event handler. The RegisterEventCallBack method does not directly add the event handler to the event. A hooking mechanism is used such that if the event is fired, the hook event is also fired which in turn calls the function pointer. |
| RegisterEventSource | Register the Delphi object which will raise the .Net event handler. |
| Repaint | Repaints the entire control. |
| ResetBackColor | Resets the BackColor property to its default value. |
| ResetBindings | Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values |
| ResetCursor | Resets the Cursor property to its default value. |
| ResetFont | Resets the Font property to its default value. |
| ResumeLayout | Overloaded. Resumes usual layout logic. |
| ResumeLayout(Boolean) | Overloaded. Resumes usual layout logic, optionally forcing an immediate layout of pending layout requests. |
| Scale(TSizeF) | Scales the control and all child controls by the specified scaling factor. |
| Select | Activates a control. |
| SetAutoSize(Boolean) | Sets the value of the AutoSize property. |
| SetBorderStyle(TBorderStyle) | Sets the value of the BorderStyle property. |
| SetBounds(Integer,Integer,Integer,Integer) | Sets the windowed control's boundary properties all at once. |
| SetName(TComponentName) | Sets the name of the control. |
| SetText(String) | Sets the text of the control. |
| SuspendLayout | Temporarily suspends the layout logic for the control. |
| UnRegisterEventCallBack(ClrWString,Pointer) | Remove an event from the instance using the specified event name and function pointer which is the event handler. |
| UnRegisterEventSource | Represents method |
| Update | Causes the control to redraw the invalidated regions within its client area. |
| UpdateDotNetControlSize | Updates .Net control size. |
| UpdateStyleElements | Invalidates a specific region of the control and causes a paint message to be sent to the control. |
| WndProc(TMessage) | Provides specific message responses for the control. |
| _AddRef | Called when an application uses a component interface. |
| _Release | Called when an application releases a component interface. |
| Name | Description | |
|---|---|---|
 | OnBackColorChanged | Occurs when the value of the BackColor property changes. |
| OnBackgroundImageChanged | Occurs when the value of the BackgroundImage property changes. |
| OnBindingContextChanged | Occurs when the value of the BindingContext property changes. |
| OnCausesValidationChanged | Occurs when the value of the CausesValidation property changes. |
| OnClick | Occurs when the control is clicked. |
 | OnClientSizeChanged | Occurs when the value of the ClientSize property changes. |
| OnCursorChanged | Occurs when the value of the Cursor property changes. |
| OnDoubleClick | Occurs when the control is double-clicked. |
| OnEnabledChanged | Occurs when the Enabled property value has changed. |
| OnEnter | Occurs when the control is entered. |
| OnFontChanged | Occurs when the Font property value changes. |
| OnForeColorChanged | Occurs when the ForeColor property value changes. |
| OnGotFocus | Occurs when the control receives focus. |
| OnInvalidated | Occurs when a control's display requires redrawing. |
| OnKeyDown | Occurs when a key is pressed while the control has focus. |
| OnKeyPress | Occurs when a character. space or backspace key is pressed while the control has focus. |
| OnKeyUp | Occurs when a key is released while the control has focus. |
| OnLeave | Occurs when the input focus leaves the control. |
| OnLostFocus | Occurs when the control loses focus. |
| OnMouseCaptureChanged | Occurs when the control loses mouse capture. |
| OnMouseClick | Occurs when the control is clicked by the mouse. |
| OnMouseDoubleClick | Occurs when the control is double clicked by the mouse. |
| OnMouseDown | Occurs when the mouse pointer is over the control and a mouse button is pressed. |
| OnMouseEnter | Occurs when the mouse pointer enters the control. |
| OnMouseHover | Occurs when the mouse pointer rests on the control. |
| OnMouseLeave | Occurs when the mouse pointer leaves the control. |
| OnMouseMove | Occurs when the mouse pointer is moved over the control. |
| OnMouseUp | Occurs when the mouse pointer is over the control and a mouse button is released. |
| OnMouseWheel | Occurs when the mouse wheel moves while the control has focus. |
| OnMove | Occurs when the control is moved. |
| OnPaint | Occurs when the control is redrawn. |
| OnPreviewKeyDown | Occurs before the OnKeyDown event when a key is pressed while focus is on this control. |
| OnResize | Occurs when the control is resized. |
| OnSizeChanged | Occurs when the Size property value changes. |
| OnSystemColorsChanged | Occurs when the system colors change. |
| OnTabIndexChanged | Occurs when the TabOrder/TabIndex property value changes. |
| OnTabStopChanged | Occurs when the TabStop property value changes. |
| OnTextChanged | Occurs when the Text property value changes. |
| OnValidated | Occurs when the control is finished validating. |
| OnValidating | Occurs when the control is validating. |
| OnVisibleChanged | Occurs when the Visible property value changes. |