cpr.controls.InputBox

InputBox A control that allows you to enter data.

Hierarchy

Index

Events

Event	Description
animationend	Event that occurs after the animation ends.
animationstart	Event that occurs at the start of the animation.
before-context-value-change	Use a bind context in a control that has a bind context An event that occurs before the value changes.
before-value-change	An event that occurs before the changed value is saved.
blur	An event that occurs after the control loses focus.
change	DOM event that fires when the value changes.
clear	An event that occurs when the input value is cleared by entering the esc key or clicking the clear button in the input box.
click	An event that occurs when the user clicks the control.
context-value-change	Use a bind context in a control that has a bind context An event that occurs after the value changes.
contextmenu	When the right mouse button is clicked or the context menu key is pressed, Event called.
copy	Event that occurs when a user copies the text.
cut	Event that occurs when a user cuts the text.
dblclick	An event that occurs when the user double-clicks the control.
dispose	The event that is called when the control is dispose.
dragenter	When the mouse pointer enters the elements included in the control while dragging Events that occur.
dragleave	During the drag, the mouse pointer may have exited the elements contained in the control.
dragover	While dragging the source control with the mouse, the mouse pointer An event that occurs when moving within a region.
drop	Drag the source control to the target control while dragging the source control with the mouse.
focus	The event that occurs after the control gains focus.
input	When the text displayed in the input box is input from the keyboard and changed The event that occurs.
keydown	Event raised when the user presses a key.
keyup	Event that occurs when the user releases the key.
measure-size	Event raised when calculating control size
mousedown	When the user presses the mouse button with the pointer over the control Occurs when an event occurs.
mouseenter	An event that occurs when the mouse pointer enters the control.
mouseleave	If the user moves the mouse pointer beyond the control and its children Events that occur when moving.
mousemove	This event is raised when the user moves the pointer over the control.
mouseup	The user releases the mouse button while over the control.
paste	Event that occurs when a user pastes text.
select	An event that occurs when the user selects text.
transitionend	Event that fires after CSS property transition ends.
transitionstart	Event that fires when CSS property transition starts.
value-change	The event that occurs after the changed value is saved.

Properties

Name	Type	Description
accessKey	String	Returns the keyboard shortcut character.
accessbility	Accessbility	Gets the accessibility-related ARIA properties or gets the context in which they can be specified.
autoSelect	Boolean	Returns whether the entire data in the edit area is selected when it is focused.
autoSkip	Boolean	Returns whether focus moves to the next control when the input string is filled in maxlength or the value is changed by pressing Enter.
autocomplete	String	Returns the browser autocomplete feature settings.
buttonFocusable	Boolean	Returns the set value to focus on the button.
clearButtonImage	String	clear button Returns the image.
displayExp	#expression	Returns the expression for the text displayed when not in focus.
displayText	String	Gets the value of the HTML Element shown in the input.
displayingText	String	Gets the value of the HTML Element shown in the input.
disposed	Boolean	Returns whether the control should be removed.
editable	Boolean	Returns whether the value can be changed by user action.
enabled	Boolean	Returns whether the control is enabled.
fieldLabel	String	Returns the logical field name of the control.
focusable	Boolean	Returns whether the control is focusable.
focused	Boolean	Returns whether the control has focus.
id	String	Returns the ID of the control.
imeMode	String	IE, FireFox Returns the HanYou conversion setting in the browser.
inputFilter	#expression	Gets the regexp for the input character.
inputMode	InputMode	The browser returns the array type of the keyboard that displays the virtual keyboard.
length	Number	Returns the length of the input value (string) of inputbox.
lengthUnit	String	Returns the unit of the total string length in the compilation area.
maxLength	Number	Returns the maximum number of characters that can be entered.
name	String	Returns the name of the control.
placeholder	String	Returns a text (hint) for the description or expected value.
readOnly	Boolean	Returns whether a non-modifiable read-only mode is in effect.
secret	Boolean	Returns whether input method password is set.
showClearButton	Boolean	Returns whether the clear button is displayed
spellCheck	Boolean	Returns the setting values for the ability to check English spelling and grammar.
style	InputBox$Styler	Returns the style settings of the control.
tabIndex	Number	Returns the control focus sequence using the Tab Key.
text	String	Returns the text shown in the control.
tooltip	String	Returns a description of the control
type	ControlType	Returns the signature string of the Control's unique Type that can distinguish the Control.
uuid	String	Returns the unique ID of the control.
value	String	Returns the value of the control.
visible	Boolean	Returns the style property for controlling css visibility.

