View Article

Control Text Box

By Xelence Documentation posted 05-27-2024 01:39

  

Text Box Properties:

This control is found in multiple Xelence file types. The properties related to this control and their order may vary based on the file type.

Common Section:

 Property  What it does  How to use it  Other notes
ID Programmatic unique ID to identify the control in the DOM.
  • Right-click the ID.
  • Select the Rename option.
  • Enter the text.
  Must be unique.
Class Custom style sheet class that can be applied to any HTML control. Enter the class or select from the drop-down list. Blank is the default appearance. The class must be configured in the Style tab of the form or the PortalCommon file in the application.
Style Allows user to give an inline CSS styles or style class for an element. Click the Edit Control Style icon to open the Style Editor tab and apply the desired style options. Style editor allows users to set the font size, font color, background color, margin, padding, border, etc.
Skin ID Controls text formatting of the cell. Enter the ID or select from the drop-down list.
Mode  Determines the visibility of the control based on the form mode. New is for creating new and Update is for opening existing. If the value is set to New, then the control will be visible only when the form is opened in new mode. Select from the drop-down list.

It defaults to All.

Only applicable for Maintenance and Wizard forms.
Visible If set to True, the control will appear on the form. Otherwise, it won’t. Select True or False from the drop-down list. It defaults to True. All controls have this property. Best practice is to toggle visibility at the control level, not the cell level.
Visible Condition If it evaluates to true, the control will appear on the form. Otherwise, it won’t. Enter the visible condition or select from the drop-down list.
Client Visible If set to False, the control will be hidden and not be rendered on the client side. Select True or False from the drop-down list. It defaults to True.
Placeholder This defines the text displayed in a form control when the control has no value. It basically provides a brief hint to the user as to the expected type of data that should be entered in the control. Enter the text.  


Caption Section:

Property What it does How to use it Other notes
Show Caption Allows user to see the descriptive text that appears on the control to identify or describe it. Select True or False from the drop-down list. It defaults to True.
Caption Text the user sees. Enter the text. This property is displayed only when the Show Caption property is set to true.
Caption Field Allows user to set a caption whose value is linked to the entity field. Enter the caption field or select from the drop-down list. This property is displayed only when the Show Caption property is set to true.
Caption Class Custom style sheet class that controls the caption appearance for the control. Enter the class or select from the drop-down list.

This property is displayed only when the Show Caption property is set to true.

Blank is the default appearance. The class must be configured in the Style tab of the form or the PortalCommon file in the application.
Caption Style Specifies an inline CSS style for caption. Click the Edit Caption Style icon to open the Style Editor tab and apply the different style options. This property is displayed only when the Show Caption property is set to true.
Caption Position

Allows user to specify position for caption. The available options are Top and Left.

 Select the position from the drop-down list.

This property is displayed only when the Show Caption property is set to true.

It defaults to Top.


General Section:

Property What it does How to use it Other notes
Entity ID/ Query ID Programmatic ID of the entity associated with the control. Enter the ID or select from the drop-down list.

Query ID is displayed when the Main/Sub Query Details are configured in the Configuration section of Lookup form, otherwise Entity ID is displayed by default.

Only applicable for Lookup Form.
Search Field Column whose value is linked to the control. Enter the search field or select from the drop-down list. Only applicable for Lookup Form.
Operator Operator used in the appended where clause. Enter the operator or select from the drop-down list.
Entity Field Column whose value is linked to the control. Enter the entity field or select from the drop-down list. Only applicable for Maintenance and Wizard forms.
Default Type User can set any of these values to this property: None, TextValue, TodaysDate, TodaysDateTime, MethodOnServer, System Constant, Global Parameter, Scalar Query. Select from the drop-down list. It defaults to None.
Default Value Use this property to automatically assign a value to the sfwTextbox control in new mode. The value of this property depends on the value that user has set in the sfwDefaultType property.

If sfwDefaultType property is set to None or TextValue, then set sfwDefaultValue property to any string value.

If sfwDefaultType property is set to TodaysDate or TodaysDateTime, then set sfwDefaultValue property to blank.

If sfwDefaultType property is set to MethodOnServer, then set sfwDefaultValue property to a valid method in entity. The method should return a string value.

If sfwDefaultType property is set to SystemConstant, then set sfwDefaultValue property to a valid code_value in sgs_code_value table where code_id = 52.

If sfwDefaultType property is set to Global Parameter, then set sfwDefaultValue property to any string value.

If sfwDefaultType property is set to ScalarQuery, then set sfwDefaultValue property to a valid query existing in entity. The query should return a scalar value.
Allow Non-ASCII Chars Determines whether to allow non-ascii characters in the text box or not. Examples of non-ascii characters include symbols, accented letters, etc. Select from the drop-down list.
EditMode Determines whether the control should be editable in which mode. The options are New, Update and All. Select from the drop-down list.

It defaults to All.

Only applicable for Maintenance and Wizard forms.
Enabled The control is grayed out, if set to False. Select True or False from the drop-down list.
Read Only Rule If it evaluates to true, the control will become a read only control. Otherwise, it won’t. Enter the read only rule or select from the drop-down list. Only applicable for Maintenance and Wizard forms.
ToolTip Text to display when the user rolls over the field. Enter the text.
Allowed Characters Allows user to set the type of characters. The available options are- Alphabet, Alphanumeric, Numeric and All. Select from the drop-down list.
PickList Field Allows user to set the column type of picklist field. The available options are – Value and Description. Select the picklist field from the drop-down list. It defaults to Description.
Required If set to true, checks if the user has entered a value into a control. If not, displays an error message. Select True or False from the drop-down list.

