Edit Class

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

Inheritance Hierarchy

Object
  VObject
    Control
      TextControl
        Edit
          MultiLineEdit
          SingleLineEdit

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

Syntax

Copy

 CLASS Edit INHERIT TextControl

public class Edit : TextControl

Request Example View Source

The Edit type exposes the following members.

Constructors

	Name	Description
	Edit	Construct an edit 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. (Inherited from Control.)
	Caption	Caption text is not displayed for single-line or multiline edit controls. It can be used to store general text information. (Overrides Caption.)
	ContextMenu	A menu object representing the local pop-up menu for a control. (Inherited from Control.)
	ControlFont	The font used to draw the text in the control. (Inherited from TextControl.)
	ControlID	A number between 1 and 8000 representing the unique ID of a control (Inherited from Control.)
	CurrentText	A string representing the text currently displayed in a text control. For edit controls, including the edit box associated with simple and drop-down combo boxes, it contains the text currently appearing in the edit box. For fixed icon and group box controls, TextControl:CurrentText contains NULL_STRING. (Inherited from TextControl.)
	FieldSpec	The field specification connected to the control. (Inherited from Control.)
	HyperLabel	The hyperlabel connected to the control. (Inherited from Control.)
	Length	A numeric value representing the number of characters in the control. (Inherited from TextControl.)
	Margins	A Dimension object specifying the left and right margins of the edit control.
	Modified	A logical value indicating whether an editable control is in the process of being modified. (Overrides Modified.)
	Name	A string representing the name of the control. (Inherited from Control.)
	NameSym	A symbol representing the name of the control. (Inherited from Control.)
	Origin	A point representing the location of a control on its owner window, in canvas coordinates. (Inherited from Control.)
	Owner	The owner window of a control. (Inherited from Control.)
	OwnerAlignment	Constant representing how the window will be aligned within its owner window. (Inherited from Control.)
	ReadOnly	A logical value specifying the read-only state of an edit control. (Overrides ReadOnly.)
	SelectedText	A string representing the text that is currently selected in this edit control.
	Selection	The position of the cursor in the edit control.
	Server	The server object that currently connected to this control. If no server is connected, the value is NIL. (Inherited from Control.)
	Size	A dimension representing the size of a control. (Inherited from Control.)
	Status	A hyperlabel indicating the status of the control after a validation attempt or other action. (Inherited from Control.)
	TextColor	The color used to draw the text in the control. (Refer to the Color:Init() method for details on specifying a color object.) (Inherited from TextControl.)
	TextLimit	A numeric value representing the maximum number of characters this edit control can hold.
	TextValue	A string representing the value held in the control. (Overrides TextValue.)
	ToolTipText	String value representing the tooltip text used when the user moves the mouse pointer over the control. (Inherited from Control.)
	UseHLForToolTip	Logical value determining whether the descriptive text of a control's Hyperlabel should be used as the tooltip text. (Inherited from Control.)
	Value	The value held in the control, in whatever data type the control holds. (Inherited from Control.)
	ValueChanged	A logical value representing whether the control's Value has been changed from its prior setting. (Inherited from Control.)

Top