Methods

Name	Return Type	Description
addEventListener		Add listeners by EventType to the control.
addEventListenerOnce	(e: cpr.events.CEvent)=>Void	Add a listener to the control that will run only once per EventType.
bind	IBindFactory	Bind that property.
blur		Removes focus from the control.
clear		Set the input box value to an empty value.
confirmEvent	Boolean	Determines whether to run the Control's Default Event Handler depending on the state of the Control.
dispatchEvent	Boolean	Forwards specific events.
dispose		Removes the objects contained in the control.
findParent	UIControl	Find the parent control.
focus		Assigns focus to the control.
focusNext		Moves focus to the next control.
focusPrevious		Moves focus to the previous control.
getActualRect	Rectangle	Gets the bounds value of the control relative to the browser's view port.
getAppInstance	AppInstance	Returns the App to which the control belongs.
getBindContext	BindContext	Returns the bind context.
getBindInfo	BindInfo	Returns the bind property information for the control.
getHtmlAttrNames	String[]	Returns all custom DOM DATA attribute names.
getNextControl	UIControl	Returns the control to be moved by Tab Key or by the autoskip property.
getOffsetRect	Rectangle	The area being displayed is obtained based on the parent container to which it belongs.
getParent	Container	Gets the parent control.
getPrevControl	UIControl	Shift + Tab Returns the focus to be moved through the key.
getRangedText	String	Returns the text corresponding to the selection range of the input box.
getSelectedRange	{ start: Number, end: Number }	Get information about the selection area of the input box.
getSelection	{ start: Number, end: Number, text: String }	Returns the selection area (start, end, text).
getUserAttrNames	String[]	Returns all custom attribute names.
getVisualParentControl	UIControl	Gets the closest parent UI control.
htmlAttr		Specifies custom DOM properties.
isAvailableBinding	Boolean	Returns whether the queried property is bindable and the binding has been configured to obtain a valid value.
isBindable	Boolean	Make sure it is a bindable property.
isFloated	Boolean	Returns whether the control is floating through an app instance or a specific container.
isShowing	Boolean	Returns the status that the screen is showing.
putValue		Sets the value of the control.
redraw		Redraw the control.
removeAllEventListeners		Removes all event listeners for the control.
removeAllHtmlAttr		Delete all custom DOM DATA attributes.
removeAllUserAttr		Delete all custom attributes.
removeEventListener		Remove Listener for each EventType in the control.
removeEventListeners		Remove all EventType listeners from the control.
removeHtmlAttr		Removes the user-defined DOM DATA attribute for a specific attribute name.
removeUserAttr		Removes user-defined attributes for a specific attribute name.
setBindContext		Sets the bind context.
setNextControl		Sets the control to be moved by Tab Key or by the autoskip property.
setPrevControl		Shift + Tab Set the focus to be moved through the key.
setRangeText		Replace or insert a string in the selection range of the input box.
setSecurityProp		Set css class, style, and attribute to be set in the input tag in order to link with external security tools such as keyboard security tools.
setSecutiryProp		Set css class, style, and attribute to be set in the input tag in order to link with external security tools such as keyboard security tools.
setSelection		The text entered is replaced or inserted in the selected selection area, and the focus is moved.
setSelectionRange		Set the selection area of the input box.
unbind		Unbind that property.
userAttr		Specifies custom properties.
userData		Specifies custom data.
userattr	Object	Returns a user-defined property.

Constructor

InputBox(id)

Create an input box.

Parameters

name	type		description
idoptional	String		input box id

Events

animationend

CAnimationEvent Event that occurs after the animation ends.

animationstart

CAnimationEvent Event that occurs at the start of the animation.

before-context-value-change

CValueChangeEvent Use a bind context in a control that has a bind context An event that occurs before the value changes.

before-value-change

CValueChangeEvent An event that occurs before the changed value is saved. The following event causes a value-change.

 oldValue: {string} Old Value 
 newValue: {string} current value

blur

CFocusEvent An event that occurs after the control loses focus.

change

CUIEvent DOM event that fires when the value changes.

clear

CMouseEvent An event that occurs when the input value is cleared by entering the esc key or clicking the clear button in the input box.

click

CMouseEvent An event that occurs when the user clicks the control.

context-value-change

