Control Class (Typed)

Provide the base class from which all X# controls are subclassed.

Inheritance Hierarchy

Object
  VObject
    Control
      More...

Namespace: XSharp.VO.SDK
Assembly: XSharp.VOGUIClasses (in XSharp.VOGUIClasses.dll) Version: 2.21

Syntax

Copy

[TypesChangedAttribute]
 CLASS Control INHERIT VObject,  IMPLEMENTS IGuiObject, 
	ITimer

[TypesChangedAttribute]
public class Control : VObject, IGuiObject, 
	ITimer

Request Example View Source

The Control type exposes the following members.

Constructors

	Name	Description
	Control	Construct a control.

Top

Properties

	Name	Description
	Background	The brush used for painting the background of the control. For example, in a single line edit control, the background is the color behind the text in the edit control.
	Caption	A string representing the caption of the control (i.e., the static text identifying the control)
	ContextMenu	A menu object representing the local pop-up menu for a control.
	ControlID	A number between 1 and 8000 representing the unique ID of a control
	ControlType
	EventReturnValue
	FieldSpec
	HasFocus
	HyperLabel	The hyperlabel connected to the control.
	IsHidden
	Modified	A logical value that is set to TRUE when a standard edit control or editable combo box is in the process of being modified.
	Name	A string representing the name of the control.
	NameSym	A symbol representing the name of the control.
	Origin	A point representing the location of a control on its owner window, in canvas coordinates.
	Owner	The owner window of a control.
	OwnerAlignment	Constant representing how the window will be aligned within its owner window.
	Parent
	ReadOnly	Is the control readonly ?
	Server	The server object that currently connected to this control. If no server is connected, the value is NIL.
	Size	A dimension representing the size of a control.
	Status	A hyperlabel indicating the status of the control after a validation attempt or other action.
	SWFControl
	TextValue	A string representing the value held in the control.
	ToolTipText	String value representing the tooltip text used when the user moves the mouse pointer over the control.
	UseHLForToolTip	Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text.
	Value	The value held in the control, in whatever data type the control holds.
	ValueChanged

Top

Functions

	Name	Description
	Activate	Provide a method that is invoked when the control has focus and a window is activated.
	AddChild
	AsString
	BringToFront
	Create	Creates the underlying Win32 control
	CreateWindowEx
	Deactivate	Provide a method that is invoked when the control has focus and a window is deactivated.
	Default	Call the default windows procedure for a control and set the EventReturnValue.
	Destroy	Provide a method to de-instantiate any Control object. (Overrides Destroy.)
	Disable	Disable a control (until a subsequent call to Control:Enable()).
	DisableTheme	Disable the WinXP theme for a control.
	Dispatch	Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers.
	Drop
	Enable	Enable a control that was previously disabled.
	Expose	Provide a method that is invoked when the control has focus and whenever part of the window needs repainting.
	FocusChange	Provide a method that is invoked when the control has focus and the input focus changes from the current control to another (or vice versa).
	Handle	Return the handle for a control.
	HasBorder	Check if a border has been set for the control
	HasStyle	Check if a style value has been set for the control
	Hide	Hide a control so it is not visible (until a subsequent call to Control:Show()).
	HorizontalScroll	Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled.
	IsEnabled	Report if this control is currently enabled.
	IsReadOnly	Report if this control is currently readonly.
	IsVisible	Report if this control is visible (completely or partially) or hidden.
	KeyDown	Provide a method that is invoked when the control has focus and a key on the keyboard is pressed.
	KeyUp	Provide a method that is invoked when the control has focus and a key on the keyboard is released.
	LinkDF	Connect a control to a data field in a data server.
	MenuInit	Provide a method that is invoked when a pop-up menu owned by the control is about to pop up.
	MenuSelect	Provide a method that is invoked when an item on a menu owned by the control is highlighted.
	MouseButtonDoubleClick	Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is double-clicked.
	MouseButtonDown	Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is clicked.
	MouseButtonUp	Provide a method that is invoked when the control has focus, the mouse pointer is positioned over the window, and a mouse button is released.
	MouseDrag	Provide a method that is invoked when the control has focus and a mouse with one or more buttons clicked is moved in the window.
	MouseMove	Provide a method that is invoked when the control has focus and the mouse is moved in the control.
	Move	Provide a method that is invoked when the control has focus and the control is moved (either by the user or by the application).
	OnControlCreated
	OnHandleCreated
	OnHandleDestroyed
	OverRide	This is a compatibility method that is no longer used or needed.
	OwnerAlignmentHandledByWinForms
	PaintBackGround
	PerformValidations	Perform all the validations defined to this control's field specification (for example, required, maximum and minimum digits, maximum and minimum value, validation rule) and return the result of the test.
	RegisterTimer	Register a timer method to be invoked for the control.
	RePaint	Send an ExposeEvent to repaint the control
	Resize	Provide a method that is invoked when the control has focus and the control changes size.
	RestoreUpdate	Resume all drawing updates for a control (after Control:SuspendUpdate() is called).
	SendToBack
	SetExStyle	Set the exstyle for the control.
	SetFocus	Pass input focus to a control, thereby directing all mouse and keyboard input to the control.
	SetStyle	Set the style for the control.
	Show	Display a control so it is visible.
	ShowToolTip
	SuspendUpdate	Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate().
	Timer	Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method.
	ValidateControl	This method validates if the control has been created and when not then it triggers the control creation
	VerticalScroll	Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled.

Top

Globals and Defines

	Name	Description
	oCargo	Cargo slot. (Inherited from VObject.)

Top

Remarks

Control is the base class for a major system class hierarchy. Controls provide an easy mechanism for user I/O. They are self-contained and notify their respective owners when the user takes some action (such as pressing a button or entering text). Controls on dialog windows created from resource entity templates are shown automatically when the dialog window is shown. However, if the application wishes to manipulate a control, it must register the control by creating a system object of the appropriate type. Controls must appear in an owner window. They also need to know where to appear. There are two basic ways you can specify where; one is by placing the control using the Window Editor. In this case, X# generates a resource to represent the control. When you construct the control in your program, you pass to the constructor the ID of the resource as its second argument. The other way is to place the controls dynamically, in which case, you pass the position and size of the control as the third and fourth arguments (the first argument is always the owner and the second argument is always the resource ID). Even when you place the control dynamically, you pass in a unique ID as the second argument.

Reference

XSharp.VO.SDK Namespace

Inheritance Hierarchy

Object
  VObject
    Control
      AnimationControl
      CustomControl
      DataBrowser
      FixedImage
      MultiMediaContainer
      ProgressBar
      ScrollBar
      Spinner
      SplitView
      StatusBar
      TextControl
      ToolBar