Auto Complete Text Field

Auto Complete Text Field

Download PDF

Auto Complete Text Field

The Autocomplete Text Field provides suggestions while you type into the field. A text field allows the user to type text into your app. Touching a text field places the cursor and automatically displays the keyboard. In addition to typing, text fields allow for a variety of other activities, such as text selection (cut, copy, paste) and data look-up via auto-completion.


You have this feature with Configure.IT, wherein you can customize the properties needed from Property Action window of the said control.

    Keywords:
  • auto complete text
  • text field

Properties

  • Custom Border
    PARAMETER
    DESCRIPTION
    Border Width

    Sets border width for a Auto Complete Text Field.

    Border Corner Radius

    Sets radius with which control's rounded corners should be drawn. Setting this property will enable control appear with rounded corners.

    Border Color

    Sets the border color for a control. Works only if "Border Width" property is set to a value more than 0. Default would be black color.

    Dash Width For Dashed Border

    Sets width of each dash in dashed border pattern for a Auto Complete Text Field.

    Space Between Dashes For Dashed Border

    Helps set the spacing between Dashes for Dashed Border.

    Transform Angle

    Sets angle in degrees to which the Auto Complete Text field is in its normal state, has to be rotated. Possible values for this property are -360 to 360.

  • Display/Text
    PARAMETER
    DESCRIPTION
    Text

    Sets text to be displayed on Auto Complete Text Field.

    Text Color

    Used to set the color of the Auto Complete Text Field.

    Font Family

    Sets the font of the text to be displayed.

    Font Size

    Sets the font size of the text to be displayed.

    Text Alignment
    Used to set the alignment of the text
    Placeholder

    The styled string that is displayed when there is no other text in the text field.

    Minimum Font Size

    The size of the smallest permissible font with which to draw the text.

    Adjusts Font Size To Fit

    A Boolean value indicating whether the font size should be reduced in order to fit the title string into the object's bounding rectangle.

    Custom Font Name

    Sets custom font name (special font, not available in default fonts) for text to be displayed in Text Field.

  • Display
    PARAMETER
    DESCRIPTION
    Border Style

    Choose from the different available options and style the border used by the Text Field.

    Clear Button Mode

    Sets the mode of the button in terms of its appearance and visibility.

    Clears On Begin Editing

    A Boolean value indicating whether the Text Field removes old text when editing begins.

    Keyboard Type

    Choose from the range of available types and set the keyboard style associated with the text object.

    Keyboard Appearance

    The appearance style of the keyboard that is associated with the text object. The appearance can be set as either Default or Alert.

    Return Key Type

    The contents of the “return” key can be set from the various available options as Default, Go, Google, etc. from the drop down.

    Enables Return Key Automatically

    A Boolean value indicating whether the return key is automatically enabled when the text is entered by the user.

    Content Horizontal Alignment

    Sets the horizontal alignment for content (text or image or both) of button.

    Content Vertical Alignment

    Sets the vertical alignment for content (text or image or both) of button.

    Enabled

    A Boolean property to indicate whether the gesture recognizer is enabled.

    User Interaction Enabled

    Enables the Interaction with user, i.e. control responds when user taps on it.

    Alpha

    Used to set the transparency to the Button which ranges from 0 to 1.

    Background Color

    Used to set the background color to the Text Field.

  • CIT Custom Properties
    PARAMETER
    DESCRIPTION
    Allow Data From DataSource Only

    This property is for enabling Auto Complete Text Field selection from data source which was populated on "LOAD" or "Auto Complete Text Field Editing" events.

    Enable Single Selection

    This property specifies whether selection should be single selection or not. i.e only one value can be selected at a time if this property is enabled.

    Allow Duplicate Values

    This property is for enabling selection of same value more than once form Auto Complete Text Field control. If this property is enabled user can select a value more than once else user can select a value from search results only once.

    Dismiss Keyboard On Selection

    This property is for enabling dismissal of keyboard when user selects a suggestion from Auto Complete Text Field suggestions. If this property is enabled keyboard will be dismissed on selection else not.

    Place Holder Text Color

    Sets the desired color for Placeholder Text.

    Suggestions View BG Color

    This property sets background color for suggestions view.

    Suggestions Text Color

    This property sets color for suggestions text.

    Suggestions Text Size

    This property sets font size for suggestions text.

    Separator For Multiple Selection

    This property is for setting divider string for multiple selected values. Default string is ",".

    Input Accessory View Id

    The control that will be displayed in the toolbar above the keyboard when user will start entering data in the Text Field.

  • Object
    PARAMETER
    DESCRIPTION
    Xpos

    Sets the X position of the Auto Complete Text Field.

    YPos

    Sets the Y position of the Auto Complete Text Field.

    Width

    Sets the width of the Auto Complete Text Field.

    Height

    Sets the height of the Auto Complete Text Field.

    Object ID

    Sets unique identifier for the control. Control can be referenced with name set in this property for configuration.

    Object Parent ID

    Set "Object ID" of Auto Complete Text Field which contains this control or can serve as parent.

    Key Name To Data

    Sets the web service key from data received from web server, which corresponds to the value to be displayed on the control.

    Key To DataSource

    Sets “key name to datasource” for a particular part of datasource as Auto Complete Text Field datasource.

    Key to Data Index

    Select the Web service key data which will be retrieved as output based on selection.

  • Vertical
    PARAMETER
    DESCRIPTION
    Vertical Group

    Group of vertical android default properties.

    Reference Type

    These are the android default properties to set selected view with respect of other view.

    Reference Value

    Reference object that is used for positioning selected object

    Offset Type

    marginTop : Specifies extra space on the top side of this view. This space is outside this view's bounds.
    marginBottom : Specifies extra space on the bottom side of this view. This space is outside this view's bounds.

    Offset Value

    Value defines the extra space value in pixel.

    Center Vertical

    This property centers the child vertically with respect to the bounds of its parent view.

    Apply Vertical Custom Properties

    If any of the vertical layout setting parameter(s) are selected then this value is selected to indicate user applied vertical custom layout setting parameter(s).

  • Horizontal
    PARAMETER
    DESCRIPTION
    Horizontal Group

    Group of horizontal android default properties.

    Reference Type

    Reference type is the the default property to set selected view with respect to other view.

    Reference Value

    Reference object that is used for positioning selected object.

    Offset Type

    marginLeft : Specifies extra space on the left side of this view. This space is outside this view's bounds.
    marginRight : Specifies extra space on the right side of this view. This space is outside this view's bounds.

    Offset Value

    Offset Value defines the extra space value in the pixel.

    Center Horizontal

    This property centers the child horizontally with respect to the bounds of its parent view.

    Apply Horizontal Custom Properties

    If any of the horizontal layout setting parameter(s) are selected then this value is selected to indicate user applied horizontal custom layout setting parameter(s).

  • Display/Image
    PARAMETER
    DESCRIPTION
    Background

    The image that represents the background appearance of the Text Field when it is enabled.

    Disabled Background

    The image that represents the background appearance of the Text Field when it is disabled.

  • Display/AdvanceText
    PARAMETER
    DESCRIPTION
    Hide

    Hiding an element can be done by checking ‘Hide’. This property lets you hide the control.


    Advance - Sets auto resizing with respect to superview, for Auto Complete Text Field.

  • Layout Setting
    PARAMETER
    DESCRIPTION
    Horizontal

    Group of horizontal android default properties.

    Vertical

    Group of vertical android default properties.

    Layout Width

    Sets the width of the view
    match_parent/fill_parent : Takes the width as its parent view
    wrap_content : Takes the width as its content’s width

    Layout Height

    Sets the height of the view
    match_parent/fill_parent : Takes the height as its parent view
    wrap_content : Takes the height as its content’s height

    Left

    The padding is expressed in pixels for the left, top, right and bottom parts of the view. Padding can be used to offset the content of the view by a specific amount of pixels.


    For instance, a Left value of 2 will push the view's content by 2 pixels to the right of the left edge.

    Right

    For instance, a Right value of 2 will push the view's content by 2 pixels to the left of the right edge.

    Top

    For instance, a Top value of 2 will push the view's content by 2 pixels to the bottom of the top edge.

    Bottom

    For instance, a Bottom value of 2 will push the view's content by 2 pixels to the top of the bottom edge.

    Apply Custom Properties

    If any of the layout setting parameter(s) are selected then this value is selected to indicate user applied custom layout setting parameter(s).

    Center In Parent

    This property centers the child vertically with respect to the bounds of its parent view.

    Default Min Height

    The height of the view cannot be less than the given value.
    If user select “Default Min Height” then android default value is taken otherwise it takes 0dp.

    Default Min Width

    The width of the view cannot be less than the given value.
    If user select “Default Min Width” then android default value is taken otherwise it takes 0dp.

  • Hidden
    PARAMETER
    DESCRIPTION