CValueChangeEvent Use a bind context in a control that has a bind context An event that occurs after the value changes.

contextmenu

CMouseEvent When the right mouse button is clicked or the context menu key is pressed, Event called.

copy

CClipboardEvent Event that occurs when a user copies the text.

cut

CClipboardEvent Event that occurs when a user cuts the text.

dblclick

CMouseEvent An event that occurs when the user double-clicks the control.

dispose

CEvent The event that is called when the control is dispose.

dragenter

CMouseEvent When the mouse pointer enters the elements included in the control while dragging Events that occur.

dragleave

CMouseEvent During the drag, the mouse pointer may have exited the elements contained in the control. The event that occurs when.

dragover

CMouseEvent While dragging the source control with the mouse, the mouse pointer An event that occurs when moving within a region.

drop

CMouseEvent Drag the source control to the target control while dragging the source control with the mouse. Event that fires when dropping.

focus

CFocusEvent The event that occurs after the control gains focus.

input

CKeyboardEvent When the text displayed in the input box is input from the keyboard and changed The event that occurs.

keydown

CKeyboardEvent Event raised when the user presses a key. Keycode related constants can be referenced at KeyCode.

keyup

CKeyboardEvent Event that occurs when the user releases the key. Keycode related constants can be referenced at KeyCode.

measure-size

CMeasureSizeEvent Event raised when calculating control size

mousedown

CMouseEvent When the user presses the mouse button with the pointer over the control Occurs when an event occurs.

mouseenter

CMouseEvent An event that occurs when the mouse pointer enters the control.

mouseleave

CMouseEvent If the user moves the mouse pointer beyond the control and its children Events that occur when moving.

mousemove

CMouseEvent This event is raised when the user moves the pointer over the control.

mouseup

CMouseEvent The user releases the mouse button while over the control. When an event occurs.

paste

CClipboardEvent Event that occurs when a user pastes text.

select

CUIEvent An event that occurs when the user selects text.

transitionend

CTransitionEvent Event that fires after CSS property transition ends.

transitionstart

CTransitionEvent Event that fires when CSS property transition starts.

value-change

CValueChangeEvent The event that occurs after the changed value is saved.

 oldValue: {string} Old Value 
 newValue: {string} current value

Properties

accessKey

declaring type	AccessableUIControl
type	String
get	Returns the keyboard shortcut character.
set	Keyboard shortcut Sets a single character (letter or number). The shortcut key is [alt] + [shortcut key] for Windows or [option] + [shortcut key] for Mac.

accessbility

declaring type	UIControl
type	Accessbility
readonly	Gets the accessibility-related ARIA properties or gets the context in which they can be specified.

autoSelect

type	Boolean
get	Returns whether the entire data in the edit area is selected when it is focused.
set	Sets whether to select all the data in the edit area when it is in focus.

autoSkip

type	Boolean
get	Returns whether focus moves to the next control when the input string is filled in maxlength or the value is changed by pressing Enter.
set	Sets whether to move the focus to the next control when the input string is filled in maxlength or the value is changed by pressing Enter. This function works only for the English, numbers, and symbols on the keyboard. Related property: [maxLength] If the maxLength property exists, the property operates.

autocomplete

type	String
get	Returns the browser autocomplete feature settings.
set	Set the browser's autocomplete feature settings. The default is empty.

buttonFocusable

type	Boolean
get	Returns the set value to focus on the button.
set	Sets the focus to the button.

clearButtonImage

type	String
get	clear button Returns the image.
set	clear button Set the image.

displayExp

type	#expression
get	Returns the expression for the text displayed when not in focus.
set	Set the Expression for the text shown when not focused. It does not apply if the Secret property is true.

displayText

deprecatedPlease use displayText.

declaring type	TextInput
type	String
readonly	Gets the value of the HTML Element shown in the input.

displayingText

declaring type	TextInput
type	String
readonly	Gets the value of the HTML Element shown in the input.

disposed

declaring type	Control
type	Boolean
readonly	Returns whether the control should be removed.

editable

declaring type	UIControl
type	Boolean
readonly	Returns whether the value can be changed by user action. UIControl (Output, etc.) that does not allow input returns false. In the case of an inputtable UIControl, returns true if the binding context in which the value is bound is valid. Otherwise, it returns false even if it is an inputtable UIControl. Accordion/Button/Group/Dialog/EmbeddedApp/EmbeddedPage/Grid/HTMLObject/Image/MDIFolder/Menu/ NavigationBar/Notifier/Output/Progress/TabFolder/Shell/FileUpload In the case of the above control, editable is always false.

