FilterPageBuilder Data Type
Version: Available or changed with runtime version 1.0.
Stores filter configurations for a filter page. A filter page is a dynamic page type that contains one or more filter controls that enables users to set filters on fields of the underlying tables.
The following methods are available on instances of the FilterPageBuilder data type.
|AddField(String, Any [, String])||Adds a table field to the filter control for a table on filter page.|
|AddField(String, FieldRef [, String])||Adds a table field to the filter control for a table on filter page.|
|AddFieldNo(String, Integer [, String])||Adds a table field to the filter control for a table on the filter page.|
|AddRecord(String, Record)||Adds a filter control for a table to a filter page. The table is specified by a record data type variable that is passed to the method.|
|AddRecordRef(String, RecordRef)||Adds a filter control for a table to a filter page. The table is specified by a RecordRef variable that is passed to the method. This creates a filter control on the filter page, where users can set filter table data.|
|AddTable(String, Integer)||Adds filter control for a table to a filter page.|
|Count()||Gets the number of filter controls that are specified in the FilterPageBuilder object instance.|
|GetView(String [, Boolean])||Gets the filter view (which defines the sort order, key, and filters) for the record in the specified filter control of a filter page. The view contains all fields in the filter control that have a default filter value.|
|Name(Integer)||Gets the name of a table filter control that is included on a filter page based on an index number that is assigned to the filter control.|
|PageCaption([String])||Gets or sets the FilterPageBuilder UI caption. Defaults to the resource text if not explicitly set.|
|RunModal()||Builds and runs the filter page that includes the filter controls that are stored in FilterPageBuilder object instance.|
|SetView(String, String)||Sets the current filter view, which defines the sort order, key, and filters, for a record in a filter control on a filter page. The view contains all fields that have default filters, but does not contain fields without filters.|