Edit Field (PRIM_MD.Edit)

Entry field used for entering and displaying text

Ancestors - Field (PRIM_MD.Input)Control (PRIM_MD.Control)Control (PRIM_CTRL)Object (PRIM_OBJT)

Details

Material Design entry field.

Properties

Name Description
Appearance Format of the control Inherited from Field (PRIM_MD.Input)
BusyUpdates BusyUpdates specifies how the control updates itself Inherited from Control (PRIM_CTRL)
BusyUpdatesOfParent BusyUpdatesOfParent specifies whether the parent controls updates Inherited from Control (PRIM_CTRL)
CanFocus CanFocus returns a value indicating whether the control can receive keyboard focus Inherited from Control (PRIM_CTRL)
Caption Caption property Inherited from Field (PRIM_MD.Input)
CaptionColor Color of caption Inherited from Field (PRIM_MD.Input)
CaptionPosition Sets the position of Caption Inherited from Field (PRIM_MD.Input)
ClearButton Specifies if clear button is displayed on control
ComponentClassName ComponentClassName is the name of the component's class. Inherited from Object (PRIM_OBJT)
ComponentMembers ComponentMembers provides access to all the member components of this component Inherited from Object (PRIM_OBJT)
ComponentPatternName ComponentPatternName is used to qualify the class of the component. Inherited from Object (PRIM_OBJT)
ComponentTag Generic space allowing a value to be stored for the instance Inherited from Object (PRIM_OBJT)
ComponentType ComponentType gives you access to the type information about the component Inherited from Object (PRIM_OBJT)
ComponentTypeName ComponentTypeName is the fully qualified name of the component's class. Inherited from Object (PRIM_OBJT)
Cursor Cursor sets the cursor image Inherited from Control (PRIM_CTRL)
DisplayAlignment DisplayAlignment sets the text alignment when not in focus
DisplayPosition DisplayPosition determines the order in which components are shown Inherited from Control (PRIM_CTRL)
DragStyle DragStyle determines how a component can be dragged Inherited from Control (PRIM_CTRL)
EditAlignment EditAlignment sets the alignment of the text when in focus
Enabled Enable activates/deactivates the component Inherited from Control (PRIM_CTRL)
FixedPosition Fix the control position so that it does not move if the parent is scrolled Inherited from Control (PRIM_CTRL)
Focus Focus tells whether the component has focus Inherited from Control (PRIM_CTRL)
FocusedStyle Reference to a style to be applied when the control is focus Inherited from Control (PRIM_CTRL)
FocusedStyles Collection of styles to be applied when the control is focus Inherited from Control (PRIM_CTRL)
Handle Returns the Windows handle in desktop applications Inherited from Control (PRIM_CTRL)
HasError Is the field flagged as being in error Inherited from Field (PRIM_MD.Input)
HasSelection True if some of the editable text is selected
Height The height of the control in pixels Inherited from Control (PRIM_CTRL)
HelperColor Color of helper text Inherited from Field (PRIM_MD.Input)
HelperPosition Position where the helper text will be displayed Inherited from Field (PRIM_MD.Input)
HelperText Text to show in the Helper area of the field Inherited from Field (PRIM_MD.Input)
Hint Caption displayed when the mouse hovers over the control Inherited from Control (PRIM_CTRL)
HintPopup HintPopup allows a PopupPanel instance to be used instead of the default hint text box Inherited from Control (PRIM_CTRL)
HintShow Enabled or disable the appearance of hints Inherited from Control (PRIM_CTRL)
HintShowOfParent Delegate hints appearance to the parent control Inherited from Control (PRIM_CTRL)
HintTitle HintTitle defines the text shown at the top of the hint window in emphasized text Inherited from Control (PRIM_CTRL)
Icon Image displayed within the button Inherited from Field (PRIM_MD.Input)
IconColor Color to be applied to the icon Inherited from Field (PRIM_MD.Input)
IconFileName FileName is the name of image file Inherited from Field (PRIM_MD.Input)
IconHeight Height of the icon in pixels Inherited from Field (PRIM_MD.Input)
IconImage Material design image to show on the control Inherited from Field (PRIM_MD.Input)
IconImageSizing Specifies the sizing behaviour of the IconImage Inherited from Field (PRIM_MD.Input)
IconOpacity Percentage opacity of the icon Inherited from Field (PRIM_MD.Input)
IconThemeDrawStyle Theme drawstyle applied to icon Inherited from Field (PRIM_MD.Input)
IsAnimating IsAnimating indicates that a control is currently being animated Inherited from Control (PRIM_CTRL)
IsRealized True if the control is currently realized Inherited from Control (PRIM_CTRL)
Left Position of the control relative to the left boundary of its parent Inherited from Control (PRIM_CTRL)
MaxLength MaxLength sets the maximum number of characters
Modified Modified indicates that the contents of the component have changed Inherited from Control (PRIM_CTRL)
MouseOver MouseOver determines whether the mouse is directly over a control Inherited from Control (PRIM_CTRL)
MouseOverStyle MouseOverStyle defines the style to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MouseOverStyles MouseOverStyles is a collection of styles to be applied to a control when the mouse is over it Inherited from Control (PRIM_CTRL)
MultiLine Allow text to wrap to a new line
Name Name identifies the component Inherited from Object (PRIM_OBJT)
Opacity Opacity denotes the appearance of a control in terms of its interaction with its background Inherited from Control (PRIM_CTRL)
Owner Owner owns this component Inherited from Object (PRIM_OBJT)
Parent Reference to the control in which this control is visually positioned Inherited from Control (PRIM_CTRL)
PasswordChar Character to use to mask the data being entered
Placeholder Text to be shown when the edit has no value Inherited from Field (PRIM_MD.Input)
PlaceholderColor Color of the placeholder text Inherited from Field (PRIM_MD.Input)
Popup Popup allows a PopupPanel instance to be used instead of the typical right click popup menu Inherited from Control (PRIM_CTRL)
PopupMenu Reference to a PopupMenu to be shown on a right click Inherited from Control (PRIM_CTRL)
PromptIcon Image displayed within the input
PromptIconColor Color to be applied to the icon
PromptIconFileName FileName is the name of image file
PromptIconHeight Height of the icon in pixels
PromptIconHint Text to be displayed for prompter
PromptIconImage Material design image to show on the control
PromptIconImageSizing Specifies the sizing behaviour of the PromptIconImage
PromptIconOpacity Percentage opacity of the icon
PromptOnly Only allow input via the prompter
ReadOnly ReadOnly controls whether a component can be used for input
Rotation Rotation allows a control to rotate a number of degrees about a given origin Inherited from Control (PRIM_CTRL)
RotationOriginLeft RotationOriginLeft defines the left coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
RotationOriginTop RotationOriginTop defines the top coordinate of an imaginary point around which a control will rotate Inherited from Control (PRIM_CTRL)
ScaleHeight ScaleHeight is the percentage of the height to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScaleOriginLeft ScaleOriginLeft defines the left coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleOriginTop ScaleOriginTop defines the top coordinate of an imaginary point from which a control will scale Inherited from Control (PRIM_CTRL)
ScaleWidth ScaleWidth is the percentage of the width to use in the visual appearance of a control Inherited from Control (PRIM_CTRL)
ScreenLeft ScreenLeft sets the distance from the left of the screen Inherited from Control (PRIM_CTRL)
ScreenTop ScreenTop sets the distance from the top of the screen Inherited from Control (PRIM_CTRL)
ScrollLeft Left position of a horizontally scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
ScrollTop Top position of a vertically scrolled child control relative to its parent control Inherited from Control (PRIM_CTRL)
SelectionEnd Position in the value that selection ends
SelectionStart Position in the value that selection starts
SkewLeft SkewLeft defines the angle at which to skew the control horizontally Inherited from Control (PRIM_CTRL)
SkewOriginLeft SkewOriginLeft defines the left coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewOriginTop SkewOriginTop defines the top coordinate of an imaginary point from which a control will skew Inherited from Control (PRIM_CTRL)
SkewTop SkewTop defines the angle at which to skew the control vertically Inherited from Control (PRIM_CTRL)
SpellCheck Use browser spell checking features
Style Style defines the style to be applied to a control Inherited from Control (PRIM_CTRL)
Styles Collection of styles to be applied to the control Inherited from Control (PRIM_CTRL)
TabPosition TabPosition sets the order of focus when the Tab key is used Inherited from Control (PRIM_CTRL)
TabStop Set to false to stop focus being given to the control via the Tab key Inherited from Control (PRIM_CTRL)
ThemeBackground Background theme to be used Inherited from Control (PRIM_MD.Control)
ThemeDrawStyle Name of the Theme DrawStyle to be applied to the control Inherited from Control (PRIM_CTRL)
Top Position of the control relative to the top boundary of its parent Inherited from Control (PRIM_CTRL)
TouchMove Determines how the control will respond to touch move processing Inherited from Control (PRIM_CTRL)
TouchRotate Determines how the control will respond to touch rotation Inherited from Control (PRIM_CTRL)
TouchScale Determines how the control will respond to touch scaling Inherited from Control (PRIM_CTRL)
TouchSize Determines whether a control can be resized Inherited from Control (PRIM_CTRL)
Value Value of the edit field
Visible Show or hide the control Inherited from Control (PRIM_CTRL)
VisualStyle VisualStyle sets the appearance Inherited from Control (PRIM_CTRL)
VisualStyleOfParent Adopt the Visual style from the parent control Inherited from Control (PRIM_CTRL)
Width Width of the component in pixels Inherited from Control (PRIM_CTRL)

