Difference between revisions of "Calendar Section Attributes"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
| Line 81: | Line 81: | ||
!width="20%"|Attribute | !width="20%"|Attribute | ||
!width="40%"|Description | !width="40%"|Description | ||
| − | !width=" | + | !width="10%"|Desktop |
| − | ! | + | !width="10%"|Web |
| + | !width="10%"|Tablet | ||
| + | !width="10%"|Phone | ||
|- | |- | ||
| − | |valign="top"|Default view||The default view to be displayed (Month | Week | Day)|||||||| | + | |valign="top"|[[Calendar Options#Default view|Default view]]||The default view to be displayed (Month | Week | Day) |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event type column||The (character) event type column from the table for the events in the calendar. | + | |valign="top"|[[Calendar Options#Event type column|Event type column]]||The (character) event type column from the table for the events in the calendar. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event type choices||The event type choices for the events in the calendar. This can be a comma separated list or a SQL statement.|||||||| | + | |valign="top"|[[Calendar Options#Event type choices|Event type choices]]||The event type choices for the events in the calendar. This can be a comma separated list or a SQL statement. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event title column||The (character) event title column from the table. | + | |valign="top"|[[Calendar Options#Event title column|Event title column]]||The (character) event title column from the table. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | | ||
|- | |- | ||
| − | |valign="top"|Event start column||The (datetime) event start column from the table. | + | |valign="top"|[[Calendar Options#Event start column|Event start column]]||The (datetime) event start column from the table. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event end column||The (datetime) event end column from the table. | + | |valign="top"|[[Calendar Options#Event end column|Event end column]]||The (datetime) event end column from the table. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event repeat column||The (int) event repeating flag column from the table. | + | |valign="top"|[[Calendar Options#Event repeat column|Event repeat column]]||The (int) event repeating flag column from the table. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event allday column||The (logical) event allday flag column from the table. | + | |valign="top"|[[Calendar Options#Event allday column|Event allday column]]||The (logical) event allday flag column from the table. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | | ||
|- | |- | ||
| − | |valign="top"|Event key column||The key expression for events in the calendar. | + | |valign="top"|[[Calendar Options#Event key column|Event key column]]||The key expression for events in the calendar. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Event type value||The event type for this calendar, e.g. meeting, vacation, appointment. Calendar contents will be filtered on this.|||||||| | + | |valign="top"|[[Calendar Options#Event type value|Event type value]]||The event type for this calendar, e.g. meeting, vacation, appointment. Calendar contents will be filtered on this. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Autosize||Autosize the calendar into the viewport (True | False)|||||||| | + | |valign="top"|[[Calendar Options#Autosize|Autosize]]||Autosize the calendar into the viewport (True | False) |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Other options | + | |valign="top"|[[Calendar Options#Other options|Other options]]||Other calendar options |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Click delegate||Delegate to call when a calendar event is clicked|||||||| | + | |valign="top"|[[Calendar Options#Click delegate|Click delegate]]||Delegate to call when a calendar event is clicked |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Dynamic day backcolor||Delegate to return the background colors and dates. You should return this as a comma separated list. The delegate is called with one parameter: 'dates' or 'colors'. The currently selected cursor contains the selected records.|||||||| | + | |valign="top"|[[Calendar Options#Dynamic day backcolor|Dynamic day backcolor]]||Delegate to return the background colors and dates. You should return this as a comma separated list. The delegate is called with one parameter: 'dates' or 'colors'. The currently selected cursor contains the selected records. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Dynamic event backcolor||Delegate to return the background color of the event for the specified event type, which is passed as a parameter|||||||| | + | |valign="top"|[[Calendar Options#Dynamic event backcolor|Dynamic event backcolor]]||Delegate to return the background color of the event for the specified event type, which is passed as a parameter. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Dynamic event forecolor||Delegate to return the foreground color of the event for the specified event type, which is passed as a parameter|||||||| | + | |valign="top"|[[Calendar Options#Dynamic event forecolor|Dynamic event forecolor]]||Delegate to return the foreground color of the event for the specified event type, which is passed as a parameter. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Custom delegate library||Custom library containing the day and event dynamic color delegates|||||||| | + | |valign="top"|[[Calendar Options#Custom delegate library|Custom delegate library]]||Custom library containing the day and event dynamic color delegates. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
| − | |valign="top"|Filter||The filter expression that restricts which events will be included in the calendar|||||||| | + | |valign="top"|[[Calendar Options#Filter|Filter]]||The filter expression that restricts which events will be included in the calendar. |
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
| + | |style="background: green"| | ||
|- | |- | ||
|} | |} | ||
Revision as of 09:54, 23 September 2015
Under construction
Contents
Details
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Name | The name for this section (unique to the page) | |||||
| Type | The type of section: calendar (readonly) | |||||
| Caption | The section caption displayed in the section header | |||||
| Database | The database for this section | |||||
| Table | The table for this section | |||||
| Height | The section height | |||||
| Fixed height | Fix the section height (True | False) | |||||
| Readonly | Section is readonly (True | False) |
Appearance
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Margin | Margin size around the section | |||||
| Add spacer at bottom | Add spacer at bottom of section (True | False) |
Header
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Hide header | Hide section header at runtime(True | False) | |||||
| Hide actionbar | Hide actionbar buttons in the section header (True | False) | |||||
| Header CSS style | CSS style (separate attributes with ; or use app:/filename.css) | |||||
| Header icon | The image for the Header (png | jpg | gif). Use app:/imagename.ext for app specific images. |
|||||
| Gradient colors | Render the Header background color as a gradient (True | False) | |||||
| Gradient type | Specify the gradient type | |||||
| Gradient start color | Gradient start color | |||||
| Gradient end color | Gradient end color | |||||
| Show OK/Cancel buttons | Show OK/Cancel buttons in the section header (True | False) | |||||
| Show Add/Delete buttons | Show Add/Delete buttons in the section header (True | False) | |||||
| Show Print button | Show Print button in the section header (True | False) | |||||
| Hide custom search icon | Hide the custom search icon (True | False) | |||||
| Show info tips icon | Show the info tips icon in the section header (True | False) | |||||
| Show help icon | Show the help icon in the section header (True | False) | |||||
| Help topic | Help topic to display when the help icon is clicked in the section header |
Calendar Options
| Attribute | Description | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|
| Default view | The default view to be displayed (Month | Week | Day) | ||||
| Event type column | The (character) event type column from the table for the events in the calendar. | ||||
| Event type choices | The event type choices for the events in the calendar. This can be a comma separated list or a SQL statement. | ||||
| Event title column | The (character) event title column from the table. | | | |||
| Event start column | The (datetime) event start column from the table. | ||||
| Event end column | The (datetime) event end column from the table. | ||||
| Event repeat column | The (int) event repeating flag column from the table. | ||||
| Event allday column | The (logical) event allday flag column from the table. | | | |||
| Event key column | The key expression for events in the calendar. | ||||
| Event type value | The event type for this calendar, e.g. meeting, vacation, appointment. Calendar contents will be filtered on this. | ||||
| Autosize | Autosize the calendar into the viewport (True | False) | ||||
| Other options | Other calendar options | ||||
| Click delegate | Delegate to call when a calendar event is clicked | ||||
| Dynamic day backcolor | Delegate to return the background colors and dates. You should return this as a comma separated list. The delegate is called with one parameter: 'dates' or 'colors'. The currently selected cursor contains the selected records. | ||||
| Dynamic event backcolor | Delegate to return the background color of the event for the specified event type, which is passed as a parameter. | ||||
| Dynamic event forecolor | Delegate to return the foreground color of the event for the specified event type, which is passed as a parameter. | ||||
| Custom delegate library | Custom library containing the day and event dynamic color delegates. | ||||
| Filter | The filter expression that restricts which events will be included in the calendar. |
Related Data
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Parent section name | Name of related parent section | |||||
| Automatically relate | Automatically relate the child section (True | False). If this is unchecked then you need to manually relate it in the parentdatachanged delegate. | |||||
| Parent key | Parent key | |||||
| Child key | Child key |
Menu
| Attribute | Description | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|
| Visible | Section menu visible (True | False) | ||||
| Height | Section menu height | ||||
| Background color | Section menu background color | ||||
| Foreground color | Section menu foreground color | ||||
| Custom menu | Section menu contents | ||||
| Custom action | Action to perform when a menu item is selected |
Search Panel
| Attribute | Description | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|
| Visible | Section search panel visible (True | False) | ||||
| Height | Section search panel height | ||||
| Background color | Section search panel background color | ||||
| Foreground color | Section search panel foreground color | ||||
| Auto create | Automatically create search panel for all Section search fields | N/A | N/A | N/A | N/A |
| Custom search panel | The delegate used to create the custom search panel |
Subtitle
| Attribute | Description | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|
| Visible | Section subtitle visible (True | False) | ||||
| Caption | Section subtitle caption | ||||
| Height | Section subtitle height | ||||
| Background color | Section subtitle background color | ||||
| Foreground color | Section subtitle foreground color | ||||
| Font | Section subtitle font | ||||
| CSS style | CSS style |
| Attribute | Description | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|
| Visible | Section footer visible (True | False) | ||||
| Caption | Section footer caption | ||||
| Height | Section footer height | ||||
| Background color | Section footer background color | ||||
| Foreground color | Section footer foreground color | ||||
| Custom menu | Section footer menu contents | ||||
| Custom action | Action to perform when a footer menu item is selected | ||||
| Footer button CSS | Footer button CSS style | ||||
| Footer button width | Footer button width |
Other Options
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Hide form NavBar | Hide form Navigation Bar at runtime if this section is in an AccordionStack (True | False) | |||||
| Collapsable | The section is collapsible at runtime (True | False) | |||||
| Exclude from accordion | The section is excluded from accordion behavior at runtime (True | False) |
Custom Delegates
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Scripting language | The default scripting language for custom code in this section (Inherit | Recital | Visual FoxPro | Python | JavaScript | PHP) | |||||
| Custom library | The filename of the library containing code for event handlers and custom procedures/functions | |||||
| Expanded | The delegate for the Expanded event | |||||
| Collapsed | The delegate for the Collapsed event | |||||
| Parent data changed | The delegate for the ParentDataChanged event | |||||
| Timer | The delegate for the Timer event | |||||
| Timer interval | The timer interval in seconds that the Timer event will be called at runtime | |||||
| Custom footer menu | The delegate for the footer menu event | |||||
| Custom search command | The delegate for the search event | |||||
| Custom section menu | The delegate for the section menu event |
Permissions and Roles
| Attribute | Description | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|
| Create roles | A comma separated list of roles that can perform create operations on data in the section | N/A | N/A | N/A | N/A |
| Read roles | A comma separated list of roles that can read (and view) the section | ||||
| Update roles | A comma separated list of roles that can perform update operations on data in the section | ||||
| Delete roles | A comma separated list of roles that can perform delete operations on data in the section | N/A | N/A | N/A | N/A |
UI Presentation Rules
| Attribute | Description | More | Desktop | Web | Tablet | Phone |
|---|---|---|---|---|---|---|
| Desktop | Include this section in a Desktop client (True | False) | |||||
| Web | Include this section in a Web client (True | False) | |||||
| Tablet | Include this section in a Tablet client (True | False) | |||||
| Phone | Include this section in a Phone client (True | False) | |||||
| UI States | UI states that affect this section. Specify multiple states as a comma separated list. | |||||
| Initial UI state | The initial UI state for this section. This will be applied to the Section and all its fields and gadgets. | |||||
| Readonly when | Section is readonly at runtime if specified expression evaluates to true. | |||||
| Visible when | Section is visible at runtime if specified expression evaluates to true. | |||||
| Display orientation | Display depending on mobile device orientation for Tablets and Phones. (Always | Portrait | Landscape) | |||||
| Apply rules on change | Apply Page UI presentation rules (Visible when and Readonly when) when data is changed interactively or when navigating records (True | False) | |||||
| Apply rules on parent change | Apply Page UI presentation rules (Visible when and Readonly when) when parent data is changed by navigating records (True | False) |