About the Visual Designer Entity List View

This component adds a List view to the form. You can add the view either to an existing tab or you can add a blank tab first and then add the view to the blank tab. The example shown above illustrates a view that has been added to a new tab on the Employees form.

In general, this view should display records from a related entity that is linked to the current entity. For example, you might want to add a view to the Dashboard Areas service that displays the list of Dashboard Parts that the area contains. This concept is similar to the Related Entity view tabs that are added automatically by the Aptify Baseline Form Template generator (see About the Baseline Form Template Generator) or to a view added as a separate tab to a form using the Form Template Tab wizard (see Using the Form Template Tab Wizard).

The Entity List View component uses the following input properties:

• Caption (required): The caption for the view.
• Entity (required): The name of the entity whose records will be displayed in the view.
• View Type (required): You can either load an existing view (View ID) or specify a SQL statement to define a temporary view (SQL View). This property defaults to SQL View.
• NewRecordParameterString: An administrator can configure this property to automatically populate fields in new records opened from within a list view. The format for passing new default values is as follows:
  • PARAMS(FieldName1=Value1|FieldName2=Value2|FieldName3=Value3...)
  • For example, to pass in the ID from the current record into the SampleServiceID for a new record in the related entity, you would enter -PARAMS(SampleServiceID=<%ID%>) as this property's Source.
  • Note that the FieldName corresponds to fields in the entity whose records appear in the view. To specify multiple fields, separate the field/value statements with a vertical bar.
  • If you want to pass in values from the current record, enclose the current record's field name with greater than/less than symbols and percentage signs.
    • For example, if the related entity whose records are displayed in the view has a SampleServiceID field, the following string passes in the Sample Services record's ID when you open a new record from the view on the Sample Services form: PARAMS(SampleServiceID=<%ID%>)
       
• SQL: If you set View Type to SQL View, specify the SQL statement (including any applicable WHERE clause) to define a temporary view.
• ViewID: If you set View Type to View ID, enter the ID of the view that will be placed on the form.
• FilterSQL: If you are placing an existing view on the form (that is, View Type is set to View ID), you can use this property to filter the results of the view to display a sub-set of the records. The string that you enter for this property is appended as a WHERE clause to the selected view's SQL statement. Typically, you will use this property to display only the records in the related entity that are linked to the current record. For example, if a SampleLinks entity has a SampleServiceID field, you can add an existing list view of the SampleLinks entity to the SampleServices form. To filter the list results to display on those SampleLinks records linked to the current SampleServices record, you would enter SampleServiceID = <%ID%> as the Source for the FilterSQL property, as shown below.
• Enable Paging: Sets the paging behavior for the view. The default value is True enabling paging.
• Page Size: The number of records per page, when paging is enabled. The default value is 250.
• LabelCaptionCultureString: This string specifies the culture string used to localize the caption. For this input property, specify the base string for the applicable Culture String record. See Working with Culture Strings for more details. 
• DisplayEntityRecordAsModal: Determines whether or not the display of the Entity record (New or Open) displays as a modal or modeless window.  The default behavior is modeless (0). Set the value of this property to true to display the Entity window as a modal window.  Note that, if the List View is displayed in a modal window, the Entity record will be displayed as a modal window, regardless of value for this property.
• CheckBoxColumnRequired: Determines whether the entity list view should display the first column as check boxes to select the records. If the value is 1, the first column will contain check boxes, and if the value is 0, the first column does not contain check boxes. Default value is 1.
• HiddenFilter: This property allows an administrator to specify a WHERE clause filter to limit the set of possible values for the entity list view. 
  • The syntax for the HiddenFilter is a SQL WHERE clause without the "WHERE" preamble (this is appended automatically by Aptify). 
     
• HideColumns: This property can be used in the Aptify web interface to hide column(s) in the entity list view. The hidden column(s) are still available for internal processing.
• DeferDataLoad: When this property is set to True, the view results are not immediately loaded. The grid is configured, but is not loaded until this property is set to False.  This property is supported in the Aptify Web Entity List View Component and not supported in the Windows Desktop client. The default value is False.