Difference between revisions of "Page Header"
Yvonne.milne (Talk | contribs) |
Yvonne.milne (Talk | contribs) |
||
Line 2: | Line 2: | ||
==Visible== | ==Visible== | ||
− | Header visible | + | The Header '''Visible''' attribute determines whether the Page Header is visible or not. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Caption== | ==Caption== | ||
− | Header | + | 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 [[Working with the Lianja Object Model|Lianja.getElementByID("page").caption]]. | |
− | The Page Header Caption attribute can be queried or changed programmatically using [[Working with the Lianja Object Model|Lianja.getElementByID("page").caption]]. | + | * Note that the Page '''Name''' is used in the [[Working with the Lianja Object Model|Lianja Object Model]] and the Page '''Title''' is used in Page navigation displays. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Height== | ==Height== | ||
− | Header height. | + | The Header '''Height''' attribute specifies its height in pixels. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Background color== | ==Background color== | ||
− | Header 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]] | * See [[Colors]] | ||
Line 25: | Line 25: | ||
==Foreground color== | ==Foreground color== | ||
− | Header foreground color. | + | The Header '''Foreground color''' attribute specifies its foreground color. |
* See [[Colors]] | * See [[Colors]] | ||
Line 31: | Line 31: | ||
==Header bottom border== | ==Header bottom border== | ||
− | + | The '''Header bottom border''' attribute determines whether a border should be displayed at the bottom of the Header. | |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Header bottom border color== | ==Header bottom border color== | ||
− | Header bottom border color. | + | The '''Header bottom border color''' attribute determines the color of the '''Header bottom border''' if displayed. |
* See [[Colors]] | * See [[Colors]] | ||
Line 42: | Line 42: | ||
==Header image== | ==Header image== | ||
− | The image for the Header (png | jpg | gif). | + | The '''Header image''' attribute specifies a background image for the Header (png | jpg | gif). |
− | + | * This is only displayed if '''Gradient colors''' is False. | |
[[#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. | |
* See [[Gradients]] | * See [[Gradients]] | ||
Line 54: | Line 54: | ||
==Gradient type== | ==Gradient type== | ||
− | + | The '''Gradient type''' attribute specifies the gradient type to be used if '''Gradient colors''' is True. | |
* See [[Gradients]] | * See [[Gradients]] | ||
Line 60: | Line 60: | ||
==Gradient start color== | ==Gradient start color== | ||
− | Gradient start color. | + | The '''Gradient start color''' specifies the start color to be used if '''Gradient colors''' is True. |
* See [[Gradients]] | * See [[Gradients]] | ||
Line 66: | Line 66: | ||
==Gradient end color== | ==Gradient end color== | ||
− | Gradient end color. | + | The '''Gradient end color''' specifies the end color to be used if '''Gradient colors''' is True. |
* See [[Gradients]] | * See [[Gradients]] | ||
Line 81: | Line 81: | ||
==Hide header icon== | ==Hide header icon== | ||
− | Hide the header icon | + | The '''Hide the header icon''' 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 search box== | ==Hide search box== | ||
− | Hide | + | The '''Hide search box''' determines whether the search box should be hidden. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Minimum search text length== | ==Minimum search text length== | ||
− | Minimum number of characters to | + | The '''Minimum search text length''' specifies the number of characters that need to be typed in the search box before the search is made. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide notifications icon== | ==Hide notifications icon== | ||
− | Hide | + | The '''Hide notifications icon''' determines whether the notifications icon should be hidden. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide fullscreen icon== | ==Hide fullscreen icon== | ||
− | Hide | + | The '''Hide fullscreen icon''' determines whether the fullscreen icon should be hidden. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide share icon== | ==Hide share icon== | ||
− | Hide | + | The '''Hide share icon''' determines whether the share icon should be hidden. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] | ||
==Hide home icon== | ==Hide home icon== | ||
− | Hide | + | The '''Hide home icon''' determines whether the home icon should be hidden. |
[[#Notes on Client Support|Notes on Client Support]] | [[#Notes on Client Support|Notes on Client Support]] |
Revision as of 10:45, 11 April 2016
Under construction
Contents
- 1 Visible
- 2 Caption
- 3 Height
- 4 Background color
- 5 Foreground color
- 6 Header bottom border
- 7 Header bottom border color
- 8 Header image
- 9 Gradient colors
- 10 Gradient type
- 11 Gradient start color
- 12 Gradient end color
- 13 Hide header icon
- 14 Hide search box
- 15 Minimum search text length
- 16 Hide notifications icon
- 17 Hide fullscreen icon
- 18 Hide share icon
- 19 Hide home icon
- 20 Notes on Client Support
Visible
The Header Visible attribute determines whether the Page Header is visible or not.
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 specifies the start color to be used if Gradient colors is True.
- See Gradients
Gradient end color
The Gradient end color specifies the end color to be used if Gradient colors is True.
- See Gradients
Check or uncheck the attributes to hide or show the icons in the Page Header.
Hide header icon
The Hide the header icon determines whether the header icon should be hidden.
Hide search box
The Hide search box determines whether the search box should be hidden.
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.
Hide notifications icon
The Hide notifications icon determines whether the notifications icon should be hidden.
Hide fullscreen icon
The Hide fullscreen icon determines whether the fullscreen icon should be hidden.
The Hide share icon determines whether the share icon should be hidden.
Hide home icon
The Hide home icon determines whether the home icon should be hidden.
Notes on Client Support
Attribute | Notes |
---|---|
Visible | - |
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 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 | - |