Difference between revisions of "Link"
Jump to navigation
Jump to search
(→Syntax) |
|||
| (12 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{UI Object Header}} | {{UI Object Header}} | ||
A button used to navigate to another page, a pop-up, or an external Web page. | A button used to navigate to another page, a pop-up, or an external Web page. | ||
| − | It has several colors (depending on the skin) and | + | It has several colors (depending on the skin) and four different sizes: |
* '''link''' (standard size) | * '''link''' (standard size) | ||
| + | :[[File:UI Object link.png]] | ||
* '''linkmini''' (medium size) | * '''linkmini''' (medium size) | ||
| + | :[[File:UI Object linkmini.png]] | ||
* '''linkmicro''' (small size) | * '''linkmicro''' (small size) | ||
| + | :[[File:UI Object linkmicro.png]] | ||
| + | * '''dlink''' (big size) | ||
| + | :[[File:UI Object dlink.png]] | ||
| + | |||
| + | For a custom image version, see [[ImageLink]]. | ||
== Parameters == | == Parameters == | ||
| + | *'''id''': the object's ID, used by UISets. Required | ||
*'''position''': the object's position. Use the pixels or rows and columns coordinates format | *'''position''': the object's position. Use the pixels or rows and columns coordinates format | ||
*'''color''': the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass) | *'''color''': the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass) | ||
| − | *'''page''': the name of the destination page associated to the button. It is possible to specify an absolute or relative URL in the '''page''' parameter. The tag will work as an <A HREF> tag, loading the new page. If the loaded page is an HSYCO menu, the '''back''' link will show up in the menu page, to reload the referrer page | + | *'''page''': the name of the destination page associated to the button. It is possible to specify an absolute or relative URL in the '''page''' parameter. The tag will work as an <A HREF> tag, loading the new page. If the loaded page is an HSYCO menu, the '''back''' link will show up in the menu page, to reload the referrer page. It is also possible to use the special keywords "$__urlkey;" and "$__query;" that will be replace with the URLKey and URL query string (if present, including the leading "?" character) |
*'''label''': the text label on the button. It can contain HTML tags | *'''label''': the text label on the button. It can contain HTML tags | ||
== Syntax == | == Syntax == | ||
| − | (link!id <pos>; <color>; <page>; <label>) | + | (link[!<id>] <pos>; <color>; <page>; <label>) |
| − | (linkmini!id <pos>; <color>; <page>; <label>) | + | |
| − | (linkmicro!id <pos>; <color>; <page>; <label>) | + | (linkmini[!<id>] <pos>; <color>; <page>; <label>) |
| + | |||
| + | (linkmicro[!<id>] <pos>; <color>; <page>; <label>) | ||
| + | |||
| + | (dlink[!<id>] <pos>; <color>; <page>; <label>) | ||
E.g. | E.g. | ||
(link!link1 x10y20; r; page1; Page 1) | (link!link1 x10y20; r; page1; Page 1) | ||
| − | (linkmini r0c1; glass | + | (linkmini r0c1; glass; <nowiki>http://www.hsyco.com</nowiki>; hsyco) |
| + | |||
| + | (linkmicro x0y100; gr; /hsycohsyco/office; HSYCO Office) | ||
| − | ( | + | (dlink!dlink1 x10y10; b; page1; <nowiki>Larger text<br>with <b>HTML</b></nowiki> tags) |
== UI Attributes == | == UI Attributes == | ||
| − | {{ | + | {{UI Object Attributes (Common)}} |
| + | {{UI Object Attributes (Label)}} | ||
| + | {{UI Object Attributes (Button)}} | ||
Latest revision as of 15:27, 24 September 2015
For a description and a complete list of UI Objects, see A button used to navigate to another page, a pop-up, or an external Web page. It has several colors (depending on the skin) and four different sizes:
- link (standard size)
- linkmini (medium size)
- linkmicro (small size)
- dlink (big size)
For a custom image version, see ImageLink.
Contents
Parameters
- id: the object's ID, used by UISets. Required
- position: the object's position. Use the pixels or rows and columns coordinates format
- color: the color of the button. It can assume any of the skin's color values (E.g. for the "blue" skin, the possible values are: b - blue; g - green; gr - gray; r - red; y - yellow; glass)
- page: the name of the destination page associated to the button. It is possible to specify an absolute or relative URL in the page parameter. The tag will work as an <A HREF> tag, loading the new page. If the loaded page is an HSYCO menu, the back link will show up in the menu page, to reload the referrer page. It is also possible to use the special keywords "$__urlkey;" and "$__query;" that will be replace with the URLKey and URL query string (if present, including the leading "?" character)
- label: the text label on the button. It can contain HTML tags
Syntax
(link[!<id>] <pos>; <color>; <page>; <label>) (linkmini[!<id>] <pos>; <color>; <page>; <label>) (linkmicro[!<id>] <pos>; <color>; <page>; <label>) (dlink[!<id>] <pos>; <color>; <page>; <label>)
E.g.
(link!link1 x10y20; r; page1; Page 1) (linkmini r0c1; glass; http://www.hsyco.com; hsyco) (linkmicro x0y100; gr; /hsycohsyco/office; HSYCO Office) (dlink!dlink1 x10y10; b; page1; Larger text<br>with <b>HTML</b> tags)
UI Attributes
Common attributes
| Name | Value | Description |
|---|---|---|
| pos | x<x>y<y> | Position specified as x/y coordinates. E.g. x-5y10 |
| visible | true | Default. Show the object |
| false | Hide the object | |
| blink | true | slow | Blink the object at a slow speed |
| fast | Blink the object at a fast speed | |
| false | Stop the blinking | |
| opacity | 0.0 ... 1.0 | Object opacity from 0 (not visible) to 1 (fully visible) |
| rotation | 0 ... 360 | Object rotation in degrees. Images are rotated around the center point, all other objects are rotated around the top left corner |
Label attributes
| Name | Value | Description |
|---|---|---|
| label | <string> | Label's text. Can contain HTML tags |
| fontfamily | <family name> | A prioritized list of font family names |
| fontsize | <size> | Font size in pixels. E.g. 15px |
| fontcolor | <CSS color> | Font color |
| fontstyle | normal | Normal font style, default |
| italic | Italic font style | |
| oblique | Oblique font style | |
| fontweight | normal | Normal characters, default |
| bold | Thick characters | |
| bolder | Thicker characters | |
| lighter | Lighter characters | |
| 100 ... 900 | Defines from thin to thick characters. 400 is the same as normal, and 700 is the same as bold |
Button attributes
| Name | Value | Description |
|---|---|---|
| style | red,green,blue... | Set the button's style (color). Styles vary depending on the selected skin |
| enabled | true | Default. Enable the button |
| false | Disable the button |