enabled

declaring type	EnableUIControl
type	Boolean
get	Returns whether the control is enabled.
set	Sets whether to activate the control.

fieldLabel

declaring type	UIControl
type	String
get	Returns the logical field name of the control.
set	Sets the logical field name of the control.

focusable

declaring type	UIControl
type	Boolean
readonly	Returns whether the control is focusable.

focused

declaring type	UIControl
type	Boolean
readonly	Returns whether the control has focus.

declaring type	Control
type	String
readonly	Returns the ID of the control.

imeMode

type	String
get	IE, FireFox Returns the HanYou conversion setting in the browser.
set	Korean-English translation settings for keyboard IME in IE, FireFox browsers. Use the CSS ime-mode attribute. Depending on the supported browser version, it may not be supported, so please check the MDN document. [auto] : Do nothing about the current inputbox's ime settings. [active] : By default, Hangul is input. [inactive] : Accepts English input as a default value. [disabled] : Only English input is accepted.

inputFilter

type	#expression
get	Gets the regexp for the input character.
set	Specifies the regexp for the input character.

inputMode

type	InputMode
get	The browser returns the array type of the keyboard that displays the virtual keyboard.
set	Set the array type of the keyboard that displays the virtual keyboard in the browser.

length

type	Number
readonly	Returns the length of the input value (string) of inputbox.

lengthUnit

type	String
get	Returns the unit of the total string length in the compilation area.
set	Sets the unit of the total string length in the editing area. [char]: Length of the character. [utf8]: The character based on utf8 byte size. [ascii]: character based on ascii byte size.

maxLength

type	Number
get	Returns the maximum number of characters that can be entered.
set	Sets the maximum number of characters that can be input. Related property: [lengthUnit] Set according to the lengthUnit property.

name

declaring type	UIControl
type	String
get	Returns the name of the control.
set	Sets the name of the control.

placeholder

type	String
get	Returns a text (hint) for the description or expected value.
set	Set a text (hint) for the description or expected value.

readOnly

declaring type	EnableUIControl
type	Boolean
get	Returns whether a non-modifiable read-only mode is in effect.
set	Sets whether to enable read-only mode, which can not be modified.

secret

type	Boolean
get	Returns whether input method password is set.
set	Sets whether or not to set password for input method.

showClearButton

type	Boolean
get	Returns whether the clear button is displayed
set	Sets whether to display the clear button.

spellCheck

type	Boolean
get	Returns the setting values for the ability to check English spelling and grammar.
set	Turn on the browser to check spelling and grammar in English.

style

type	InputBox$Styler
readonly	Returns the style settings of the control. In case of style changes, only the corresponding control is updated. Propagation from style changes does not occur.

tabIndex

declaring type	AccessableUIControl
type	Number
get	Returns the control focus sequence using the Tab Key. This property controls the tabindex in HTML.
set	Set the control focus order using Tab Key. This property controls the tabindex in HTML.

text

declaring type	TextInput
type	String
get	Returns the text shown in the control.
set	Sets the visible text in the control.

tooltip

declaring type	VisibleUIControl
type	String
get	Returns a description of the control It works when mouse over.
set	Set a description for the control. It works when mouse over.

type

declaring type	Control
type	ControlType
readonly	Returns the signature string of the Control's unique Type that can distinguish the Control. Please refer to ControlType for available constant values. For UDC controls, each unique type name is returned. Example: udc.MyUDC

uuid

declaring type	Control
type	String
readonly	Returns the unique ID of the control.

value

declaring type	TextInput
type	String
get	Returns the value of the control.
set	The value of the control is set, and a value-change event is raised.

visible

declaring type	VisibleUIControl
type	Boolean
get	Returns the style property for controlling css visibility.
set	Sets the style property to control css visibility.

Methods

addEventListener(type, listener)

declaring typeUIControl

Add listeners by EventType to the control.
Add a listener to the control to handle when a specific event occurs.

var button = new cpr.controls.Button("btn01");
button.addEventListener("click", function(e) {
// event code...
});

Parameters

name	type		description
type	String
listener	(e: cpr.events.CEvent)=>Void

addEventListenerOnce(type, listener)

declaring typeUIControl