Events

Name Description
AnimationEnded Fired when an animation is ended Inherited from Control (PRIM_CTRL)
Cancelled
AutoCompleting Fired as a value is being edited allowing for a replacement value to be returned
Value
AutoSuggest Fired when the value is changed after a short delay
Changed Fired when the value is changed
CreateInstance CreateInstance is signalled when an instance of a component is created Inherited from Control (PRIM_CTRL)
DestroyInstance DestroyInstance is signalled when an instance of a component is about to be destroyed Inherited from Control (PRIM_CTRL)
DragDrop Fired on mouse up to signify the end of a drag process Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, AggregatedSource, Origin, Handled, DragResult
DragOver Fired during the drag and drop process when the cursor moves over the control Inherited from Control (PRIM_CTRL)
PosX, PosY, Source, Payload, DragState, AcceptDrop, DragCursor, ShowDropHilight, AggregatedSource, Origin, Handled
EndDrag Fired when the drag and drop process has completed Inherited from Control (PRIM_CTRL)
Source, Payload, DragResult, AggregatedSource, Origin, Handled
Enter Fired when the enter key is pressed
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
GotFocus Fired when the control receives the focus
IconClick Fired when the icon is clicked Inherited from Control (PRIM_CTRL)
Origin, Handled
Initialize Fired after a component has been realized for the first time Inherited from Control (PRIM_CTRL)
KeyPress Fired when a key is pressed on the keyboard
KeyCode, Char, IsAltDown, IsControlDown, IsShiftDown, Handled
LostFocus Fired when the control loses focus
MouseEnter The mouse has entered the bounds of the control Inherited from Control (PRIM_CTRL)
MouseHover The mouse has hovered over the control Inherited from Control (PRIM_CTRL)
Origin, Handled
MouseLeave The mouse has left the bounds of the control Inherited from Control (PRIM_CTRL)
Prompting Fired when prompt icon is pressed
Origin, Handled
StartDrag Fired when the user starts a drag and drop process Inherited from Control (PRIM_CTRL)
Source, Payload, Continue, DragList, AggregatedSource, Origin, Handled
TouchChange Fired repeatedly between the TouchStart and TouchEnd boundaries to provide details of the touch events Inherited from Control (PRIM_CTRL)
MoveLeft, MoveTop, ScaleWidth, ScaleHeight, Rotation, Continue
TouchEnd Fired when the user stops touching the screen Inherited from Control (PRIM_CTRL)
TouchStart Fired when the user first makes physical contact with the screen Inherited from Control (PRIM_CTRL)
Origin, TouchMove, TouchRotate, TouchScale, TouchSize

