Lookup

It is an object that presents the values from a data source or the values that the developer adds as an element to the user in the form of a table structure in the web interface and serves to select elements from this data.

If a lot of data comes from the source, it is preferable to display that data in a table structure in the Lookup object rather than in a list in the ComboBox object.

While the active screen is a form in the authoring interface, the Toolbox panel lists form objects. The object is added to the form by drag/drop from the toolbox panel.

Clicking on the object displays the "General" and "Events" tabs in the Property Viewer panel, and the properties of the object can be viewed and edited. The inheritance scheme by which the properties of the object are transferred is as follows;

General

Design

'Name' - The name of the object to be used by the system. Inside another object and on the code side, the object is accessed by the value written in the namespace.

Caption

'Title' - The part where the label text of the object is edited.

'Position' - The part of the object label that regulates whether it is positioned on the left, right or above the object.

>Choices Available : Left, Right, Top, Bottom

'Width' - This is where the width of the label field is set.

'Height' - This is the part where the height of the label field is set.

'Font' - The part of the text in the label area where the font, font, font size and color are set.

'Ellipsis' - The portion where the label text is set to appear for the part of the text that does not fit, whether the ellipsis (...) appears.

'Visible' - The part where the label field is set to be hidden or visible.

'Show Colon' - Colon next to label text (:) is the part where the expression is set to appear or not.

'Horizontal Align' - Label text; This is the portion where right-just, left-just, or center-justify settings are performed.

>Choices Can Be Made: Left, Center, Right

'Vertical Align' - Label text; This is the portion where the Justify, Snap Down, or Center settings are performed.

>Choices Available : Top, Middle, Bottom

'Mark Char' - To make the object stand out, enter *, ! is the area where characters such as can be entered.

'Mark Position' - The part where the character designated as the mark character is set to be shown at the beginning or end of the label text.

>Choices Can Be Made: AtFirst, AtLast

Datasource

'DataSource' - The field in the object that will be used to be able to list values from a data source. The data source definition that is added to the DataSource section of the project in Solution Explorer and that compiles successfully becomes selectable from the DataSource portion of the object.

'RunAtServer' - This option determines whether the query connecting to the object is run from the server or the client.

If this option is enabled, when clicking on the form in the web interface, the query is run on the server side before the form is opened, and when the form is opened, the query result is loaded into the object. When the option is made inactive, when the form is clicked in the web interface, the object starts to load the result values of the query after the form is opened.

The wait time for the query result to load takes effect at the time the form is opened with this feature active, and at the time the data is loaded into the object after the form is opened quickly when the feature is passive.

'Value Expression' - This field is visible when a data source definition is selected from the Data Source section. All columns returned from the selected data source are listed in this field. When the user makes a selection from the interface, it is determined in this field which column value the registration field of the selection will be.

For example, a query that returns a list of users is bound to the object. Let the ID (Username), FIRSTNAME (Name), EMAIL (Mail Address) columns return from the query. Because the purpose of this object is user choice, the ID column returned from the query must be selected in the Value Expression section because the unique record value of the selected user is contained in the ID column.

'Display Expression' - This field is visible when a data source definition is selected from the Data Source section. All columns returned from the selected data source are listed in this field. When the user selects from the interface, this field determines which query column the expression that will appear in the object will come from.

For example, a query that returns a list of users is bound to the object. Let the ID (Username), FIRSTNAME (First Name), LASTNAME (Last Name), EMAIL (Mail Address) columns return from the query. Since the purpose of this object is user choice, the values returned from the FIRSTNAME and LASTNAME columns of the selected user will be desired to be displayed in the object. Therefore, these column values are selected in the Visible Expression section.

The column or columns selected from the 'Display Format' - Appearance Expression field are automatically added to this field as well. The area used to specify the appearance format for element text to list in the object. In order for the elements to be displayed in a desired format, the corresponding format structure can be specified in this field. And after object selection, the value to be displayed in the object can be made to appear in the web interface to the end users in the specified format.

