- Introduction to WorkXpress
- Building Your Application
- Examples and Best Practices
- Technical Manual
This shows you the differences between two versions of the page.
|
field type - filter [2016/09/14 18:19] |
field type - filter [2016/09/14 18:19] (current) |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Filter ====== | ||
| + | The filter field is used to create an interface through which an application developer can define specific criteria to be met by [[Record|records]] that will be displayed in a list. | ||
| + | |||
| + | |||
| + | ===== How to Create - Method 1 ===== | ||
| + | - Click the {{:presentation-layer:field-plus.png|}} to add a field in your [[Form|form]]. | ||
| + | - Choose "New Field" | ||
| + | - Select the table you wish to add the field to. Most of the time, this will be the current [[Table|table]] you are on, called the current [[Context|context]]. | ||
| + | - Select a field name and click "Choose Type". | ||
| + | - Choose "Filter" from the list of field types. | ||
| + | - You can continue adding fields or click the "Select" button to finish adding. | ||
| + | |||
| + | ===== How to Create - Method 2 ===== | ||
| + | This field is able to be placed on a page itself, not as part of a table's records. | ||
| + | |||
| + | ==== Adding the Field ==== | ||
| + | - Click the "Fields" button in the left toolbar to expand the list of fields available. {{ :expand_fields.png?nolink&200 |}} | ||
| + | - Click on "Filter", holding the mouse button down and dragging the filter field onto the page, releasing over the grey shadow where the field will be placed. {{ :filter_drop.png?nolink&1000 |}} | ||
| + | - Select a variant to use and click "save". You can always change this later.{{ :filter_variants.png?nolink&1000 |}} | ||
| + | - The filter field will appear on the page in the location specified. | ||
| + | |||
| + | ==== Accessing the Features ==== | ||
| + | When hovering the mouse over the field, an icon containing a blue pencil over a sheet of paper will appear in the top left corner of the field. Click this icon to access the field features as listed above. | ||
| + | {{ :filter_edit.png?nolink&500 |}} | ||
| + | |||
| + | ===== Features ===== | ||
| + | Field features can be edited by clicking on the orange field icon {{:type-24.png|}} when the [[Presentation Layer|presentation layer]] is displayed. | ||
| + | |||
| + | ==== Field Label ==== | ||
| + | * [[Field Setting - Field Label|Field Label]] | ||
| + | * [[Field Setting - Display Alternate Label]] (affects this form only) | ||
| + | |||
| + | ==== Grid Appearance ==== | ||
| + | |||
| + | * [[Field Setting - Column Span|Column Span]] | ||
| + | * [[Field Setting - Row Span|Row Span]] | ||
| + | |||
| + | ==== Tooltip ==== | ||
| + | * [[Field Setting - Tooltip|Tooltip]] | ||
| + | * [[Field Setting - Descriptive Text|Descriptive Text]] | ||
| + | * [[Field Setting - Display Alternate Descriptive Text|Display Alternate Descriptive Text]] (affects this form only) | ||
| + | |||
| + | ==== Block Association ==== | ||
| + | * [[Field Setting - Temporary Block Association|Temporary Block Association]] | ||
| + | * [[Field Setting - Global Block Association|Global Block Association]] | ||
| + | |||
| + | ==== Default Value ==== | ||
| + | * [[Field Setting - Default Value|Default Value]] | ||
| + | |||
| + | ==== Validation ==== | ||
| + | * [[Field Setting - Required|Required]] | ||
| + | |||
| + | ==== Audit History ==== | ||
| + | * [[Field Setting - Audit This Field|Audit This Field]] | ||
| + | * [[Field Setting - Show Audit History|Show Audit History]] | ||
| + | |||
| + | ==== View Only ==== | ||
| + | * [[Field Setting - View Only|View Only]] | ||
| + | |||
| + | ==== Filter Options ==== | ||
| + | * [[Field Setting - Purpose|Purpose]] | ||
| + | * [[Field Setting - Form ID|Form ID]] | ||
| + | * [[Field Setting - Variant|Variant]] | ||
| + | * [[Field Setting - Filters|Filters]] | ||
| + | |||
| + | ===== Variants Available ===== | ||
| + | This field has nine variants that can be chosen from. | ||
| + | |||
| + | |< 80% >| | ||
| + | ^Name^Format^Label Placement^ | ||
| + | |Dropdown of Fields with a label on the top|Dropdown box|Top| | ||
| + | |Dropdown of Fields with a label to the left|Dropdown box|Left| | ||
| + | |Dropdown of Fields with out a label|Dropdown box|None| | ||
| + | |Grid of Fields, Labels and Data Inline with a label on the top|Grid, Data labels next to data|Top| | ||
| + | |Grid of Fields, Labels and Data Inline with a label to the left|Grid, Data labels next to data|Left| | ||
| + | |Grid of Fields, Labels and Data Inline with out a label|Grid, Data labels next to data|None| | ||
| + | |Grid of Fields, Labels above Data with a label on the top|Grid, Data labels above data|Top| | ||
| + | |Grid of Fields, Labels above Data with a label to the left|Grid, Data labels above data|Left| | ||
| + | |Grid of Fields, Labels above Data with out a label|Grid, Data labels above data|None| | ||
| + | ===== Filter Types ===== | ||
| + | The filter field can be configured to use any one of the standard [[Query Builder - Filter##Text-Type Filters|text-type filters]]. | ||
