Autocomplete

This post is referring to Vahana 2 (beta version). To check the document for production, please go to vDesigner-v1.0

The “Autocomplete” element provides the auto-search option. It is a dropdown type element. After the user enters a value in the “Search” box, the dropdown list displays the near-term values or the exact value.   

For example: – You can use the “Autocomplete” element if the dropdown list contains several assorted values.

Usage

When to use
Use the “Autocomplete” element when a dropdown list contains a huge list of values and the end-user may face difficulty finding a specific value by scrolling down the list.

Autocomplete Configuration

The “Autocomplete” element consists of the following properties:

  • UI Configuration
  • Event Configuration

UI Configuration

TabProperty NameDescriptionMandatoryNew Default ValueVisibility Rules
BasicReference NameSpecifies a unique name of the element. At the application level, an element is identified and managed by the reference name.Yes





SingleSelect 1
BasicCaptionSpecifies the title of the element.NoSingle Select
BasicInput SourceThis property allows you to configure the source location for the following purposes:
–> Fetch data from the source and the display it on the element.
–> Store data in the source.


You can click one of the following tabs to configure the input source:
1) Data Store:-
If you select this tab, the Input Value box appears. In the Input Value box, select an entity so that the application fetches the data from the entity and then displays it in the element.

Note:- To define the entity, you can refer to the Sample Array of Objects screen capture at the end of the post.

2) Enumeration:-
If you select this tab, a Select Master list appears. Click the Select Master list, and then it displays a list of enum objects from the Data Modeler module. In the list, select an enum object. After you select an enum object, the application will access the enum object to fetch the data and then display it in the element.



Note:– To use the enum object, you need to define the enum object in the Data Modeler. For reference, see the screen capture at the end of the post.
NoData Store
BasicInput ValueClick in the Input Value box, and a smart selector expands. In the smart selector, select the entity so that the application can fetch data from the entity and then display it in the element.Yes{{fx}}When Input Source = Data Store
BasicMappingThis property allows you to map the key or attribute of an entity.NoWhen Input SourceData Store
BasicCodeIn this box, enter the attribute’s name that contains the code of the value.

Note:- To understand how to define an attribute that stores a code, see the Sample Array of Objects screen capture at the end of the post.
YesWhen the Mapping check box is selected
BasicValueIn this box, enter the attribute’s name. This attribute stores the actual value that the application displays in the element.

Note:- To understand how to define an attribute that stores the element’s value, see the Sample Array of Objects screen capture at the end of the post.
YesWhen the Mapping check box is selected
BasicVisibleAllows you to define the default visibility of the UI element. NoYes
BasicBusiness RuleClick this list and then select a pre-defined business rule that will determine the element’s visibility. If the user’s action satisfies the condition in the business rule, the application will display or hide the element.

To define the business rule, access the Business Rule Manager module.
No
BasicEnableAllows the user to enable/disable an element. You can decide whether the element needs to be clickable and usable.NoYes
BasicBusiness RuleClick this list and then select a business rule to make the element active or inactive. If the user’s action satisfies the condition in the business rule, the application will make the element active or inactive in the application.

To define the business rule, access the Business Rule Manager module.
No
BasicMandatoryAllows you to configure the element as a mandatory element.NoNo
BasicMessage on FailureThis property becomes visible when you select Yes under Mandatory. In the Message on Failure box, enter the error message that the application will display if the user does not perform the function on the element.NoRequiredwhen Mandatory = checked
BasicDefault ValueThis property allows you to define the default value of an element.

To define the default value:
–> Click in this box, and it displays the list of the pre-define functions, attributes, and element IDs.
–> In the list, select an attribute from which the application will fetch the default value and then display it in the element.
BasicParent Element IDIn this list, you can select the ID of an element. Based on the selected ID of an element, the current element will display the list of values.