Methods

Name Description
ClearError Clear the error Inherited from Field (PRIM_MD.Input)
FadeIn Animate from invisible to visible Inherited from Control (PRIM_CTRL)
Duration, Delay
FadeOut Animate from visible to invisible Inherited from Control (PRIM_CTRL)
Duration, Delay, Visible
MoveFrom Move a control from the specified position to the current position Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
MoveTo Animate a move from the specified number of pixels Inherited from Control (PRIM_CTRL)
Left, Top, Duration, Delay
Realize Creates the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
Scale Animate a change of scale Inherited from Control (PRIM_CTRL)
ScaleWidth, ScaleHeight, Duration, Delay
SelectText Set selection within the value
StartPosition, Length
SetFocus Sets the control to be the focus control Inherited from Control (PRIM_CTRL)
ShowError Set the field in error Inherited from Field (PRIM_MD.Input)
ErrorText
ShowMessages LANSA Internal Use Inherited from Control (PRIM_CTRL)
SizeTo Changes and animates control size changing Inherited from Control (PRIM_CTRL)
Width, Height, Duration, Delay
Unrealize Destroys the visual portion of dynamically created controls Inherited from Control (PRIM_CTRL)
UpdateDisplay UpdateDisplay updates the display immediately Inherited from Control (PRIM_CTRL)

See also

All Component Classes

Technical Reference

LANSA Version 15, April 2020