Add a listener to the control that will run only once per EventType.
Add a listener to the control to handle when a specific event occurs. The added listener is automatically deleted after running once. Since the object of the added listener is changed, when the listener is deleted It is an object returned after calling addEventListenerOnce and can be deleted.

var button = new cpr.controls.Button("btn01");
button.addEventListenerOnce("click", function(e) {
// event code...
});

Parameters

name	type		description
type	String
listener	(e: cpr.events.CEvent)=>Void

return	(e: cpr.events.CEvent)=>Void	The modified Listener object.

bind(name)

declaring typeUIControl

Bind that property.

Parameters

name	type		description
name	String

return	IBindFactory	Factory showing bind type.

blur()

declaring typeUIControl

Removes focus from the control.

clear(emitEvent)

Set the input box value to an empty value.
Raises the clear event.

Parameters

name	type		description
emitEventoptional	Boolean	default`true`	Whether to trigger the clear event

confirmEvent(e)

declaring typeTextEditor

Determines whether to run the Control's Default Event Handler depending on the state of the Control.

Parameters

name	type		description
e	CEvent		event

return	Boolean	Whether the control's event handler is running.

dispatchEvent(e)

declaring typeUIControl

Forwards specific events.

Parameters

name	type		description
e	CEvent

return	Boolean	Whether to continue processing the default action after propagating the event.

dispose()

Removes the objects contained in the control.

findParent(predicate, includeSelf)

declaring typeUIControl

Find the parent control.
If includeSelf is true, the parent including the self is found.

Parameters

name	type		description
predicate	(c: cpr.controls.UIControl)=>Boolean
includeSelfoptional	Boolean	default`false`	Whether you include yourself.

return	UIControl	Parental control.

focus(forward)

Assigns focus to the control.

Parameters

name	type		description
forwardoptional	Boolean	default`true`

focusNext()

declaring typeUIControl

Moves focus to the next control. If there are multiple structural elements that have focus inside a control, focus may transition to the next element.

focusPrevious()

declaring typeUIControl

Moves focus to the previous control. If there are multiple structural elements that have focus inside a control, focus may transfer to the previous element.

getActualRect()

declaring typeUIControl

Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values of 0 is returned.

return	Rectangle	About the position and size of controls in the HTML DOM

getActualRect(includeWrap)

declaring typeUIControl

Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values of 0 is returned.

Parameters

name	type		description
includeWrap	Boolean		If this value is true, the layout of the parent group gets the area of the node surrounding this control. If false, only get the area of the control node.

return	Rectangle	About the position and size of controls in the HTML DOM

getActualRect(options)

declaring typeUIControl

Gets the bounds value of the control relative to the browser's view port. If the control is not drawn on the screen, an object with all values 0 is returned.

Parameters

name	type		description
options	{ includeWrap?: Boolean, scaled?: Boolean }

return	Rectangle

getAppInstance()

declaring typeUIControl

Returns the App to which the control belongs.

return	AppInstance	App that belongs

getBindContext()

declaring typeUIControl

Returns the bind context.

return	BindContext	bind context

getBindInfo(name)

declaring typeUIControl

Returns the bind property information for the control.

Parameters

name	type		description
name	String

return	BindInfo	BindInfo Properties

getHtmlAttrNames()

declaring typeUIControl

Returns all custom DOM DATA attribute names.

return	String[]	An array of all custom DOM DATA attribute names.

getNextControl()

declaring typeUIControl

Returns the control to be moved by Tab Key or by the autoskip property.

return	UIControl	control.

getOffsetRect(includeWrap)

declaring typeUIControl

The area being displayed is obtained based on the parent container to which it belongs.

Parameters

name	type		description
includeWrapoptional	Boolean	default`false`	If this value is true, the layout of the parent group gets the area of the node surrounding this control. If false, only get the area of the control node.

return	Rectangle

getParent()

declaring typeUIControl

Gets the parent control.

return	Container	Parental control.

getPrevControl()

declaring typeUIControl

Shift + Tab Returns the focus to be moved through the key.

return	UIControl	control.

getRangedText(range)

declaring typeTextEditor

Returns the text corresponding to the selection range of the input box.

Parameters

name	type		description
range	{ start: Number, end: Number }		selection range

return	String

getRangedText(start, end)

declaring typeTextEditor

Returns the text corresponding to the entered selection range.

Parameters

name	type		description
start	Number		Start selection range
end	Number		end of selection

return	String

getSelectedRange()

declaring typeTextEditor