To select the element ID:
i. Click in this box, and it displays the list of the pre-defined functions, attributes, and element IDs.
ii. In the list, select an element’s ID.
UI PropertiesStylesAllows you to select a specific style for the element from the list of pre-defined styles. The vDesigner module offers pre-defined styles that you can apply to the element.NoDefault
UI Properties-
Background
ColorClick the Color list and then select the color to define the background color of theNoTheme Variable (Neutral)
UI Properties-
Background
OpacityOpacity is the degree to which content behind an element is hidden, and is the opposite of transparency.No100%
UI Properties- Alignment & SpacingMarginAllows you to desirably define margin around each side of the element. It provides four different boxes to define the margin outside the right, left, top, and bottom border of the element.NoTheme Variable (Margin)
UI Properties- Alignment & SpacingElement’s AlignmentThis property contains three tabs. You can use these tabs as follows:
1. Left:- By default, this tab is selected. It aligns the element to the left of the page.
2. Center:- If you select this tab, it aligns the element at the center of the page.
3. Right:- If you select this tab, it aligns the element to the right of the page.
NoLeft
UI Properties- CaptionFontSelect the font type (For example: – Arial) of the element?s caption.No
UI Properties- CaptionSizeEnter the font size of the caption.NoTheme Variable (Font Family)
UI Properties- CaptionColorSelect the color of the font of the caption.NoTheme Variable (Caption)
UI Properties- CaptionStyleSelect the style of font (For example:- Italic) of the captionNoNormal
UI Properties- CaptionBoldEnter the thickness of the character of the element?s caption in the range of values from 1 to 9.No
UI Properties- IconPrefix SourceAllows you to configure an icon that you want to use with the element. After you configure the icon, the app will display the icon to the left of the element.

You can use the following options to configure the icon:
–> None
–> URL
–> Asset Library
NoNone
UI Properties- IconPrefix URLIn this box, enter the URL of the icon. The application fetches the icon from the URL-based location and then displays it to the left of the element.YesIf prefix Source = URL
UI Properties- IconSelect Prefix IconAllows you to fetch the image of icon from the Assets Manager module. In this box:
–> Click the asset library icon (), and the Select Asset dialog box opens.
–> In the Select Asset dialog box, select an icon, and then click Select, and you successfully configure the image of the icon.
YesIf prefix Source = Assets
UI Properties- IconPrefix SizeIn this box, enter the numeric value (for example:-14) to define the size of the icon.Yes16When Prefix != None
UI Properties- IconPrefix ColorClick the Color box and then select the color to define the color of the icon.

Note: – The ?Color? property can only be configured for ?Material? icons. If you have defined the URL to load the image, the ?Color? property cannot be applied to the URL-based images.
Yes#161616When Prefix != None
UI Properties- IconSuffix SourceAllows you to configure an icon that you want to use with the element. After you configure the icon, the app will display the icon to the right of the element.

You can use the following options to configure the icon:
–> None
–> URL
–> Asset Library
NoNone
UI Properties- IconSuffix URLIn this box, enter the URL of the icon. The application fetches the icon from the URL-based location and then displays it to the right of the element.YesWhen Suffix = URL
UI Properties- IconSelect Suffix IconAllows you to fetch the image of icon from the Assets Manager module. In this box:
–> Click the asset library icon (), and the Select Asset dialog box opens.
–> In the Select Asset dialog box, select an icon, and then click Select, and you successfully configure the image of the icon.
YesIf Suffix Source = Assets
UI Properties- IconSuffix SizeIn this box, enter the numeric value (for example:-14) to define the size of the icon.Yes16When Suffix != None
UI Properties- IconSuffix ColorClick the Color box and then select the color to define the color of the icon.

