TextBox

Namespace: PP.Ui;

Inheritance Hierarchy

Object

Control

TextBox

Description

The TextBox class implements a text box.

Syntax

PP.initClass(PP.Ui.TextBox,  PP.Ui.Control, "PP.Ui.TextBox");

Constructor

	Constructor name	Brief description
	TextBox	The TextBox constructor creates an instance of the TextBox component.

Properties

	Property name	Brief description
	ColImgIndex	The ColImgIndex property determines index of the sprite row that contains the background image to be set.
	ControlButton	The ControlButton property determines a button that is used to control text field.
	EnableEdit	The EnableEdit property determines whether text field can be edited.
	ImageAlign	The ImageAlign property determines background image alignment.
	ImageEnabledAlways	The ImageEnabledAlways property determines whether text field background image is active, if the field is inactive.
	ImageHeight	The ImageHeight property determines height of text field background image.
	ImageList	The ImageList property determines text field sprite.
	ImageUrl	The ImageUrl property determines the path to text field image.
	ImageWidth	The ImageWidth property determines width of text field background image.
	IsHint	The IsHint property determines whether a tooltip is displayed on the mouse hover on text field background image.
	IsPassword	The IsPassword property determines whether the entered text is replaces with asterisks.
	IsWatermark	The IsWatermark property determines whether transparent text is rendered if text field is empty and not focused.
	MaxLength	The MaxLength property determines maximum text length in text field.
	RowImgIndex	The RowImgIndex property determines index of sprite column that contains the background image to be set.
	UseImageClass	The UseImageClass property determines CSS class of text field background image component.
	ValidState	The ValidState property determines text field state as correctly or incorrectly filled in, which is displayed by means of corresponding highlighting.
	WatermarkText	The WatermarkText property determines the text displayed if text field is empty and not focused.

Methods

	Method name	Brief description
	applyNotValidCSS	The applyNotValidCSS method sets the style that determines highlighting of invalid input value of text field.
	applyValidCSS	The applyValidCSS property sets the style that determines highlighting of valid input value of text field.
	blur	The blur method defocuses text field.
	getImageMargin	The getImageMargin method returns value of background image margins of text field.
	selectAll	The selectAll method selects the entire text contents of text field.
	setAllowedSymbols	The setAllowedSymbols method determines the list of characters that can be entered.
	setRestrictedSymbols	The setRestrictedSymbols method sets the list of restricted characters.

Events

	Event name	Brief description
	AfterChange	The AfterChange event occurs after completing of text field editing.
	AfterTimeout	The AfterTimeout event occurs after completing of text field editing when the delay time between field editing and calling the event expires.
	BeforeChange	The BeforeChange event occurs on starting editing of text field.
	Blur	The Blur event occurs when text field loses focus.
	Enter	The Enter event occurs on pressing the ENTER key in the active text field.
	Focus	The Focus event occurs when text field gets focus.
	ImageClick	The ImageClick event occurs on the left mouse click on the text field image.
	ImageMouseDown	The ImageMouseDown event occurs on holding down the left mouse button on the text field image.
	ImageMouseOut	The ImageMouseOut event occurs after the mouse cursor leaves the area of text field background image.
	ImageMouseOver	The ImageMouseOver event occurs after pointing the mouse cursor on the text field background image.
	ImageMouseUp	The ImageMouseUp event occurs on releasing the left mouse button when the cursor is in the area of text field image.
	TextChanged	The TextChanged event occurs after changing text field text.
	ValueChanged	The ValueChanged event occurs after changing the value of text field.

Properties inherited from the Control class

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the Control class

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the Control class

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

PP.Ui