A custom control that implements the FrontPage Navigation (“Navigation”) control.
FpLinkBar displays a set of hyperlinks that enable site visitors to navigate to the pages in your Web site. You place link bars in a prominent and consistent location on each page, and they act as a map to the pages you designate. If the web page uses a FrontPage theme, graphical navigation buttons may be used. Several standard text formats are supported through the ButtonFormat property, as well as several advanced properties that allow complete control over the formatting.
When you create your web site, you can either create link bars that you specify the links for, or add a link bar that is based on the navigation structure of your site. PagePorter maintains the link bars you create; if you move or add a page, PagePorter updates the link bars accordingly.
You can format your link bars in the following ways:
FpLinkBar must be hosted in a project that has a valid web
metadata file (usually _config/service.cnf or _vti_pvt/service.cnf)
and a navigation structure file (usually _config/structure.cnf
or _vti_pvt/structure.cnf). If not, the control will throw an
exception at design-time and runtime.
| Property | Summary | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ButtonFormat |
The format of the navigation buttons (HTML rendering only):
|
|||||||||||||||||||||||||||||||||||||||||||||
| ButtonFormatNormal | The HTML macro for a normal link bar button. Advanced Property. See the Advanced Button Formats section for more information. | |||||||||||||||||||||||||||||||||||||||||||||
| ButtonFormatPrefix |
The HTML to emit at the beginning of the link bar. Advanced
Property.
|
|||||||||||||||||||||||||||||||||||||||||||||
| ButtonFormatSelect |
The HTML macro for a selected link bar button. Advanced Property.
See the HTML Macros section for more information.
|
|||||||||||||||||||||||||||||||||||||||||||||
| ButtonFormatSeparator |
The HTML to emit between link bar buttons. Advanced Property.
|
|||||||||||||||||||||||||||||||||||||||||||||
| ButtonFormatSuffix |
The HTML to emit at the end of the menu bar. Advanced Property.
|
|||||||||||||||||||||||||||||||||||||||||||||
| IncludeHome |
Whether or not to include the Home page.
|
|||||||||||||||||||||||||||||||||||||||||||||
| IncludeUp | Whether or not to include the Parent page. | |||||||||||||||||||||||||||||||||||||||||||||
| LinkBarPage | The SID of the custom link bar (Valid only in Custom or CustomArrows types). | |||||||||||||||||||||||||||||||||||||||||||||
| Orientation |
The orientation of the link bar:
|
|||||||||||||||||||||||||||||||||||||||||||||
| Rendering | How the link bar is rendered:
|
|||||||||||||||||||||||||||||||||||||||||||||
| Target | The value for the target attribute in the link bar
button. For graphical buttons, it is included in the link tag
enclosing the graphic image. For HTML buttons, it is the value for the #TARGET# HTML macro substitution
for ButtonFormatNormal and ButtonFormatSelect.
Target may be anything, but these are well-known HTML targets:
|
|||||||||||||||||||||||||||||||||||||||||||||
| MsTheme | The Theme override. Normally inherits from the page that hosts this control. | |||||||||||||||||||||||||||||||||||||||||||||
| Type | The type of navigation:
|
|||||||||||||||||||||||||||||||||||||||||||||
Although the standard HTML button formats specified by the FpLinkBarButtonFormat enumeration provide a variety of display options, you may want a button format that is different from any of the standard ones. By specifying values for the ButtonFormatNormal, ButtonFormatPrefix, ButtonFormatSelect, ButtonFormatSeparator, and ButtonFormatSuffix properties, you can modify an existing format or define your own format.
When the FpLinkBar control renders, it outputs the ButtonFormatPrefix value to begin the link bar itself. For each link button, it outputs either ButtonFormatNormal or ButtonFormatSelect depending on whether or not the button’s link URL is the current page, followed by ButtonFormatSeparator unless this is the last button. Finally, the ButtonFormatSuffix value is output to end the link bar. The following table shows the default values for these format properties for the various FpLinkBarButtonFormat values, which may be used as a starting point for your custom format:
| Format | ButtonFormatPrefix | ButtonFormatNormal | ButtonFormatSelect | ButtonFormatSeparator | ButtonFormatSuffix | ||
|---|---|---|---|---|---|---|---|
| Horizontal | Vertical | Horizontal | Vertical | ||||
| Bars | <a href="#URL#" target="#TARGET#" style="{text-decoration: none;}">#LABEL#</a> | #LABEL# | | | <br> | |||
| Brackets | [<a href="#URL#" target="#TARGET#" style="{text-decoration: none;}">#LABEL#</a>] | [#LABEL#] | | <br> | |||
| Dots | <a href="#URL#" target="#TARGET#" style="{text-decoration: none;}">#LABEL#</a> | #LABEL# | • | <br> | |||
| MoreDots | • | • | <a href="#URL#" target="#TARGET#" style="{text-decoration: none;}">#LABEL#</a> | #LABEL# | • | •<br>• | • |
| Slashes | <a href="#URL#" target="#TARGET#" style="{text-decoration: none;}">#LABEL#</a> | #LABEL# | / | <br> | |||
| Tabular | <table width="100%"><tr><td align="center"> | <table><tr><td align="center"> | <a href="#URL#" target="#TARGET#">#LABEL#</a> | #LABEL# | </td><td align="center"> | </td></tr><tr><td align="center"> | </td></tr></table> |
| Underlined | <a href="#URL#" target="#TARGET#">#LABEL#</a> | <u>#LABEL#</u> | | <br> | |||
The ButtonFormatNormal and ButtonFormatSelect properties use macro substitution to render the text for these button parts. This is, for example, how the link URL is output. The following table shows the possible macros and their substitutions:
| Macro | Summary |
|---|---|
| #LABEL# | The page Caption property, HTML-encoded with non-breaking spaces. |
| #TARGET# | The page Target property or, if blank, the control Target property. |
| #URL# | The page URL link. |