Note: – The ?Color? property can only be configured for ?Material? icons. If you have defined the URL to load the image, the ?Color? property cannot be applied to the URL-based images.
`#161616When Suffix != None
UI Properties- Shape & DecorationTypeUnder the Shape and Decoration section, this property has the two following options:

Autofill:-  If you select this option, the element will occupy the available space of the parent layout.

Manual:- If you select this option, you can define a specific size of the element.
UI Properties- Shape & DecorationWidth ValueEnter the width of the element in the pixel unit.No100%
UI Properties- Shape & DecorationHeight ValueEnter the height of the element in the percentage unit or pixel unit.NoSet as _and Disable
UI Properties- Shape & DecorationXAllows you to move the element along the X-axis; when the value increases, the element moves from left to right.NoShow and Disable
UI Properties- Shape & DecorationYAllows you to move the element along the Y-axis; when the value increases, the element moves from top to bottom.NoShow and Disable
UI Properties- Shape & DecorationBorder ColorClick the first box and then define the color of the element?s border.No#C6C6C6
UI Properties- Shape & DecorationBorder RadiusAllows you to define the radius of any of the corners of the element. Defining the radius of the corner makes the corner of the element round.NoTheme Variable (Border Radius)
UI Properties- HintTextIn this box, enter the text that appears as a hint in the “Autocomplete” element. The hint text helps the user perform the function on the element.NoPlease select
UI Properties-HintSizeEnter the size of the font of the hint text.No14
UI Properties-HintColorClick in the Color box and then define the font color of the hint text.No#6F6F6F
UI Properties-
Option
FontClick this list to select the type of font (for example: – Calibri) of the item descriptor.

Note: – The item descriptor is the option or value that the “Autocomplete” element displays to the end-user.
NoTheme Variable (Font Family)
UI Properties-OptionSizeIn this box, enter the size of the font (for example: – 16) of the item descriptor.No14
UI Properties-OptionColorClick the Color box and then select the color of the font of the item descriptor.NoTheme Variable (Answer Text)
UI Properties-OptionBoldIn this box, enter the numeric value (for example: – 6) that defines the thickness of the font of the item descriptor.No4
UI Properties-OptionStyleClick this list to select any of the following styles of the item descriptor?s font:NoNormal
DataEntity PathThis property allows you to map an attribute to the element. You define the JSON based attributes in the entity in the Data Modeler module.

To define the entity path:
–> Click in the Entity Path box, and a list expands.
–> The list displays several attributes from the entity.
–> In the list, select an attribute to map it to the element.

After the user performs the function on the element, the application can perform the following functions:
a. Fetches data from the attribute and then displays it in the element.
b. Stores data in the attribute.
YesEntityNamethis.entityObj(‘N’)
DataKeyboard TypeThis list displays different data types and data formats. In the list, select a data type or format.

After you select a data type or format (For example:- Number), the application opens a keyboard in the selected data format so that the user can enter the data in the required format.
SecurityRegexIn this box, enter a regular expression based condition. The regex based condition first validates the options and then the app displays these options in the dropdown list. No
SecurityCopy and PasteClick this check box to activate the feature to copy the value of the dropdown list and paste it elsewhere.NoSelected
Security Properties-BasicData MaskingThis property allows you to mask the data. After you click the Data Masking check box, the following boxes appear:
1. Masking Type
2. N
3. Masking Symbol
NoClear Check box
Security Properties-BasicMasking TypeClick this list to select one of the following options:
1. From Start
This option masks a specified number of characters (for example:- **ample123) from the left.

2. From End
This option masks a specified number of characters (for example:- Example1**) from the right.

3. From Start & End
This option masks specified numbers of characters (for example:- **ample***) from the left and right of the string.

4. Except Start
This option masks all characters except a specified number of characters (for example:- Ex********) from the left.

5. Except End
This option masks all characters except a specified number of characters (for example:- ********23) from the right.

6. Except Start & End
This option masks all characters except specified numbers of characters (for example:- Ex*****123) from the left and right.

7. All Alphabets
This option masks all alphabets (for example:- *******123) in the string.

8. All Numbers
This option masks all numbers (for example:- Example***) in the string.

9. All
This option masks all characters in the string.
NoFrom StartIf Data Masking check box is selected
Security Properties-BasicNThis box comes into view after you click the Data Masking check box.

In this box, enter a numeric value that specifies the number of characters that are masked from right or left in the string.

For example:- If you select From Start in the Masking Type list and then enter 4 in the N box, the data masking property masks four characters from the left.

If you select From End in the Masking Type list and then enter 4 in the N box, the data masking property masks four characters from the right.
NoIf Data Masking check box is selected
Security Properties-BasicMThis box comes into view after you select From Start & End in the Masking Type list.

In the M box, enter a numeric value that specifies the number of characters that the Data Masking feature masks from the right of the string.

For example:- If you enter 4 in the M box, the data masking property masks four characters from the right.
YesIf Masking Type = From Start & End
Security Properties-BasicMasking SymbolClick this list and then select one of the following characters that you can use as a masking symbol or character:
1. *
2. &
3. %
4. $
5. #
6. @
7. x
8. –
9. +
NoIf Data Masking check box is selected

Event Configuration

On the “Autocomplete” element, you can configure the following event:

  • onSelect

Sample Array of Objects in the Data Modeler module

Sample enum in the Data Modeler module

Was this article helpful?
YesNo