Difference between revisions of "Page Header"
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) (→Notes on Client Support) |
||
| (28 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
==Visible== | ==Visible== | ||
The Header '''Visible''' attribute determines whether the Page Header is visible or not. | The Header '''Visible''' attribute determines whether the Page Header is visible or not. | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ==Custom header== | ||
| + | The '''Custom header''' attribute determines whether the page header is rendered using the [[#Custom header display delegate|Custom header display delegate]] or not. | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ==Custom header display delegate== | ||
| + | The '''Custom header display delegate''' attribute specifies the name of a procedure/function that will render the page header when [[#Custom header|Custom header]] is true. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| Line 58: | Line 68: | ||
==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]]. | ||
| Line 64: | Line 74: | ||
==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]]. | ||
| Line 80: | Line 90: | ||
<br clear=all> | <br clear=all> | ||
| − | The '''Hide the header icon''' determines whether the header icon should be hidden. | + | The '''Hide the header icon''' attribute determines whether the header icon should be hidden. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ==Hide database switcher== | ||
| + | The '''Hide database switcher''' determines whether the database switcher should be hidden. | ||
| + | * From v6.3. | ||
| + | * See [[Database Tenancies#Database Switcher|Database Switcher]]. | ||
==Hide search box== | ==Hide search box== | ||
The '''Hide search box''' determines whether the search box should be hidden. | The '''Hide search box''' determines whether the search box should be hidden. | ||
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
* See [[Instant Search]]. | * See [[Instant Search]]. | ||
| Line 91: | Line 107: | ||
==Minimum search text length== | ==Minimum search text length== | ||
| − | The '''Minimum search text length''' specifies the number of characters that need to be typed in the search box before the search is made. | + | The '''Minimum search text length''' attribute specifies the number of characters that need to be typed in the search box before the search is made. |
| + | * See [[Instant Search]]. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide notifications icon== | ==Hide notifications icon== | ||
| − | The '''Hide notifications icon''' determines whether the notifications icon should be hidden. | + | The '''Hide notifications icon''' attribute determines whether the notifications icon should be hidden. |
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| − | ==Hide | + | ==Hide search icon== |
| − | The '''Hide | + | The '''Hide search icon''' attribute determines whether the custom search icon should be hidden. |
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
* See [[Custom Search]]. | * 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 page header is clicked. | ||
| + | * See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Pages]] | ||
| + | |||
| + | [[#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 page header is clicked. | ||
| + | * See [[QueryBuilder#Using_the_Query_Builder_in_Sections|Using the Query Builder in Pages]] | ||
| + | |||
| + | [[#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 page header is clicked. | ||
| + | * See [[QueryBuilder#Using_the_Query_Builder_in_Pages|Using the Query Builder in Pages]] | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide fullscreen icon== | ==Hide fullscreen icon== | ||
| − | The '''Hide fullscreen icon''' determines whether the fullscreen icon should be hidden. | + | The '''Hide fullscreen icon''' attribute determines whether the fullscreen icon should be hidden. |
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide share icon== | ==Hide share icon== | ||
| − | The '''Hide share icon''' determines whether the share icon should be hidden. | + | The '''Hide share icon''' attribute determines whether the share icon should be hidden. |
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide home icon== | ==Hide home icon== | ||
| − | The '''Hide home icon''' determines whether the home icon should be hidden. | + | The '''Hide home icon''' attribute determines whether the home icon should be hidden. |
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ==Hide print icon== | ||
| + | The '''Hide print icon''' attribute determines whether the print icon should be hidden. | ||
| + | * From v4.2. | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ==Hide hamburger menu== | ||
| + | The '''Hide hamburger menu''' attribute determines whether the hamburger menu icon should be hidden at runtime. | ||
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
| + | * See also [[Page_Menu#Hide_hamburger_menu|Page Menu: Hide hamburger menu]] | ||
| + | |||
| + | [[#Notes on Client Support|Notes on Client Support]] | ||
| + | |||
| + | ==Hide navigation history icons== | ||
| + | The '''Hide navigation history icons''' attribute determines whether the navigation history icons should be hidden. This overrides a True '''Show navigation history''' [[App Settings|App Setting]]. | ||
| + | * See [[#Hide_header_icon|screenshot above]]. | ||
| + | * See also [[Page_Menu#Hide_navigation_history_icons|Page Menu: Hide navigation history icons]] | ||
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
| Line 123: | Line 183: | ||
==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"|Visible||- | |valign="top"|Visible||- | ||
| + | |- | ||
| + | |valign="top"|Custom header||- | ||
| + | |- | ||
| + | |valign="top"|Custom header display delegate||The delegate must be written in JavaScript on the Web/Mobile client. | ||
|- | |- | ||
|valign="top"|Caption||- | |valign="top"|Caption||- | ||
| Line 158: | Line 222: | ||
|valign="top"|Hide notifications icon||The notifications icon is always hidden on the Web/Mobile client. | |valign="top"|Hide notifications icon||The notifications icon is always hidden on the Web/Mobile client. | ||
|- | |- | ||
| − | |valign="top"|Hide | + | |valign="top"|Hide 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"|Hide fullscreen icon||The fullscreen icon is always hidden on the Web/Mobile client. | |valign="top"|Hide fullscreen icon||The fullscreen icon is always hidden on the Web/Mobile client. | ||
| Line 165: | Line 235: | ||
|- | |- | ||
|valign="top"|Hide home icon||- | |valign="top"|Hide home icon||- | ||
| + | |- | ||
| + | |valign="top"|Hide print icon||- | ||
| + | |- | ||
| + | |valign="top"|Hide hamburger menu||- | ||
| + | |- | ||
| + | |valign="top"|Hide the navigation history icons||Hiding the navigation history icons is supported on the Desktop client only. | ||
|- | |- | ||
|} | |} | ||
[[Category:Attribute Categories]] | [[Category:Attribute Categories]] | ||
| + | [[Category:Pages]] | ||
| + | [[Category:PageAnatomy]] | ||
Latest revision as of 09:24, 13 June 2023
Contents
- 1 Visible
- 2 Custom header
- 3 Custom header display delegate
- 4 Caption
- 5 Height
- 6 Background color
- 7 Foreground color
- 8 Header bottom border
- 9 Header bottom border color
- 10 Header image
- 11 Gradient colors
- 12 Gradient type
- 13 Gradient start color
- 14 Gradient end color
- 15 Hide header icon
- 16 Hide database switcher
- 17 Hide search box
- 18 Minimum search text length
- 19 Hide notifications icon
- 20 Hide search icon
- 21 Show Custom search dialog
- 22 Show custom search dialog panel
- 23 Columns
- 24 Hide fullscreen icon
- 25 Hide share icon
- 26 Hide home icon
- 27 Hide print icon
- 28 Hide hamburger menu
- 29 Hide navigation history icons
- 30 Notes on Client Support
Visible
The Header Visible attribute determines whether the Page Header is visible or not.
Custom header
The Custom header attribute determines whether the page header is rendered using the Custom header display delegate or not.
Custom header display delegate
The Custom header display delegate attribute specifies the name of a procedure/function that will render the page header when Custom header is true.
Caption
The Header Caption attribute specifies the text to be displayed in the center of the Page Header.
- The Page Header Caption attribute can be queried or changed programmatically using Lianja.getElementByID("page").caption.
- Note that the Page Name is used in the Lianja Object Model and the Page Title is used in Page navigation displays.
Height
The Header Height attribute specifies its height in pixels.
Background color
The Header Background color attribute specifies its background color. This is only used if Gradient colors is False and no Header image is specified.
- See Colors.
Foreground color
The Header Foreground color attribute specifies its foreground color.
- See Colors.
Header bottom border
The Header bottom border attribute determines whether a border should be displayed at the bottom of the Header.
Header bottom border color
The Header bottom border color attribute determines the color of the Header bottom border if displayed.
- See Colors.
Header image
The Header image attribute specifies a background image for the Header (png | jpg | gif).
- This is only displayed if Gradient colors is False.
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.
Hide header icon
Check or uncheck the attributes to hide or show the icons in the Page Header.
The Hide the header icon attribute determines whether the header icon should be hidden.
Hide database switcher
The Hide database switcher determines whether the database switcher should be hidden.
- From v6.3.
- See Database Switcher.
Hide search box
The Hide search box determines whether the search box should be hidden.
- See screenshot above.
- See Instant Search.
Minimum search text length
The Minimum search text length attribute specifies the number of characters that need to be typed in the search box before the search is made.
- See Instant Search.
Hide notifications icon
The Hide notifications icon attribute determines whether the notifications icon should be hidden.
- See screenshot above.
Hide search icon
The Hide search icon attribute determines whether the custom search icon should be hidden.
- See screenshot above.
- 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 page 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 page header is clicked.
Columns
The Columns attribute determines whether the table columns listed in the Query Builder when the custom search icon in the page header is clicked.
Hide fullscreen icon
The Hide fullscreen icon attribute determines whether the fullscreen icon should be hidden.
- See screenshot above.
The Hide share icon attribute determines whether the share icon should be hidden.
- See screenshot above.
Hide home icon
The Hide home icon attribute determines whether the home icon should be hidden.
- See screenshot above.
Hide print icon
The Hide print icon attribute determines whether the print icon should be hidden.
- From v4.2.
The Hide hamburger menu attribute determines whether the hamburger menu icon should be hidden at runtime.
- See screenshot above.
- See also Page Menu: Hide hamburger menu
The Hide navigation history icons attribute determines whether the navigation history icons should be hidden. This overrides a True Show navigation history App Setting.
- See screenshot above.
- See also Page Menu: Hide navigation history icons
Notes on Client Support
| Attribute | Notes |
|---|---|
| Visible | - |
| Custom header | - |
| Custom header display delegate | The delegate must be written in JavaScript on the Web/Mobile client. |
| Caption | - |
| Height | The Header Height is adjustable on the Desktop client only. |
| Background color | The Background color is supported on the Desktop client only. |
| Foreground color | The Foreground color is supported on the Desktop client only. |
| Header bottom border | The Header bottom border is always displayed on the Web/Mobile client. |
| Header bottom border color | The Header bottom border color is adjustable on the Desktop client only. On the Web/Mobile client it is orange. |
| Header image | The Header image is displayed on the Desktop client only. |
| 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. |
| Hide header icon | The header icon is always hidden on the Web/Mobile client. |
| Hide search box | - |
| Minimum search text length | The Minimum search text length is supported on the Desktop client only. On the Web/Mobile client, the search starts from the first character entered. |
| Hide notifications icon | The notifications icon is always hidden on the Web/Mobile client. |
| Hide search icon | - |
| Show Custom search dialog | - |
| Show custom search dialog panel | - |
| Columns | The Columns attribute is supported on the Desktop client only. |
| Hide fullscreen icon | The fullscreen icon is always hidden on the Web/Mobile client. |
| Hide share icon | The share icon is always hidden on all clients. |
| Hide home icon | - |
| Hide print icon | - |
| Hide hamburger menu | - |
| Hide the navigation history icons | Hiding the navigation history icons is supported on the Desktop client only. |
