Difference between revisions of "Section Header"
From Lianjapedia
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) (→Notes on Client Support) |
||
| (19 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | ==Hide header== | + | ==Header== |
| + | ===Hide header=== | ||
The '''Hide header''' attribute determines whether the Section Header is hidden or not. | The '''Hide header''' attribute determines whether the Section Header is hidden or not. | ||
* Note that the Section header will be hidden at runtime only. | * Note that the Section header will be hidden at runtime only. | ||
| + | * For [[Page Center Section Attributes|Page Center Sections]], the '''Hide header''' attribute is checked (True) by default. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Hide | + | ===Hide navigation buttons=== |
| + | The '''Hide navigation buttons''' attribute determines whether the actionbar navigation buttons (as above: First, Previous, Next, Last) are displayed in the section header. | ||
| + | * This only applies when the actionbar is not hidden. | ||
| − | [[ | + | [[#Notes on Client Support|Notes on Client Support]] |
| − | + | ===Hide editing buttons=== | |
| − | + | The '''Hide editing buttons''' attribute is ignored. See below [[#Show OK/Cancel buttons|to hide or show the OK/Cancel buttons]]. | |
| − | The '''Hide | + | * Note that the section '''Readonly''' attribute can be checked to True to make the section readonly (non-editable). |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | == | + | ===Show record count badge=== |
| − | The ''' | + | The '''Show record count badge''' attribute determines whether the record count badge should be displayed in the section header. This is available for data-bound sections.<br>From v5.2. |
| − | + | ||
| + | [[{{ns:file}}:recordcountbadge.png|800px|left|border|link={{filepath:recordcountbadge.png}}|Show record count badge]] | ||
| + | <br clear=all> | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Hide | + | ===Hide actionbar=== |
| − | The '''Hide | + | |
| − | + | The '''Hide actionbar''' attribute determines whether the [[Page_Appearance#Hide_actionbar|Page actionbar]] is displayed when this section is activated as a [[Accordion_Behavior#Stacked_behavior_at_runtime|stacked section at runtime]]. | |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Header CSS style== | + | ===Header CSS style=== |
The '''Header CSS style''' attribute specifies CSS attributes for the header. | The '''Header CSS style''' attribute specifies CSS attributes for the header. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Background color== | + | ===Background color=== |
The '''Background color''' attribute specifies the header background color. | The '''Background color''' attribute specifies the header background color. | ||
* See [[Colors]] | * See [[Colors]] | ||
| Line 38: | Line 44: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Foreground color== | + | ===Foreground color=== |
The '''Foreground color''' attribute specifies the header foreground color. | The '''Foreground color''' attribute specifies the header foreground color. | ||
* See [[Colors]] | * See [[Colors]] | ||
| Line 44: | Line 50: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Header icon== | + | ===Header icon=== |
The '''Header icon''' attribute is ignored. | The '''Header icon''' attribute is ignored. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Gradient colors== | + | ===Gradient colors=== |
The '''Gradient colors''' attribute determines whether the Header background should be rendered with gradient colors. | The '''Gradient colors''' attribute determines whether the Header background should be rendered with gradient colors. | ||
* See [[Gradients]] | * See [[Gradients]] | ||
| Line 55: | Line 61: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Gradient type== | + | ===Gradient type=== |
The '''Gradient type''' attribute specifies the gradient type to be used if '''Gradient colors''' is True. | The '''Gradient type''' attribute specifies the gradient type to be used if '''Gradient colors''' is True. | ||
* See [[Gradients]] | * See [[Gradients]] | ||
| Line 61: | Line 67: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Gradient start color== | + | ===Gradient start color=== |
| − | The '''Gradient start color''' specifies the start color to be used if '''Gradient colors''' is True. | + | The '''Gradient start color''' attribute specifies the start color to be used if '''Gradient colors''' is True. |
* See [[Gradients]] | * See [[Gradients]] | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Gradient end color== | + | ===Gradient end color=== |
| − | The '''Gradient end color''' specifies the end color to be used if '''Gradient colors''' is True. | + | The '''Gradient end color''' attribute specifies the end color to be used if '''Gradient colors''' is True. |
* See [[Gradients]] | * See [[Gradients]] | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Show OK/Cancel buttons== | + | ===Show OK/Cancel buttons=== |
[[{{ns:file}}:section_header_icons.png|450px|thumb|left|link={{filepath:section_header_icons.png}}|Section Header: buttons and icons]] | [[{{ns:file}}:section_header_icons.png|450px|thumb|left|link={{filepath:section_header_icons.png}}|Section Header: buttons and icons]] | ||
| Line 88: | Line 94: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Show Add/Delete buttons== | + | ===Show Add/Delete buttons=== |
The '''Show Add/Delete buttons''' attribute determines whether the Add (+) and Delete (-) buttons should be displayed in the section header. | The '''Show Add/Delete buttons''' attribute determines whether the Add (+) and Delete (-) buttons should be displayed in the section header. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Show Print button== | + | ===Show Print button=== |
The '''Show Print button''' attribute determines whether the Print button should be displayed in the section header. | The '''Show Print button''' attribute determines whether the Print button should be displayed in the section header. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Hide custom search icon== | + | ===Show Edit button=== |
| + | The '''Show Edit button''' attribute determines whether the Edit button should be displayed in the section header. | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ===Hide custom search icon=== | ||
The '''Hide the custom search icon''' attribute determines whether the custom search icon should be displayed in the section header. | The '''Hide the custom search icon''' attribute determines whether the custom search icon should be displayed in the section header. | ||
| + | * See [[Custom Search]] | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ===Show Custom search dialog=== | ||
| + | The '''Show Custom search dialog''' attribute determines whether the Query Builder custom search dialog should be displayed when the custom search icon in the section header is clicked. | ||
| + | * See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Sections]] | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ===Show custom search dialog panel=== | ||
| + | The '''Show Custom search dialog panel''' attribute determines whether the Query Builder custom search dialog panel should be displayed when the custom search icon in the section header is clicked. | ||
| + | * See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Sections]] | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ===Columns=== | ||
| + | The '''Columns''' attribute determines whether the table columns listed in the Query Builder when the custom search icon in the section header is clicked. | ||
| + | * See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Sections]] | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Show info tips icon== | + | ===Show info tips icon=== |
The '''Show the info tips icon''' attribute determines whether the info tips icon should be displayed in the section header. | The '''Show the info tips icon''' attribute determines whether the info tips icon should be displayed in the section header. | ||
* See [[Help Attributes#Info tips|Help Attributes: Info tips]] | * See [[Help Attributes#Info tips|Help Attributes: Info tips]] | ||
| Line 109: | Line 139: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Show help icon== | + | ===Show help icon=== |
The '''Show the help icon''' attribute determines whether the help icon should be displayed in the section header. | The '''Show the help icon''' attribute determines whether the help icon should be displayed in the section header. | ||
* See [[Help Attributes#Help table|Help Attributes: Help table]] | * See [[Help Attributes#Help table|Help Attributes: Help table]] | ||
| Line 115: | Line 145: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Help topic== | + | ===Help topic=== |
The '''Help topic''' attribute specifies the name of the help topic to display when the help icon is clicked in the section header | The '''Help topic''' attribute specifies the name of the help topic to display when the help icon is clicked in the section header | ||
* See [[Help Attributes#Help table|Help Attributes: Help table]] | * See [[Help Attributes#Help table|Help Attributes: Help table]] | ||
| Line 121: | Line 151: | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Notes on Client Support== | + | ===Notes on Client Support=== |
{| class="wikitable" width="100%" | {| class="wikitable" width="100%" | ||
| − | !width=" | + | !width="30%"|Attribute |
| − | !width=" | + | !width="70%"|Notes |
|- | |- | ||
|valign="top"|Hide header||- | |valign="top"|Hide header||- | ||
| Line 133: | Line 163: | ||
|- | |- | ||
|valign="top"|Hide editing buttons||The editing buttons are always hidden on the Web/Mobile client. | |valign="top"|Hide editing buttons||The editing buttons are always hidden on the Web/Mobile client. | ||
| + | |- | ||
| + | |valign="top"|Show record count badge||- | ||
|- | |- | ||
|valign="top"|Header CSS style||The Header CSS style is supported on the Desktop client only. | |valign="top"|Header CSS style||The Header CSS style is supported on the Desktop client only. | ||
| Line 156: | Line 188: | ||
|valign="top"|Show Print button||The Print button is always hidden on the Web/Mobile client. | |valign="top"|Show Print button||The Print button is always hidden on the Web/Mobile client. | ||
|- | |- | ||
| − | |valign="top"| | + | |valign="top"|Show Edit button||The Edit button is always hidden on the Web/Mobile client. |
| + | |- | ||
| + | |valign="top"|Hide custom search icon||- | ||
| + | |- | ||
| + | |valign="top"|Show Custom search dialog||- | ||
| + | |- | ||
| + | |valign="top"|Show custom search dialog panel||- | ||
| + | |- | ||
| + | |valign="top"|Columns||The Columns attribute is supported on the Desktop client only. | ||
|- | |- | ||
|valign="top"|Show info tips icon||The info tips icon is always hidden on the Web/Mobile client. | |valign="top"|Show info tips icon||The info tips icon is always hidden on the Web/Mobile client. | ||
| Line 165: | Line 205: | ||
|- | |- | ||
|} | |} | ||
| + | |||
| + | ==Custom Header Style== | ||
| + | Custom Header Style attributes are available from v4.1. | ||
| + | |||
| + | ===Use custom header style=== | ||
| + | The '''Use custom header style''' attribute determines whether a custom header style should be used. | ||
| + | |||
| + | ===Header background color=== | ||
| + | The '''Header background color''' attribute specifies the header background color. | ||
| + | * See [[Colors]] | ||
| + | |||
| + | ===Header foreground color=== | ||
| + | The '''Header foreground color''' attribute specifies the header foreground color. | ||
| + | * See [[Colors]] | ||
| + | |||
| + | ===Header bottom border=== | ||
| + | The '''Header bottom border''' attribute determines whether the header bottom border should be displayed. | ||
| + | |||
| + | ===Header bottom border height=== | ||
| + | The '''Header bottom border height''' attribute determines the height (in pixels) of the header bottom border (if displayed). | ||
| + | |||
| + | ===Header bottom border color=== | ||
| + | The '''Header bottom border color''' attribute specifies the header bottom border color. | ||
| + | * See [[Colors]] | ||
| + | |||
| + | ==App Settings== | ||
| + | The '''Section Defaults''' category of [[App Settings]] includes options for defining section header appearance throughout the App. These settings apply to desktop Apps only. | ||
| + | |||
| + | ===Header type=== | ||
| + | The '''Header type''' attribute specifies whether section headers should have a 'flat' color or 'gradient' background. | ||
| + | |||
| + | ===Icon set=== | ||
| + | The '''Icon set''' attribute specifies which icon set should be used for section headers: 'gradient', 'black', 'white', 'gray' or darkgray'. | ||
| + | |||
| + | ===Header height=== | ||
| + | The '''Header height''' attribute specifies the section header height in pixels. | ||
| + | |||
| + | ===Header background color=== | ||
| + | The '''Header background color''' attribute specifies the background color for section headers. This is only applied when the '''Header type''' is 'flat'. | ||
| + | |||
| + | ===Header foreground color=== | ||
| + | The '''Header foreground color''' attribute specifies the foreground color for the 'Caption' in section headers. | ||
| + | |||
| + | ===Header font size=== | ||
| + | The '''Header font size''' attribute specifies the font size for the 'Caption' in section headers. | ||
| + | |||
| + | ===Header CSS=== | ||
| + | The '''Header CSS''' attribute specifies the CSS styles for section headers. See also [[CSS]]. | ||
[[Category:Attribute Categories]] | [[Category:Attribute Categories]] | ||
| + | [[Category:Sections]] | ||
| + | [[Category:SectionAnatomy]] | ||
Latest revision as of 09:24, 13 June 2023
Contents
- 1 Header
- 1.1 Hide header
- 1.2 Hide navigation buttons
- 1.3 Hide editing buttons
- 1.4 Show record count badge
- 1.5 Hide actionbar
- 1.6 Header CSS style
- 1.7 Background color
- 1.8 Foreground color
- 1.9 Header icon
- 1.10 Gradient colors
- 1.11 Gradient type
- 1.12 Gradient start color
- 1.13 Gradient end color
- 1.14 Show OK/Cancel buttons
- 1.15 Show Add/Delete buttons
- 1.16 Show Print button
- 1.17 Show Edit button
- 1.18 Hide custom search icon
- 1.19 Show Custom search dialog
- 1.20 Show custom search dialog panel
- 1.21 Columns
- 1.22 Show info tips icon
- 1.23 Show help icon
- 1.24 Help topic
- 1.25 Notes on Client Support
- 2 Custom Header Style
- 3 App Settings
Header
Hide header
The Hide header attribute determines whether the Section Header is hidden or not.
- Note that the Section header will be hidden at runtime only.
- For Page Center Sections, the Hide header attribute is checked (True) by default.
The Hide navigation buttons attribute determines whether the actionbar navigation buttons (as above: First, Previous, Next, Last) are displayed in the section header.
- This only applies when the actionbar is not hidden.
Hide editing buttons
The Hide editing buttons attribute is ignored. See below to hide or show the OK/Cancel buttons.
- Note that the section Readonly attribute can be checked to True to make the section readonly (non-editable).
Show record count badge
The Show record count badge attribute determines whether the record count badge should be displayed in the section header. This is available for data-bound sections.
From v5.2.
Hide actionbar
The Hide actionbar attribute determines whether the Page actionbar is displayed when this section is activated as a stacked section at runtime.
Header CSS style
The Header CSS style attribute specifies CSS attributes for the header.
Background color
The Background color attribute specifies the header background color.
- See Colors
Foreground color
The Foreground color attribute specifies the header foreground color.
- See Colors
Header icon
The Header icon attribute is ignored.
Gradient colors
The Gradient colors attribute determines whether the Header background should be rendered with gradient colors.
- See Gradients
Gradient type
The Gradient type attribute specifies the gradient type to be used if Gradient colors is True.
- See Gradients
Gradient start color
The Gradient start color attribute specifies the start color to be used if Gradient colors is True.
- See Gradients
Gradient end color
The Gradient end color attribute specifies the end color to be used if Gradient colors is True.
- See Gradients
Show OK/Cancel buttons
Check or uncheck the attributes to hide or show the buttons and icons in the Section Header.
The Show OK/Cancel buttons attribute determines whether the OK (green tick) and Cancel (red cross) buttons should be displayed in the section header when the section is in edit mode.
Show Add/Delete buttons
The Show Add/Delete buttons attribute determines whether the Add (+) and Delete (-) buttons should be displayed in the section header.
Show Print button
The Show Print button attribute determines whether the Print button should be displayed in the section header.
Show Edit button
The Show Edit button attribute determines whether the Edit button should be displayed in the section header.
Hide custom search icon
The Hide the custom search icon attribute determines whether the custom search icon should be displayed in the section header.
- See Custom Search
Show Custom search dialog
The Show Custom search dialog attribute determines whether the Query Builder custom search dialog should be displayed when the custom search icon in the section header is clicked.
Show custom search dialog panel
The Show Custom search dialog panel attribute determines whether the Query Builder custom search dialog panel should be displayed when the custom search icon in the section header is clicked.
Columns
The Columns attribute determines whether the table columns listed in the Query Builder when the custom search icon in the section header is clicked.
Show info tips icon
The Show the info tips icon attribute determines whether the info tips icon should be displayed in the section header.
Show help icon
The Show the help icon attribute determines whether the help icon should be displayed in the section header.
Help topic
The Help topic attribute specifies the name of the help topic to display when the help icon is clicked in the section header
Notes on Client Support
| Attribute | Notes |
|---|---|
| Hide header | - |
| Hide actionbar | The actionbar is always hidden on the Web/Mobile client. |
| Hide navigation buttons | The navigation buttons are always hidden on the Web/Mobile client. |
| Hide editing buttons | The editing buttons are always hidden on the Web/Mobile client. |
| Show record count badge | - |
| Header CSS style | The Header CSS style is supported on the Desktop client only. |
| Background color | The Background color is ignored on all clients. |
| Foreground color | The Foreground color is ignored on all clients. |
| Header icon | The Header icon is always hidden on all clients. |
| Gradient colors | Gradient colors are supported on the Desktop client only. |
| Gradient type | The Gradient type is supported on the Desktop client only. |
| Gradient start color | The Gradient start color is supported on the Desktop client only. |
| Gradient end color | The Gradient end color is supported on the Desktop client only. |
| Show OK/Cancel buttons | The OK/Cancel buttons are always hidden on the Web/Mobile client. |
| Show Add/Delete buttons | The Add/Delete buttons are always hidden on the Web/Mobile client. |
| Show Print button | The Print button is always hidden on the Web/Mobile client. |
| Show Edit button | The Edit button is always hidden on the Web/Mobile client. |
| Hide custom search icon | - |
| Show Custom search dialog | - |
| Show custom search dialog panel | - |
| Columns | The Columns attribute is supported on the Desktop client only. |
| Show info tips icon | The info tips icon is always hidden on the Web/Mobile client. |
| Show help icon | The help icon is always hidden on the Web/Mobile client. |
| Help topic | The Help topic is supported on the Desktop client only. |
Custom Header Style
Custom Header Style attributes are available from v4.1.
Use custom header style
The Use custom header style attribute determines whether a custom header style should be used.
Header background color
The Header background color attribute specifies the header background color.
- See Colors
Header foreground color
The Header foreground color attribute specifies the header foreground color.
- See Colors
Header bottom border
The Header bottom border attribute determines whether the header bottom border should be displayed.
Header bottom border height
The Header bottom border height attribute determines the height (in pixels) of the header bottom border (if displayed).
Header bottom border color
The Header bottom border color attribute specifies the header bottom border color.
- See Colors
App Settings
The Section Defaults category of App Settings includes options for defining section header appearance throughout the App. These settings apply to desktop Apps only.
Header type
The Header type attribute specifies whether section headers should have a 'flat' color or 'gradient' background.
Icon set
The Icon set attribute specifies which icon set should be used for section headers: 'gradient', 'black', 'white', 'gray' or darkgray'.
Header height
The Header height attribute specifies the section header height in pixels.
Header background color
The Header background color attribute specifies the background color for section headers. This is only applied when the Header type is 'flat'.
Header foreground color
The Header foreground color attribute specifies the foreground color for the 'Caption' in section headers.
Header font size
The Header font size attribute specifies the font size for the 'Caption' in section headers.
Header CSS
The Header CSS attribute specifies the CSS styles for section headers. See also CSS.
