FolderBreadcrumb

Inserting the FolderBreadcrumb server control onto a page

Prerequisite

You must have installed the server controls. See Installing server controls into Visual Studio Toolbox.

1. In Visual Studio, choose View > Toolbox.
2. Click the Ektron server control tab to display the server controls.
3. Drag the FolderBreadcrumb server control and drop it into the desired location on the page.

   NOTE: You also can place the cursor on the page where you want the server control, then double click the server control that you want.

   <CMS:FolderBreadcrumb ID="FolderBreadcrumb1" runat="server" />

4. Click on FolderBreadcrumb in the code to display and modify the control’s properties using the Properties window of Visual Studio. The page is updated as you modify the property values.
   —Image—

   

FolderBreadCrumb properties

The following are Ektron-specific server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. properties. For information about native .NET properties such as font, height, width and border style, use Visual Studio^® help.

• AddContentTitleToBreadcrumb (Boolean)

  When set to true, the content title is added to the end of the breadcrumb path, as shown.

  Home > Content > Content_Title

  By default, the value is set to false. In that case, the breadcrumb path looks like this.

  Home > Content

• DefaultContentID (Long)

  Display the breadcrumb trail for the folder in which the given content ID resides. To use this property, breadcrumb information for a folder must be defined in the Workarea > [Specified Folder] > Folder properties > Breadcrumb tab.

• DefaultFolderID (Long)

  The folder ID for which you want the breadcrumb trail to display. If a DefaultContentID is given, it overrides this property. To use this property, breadcrumb information for a folder must be defined in the Workarea > [Specified Folder] > Folder properties > Breadcrumb tab.

• DisplayStyle (DisplayStyles)

  Indicate how to display the breadcrumb trail: horizontally or vertically. The default is Horizontal.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page. If nothing is specified, the menu is output as raw XML. FlexMenus use an .xsl file to control the menu’s behavior, and a .css file to control its display. Ektron provides several sample menus, and each has an xslt file. If this is a new menu, you may find it easier to copy and edit an xslt file provided with a sample menu. See also: SampleMenu.

  WARNING! Files stored in the siteroot\Workarea folder are overwritten (or deleted) when you upgrade Ektron. To avoid problems, copy the default file to a folder outside the siteroot\workarea folder then edit it. If there is no default file, create the file outside the siteroot\workarea folder. Next, in this property, enter the path to that file relative to the site root folder.

• DoInitFill (Boolean)

  By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, Fill is automatically called during the Page Render event. You might do this if you need to set or change a property on the control in code-behind and have it render with your changes shown.

• DynamicParameter (String)

  Gets or sets the QueryString parameter to read a content ID dynamically.

• Hide (Boolean)

  Hides or displays the output of the control in design time and run time.

  • True. Hide the control output.
  • False. Display the control output.
• Language (Integer)

  Set a language for viewing content; shows results in design-time (in Visual Studio) and at run-time (in a browser).

• LinkTarget (ItemLinkTargets)

  Determines the type of window that appears when you click a link in the server control.

  • _Self (default). Opens in same window.
  • _Top. Opens in parent window.
  • _Blank. Opens in new window.
  • _Parent. Opens in the parent frame.
• Mode (Modes)

  Lets you make the breadcrumb trail appear as non-hyperlinked plain text.

  • Normal (normal). Breadcrumb trail is hyperlinked
  • DisplayOnly. Breadcrumb trail is plain text
• Separator (String)

  Enter one or more characters to separate the items in a breadcrumb trail on this Web form. The default character is the greater than sign (>).

• SuppressWrapperTags (Boolean)

  Suppresses the output of the span/div tags around the control.

  • True. Suppress wrap tags.
  • False (default). Allow wrap tags.
• WrapTag (String)

  Lets a developer specify a server control’s tag.

  • Span (default). Designate an inline portion of an HTML document as a span element.
  • Div. Apply attributes to a block of code.
  • Custom. Lets you use a custom tag.

Using a FolderBreadcrumb server control

Add the FolderBreadcrumb server controla server control uses API language to interact with the CMS and Framework UI to display the output. A server control can be dragged and dropped onto a Web form and then modified. to each Web form for which you want to create a breadcrumb site map.

Follow these steps to use a FolderBreadcrumb server control.

1. In the Workarea, define breadcrumb information for a folder. See also: BreadCrumb
2. Open a Web form for which you want to create a site map.
3. Drag and drop the FolderBreadcrumb server control onto the Web form.
4. Set the DefaultContentID or DefaultFolderID property. If you use DefaultContentID, make sure the content is in a folder for which breadcrumb information is defined. If you use DefaultFolderID, make sure breadcrumb information is defined for that folder.
5. Save the Web form.
6. Open a browser.
7. View a Web page that hosts the control to view the breadcrumb trail.
   —Image—