Actions

  • Load

    This event is triggered on load Text Field. Hence any action can be defined [for eg: when a Text Field loads like API Call to load data to be shown on cells]. This can be configured in "LOAD" event listed under "Action(S)" tab of Text Field control.

  • Auto Complete Text View Editing

    This event is triggered when user edits "Auto Complete Text Field" control. So any actions you want perform when user edits "Auto Complete Text Field", like reloading datasource of the control, can be configured in “Auto Complete Text View Editing” event listed in ”ACTION(S)” tab of "Auto Complete Text Field" control. “currentText” is the response parameter of “Auto Complete Text View Editing”, which is text entered by user, in the control.

  • Begin Editing

    This event is triggered when user starts typing the text in the Text Field.

  • End Editing

    The action related to this event will be called when user has completed editing the text in the Text Field.

Remarks

  • Key Name To Data and Key To Data Index

    If Auto Complete Text Field’s data comes as an API call response then setting “Key Name To Data” property is mandatory. You need to set “Key Name To Data” property to a key from API response, which points to the value to be shown as suggestions. “Key To Data Index” property gives you the desired output value. In case the values shown in Auto Complete Text Field are repeating, this property will serve the purpose of differentiating/bifurcating. Set a key from API response which gives a value to identify each suggestion uniquely, in “Key To Data Index” property.

  • Allow Data From DataSource Only

    This property is for enabling auto complete text field selection from data source which was populated on "LOAD" or "Auto Complete Text View Editing" events. When this option is enabled, user can select only from search results filtered from data source associated with auto complete control; else user can select the manually typed value.

  • Dismiss Keyboard On Selection

    When user selects a suggestion from suggestions list, if you want keyboard to be dismissed enable “Dismiss Keyboard On Selection” property.