Format

A format is a customized HTML-Page build on the XML result of a Plex-XML function call.

All data you see in the format is extracted from your Plex-Modell via Meta-Code on the first function call. You don't have to type it manually.

--> Hint: See Format Field Attributes for additional attributes

Contents 1 Translate a format name 2 Hide a format 3 Refresh a format 4 Format properties 4.1 DictionaryFindBrowse 4.2 DictionaryEdit, DictionarySimpleDialog 5 Example

Translate a format name

If need to translate the name of a format you could enter a translation just like you enter the header of a function. While a header translation has the running number 1 a format translation has number 2.

Hide a format

If you need to hide a format from the user selection in the upper right corner you could set the "Authorization" field to "Private" and the "Owner" to your name or another fictive name. If you use your name that format is only visible for you.

Note: A function format that has the authorization private could still be called form every user that is allowed to use that function by using the URL. The authorization effects only if the format is shown in the upper right corner.

Refresh a format

If you have added fields to an existing table in the database you can refresh the format definition in order to insert the new fields into an existing format.

Format properties

For dictionary functions you can define as many formats as you like. In each format each field could be customized in the following properties:

DictionaryFindBrowse

1. Required (yes, no)
2. Show Field (Input, Readonly, Hidden, Excluded)
3. Sequence in a row (number)
4. Sequence in column (normal, 2.Field 1.Row, 3.Field 1.Row, 1.Field 2.Row...)
5. Column width
6. Find Field (yes, no)
7. Use in Fulltext search (yes, no)
8. Find Operator (Equal, Not Equal, Start, Less, Less Equal, Greater, Greater Equal, Full Text, In, Between)
9. Order By (number)
10. Order By Descending (yes, no)
11. Row Sort (yes, no)
12. Group by (yes, no)
13. Alow Wrap (yes, no)
14. Style Attributes (free CSS status field)
15. Local overide (yes, no)
16. Translation
17. Shape (Character, Check-Box, Combo-Box...)
18. Field Type (Character, Numeric, Date-ISO, Date-Numeric-7, Date-Numeric-8, Time-ISO, Time-Numeric-6, Timestamp-ISO, BLOB)
19. Max Length
20. Display Length
21. Decimal Places

DictionaryEdit, DictionarySimpleDialog

1. Required (yes, no)
2. Show Field (Input, Readonly, Output, Hidden, Excluded)
3. Sequence in a row (number)
4. Sequence in a column (number)
5. Show column label if sequence in column is >1 (yes, no)
6. Column label width (in px)
7. Field Set (number)
8. Tab (number)
9. Tab Index (number)
10. Style Attributes (free CSS status field)
11. Initialization for Insert-Functions

• Free value for character
• Free value for numeric. Be aware that a decimal separator could be different in different locales.
• *User is the DefaultUserId
• *Now actual system date, time or timestamp
• You should be careful with date, time and timestamps other than now because it won't be translated in different locales.

1. Local override (yes, no)
2. Translation
3. Shape (Character, Check-Box, Combo-Box...)
4. Field Type (Character, Numeric, Date-ISO, Date-Numeric-7, Date-Numeric-8, Time-ISO, Time-Numeric-6, Timestamp-ISO, BLOB)
5. Max Length
6. Display Length
7. Decimal Places

Example

Formats can be customized by Drag&Drop for a Grid...

...and by Drag&Drop for a Detail-Screen...

...or by editing the field values in a dialog window.

General format options dialog