Get information about the selection area of the input box.

return	{ start: Number, end: Number }	selection area

getSelection()

declaring typeTextEditor

deprecatedPlease use the getSelectedRange, getRangedText API.

Returns the selection area (start, end, text).
A selection area represents information with a starting location, ending location, and text to select.

return	{ start: Number, end: Number, text: String }	Information about the selection area (start, end, text).

getUserAttrNames()

declaring typeControl

Returns all custom attribute names.

return	String[]	An array of all custom attribute names.

getVisualParentControl()

declaring typeUIControl

Gets the closest parent UI control. Unlike getParent(), it finds nearby parent controls, including external apps.

return	UIControl

htmlAttr(key, value)

declaring typeUIControl

Specifies custom DOM properties.

Parameters

name	type		description
key	String		The attribute name to assign
value	String		The attribute value to specify.

htmlAttr(key)

declaring typeUIControl

Returns a custom DOM property.

Parameters

name	type		description
key	String		The attribute name to get.

return	String	Custom properties.

htmlAttr(values)

declaring typeUIControl

Specify multiple custom DOM properties at once.

Parameters

name	type		description
values	{[key:string]: String}		A JSON object containing custom attribute keys/values.

htmlAttr()

declaring typeUIControl

Get all custom DOM properties in the form of a map.

return	{[key:string]: String}

isAvailableBinding(name)

declaring typeUIControl

Returns whether the queried property is bindable and the binding has been configured to obtain a valid value. Even if no binding is configured and a simple value is specified, it is treated as configured so that a valid value is obtained. For example, binding to a row index that does not exist in the DataSet is an invalid binding.

Parameters

name	type		description
name	String

return	Boolean

isBindable(name)

declaring typeUIControl

Make sure it is a bindable property.

Parameters

name	type		description
name	String

return	Boolean	Confirmation.

isFloated()

declaring typeUIControl

Returns whether the control is floating through an app instance or a specific container.

return	Boolean

isShowing()

declaring typeUIControl

Returns the status that the screen is showing. Returns false if the visible state of all parents including itself is false.

return	Boolean

putValue(value)

declaring typeTextInput

Sets the value of the control.

Parameters

name	type		description
value	String		The value of the control.

redraw()

declaring typeUIControl

Redraw the control.

removeAllEventListeners()

declaring typeControl

Removes all event listeners for the control.

removeAllHtmlAttr()

declaring typeUIControl

Delete all custom DOM DATA attributes.

removeAllUserAttr()

declaring typeControl

Delete all custom attributes.

removeEventListener(type, listener)

declaring typeControl

Remove Listener for each EventType in the control.

control.removeEventListener ('click', listener);


      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              type
              
              String
              Event type.
            
            
              listener
              
              (e: cpr.events.CEvent)=>Void
              Event listeners.


    
      removeEventListeners(type)
      declaring typeControl
      
      Remove all EventType listeners from the control. 

control.removeEventListeners ('click');  

      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              type
              
              String
              Event type.
            
          
        
      
    

    
      removeHtmlAttr(key)
      declaring typeUIControl
      
      Removes the user-defined DOM DATA attribute for a specific attribute name.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              key
              
              String
              The custom DOM DATA attribute name to remove.
            
          
        
      
    

    
      removeUserAttr(key)
      declaring typeControl
      
      Removes user-defined attributes for a specific attribute name.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              key
              
              String
              The custom attribute name to remove.
            
          
        
      
    

    
      setBindContext(context)
      declaring typeUIControl
      
      Sets the bind context.
container.setBindContext({dataControl:grid.dataSet,rowIndex:rowIndex})
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              context
              
              BindContext
              bind context
            
          
        
      
    

    
      setNextControl(nextControl)
      declaring typeUIControl
      
      Sets the control to be moved by Tab Key or by the autoskip property.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              nextControl
              
              UIControl
              control.
            
          
        
      
    

    
      setPrevControl(prevControl)
      declaring typeUIControl
      
      Shift + Tab Set the focus to be moved through the key.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              prevControl
              
              UIControl
              control.
            
          
        
      
    

    
      setRangeText(replacement, start, end)
      declaring typeTextEditor
      
      Replace or insert a string in the selection range of the input box.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              replacement
              
              String
              String to replace or insert
            
            
              start
              
              Number
              Start of range to replace
            
            
              end
              
              Number
              end of range to replace
            
          
        
      
    

    
      setRangeText(replacement, range)
      declaring typeTextEditor
      
      Replace or insert a string in the selection range of the input box.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              replacement
              
              String
              String to replace or insert
            
            
              range
              
              {
  start: Number,
  end: Number
}
              Range of strings to replace
            
          
        
      
    

    
      setSecurityProp(prop)
      Set css class, style, and attribute to be set in the input tag in order to link with external security tools such as keyboard security tools.