The types of formats that can be used in formatting can be accessed from the link (https://shopify.github.io/liquid/) in the information message that appears when the field is focused and the desired format structure can be applied to the relevant column in the View Format field.

NOTE :::note

See Display Format Examples for Display Format sample applications.

:::

Appearance

'Visible' - This is the part where the object is hidden and made visible. When this field is active, the object is visible on the form. When the field is made passive, the object becomes invisible.

'Client Visible' - When the object is not visible when the form is first opened, when it is desired to make the object visible, to make the object visible when a certain condition is met, this field is made passive so that the object is invisible on the client side. When the condition set by the code or the Rules Manager is met, the object can be made visible again. When server visibility is inactive, the client cannot intervene, but the server can intervene when client visibility is inactive.

'Enabled' - The active mode of the object is set from this field. When this feature is active, data entry can be provided to the object and the object can be edited. When the feature is passive, the object is in non-editable mode and appears passive.

'Client Enabled' - When the form is first opened, the object is not active, when a certain condition is met, etc., this field is made inactive so that the object is not active on the client side. Once the condition set by the code or the Rules Manager is met, the object can be activated again. When server activity is inactive, the client cannot intervene, but the server can intervene when client activity is inactive.

'Background Color' - The area used to give the object a background color.

'Title' - Hovering over the object with the cursor while the form is open in the interface, the text typed in this field is shown as a hint. It is a feature used to direct the end user when detailed information about the object is desired.

'ClassName' - The field in which the object visibility can be changed by defining a class written in the CSS file of the form.

'Size Type' - This is where the object selection area size is set.

>Choices Can Be Made : Small, Middle, Large

'Placeholder' - A property used to display the data information requested to be entered by the end user into the object for informational purposes within the object. When the end user views the object, they see the referring text typed in this field, and the router text disappears when they focus on the object and begin entering values.

'Text Align' - Used within the object to determine how the text of the element is aligned within the object selected within the object.

>Choices Can Be Made: Left, Center, Right

Behavior

'ReadOnly' - This is where the object is set to be in edit mode. When this feature is enabled, the object does not allow data entry, it is in read-only mode. The property must be passive for data entry to be allowed into the object.

'Tab Index' - By entering numeric values in this field, it is determined in which order the tab button is pressed to focus between the form objects. When filling out the form, instead of clicking the cursor on the object where the data is to be entered, the tab button is pressed to focus directly on the indexed objects in a certain order. This is a feature that increases the speed of filling out forms.

'Required' - The field in which it is determined whether data entry is required on the object. When this feature is activated, it is not possible to advance/save the form without entering data into the object.

'Columns' - This is the area where the columns of the table to be opened are specified and edited when clicking on the object to make a selection in the web interface.

Clicking on the Columns section opens the window to specify and edit the table columns. In this window, manual columns can be added to the table with the "+ Add" button. With the **"Generate Columns" button, columns returned from the query linked to the object can be added directly to this field by selecting them individually or all of them in the generating window.

Clicking on any of the added columns lists the properties for that column on the right. Column properties can be edited, or if the corresponding column is not wanted to be shown in the table, it can be removed from the "Added Columns" field by clicking on the trash can icon.

In the section that lists the column properties, the fields on the General tab are:

NOTE :::note

The following list is written in the object by Text column type.

:::

• 'Name' - This is the column name field. If the column was created manually with the "Add" button, this field is editable. The column is added to this field with the "Generate Columns" button, a column name returned from the query comes automatically.

• 'Caption' - This is the column header field. The column name to be displayed in the table is set here.

• 'Width' - This is the area where the column width is set.

• 'Visible' - This is the part where the column is separated by whether it will appear in the web interface or not.

• 'Disable to Export' - This is the setting used when the table is exported to prevent the column in which the feature is enabled from being exported.

• 'Allow Hiding' - This is the setting that is activated if you want to allow the column to be hidden during the table display. Used in conjunction with the Show Column Chooser setting on the object.

• 'Cell Type' - The column type value is kept in this field. The column is added to this field with the "Generate Columns" button, and if it is a column returned from the query, this field is read-only. If it is a column created manually with the "Add" button, this field is in editable mode. The options listed in the Cell Type field are as follows;

• Column types to choose from: Text, Number, Boolean, Date, Time, DateTime, Select, Multilanguage, Action Button

• 'Text' - means that data of text type is held in the column. When the cell type is Text, the Control tab opens the fields to specify the name, size, and nullable properties of the area of the column to keep in the database.

  • 'Number' - If a number type value is to be kept in the column, this cell type is selected. For a column of Number type, the General tab appears in the Summary Types field, which lists the Total, Maximum", Minimum, Average, and Number options, and the Auto Increment field, which determines whether the column value increases automatically.
  • 'Boolean' - means that a true/false type value is kept in the column.
  • 'Select' - A column of type Select can list data from a data source or manually added elements. In the web interface, the user can select from the listed values when they click on the Select column. Selecting Select as the cell type opens a field named DataSource on the Control tab. In this field, if you want to list the values fetched from a data source in the column, "Dynamic" should be selected as the Type, and if you want to list the manually added values in the column, the "Static" option should be selected as the Type.
  • 'Action Button' - A type of cell used to add an action button to the column, which, when clicked, is designed to perform a specific action. When the Action Button is selected as the cell type, a tab called Action Button will appear on the screen. In the web interface, clicking this button in the column indicates which action to perform on the action button tab. In the Type field of the action button tab, the action selection is made. According to the action options listed here, Create a Form, Open a Form, Open a Process, Open a Selection Form, Execute Custom Action operations can be performed by clicking this action button in the web interface.

Depending on each selected action type, the fields that need to be filled in the Action Properties section vary.

Process	Required Information
Of the form to be created	Project Name, Form Name
Open the form	Document id value
Process to be opened	Process id and Process Request id values
Open the selected form	Defining data connections that will drive their value
Process to start	Process name and Flow Name values

From the columns listed in the Added columns field, the column containing the relevant data should be selected and filled.

• 'Date' - The cell type value of the columns that contain date-type data.

  • 'Time' - The cell type value of the columns that contain time-type data.
  • 'DateTime' - The cell type value of the columns that contain date and time type data.

• 'Align' - The adjustment of alignment of the column to the right, left or center is made from this area.

• 'Allow Null' - This is done from this field if you want to allow a null value in the column.

• 'Icon Source Field' - Based on the selected column name, the icon display is provided in the column where the feature is active when the value requirement in that column is met. For example, in Column1, the field lists Colon1 and Column2. When Column1 is selected, according to the conditions to be created for this column, icons will be displayed in the column where the feature is active, at the values where the conditions are met.

• 'Icon Matchers' - used to create the conditions under which icon will be displayed at which value in the selected column in the Icon Source Field field.

• 'Header Filter Enabled' - Used in the column to enable filtering by selecting the data in the column with the column header filter.

• 'Is Primary Key' - At least one of the columns in the Added columns field must be selected as the primary key. The column that has the unique value for the records is marked as the primary key. If there is no unique column among the added columns, a column of the Number type can be added with the "Add" button, the auto-increment feature can be activated, a unique number column can be created for each record and this column can be determined as the primary key.

• 'Editing Enabled' - Whether the column can be edited or not is set here.

INFO

As of this section, the description of the column properties has been completed and the object properties will be continued.

'Allow Clear' - The property used to clear the selected value in the object. When this feature is activated, when the user makes a selection from the object in the web interface, a × (Cross) appears on the edge of the object. By pressing the cross, the selected value can be deleted and another object element can be selected.

'Value Type' - The field in which the type of object elements is specified. Based on the type specified here, the Value field type of the row inserted in the Elements field is changed. Also, when a parametric query is bound to the object, the parameter type must match the type value selected in the Value Type field.

>Choices Can Be Made: string, boolean, integer, decimal, date

Column Settings

'Orderable' - A property for sorting table columns in the selection panel within an object by drag-and-drop. By clicking on the column name and dropping it to the desired place, it can be moved between the columns.

'Show Column Chooser' - Table columns with the Allow Hiding feature turned on in the in-object selection panel will activate the column selector pop-up on the table if it is desired to be hidden during item selection.

'Resizeable' - A feature for increasing or decreasing the column width.

Filtering Settings

'Enabled' - When this feature is enabled, filter fields will pop up in the table columns in the selection panel within the object, under each column. The value typed into the filter field is filtered through the column records, listing related records.

Paging Settings

'Enabled' - This is the property that sets whether the data listed in the table is shown as sheets. When this feature is disabled, how many records are in the table are listed one after the other. When the feature is activated, the data is displayed in the form of pages.

'Current Page' - The property used to ensure that the object, when opened in the web interface, opens from the page specified here.

'Paging Size' - Record count per page display settings. Defaults to 10, 20, 30, 40. How many rows you want to show on a page can be set from this field.

Searching Settings

'Enabled' - When the feature is activated, the search bar appears above the table structure. And the value typed in this search bar is searched in all columns of the table, listing the mapping rows.

Sorting Settings

'Mode' - A feature that allows sorting between table records. Clicking on any column ensures that the data in the column is listed in ascending or descending order.

>Choices to Make: none, single, multiple

INFO

For values that are listed in the Mode field, the None option means that no sorting will be done. With the Single option, you can only sort by a single column. The Multiple option means that more than one column can be sorted.

Selection Settings

'Mode' - A feature that allows only one item or more than one item to be selected between table records. While only one item can be selected when Signle is selected, more than one item can be selected when multiple is selected.

>Choices to Make: single, multiple

Data Definition Language

'Field Name' - The field in the database of the system that determines the name of the column it will create for the object. In the "Name" section, the object can be given another name and the column name to be created for the object in the database table can be created as a different name.

'Allow Null' - This section indicates whether the database field to be created for the object will allow null values.

'Size' - The size that the object will hold in the database field is determined in this field. Automatically retrieves the value entered in the MaxLenght field.

Events

The events owned by the object are located in the "Events" tab in the Property Viewer panel. Each event is triggered at different runtime moments, performing its own unique operations. Code written by the developer to these events is also executed at the time the corresponding event is triggered.

Double-clicking on the events in the "Client" field redirects the screen to the form code editor named "Formadı.ts" where TypeScript coding can be done and the method block for the clicked event is automatically created.

Double-clicking on the events in the "Server" field redirects the screen to the form code editor named "Jersey.cs" where C# coding can be done and the method block for the clicked event is automatically created.

The developer can construct any code block within these methods. Next to the event whose method is created on the code side by clicking from the Events tab, the method name information is automatically generated and the relationship between the event and the method is specified.

Formed methods;