Methods

	Name	Description
	Activate	Provide a method that is invoked when the control has focus and a window is activated. (Inherited from Control.)
	AsString	Return the contents of the control (or its identifying label). (Inherited from Control.)
	CanUndo	Determine if the Edit:Undo() method can be called for this edit control.
	Clear	Delete the current selection in this edit control.
	Copy	Copy the current selection in this edit control to the clipboard.
	Create	Creates the underlying Win32 control (Inherited from TextControl.)
	Cut	Delete the current selection in this edit control and copy it to the clipboard.
	Deactivate	Provide a method that is invoked when the control has focus and a window is deactivated. (Inherited from Control.)
	DEFAULT	Call the default windows procedure for a control and set the EventReturnValue. (Inherited from Control.)
	Destroy	Provide a method to de-instantiate any TextControl.Destroy object. (Inherited from TextControl.)
	Disable	Disable a control (until a subsequent call to Control:Enable()). (Inherited from Control.)
	DisableTheme	Disable the WinXP theme for a control. (Inherited from Control.)
	Dispatch	Provide the prototype dispatcher for events within the system when the control has focus; routing various events to their appropriate event handlers. (Inherited from Control.)
	Enable	Enable a control that was previously disabled. (Inherited from Control.)
	Expose	Provide a method that is invoked when the control has focus and whenever part of the window needs repainting. (Inherited from Control.)
	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). (Inherited from Control.)
	GetExStyle	Retrieve the Ex styles for the control. (Inherited from Control.)
	GetStyle	Retrieve the styles for the control. (Inherited from Control.)
	Handle	Return the handle for a control. (Inherited from Control.)
	HasBorder	Check if a border has been set for the control (Inherited from Control.)
	HasStyle	Check if a style value has been set for the control (Inherited from Control.)
	Hide	Hide a control so it is not visible (until a subsequent call to Control:Show()). (Inherited from Control.)
	HorizontalScroll	Provide a method that is invoked when the control has focus and a horizontal scroll bar is scrolled. (Inherited from Control.)
	Ime	Return and optionally set whether Input Method Editor is enabled for this text control. (Inherited from TextControl.)
	IsEnabled	Report if this control is currently enabled. (Inherited from Control.)
	IsExStyle	Check if a exstyle value has been set for the control (Inherited from Control.)
	IsReadOnly	Report if this control is currently readonly. (Inherited from Control.)
	IsStyle	Check if a style value has been set for the control (Inherited from Control.)
	IsVisible	Report if this control is visible (completely or partially) or hidden. (Inherited from Control.)
	KeyDown	Provide a method that is invoked when the control has focus and a key on the keyboard is pressed. (Inherited from Control.)
	KeyUp	Provide a method that is invoked when the control has focus and a key on the keyboard is released. (Inherited from Control.)
	LinkDF	Connect a control to a data field in a data server. (Inherited from Control.)
	MenuInit	Provide a method that is invoked when a pop-up menu owned by the control is about to pop up. (Inherited from Control.)
	MenuSelect	Provide a method that is invoked when an item on a menu owned by the control is highlighted. (Inherited from Control.)
	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. (Inherited from Control.)
	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. (Inherited from Control.)
	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. (Inherited from Control.)
	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. (Inherited from Control.)
	MouseMove	Provide a method that is invoked when the control has focus and the mouse is moved in the control. (Inherited from 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). (Inherited from Control.)
	OverRide	This is a compatibility method that is no longer used or needed. (Inherited from Control.)
	Paste	Replace the current selection in this edit control with a string, if specified, or the contents of the clipboard.
	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. (Inherited from Control.)
	RegisterTimer	Register a timer method to be invoked for the control. (Inherited from Control.)
	RemoveEditBalloonTip	Removes the current BallonTip from the Edit control that has inherited from this class. (Inherited from TextControl.)
	RePaint	Send an ExposeEvent to repaint the control (Inherited from Control.)
	Resize	Provide a method that is invoked when the control has focus and the control changes size. (Inherited from Control.)
	RestoreUpdate	Resume all drawing updates for a control (after Control:SuspendUpdate() is called). (Inherited from Control.)
	SetCueBanner	Add a cue banner to the Edit control that has inherited from this class. (Inherited from TextControl.)
	SetExStyle	Set the exstyle for the control. (Inherited from Control.)
	SetFocus	Pass input focus to a control, thereby directing all mouse and keyboard input to the control. (Inherited from Control.)
	SetParent	Change the parent handle for the control. (Inherited from Control.)
	SetStyle	Set the style for the control. (Inherited from Control.)
	Show	Display a control so it is visible. (Inherited from Control.)
	ShowEditBalloonTip	Add a BallonTip to the Edit control that has inherited from this class. (Inherited from TextControl.)
	SuspendUpdate	Temporarily suspend all drawing updates for a control; drawing resumes with a call to Control:RestoreUpdate(). (Inherited from Control.)
	Timer	Provide a method to be invoked at specific intervals defined when the timer is registered though the RegisterTimer() method. (Inherited from Control.)
	Undo	Undo the last modification to the text in this edit control.
	ValidateControl	This method validates if the control has been created and when not then it triggers the control creation (Inherited from Control.)
	VerticalScroll	Provide a method that is invoked when the control has focus and a vertical scroll bar is scrolled. (Inherited from Control.)

Top

Fields

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

Top

Remarks

The Edit class provides simple text editing facilities for entering, deleting, and selecting text. In addition, you can specify if edit controls are to have a border, whether they should be read-only, or perhaps whether they should be password protected. Edit controls in this class hierarchy treat the text they contain as a series of numbered characters. In these edit controls, a selection is an ordered pair of character numbers. For example, if an edit control contains the text "samarkand," the selection (3,7) would select the text "mark." Also, for each control, the text limit is the maximum number of characters you wish the edit to hold. The non-graphic characters for newline (Chr(10)), tab (Chr(9)), and null (Chr(0)) occupy one character position.

Reference

VO Namespace