It defaults to False.
Min Length Allows user to specify minimum number of characters the user can enter. Enter the minimum length.
Max Length Allows user to specify maximum number of characters the user can enter. Enter the maximum length.
Disable Copy Paste If set to True, prevents the user from copying and pasting the value in the control. Select True or False from the drop-down list.
Is Encrypted Data Field If the field is encrypted in the database and is added in the criteria section of the form to search the records, then this property needs to be set to true. In this case, Xelence will first encrypt the field and then search the record in the database and give the results. Select True or False from the drop-down list. Only applicable for Lookup Form.


Retrieval Section:

Property What it does How to use it Other notes
Query Radio Button Executes a query to retrieve values for auto populating controls. Select the Query option. It defaults to Query option.
Rule Radio Button Executes a rule to retrieve values for auto populating controls. Select the Rule option.
Retrieval Query Query that executes to retrieve the matching values to populate selected controls. Enter the query name or select from the drop-down list. Alternatively, you can click the Base Query search icon to browse for query. This control only displays if the Query option is selected.
Retrieval Rule This property is the rule name which will be used for retrieving values. In retrieval rule, values of the entity fields are set corresponding to the controls for which the value is to be retrieved. Enter the rule name or select from the drop-down list. This control only displays if the Rule option is selected.
Retrieval Parameters Configures query/rule parameters with form controls. Enter the parameter value. Queries/ rule without parameters don’t need this.
Control Mapping Controls populated when the application executes the retrieval query or rule.

Open the Control Mapping tab and select the control fields.
After Retrieval Script Method Represents the JavaScript method which is called after the retrieval. Enter the method name.


AutoComplete Section:

Property What it does How to use it Other notes
AutoComplete Query Query the application executes to find matching values to populate the drop down of available auto complete selections. Enter the query address (entName.QueryID) or select from the drop-down list. Alternatively, you can click the Base Query search icon to browse for query. By default, the Query option is selected.
API API the application executes to find matching values to populate the drop down of available auto complete sections. Enter the File name.
Parameters Configures query parameters with form controls. Enter the parameter value. Queries without parameters don’t need this.
Display Columns Columns the application uses to populate the drop down of available auto complete selections. Open the Display Columns tab and add the desired columns.

Text entry is not possible.
Control Mapping Control the selected auto complete option populates. Open the Control Mapping tab and enter the column names against the ID.
Minimum Length Number of characters the user enters before the application displays a list of possible matches. Enter the number of characters. It Defaults to 3.
Delay Number of milliseconds following the entry of the last character before the application displays the list of options. Enter the number of milliseconds. It Defaults to 1000.


Event Section:

Property What it does How to use it Other notes
On Client Change This property value is the JavaScript method name added in the Form Level JS. When the value of the control is changed, the change event is fired, and the JavaScript method is called for any custom logic to be added on the client side (browser). Enter the JavaScript function name.
On Refresh Data

This property is useful when we have an AutoRefresh Panel on the Form. This is a hook provided after refreshing the Panel.

 Enter the JavaScript function name.


Advance Section:

Property What it does How to use it Other notes
Advance Operator This property is used for the criteria controls added for searching the records. When the operator ‘Exists’ is selected, an option is available to select the exact SQL operator to be used in query for searching records using the Advance Operator Property. If the advanced operator is not specified, then by default Xelence will use the ‘Like’ operator for that condition. Enter the text.
Allow Partial Mask Allows the user to accept partial input values, if set to True. Select True or False from the drop-down list. It defaults to False.
Allow Soundex Enables phonetic sound. Select True or False from the drop-down list. It defaults to False.
Apply Mask Gets or sets the input mask to use at run time. Select True or False from the drop-down list. It defaults to False.
Culture Language Field This property is used to specify the runtime culture format to be applied for that control. If you want the value of the control in other format other than the Application's default culture, then this property can be used to set the entity field value which will hold the culture language value. Enter the text.
Custom Attributes User can define user own attributes to be rendered on the HTML page. Click the Custom Attributes edit icon and enter the attribute name and attribute value.
Data Format This specifies how the data should be structured or formatted when an input is entered in the text box. It helps in providing a pattern to the text. Enter the data format or select from the drop-down list. Options available for data formats are date, currency, percent, and Social Security number, etc.
Export Format Allows the user to export data to different formats. Enter the export format. Different formats like PDF, XLS, XLSX, DOCSX, RTF, CSV.
Ignore Read Only If set to true, ignores the read only rule while updating an existing value or entering a new one. Select True or False from the drop-down list. It defaults to False.
Leading zero Determines whether the zero number should come before any numeric value or not. Select from the drop-down list. Options available are Allow, Keep, Deny. It defaults to Allow. This property is generally used for numeric value.
Related Control This is mainly used for action controls to set the related data table.
Related Field Allows the user to select the control to which the field must be related to. Enter the related field or select from the drop-down list.
Remove Chars

This is mainly added for controls which are passed as Retrieval parameters. If the control has a formatted value, then the parameter value for retrieval should not have formatting characters. Therefore, which character is to be removed can be specified using this property.

 Enter the text.

Related Data Table

 If the textbox is not in the data table itself but is used to update the data table, it has to be linked to the data table. Enter the data table or select from the drop-down list.
Validation Rules Use this property to get rule or collection of rules as server errors or soft errors that check validity of the user input. Click the Validation Rules icon and select the condition ID.

#Develop

#Development

#ControlsandButtons

#Xelence

0 comments
143 views

Related Content