Properties with the same name as inline properties declared in InputBox take precedence over property values declared in InputBox.
Only properties that are essential for integration should be declared and used.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              prop
              
              {
  class: String[],
  attr: {[key:string]: String},
  style: {[key:string]: String}
}
              Security attribute to register
            
          
        
      
    

    
      setSecutiryProp(prop)
      deprecatedPlease use setSecurityProp.
      
      Set css class, style, and attribute to be set in the input tag in order to link with external security tools such as keyboard security tools.
Properties with the same name as inline properties declared in InputBox take precedence over property values declared in InputBox.
Only properties that are essential for integration should be declared and used.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              prop
              
              {
  class: String[],
  attr: {[key:string]: String},
  style: {[key:string]: String}
}
              Security attribute to register
            
          
        
      
    

    
      setSelection(selection)
      declaring typeTextEditor
      
      deprecatedPlease use the setSelectionRange, setRangeText API. 2024.07.13 This API is not used.
      
      The text entered is replaced or inserted in the selected selection area, and the focus is moved.

editor.setSelection({start: 0, end: 8, text: "inputbox"});
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              selection
              
              {
  start?: Number,
  end?: Number,
  text?: String
}
              Text to select, insert, or replace
            
          
        
      
    

    
      setSelectionRange(selectionStart, selectionEnd)
      declaring typeTextEditor
      
      Set the selection area of the input box.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              selectionStart
              
              Number
              Start selection
            
            
              selectionEnd
              
              Number
              end of selection
            
          
        
      
    

    
      unbind(name)
      declaring typeUIControl
      
      Unbind that property.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              name
              
              String
              
            
          
        
      
    

    
      userAttr(key, value)
      declaring typeControl
      
      Specifies custom properties.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              key
              
              String
              The attribute name to assign
            
            
              value
              
              String
              The attribute value to specify.
            
          
        
      
    

    
      userAttr(key)
      declaring typeControl
      
      Returns a user-defined property.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              key
              
              String
              The attribute name to get.
            
          
        
      
      
        
          
            return
            
            String
            Custom properties.
          
        
      
    

    
      userAttr(values)
      declaring typeControl
      
      Specify multiple custom properties at once.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              values
              
              {[key:string]: String}
              A JSON object containing custom attribute keys/values.
            
          
        
      
    

    
      userAttr()
      declaring typeControl
      
      Get all custom properties in the form of a map.
      
        
          
            return
            
            {[key:string]: String}
            
          
        
      
    

    
      userData(key, value)
      declaring typeControl
      
      Specifies custom data. Unlike user-defined attributes, you can use arbitrary types in addition to strings.
When the control is dispose, all custom data is removed.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              key
              
              String
              The key of the data to be specified.
            
            
              value
              
              Object
              Data to specify.
            
          
        
      
    

    
      userData(key)
      declaring typeControl
      
      get custom data
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              key
              
              String
              The key of the data to get.
            
          
        
      
      
        
          
            return
            
            Object
            
          
        
      
    

    
      userData(override)
      declaring typeControl
      
      Specifies multiple user-defined data.
      
        Parameters
        
          
            
              name
              type
              description
            
          
          
            
              override
              
              {[key:string]: Object}
              A JSON object containing user-defined data.
            
          
        
      
    

    
      userData()
      declaring typeControl
      
      Get all your custom data.
      
        
          
            return
            
            {[key:string]: Object}
            
          
        
      
    

    
      userattr()
      declaring typeControl
      
      deprecatedPlease use userAttr.
      
      Returns a user-defined property.
      
        
          
            return
            
            Object
            Custom properties.

name	type		description
type	String		Event type.
listener	(e: cpr.events.CEvent)=>Void		Event listeners.

name	type	description
replacement	String	String to replace or insert
start	Number	Start of range to replace
end	Number	end of range to replace

name	type		description
selectionStart	Number		Start selection
selectionEnd	Number		end of selection

name	type		description
key	String		The key of the data to be specified.
value	Object		Data to specify.