Page Header
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 search box
- 17 Minimum search text length
- 18 Hide notifications icon
- 19 Hide custom search icon
- 20 Hide fullscreen icon
- 21 Hide share icon
- 22 Hide home icon
- 23 Hide hamburger menu
- 24 Hide navigation history icons
- 25 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 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 custom search icon
The Hide fullscreen icon attribute determines whether the custom search icon should be hidden.
- See screenshot above.
- See Custom Search.
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.
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 custom search icon | The custom search icon is always hidden on the Web/Mobile client. |
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 hamburger menu | - |
Hide the navigation history icons | Hiding the navigation history icons is supported on the Desktop client only. |