ActiveTopics 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (Boolean)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• BoardID (Long)

  The ID of the board from which to get entries. If you don’t know the ID, click Ellipses (), then sign in, browse to, and select a discussion board.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DisplayMode (eDisplayMode)

  Choose between Active or Recent. The default is Active.

  • Active—lists the most active posts.
    
  • Recent—lists recently added posts.
• 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.

• Hide (Boolean)

  Select False to display this server control on the page. Select True to suppress it.

• Language (Integer)

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

• MaxNumber (Integer)

  The maximum number of topics listed. The default is 10.

• SuppressWrapperTags (Boolean)

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

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

  Enter the path to the Forum server control’s Web page. For example: http://<your site>/siteroot/forum.aspx or /CMS400Developer/forum.aspx. If your Forum page and your Active Topics page are in the same folder, just enter the name of the page. For example: forum.aspx.

• 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.

ActivityStream 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultObjectID (Long)

  The ID of the object whose activity stream will appear where you place this server control. For example, if you want this control to display Scott Markey’s activities, and his USER ID is 142, place 142 here, and set the ObjectType property to User. To display the activity stream for the logged-in user, enter zero (0).

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• 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.

• DynamicObjectParameter (String)

  Gets or sets the QueryString parameter to read a object ID dynamically. To use the default object ID, leave blank. For example, if you are passing the ID value of a community group, you might enter ‘gid’ for this property. So, if you passed http://~yoursite~/CGHome.aspx?gid=21 on the Query Strings to a page containing this control, you would see the activity stream for the group with an ID of 21.

• EnablePaging (Boolean)

  This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen.

• 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).

• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  The Maximum number of notifications to fetch. 0 (zero) = unlimited.

• ObjectType (ActivityFeedType)

  The type of object to which this control is assigned. Choices are:

  • User—control is assigned to an individual
  • Group—control is assigned to a community group
• ProfileParamName (String)

  The parameter name to pass in the QueryString to the TemplateUserProfile page, if you want it to be anything other than id. For example, you may prefer userid, because it is more descriptive, as shown in the following example.

  

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

• SuppressWrapperTags (Boolean)

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

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

  The URL path to a page that contains another ActivityStream server control.
  When this property contains a path and the destination page has an ActivityStream control whose ObjectType property is set to Activity, a user can click an Activity Stream’s time span on the first page to open a second page that contains just that activity. See Also: Server Control Reference

• TemplateUserProfile (String)

  The URL path to a page that contains the UserProfile server control. The path can be relative or absolute. If you enter a path, a user can click a user’s name or avatar from the Message Board server control and be forwarded to the profile page. See illustration.

  —Image—

  

  User templates can be defined in the Ektron Workarea > Settings > Community Management > Templates screen. However, if you assign a template in this field, this setting takes precedence over the setting on the Workarea Template screen.

• 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.

AdaptiveMultiView Properties

• GroupId (Long)

  Group Id for the Device Group, which is displayed you can find in the table at Workarea > Settings > Configuration > Mobile Settings > View All Device Groups. If you set this to 0, GroupID is associated with any device that does not fit into any of the Device Groups created.

  NOTE: If Breakpoint Groups exist, every device will fall into one of these groups, therefore making this “Generic Mobile” group unusable.

• GroupType (String)

  Determines whether the group is a Breakpoint Group or a manually created Device Configuration. The possible values for this property are Breakpoint or DeviceGroup.

• IsDefaultView (Boolean)

  Set this value to “true” to display this view for any visitors using a device that doesn’t fit into any other group. This view will typically be displayed for any desktop visitors.

Analytics Tracker 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (Boolean)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• ContentIdsList (String)

  Enter a comma-separated list of content IDs to be tracked. The DefaultContentId and the dynamicParameter are also tracked. See Also: Running Ektron Business Analytics

• DefaultContentID (Long)

  The ID of a content block being tracked by this server control. It typically would be the content directly above the analytics tracker if no other content block is identified, or is not available. If you don’t know the ID number of the content block, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• 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)

  To make this control dynamic, select id. When you do, this server control is attached to the content block passed as a URL parameter.

• EnableAnalytics (String)

  Set one of these values to determine if this server control tracks Business Analytics statistics.

  • true—this control tracks analytics
  • false— this control does not track analytics
  • ConfigSpecified—use the setting in the site root/web.configfile'senableAnalytics key. For example, if that key =true, this control tracks analytics.

  Note that the first 2 options (true and false) let you enable/disable this particular control. Use the last option, ConfigSpecified, if you want to use a single web.config setting to enable/disable all analytics controls.

• 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).

• 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.

AssetControl 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• DefaultAssetID (Long)

  The ID of the asset you want to update. This property is used when the UploadType property is set to Update. If you don’t know the ID number of the asset, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• DefaultFolderID (Long)

  The ID of the folder where assets are added. This property is used when the UploadType property is set to Add. If you don’t know the ID number of the folder, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• 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 or folder ID dynamically. The content ID is read when the UploadType property is set to Update. The folder ID is read when UploadType property is set to Add. To use the default content ID or default folder ID, leave blank.

• 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.
• IsImage (Integer)

  Setting this control to 1 (one) restricts the control so only images can be uploaded.

  • 1 (one)—restrict the control to uploading images only.
    
  • 0 (zero)—upload all types of assets.
• Language (Integer)

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

• OverrideExtension (String)

  Lets you restrict the type of asset that can be uploaded by its extension. For example, to restrict the control to uploading Word documents, enter doc in the property.

  NOTE: When using this property, enter only the extension’s letters not the wildcard (*) or the dot (.).

  You can add multiple extensions by creating a comma separated list of extensions. You should limit the list to 5 extensions.

• SuppressWrapperTags (Boolean)

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

  • True—Suppress wrap tags.
  • False (default)—Allow wrap tags.
• TaxonomyID (Long)

  The ID of the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. with which to associate the asset.

• UploadType (UploadTypeEnum)

  Select whether the control adds new assets or updates existing ones.

  • Add (default)—add assets and use the DefaultFolderID property. If a file of the same name already exists in the folder, the new file is created using the naming convention filename(2).
  • Update—update assets. In this case, you must identify an asset at the DefaultAssetID property.
• 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.

Blog

The Blog server control lets you add a blogshort for Web Log to a Web form. This control has the items commonly found on a blog page, such as blog posts, comments link, a blog roll, blog subjects, recent blog posts, the blog's RSS feed, archivethe state of content upon reaching its end date. What happens next is determined by your choice at the content's Schedule tab > Action on End Date options field. Choices are * Archive and remove from site (expire) * Archive and remain on site * Add to CMS Refresh Report, and a blog calendar.

The Blog server control lets you easily maintain the overall look of the blog. Any change to display properties, such as background color or font, affects the entire blog. However, you cannot change the location of each server control item. The title always appears on top, with the tagline below it. The blog posts always appear to the left,and the calendar, blog roll, blog subjects, recent blog posts, RSS feed, archive and blog roll to the right.

NOTE: You can use individual blog server controls to change the page layout.

To customize a blog's styling, edit the Blog.css file located in webroot\siteroot\Workarea\csslib.

BlogArchive

The BlogArchive server control displays past months or years that have blog posts. Use this control with the BlogEntries and Calendar controls to let site users scan for older Blog posts.

When a site visitor clicks a month in the archivethe state of content upon reaching its end date. What happens next is determined by your choice at the content's Schedule tab > Action on End Date options field. Choices are * Archive and remove from site (expire) * Archive and remain on site * Add to CMS Refresh Report, the blog posts for that month appear.

Typically this control appears along side other individual Blog server controls.

BlogEntries

The BlogEntries server control displays several blog posts or a user’s Journal (personal blog) on a Web form. You can change this server control's appearance without changing the other blog controls. Below is an example of a BlogEntries server control.

To use this server control to dynamically display a blog’s entries, set the following properties:

• DynamicParameter—set this property to the parameter name used to pass a blog ID to the QueryString. The default is blogid.
• BlogPostParameter—set this property to the parameter name used to pass a blog post’s ID to the QueryString. The default is id.

To use this server control to dynamically display a user’s Journal, set the following properties:

• DynamicUserParameter—Set this property to the parameter name used to pass a user’s ID to the QueryString.
• BlogPostParameter—set this property to the parameter name used to pass a blog post’s ID to the QueryString. The default is id.

BlogCalendar

The BlogCalendar server control displays a calendar on a Web page and associates it with a blog. Days with blog posts are highlighted on the calendar. You can use a BlogCalendar server control with a BlogEntries server control to display blog posts for a given day.

BlogCategories

The BlogCategories server control displays a blog’s subjects as a clickable list of links on a Web form. When a link is clicked, it displays all subjects associated with the category. See Also: Adding Blog Subjects. Typically this control appears with other Blog server controls.

BlogPost

The BlogPost server control displays an individual blog post on a page. There are 2 ways that this control displays a blog post.

• If a user is logged in as an Ektron or a membership user, the control displays the blog post, comments, and comments from the Web page.
• If a user is not logged in, the control displays only the blog post.

NOTE: The Enable Comments property in the Workarea must be enabled for comments and the comments form to appear.

BlogRecentPosts

The BlogRecentPosts server control displays a list of recent blog post links on a Web form. When you click a link, you are directed to the blog post. The NumberofPosts property lets you control how many links appear. Typically, this control appears with other individual Blog server controls.

NOTE: On a PageBuilder page, you can display recent blog posts using the Recent blog posts widget. See Also: Widget Reference

BlogRoll

The BlogRoll server control displays a blog roll on a Web form. A blog roll is a list of links to other blogs. For more information, see Adding Blog Roll Links. Typically, this control appears with other individual Blog server controls.

BlogRSS

The BlogRSS server control displays a blog’s RSS feed icon () on a Web form. When the icon is clicked, the blog's RSS feed appears. Typically this control appears along side other individual Blog server controls.

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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CssClass (String)

  Use this field if you want to change the .css class used in the default template’s outermost wrapper (DIV tag). This lets you change the styling and appearance of the server control without having to change the markup.

• FormURL (String)

  The path to the page that appears when a user clicks the Micro-messaging bookmarklet link. By default, when a user clicks a link, he is redirected to the siteroot/Workarea/share.aspx page.

• 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.
• ID (String)

  A unique name you apply to this instance of the control.

• IncludeCSS (Boolean)

  Lets you include or exclude the control's default .css file, which provides the "look and feel" of the control on a Web page.

• Language (Integer)

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

• LinkText (String)

  The text that appears on the Micro-messaging bookmarklet link.

  

  To modify the look and feel of this area, edit the ektron.micromessaging.bookmarklet.css file in the siteroot/Workarea/csslib folder.

• OutputLinkIcon (Boolean)
  • False—suppress the icon
  • True—show the Micro-messaging bookmarklet link icon on the button

    

  To modify the look and feel of this icon, edit the ektron.micromessaging.bookmarklet.css file in the siteroot/Workarea/csslib folder.

• PopupHeight (Integer)

  The height of the Micro-messaging bookmarklet link window in pixels.

• PopupWidth (Integer)

  The width of the Micro-messaging bookmarklet link window in pixels.

• SiteName (String)

  The name of the website using this server control. The SiteName value is embedded in the instructions for adding the bookmarklet to the toolbar. See example below.

  

• Visible (Boolean)
  • True—the control is visible and rendered
  • False—the control is not visible

Customizing the Bookmarklet Server Control

The (Micro-messaging) Bookmarklet server control is template-based which means you can change the control's appearance without an extensive XSLTExtensible Stylesheet Language Transformations or EkMLEktron Markup Language file.

The JavaScript used to render the Bookmarklet control is loaded into the Href property of the control's anchor tag.

The following code shows the first Bookmarklet server control in bookmarklet.aspx.

<li>
<div class="controlWrapper">
<h3>Default</h3>
<CMS:micromessagingbookmarklet ID="bookmarkletDefault" runat="server" />
</div>
</li>

Because Bookmarklet is a templated server control, you can enter any valid markup, and it will be rendered exactly as you entered it. As examples, you can enter the following items within the <div> tags that surround the control.

• another Ektron server control
• any third-party server control
• HTML syntax
• databinding syntax
• style classes
• style tags, such as <strong>

Types of BreadCrumb properties

BreadCrumb properties are divided into 2 categories:

The Trail Created by the Breadcrumb Server Control

A breadcrumb trail can appear vertically or horizontally on a Web page with the DisplayStyle parameter. In addition, you can define how many breadcrumbs (MaxItems) are left for site visitors to navigate back. You can also use an image and Alt text instead of, or in addition to, text to display the breadcrumb trail. These variations are illustrated below and described in BreadCrumb Properties.

NOTE: If a site visitor revisits a page that is in the breadcrumb trail already, the breadcrumb trail reverts back to that point in the trail. For example, if you visit the following pages Dev > FAQ > WebForm > PR, and then return to FAQ, the breadcrumb trail looks like this: Dev > FAQ.

• Horizontal; text only

  

• Horizontal with images

  

• Horizontal with images and Alt text

  

• Vertical; text only

  

• Vertical with images

  

• Vertical with images and Alt text

  

To implement sitemap breadcrumb navigation, add a BreadCrumb server control to every Web form in your site. Doing this ensures that a breadcrumb trail may appear on each Web page.

BreadCrumb 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CurrentPageIndicator (String)

  If desired, enter one or more symbols or characters that identify the current page in the breadcrumb trail. See example below.

  

  These characters appear after the image or title that identifies the current page in the breadcrumb trail.

• DefaultContentID (Long)

  Gets or Sets the ContentID for the BreadCrumb display title.

• DisplayStyle (String)

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

• DisplayTitle (String)

  Enter text to describe this Web form in the breadcrumb trail. For example, if the Web form’s properties you are defining is used for all Human Resources pages on your site, enter Human Resources.

  If you define an image in the IconPath property below, the image appears in the trail, followed by this text.

  IMPORTANT: This property is for code-behind only. It cannot be set in design time.

• 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)

  Used to hide the breadcrumb trail in design time and run time.

  • True—Hide breadcrumb trail
  • False—Show breadcrumb trail
• IconAlt (String)

  If you define an image in the IconPath property, enter “Alt” text that should appear when a site visitor hovers the cursor over that image. Here is an example.

  —Image—

  

• IconPath (String)

  If you want the breadcrumb trail to display an image to identify this Web form, enter the path to the image. For example: \CMS400Developer\Workarea\Images\bc_meta_icon.gif

  IMPORTANT: The image location must be relative to the Web root.

  On the breadcrumb trail, the image precedes any text defined in the DisplayTitle property.

• Language (Integer)

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

• LinkLastItem (Boolean)

  Use this property to determine whether the last breadcrumb item appears as a hyperlink on this Web form. If this property is set to True, and a user clicks the item, the current page reappears.

  • True—last item is a hyperlink
  • False—last item is an image or text only; the user cannot click on it
• LinkTarget (String)

  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.
• MaxItems (Integer)

  Enter the maximum number of items in the breadcrumb trail on this Web form. The default is 5. If you set a value of 1 or greater and the user navigates beyond that number of pages, only the most recent pages appear. The older pages disappear from the trail. 0 (zero) = unlimited.

• MetadataName (String)

  Specify the name of a Metadata Type that you want to associate with the page.

  BreadCrumb metadata type

  BreadCrumb Metadata Type

  To associate a Metadata Type with the BreadCrumb server control:

  1. In the properties window for the BreadCrumb server control, click on the MetadataName property.
  2. Click Ellipses ().
  3. If you are not logged in, log in using the CMS Explorer window.
  4. The Browsing Metadata screen appears.
     —Image—

     

  5. Select a Metadata Type to apply to the BreadCrumb server control.
  6. Set the DynamicParameter to ID. This allows the metadata to reflect the content block on the page.
• Mode (String)

  Lets you display the breadcrumb trail as non-hyperlinked, plain text. The default is Normal.

  • Normal—breadcrumb trail is hyperlinked

    

  • DisplayOnly—breadcrumb trail is plain text

    

• Separator (String)

  Enter one or more characters to separate breadcrumb trail items 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 the BreadCrumb Server Control

NOTE: Do not add a BreadCrumb server control to a Web form that contains a Calendar server control. When both controls appear on a page and a site visitor clicks on different months, the BreadCrumb trail could look like this: Calendar > Calendar > Calendar > Calendar > Calendar. This happens because each time a site visitor clicks on a month, you are in effect opening a new Web form.

To learn about the Breadcrumb server control properties, see BreadCrumb.

Add a BreadCrumb server control to each Web form for which you want to create a breadcrumb trail. To use the BreadCrumb server control:

1. Open a Web form for which you want to create a breadcrumb trail.
2. Drag and drop the BreadCrumb server control onto the Web form.
3. Set the DisplayTitle property.
4. Save the Web form.
5. Repeat steps 1 through 4 for all Web forms in the breadcrumb trail.
6. Open a browser.
7. View a Web page with a BreadCrumb server control in it.
8. Navigate to the rest of the Web pages that contain BreadCrumb server controls.
9. As you move around, the pages are added to the breadcrumb trail.
   —Image—

   

ContentBlock1.Fill()

ContentBlock1.Fill()
BreadCrumb1.DisplayTitle = ContentBlock1.EkItem.Title

BusinessRules 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• 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.

• 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).

• RuleID (Long)

  The ID of the Ruleset to evaluate. If you don’t know the ID number of the Ruleset, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• 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.

Cart 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CustomXml (Code-behind Only) (String)

• Lets you inject custom XML into the generated XML before being processed by the XSLTExtensible Stylesheet Language Transformations. Enter a string of XML that you want to make available to the XSLT as follows:

  <root><customXml>custom-xml-inserted-here</customXml></root>

  See Also: Displaying Custom XML in Ektron’s Server Controls.

• DisplayXslt (String)—If desired, enter a relative or absolute path to an Xslt that determines the display of the page. By default, the control uses Cart.xsl. This file is located in <siteroot>\Workarea\Xslt\Commerce.

  IMPORTANT: If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• DoInitFill (Boolean)—Controls when Fill occurs.

  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.

• DynamicProductParameter (String)—The QueryString parameter name which is used to pass the product ID to the product details page. For example, if your QueryString parameter for products is ID, enter that in this property. Then, when a customer clicks a product’s title, this parameter is passed with the product’s ID to the product details page.
• EnableCoupons (Boolean)—Set to true to allow a customer to enter coupon codes for discounts. When set to false, the Apply Coupon button is hidden. Default value is True if this property is not set. See Also: Applying Coupons, Using Coupons.
• Hide (Boolean)—Used to hide the control in design time and run time.
  • True—Hide the control
  • False—Show the control
• Language (Integer)—

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

• LoadingImage (String)—The image to display while the cart is loading. The default is ajaxloader_circle_lg.gif. This file is located in siteroot\Workarea\images\application.
• Stylesheet (String)—Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet. The default is Cart.css. This file is located in: siteroot\Workarea\csslib\Commerce

  IMPORTANT: If you want to edit this file, make a copy, change its name and move it outside of the Workarea folder. If you make changes to this file and do not move it out of the Workarea, this file and the changes will be lost when you upgrade.

• SuppressWrapperTags (Boolean)

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

  • True—Suppress wrap tags.
  • False (default)—Allow wrap tags.
• TemplateCheckout (String)—The template that contains the Checkout server control. A customer is directed to this page when he clicks Checkout. If the template file is located in the same folder as the Web form containing this server control, just enter its name. The path can be relative or absolute.See Also: Checking Out.
• TemplateProduct (String)—The template that contains the Product server control. A customer is directed to this page when a product in the cart is clicked. This page provides details about the product.See Also: Displaying an Item’s Information.

  If this property is blank, the server control uses the Product’s QuickLink information.

  If the template file is located in the same folder as the Web form containing this server control, just enter its name. The path can be relative or absolute.See Also: Displaying an Item’s Information.

• TemplateShopping (String)—The URL to navigate to when the customer clicks Continue Shopping. This URL could direct the customer to a template containing a ProductSearch or ProductList server control, which lets the person select additional products. See Also: Continuing to Shop.

  See Also: Using the ProductList Server Control or Product Search Server Controls

Checkout 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• CurrentPhase (code-behind Only) (ControlPhase)

  Reports or selects the current page (or phase) of the checkout control. This lets you customize the flow of the control. For example, if you only offer one shipping option, skip the ShippingInfoEntry phase.

  • Login—allows existing users to log in. See Also: Logging In or Setting Up an Account
  • BillingInfo—displays a customer’s billing information. See Also: Billing Information
  • BillingInfoEntry—allows entry of a customer’s billing information. See Also: Billing Information.
  • ShippingInfo—allows entry of a customer’s shipping information.
  • ShippingInfoEntry—allows entry of a customer’s shipping information. See Also: Shipping Information
  • ShippingMethodSelect—allows selection of the shipping method. See Also: Shipping Method
  • ReviewOrder— displays the current order’s details. See Also: Review Order
  • SubmitOrder—lets customers add payment information. See Also: Submit Order
  • Complete—displays completion message. See Also: Order Complete
  • Error_EmptyBasket— used when a cart has no items and the customer somehow enters the control.
  • Error_UnhandledException—occurs when there’s an error that the control cannot resolve.
• CustomXml (code-behind Only) (String)

  Lets you inject custom XML into the generated XML before being processed by the XSLTExtensible Stylesheet Language Transformations. Enter a string of XML that you want to make available to the XSLT as follows:

  <root><customXml>custom-xml-inserted-here</customXml></root>

  See Also: Displaying Custom XML in Ektron’s Server Controls.

• DefaultCountryId (Integer)

  The ID of the default country that appears in the Billing Address and Shipping Address. Set this to the country from which the majority of your customers make purchases. If a customer is from a different country, he can change it when editing the Billing or Shipping Address.

  To find a country’s numeric ID, go to Workarea > Settings > Commerce > Configuration > Countries. The Numeric ID is in the left column of that screen.

• 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.

• DynamicPhaseParameter (String)

  The name of the parameter on the QueryString that identifies desired phase ID.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page. By default, the control uses Checkout.xsl. This file is located in siteroot\Workarea\Xslt\Commerce\Checkout\Standard

  IMPORTANT: If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• FriendlyErrorMessage (String)

  The message displayed when an unhandled error occurs. Details are sent to the event log.

  The default message is “We're sorry, an error occurred while processing your request. Please try again later...”

• AllowGuestCheckout (Boolean)

  Set to true if you wish to allow the Guest Checkout feature. See Also: Logging In or Setting Up an Account

• 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.
• IsSSLRequired (Boolean)

  When set to True, switches to an SSL encrypted URL. For the SSL encryption to work, you must have an SSL certificate installed for your site. See Also: Installing Ektron. Information on SSL can be found at the following websites.

  • Secure Sockets Layer (SSL) (Tech-FAQ)
  • Introduction to SSL (Symantec)
    

  NOTE: Ektron, Inc. is not associated with TechFAQ or VeriSign. However, both sites offer good explanations of Secure Sockets Layer.

  Installing and using an SSL is one of the most important things you can do to protect your customer’s credit card data.

• Language (Integer)

  Set a language for viewing the checkout control. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

• LoadingImage (String)

  The image to display while the control is fetching data. The default is siteroot\Workarea\images
\application\ajax-loader_circle_lg.gif.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

• SuppressWrapperTag (Boolean)

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

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

  The URL path of the template that contains the Cart server control. The path can be relative or absolute.

  When a path is entered, a link appears in the Review Order part of the process that allows a user to navigate to the template containing the Cart server control. See Also: Review Order and Using the eCommerce Server Controls

• TemplateOrderHistory (String)

  The URL path of the template that contains the OrderList server control. The path can be relative or absolute. When a path is entered, a link appears at the end of checkout process that allows a user to navigate to the template containing the OrderList server control. See Also: Order Complete and Managing Customer Orders.

• TemplateRecoverPassword (String)

  The URL path of the template that helps a customer recover a password. The path can be relative or absolute. When a path is entered and a customer has not logged in, a link appears at the beginning of checkout process that lets the customer navigate to a template containing information to recover the password. The Membership server control contains an option for recovering passwords. See Also: Logging In or Setting Up an Account and Membership server control

• TemplateShopping (String)

  The URL path of the template that allows the customer to continue shopping. If a path is entered, a link appears at the end of checkout that allows a user to navigate to a template that lets the person continue shopping; for example, the template containing a ProductList or ProductSearch server control. See Also: Order Complete, Using the ProductList Server Control and Product Search Server Controls

Collection 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AddText (String)

  Override the control’s default text for the Add Content menu item. For example, If you have a News website, you could change Add Content to Add News Item.

  

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

• The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

  NOTE: If the EnablePaging property is set to True, the CacheInterval property is disabled.

• ContentParameter (String)

  Checks the QueryString for this value and replaces the collection with a content block when specified. Leave blank to always display the Collection.

• DefaultCollectionID (Long)

  The ID of a collection that appears where you insert this server control if no other collection is identified, or is not available. If you don’t know the ID number of the collection, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• DisplayXslt (String)

  Determines how the information on the page appears.

  • None—databind only
  • ecmNavigation—lists the title of every content block in the collection

    See Also: Collection (deprecated)

  • ecmTeaser—lists the title of every content block in the collection plus the content summary

    See Also: ecmTeaser Display Example

  • Path to Custom Xslt—If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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)

  To make this collection dynamic, select coll_id. When you do, this server control uses the collection passed as a URL parameter.

• EnablePaging (Boolean)

  This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen.See the following example.

  

  For example, if a collection has 9 items and the MaxResults property is set to 4, the screen displays only the first 4 items. When the site visitor clicks [Next], he sees items 5, 6, 7 and 8, and so on.

  NOTE: If the EnablePaging property is set to True, the CacheInterval property is disabled.

• GetAnalyticsData (Boolean)

  Set this property to True if you want the following information for each content in the list. Returns Content View Count, Content Rating, Content Rating Average. Create your own XSLTExtensible Stylesheet Language Transformations styles to display this data. This property only provides reliable data when the Business Analytics Feature is on. Analyzing Websites.

• GetHtml (Boolean)

  Set to True if you want to retrieve and display content (html body) for all content blocks in the collection. For example, to display content inside a Web server control such as a GridView.

• 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.
• IncludeIcons (Boolean)

  Choose whether to display icons next to the collection list’s links.

  IMPORTANT: This property only works when ecmSummary or ecmTeaser are used in the DisplayXslt property. If the [$ImageIcon] variable is used in an EkML file and that file is assigned to the MarkupLanguage property, this property acts as True.

  

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language.

  See Also: collection.ekml

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored. If the EkML file contains the [$ImageIcon] variable, the IncludeIcons property acts as True.

• MaxResults (Integer)

  Enter the maximum number of items to appear in the initial display of this server control. To set no maximum, enter zero (0). To let site visitors view more than the maximum but limit the amount of space, enter the maximum number of results per page here. Then, set the EnablePaging property to True. If you do and more than the number of MaxResults are available, navigation aids help the site visitor view additional items. See example below.

  

• MemberMenuActive (Boolean)

  Set this property to True to hide the drop-down menu next to a content item when a membership user is logged-in.

  • True—Hide the drop-down next to a content item from membership users.
  • False—Membership users can have access to the drop-down menu next to content item.

  NOTE: This only affects membership users. Ektron users always see the drop-down menu when they are logged-in.

• Random (Boolean)

  Set to True if you want to randomly display one collection item. The item changes each time a site visitor views the page.

  NOTE: If you use a custom XSLT or EkML file, the type of content displayed can be manipulated. For example, if you use an EkML file that has the [$Html] variable in it, the actual content appears instead of a link. See Also: Controlling Server Control Output with Ektron Markup Language and [$Html].

• SelTaxonomyID (Integer)

  Set the ID of the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. with which content is associated if a logged-in site visitor uses the Silver Access Point’s Add HTML Content option to add content to a Collection server control.

• SuppressWrapperTags (Boolean)

  This property is set to false because Ajax uses <div> tags to rewrite the region around the tag. You cannot change the value to true.

• 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.

ecmNavigation Display Example

The following figure shows a collectionA list of Ektron content links for display on a Web page. being used as a navigation menu.

ecmNavigation XSL code

The following XSL code creates the ecmNavigation Display. You can use this code as the basis to design your own XSLT.

WARNING! If you create a custom file, do not store it in the Workarea folder. If you do, the file will be overwritten when you upgrade.

<?xml version="1.0" encoding="ISO-8859-1"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:template match="/">
  <table border="0" cellspacing="0" cellpadding="0" width="100%">
   <xsl:for-each select="Collection/Content">
   <tr>
      <td>
         <a>
            <xsl:attribute name="href">
                <xsl:value-of select="QuickLink"/>
            </xsl:attribute>
                <xsl:value-of select="Title"/>
         </a>
     </td>
   </tr>
   </xsl:for-each>
  </table>
</xsl:template>
</xsl:stylesheet>

ecmTeaser Display Example

The following example shows a collectionA list of Ektron content links for display on a Web page. using the ecmTeaser display style.

ecmTeaser XSL code

The following XSL code creates the ecmTeaser Display. You can use this code as the basis to design your own XSLT.

WARNING! If you create a custom file, it is strongly recommended to not store the file in the Workarea folder. If you do, the file will be overwritten when you upgrade.

<?xml version="1.0" encoding="ISO-8859-1"?>
<xsl:stylesheet version="1.0" xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
<xsl:template match="/">
  <table border="0" cellspacing="0" cellpadding="0" width="100%">
    <xsl:for-each select="Collection/Content">
      <tr>
        <td>
          <a>
            <xsl:attribute name="href">
              <xsl:value-of select="QuickLink"/>
              </xsl:attribute>
             <xsl:value-of select="Title"/>
          </a>&#160;
        </td>
      </tr>
      <tr>
         <td>
            <xsl:value-of select="Teaser" />
         </td>
      </tr>
      <tr>
          <td>&#160;</td>
      </tr>
    </xsl:for-each>
  </table>
</xsl:template></xsl:stylesheet>

Using the Collection Server Control Programmatically Example

The following is an example of using code-behind, and a drag and drop Collection server control to display random content from a collection.

1. Drag and drop a Collection server control on your Web form.
2. Set the properties in the properties window.

   NOTE: In this example, the Random and GetHtml properties must be set to True.

   —Image—

   

3. Add the following code to the code-behind.

   Dim str As String
   str = "<h1>Hello There</h1><br>"
   str &= Collection1.EkItems(0).Html
   Collection1.Text = str

4. Build and browse your Web form.
   —Image—

   

Retrieving the XML Structure of a Collection

Retrieving the XML structure of a collectionA list of Ektron content links for display on a Web page. allows for greater control over developing XSLs. The following is an example of how to do that.

1. Open a new Web form.
2. Drag and drop a Collection server control onto it.
3. Set the DefaultCollectionID property.
4. Drag and drop a textbox on the Web form.
5. Set the TextMode property to MultiLine.

   NOTE: Set the text box width to at least 400px.

6. On the code-behind page, add the following line.

   Textbox1.Text = Collection1.XmlDoc.InnerXml

7. Build the project.
8. View the Web form in a browser.
9. The XML structure of the collection appears in the textbox.

For an additional example, see the Collection XML page on the Developer samples page. It is located at:

• In a browser:

  http://sitroot/CMS400Developer/Developer/Collection/CollectionXML.aspx

• In the source code:

  siteroot/CMS400Developer/Developer/Collection/CollectionXML.aspx 
    and CollectionXML.aspx.vb

CommunityDocuments 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultObjectID (Long)

  The default object ID for this control to use when there is no matching dynamic parameter value passed.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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.

• DynamicContentBoxHeight (Integer)

  The height of the dynamic content box in pixels

• DynamicContentBoxWidth (Integer)

  The Width of the dynamic content box in pixels

• DynamicContentTemplate (String)

  The template to use when displaying dynamic content. Leave blank to use the dynamic box.

• DynamicParameter (String)

  Gets or sets the QueryString parameter to read a object ID dynamically. To use the default object ID, leave blank.

• EnablePaging (Boolean)

  This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen.

• 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.
• IncludeIcon (Boolean)

  Choose whether to display icons next to the navigation list’s links.

  • True—Show icons
  • False—Hide icons

  

• ItemSortOrder

  Specify the sort order of results. Choices are:

  • taxonomy_item_display_order—the order of taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. items as set in the Workarea. For additional information, see Reordering Content Assigned to a Taxonomy Category.
  • content_title—alphabetical order by title
  • date_created—chronological order by creation date
  • last_edit_date—chronological order by last edit date

  You can specify the direction of the items with the SortDirection property.

• Language (Integer)

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

• LinkTarget (String)

  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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup LanguageControlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  Enter the maximum number of items to appear in the initial display of this server control. To set no maximum, enter zero (0). To let site visitors view more than the maximum but limit the amount of space, enter the maximum number of results per page here. Then, set the EnablePaging property to True. If you do and more than the number of MaxResults are available, navigation aids help the site visitor view additional items.

• ObjectType (CommunityDocumentsObjectType)

  The type of object to which this control is assigned. Choices are:

  • User—control assigned to an individual
  • Group—control assigned to a community group
• ShowCount (Boolean)

  Determines if an integer representing the number of items in a category appears next to the category.

  • True—Show number next to category
  • False (default)—Do not show number next to category

  

• SortDirection (String)

  Select the direction of the itemSortOrder property. Choose Ascending or Descending.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• TaxonomyCols (Integer)

  Enter the number of columns in which this taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure./category appear on the page.

• TaxonomyItemCols (Integer)

  Enter the number of columns in which the taxonomy item appears on the page.

• 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 the CommunityDocuments Server Control

Part of the Community Platform, this server control lets users create and upload individual user content to the user profile or group content to the group profile. The content can be HTML content or an assetan external file, such as a Microsoft Word document or image, stored in Ektron. It can be managed like native Ektron content., such as a .PDF document or a .jpeg file.

CommunityGroupBrowser 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• AvatarHeight (Integer)

  The display height of the avatar in the results box.

• AvatarWidth (Integer)

  The display width of the avatar in the results box.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade. If you enter a valid EkMLEktron Markup Language file at the MarkupLanguage property, the DisplayXslt property value is ignored.

• 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.

• 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).

• Link (String)

  Add a link to the group’s profile page. This allows a user to click a link in the community group list and be taken to the group’s profile page. There are 2 variables used within the link that represent the group ID and the group name.

  • {0}—represents the group’s ID.
  • {1}—represents the group’s name.

  You need to have both variables in the link. The Web form can be relative or absolute. Below is an example.

  groupprofilepage.aspx?gid={0}&gn={1}

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  The Maximum number of items to fetch. 0 (zero) = unlimited.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• SuppressWrapperTags (Boolean)

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

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

  Add a path to another Web form to create links for the tag text. The path can be relative or absolute. By providing the path to CommunitySearch server control, a user viewing the list of groups can click a tag and search for other groups with the same tag. There are 5 parameters that are automatically added to the link’s QueryString that let you pass information about tag.

  • searchgrptag—the tag’s text for community groups.
  • TagId—the tag’s ID.
  • TagLanguage—the tag’s language.
  • TagCount—the tag’s count (the number of times a tag has been used.)
  • TagType—the tag’s type: user or community group.

  In addition to these parameters, you can add your own by defining them in the path. If you do, these parameters are appended to yours.

• TagTemplateTarget (String)

  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.
• TaxonomyId (Long)

  Enter the ID number of the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. or category to appear in this server control. If you don’t know the number, click the button and navigate to the taxonomy or category. When you select one, it appears in the center of the Visual Studio window.

• 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.

CommunityGroupList 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AllowGroupCreation (Boolean)

  If the user has permission to create community groups and this property is set to True, the Create Groups link appears in the control.

  • True—Create Group link appears on the control.
  • False—Create Group link is hidden on the control.
• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• AvatarHeight (Integer)

  The display height (in pixels) of the avatar in the results box.

• AvatarWidth (Integer)

  The display width (in pixels) of the avatar in the results box.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultUserID (Long)

  The default User ID for this control to use if no matching dynamic parameter value is passed.

• DisplayMode (eDisplayMode)

  Select the way this control initially displays community group information. Choices are:

  • Newest—newly added community groups.
  • MostPopular—community groups with the most members.
  • Name—community groups sorted alphabetically by name
  • MyGroups—community groups to which the logged-in user belongs
  • MyPendingGroups—community groups to which the logged-in user has asked to join, but has not yet been accepted
• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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.

• DynamicUserParameter (String)

  Gets or sets the QueryString parameter to read a user ID dynamically. To use the default user ID, leave blank.

• 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).

• Link (String)

  Add a link to the group’s profile page. This allows a user to click a link in the community group list and be taken to the group’s profile page. The link includes these 2 variables.

  • {0}—group ID
  • {1}—group name

  The link requires both variables. The Web form can be relative or absolute. Below is an example.

  groupprofilepage.aspx?gid={0}&gn={1}

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup LanguageControlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  The Maximum number of items to fetch. 0 (zero) = unlimited.

• ShowMySortingOptions (Boolean)

  If this control is associated with a user and this property is set to True, the controls displays the following sorting options:

  • My Groups—a list of community groups to which the user belongs.
  • Group Requests—a list of community groups to which a user has requested to join, but has yet to be accepted.
  • Group Invitations—a list of community group that the user has been invited to join, but has yet to accept.

  When set to False, Leave Selected Group is the only option that appears.

  Depending on how the DisplayMode property is set, you may see additional sorting options.

• ShowSortingOptions (Boolean)

  If this control is used to display a general list of community groups and this property is set to True, the following sorting options appear.

  • Newest—recently added community groups
  • Most Popular—community groups with the most members.
  • Group Name—community groups sorted alphabetically
• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• SuppressWrapperTags (Boolean)

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

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

  Add a path to another Web form to create links for the tag text. The path can be relative or absolute. By providing the path to CommunitySearch server control, a user viewing the list of groups can click a tag and search for other groups with the same tag. There are 5 parameters that are automatically added to the link’s QueryString that let you pass information about tag.

  • searchgrptag—the tag’s text for community groups.
  • TagId—the tag’s ID.
  • TagLanguage—the tag’s language.
  • TagCount—the tag’s count. The tag’s count is the amount of times a tag has been used.
  • TagType—the tag’s type. The tag’s type will be user or community group.

  In addition to these parameters, you can add your own by defining them in the path. When you do, these parameters will be appended to your parameters. See Also: Tagging Content, Library Items, Users, and Groups with Keywords

• TagTemplateTarget (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.
• 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.

CommunityGroupMembers 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• AvatarHeight (Integer)

  The display height (in pixels) of the avatar in the results box.

• AvatarWidth (Integer)

  The display width (in pixels) of the avatar in the results box.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultCommunityGroupID (Long)

  The default community group ID for this control to use if no matching dynamic parameter value is passed.

• DisplayMode (eDisplayMode)

  Select whether this control displays a community group’s current members or their pending members. Choices are:

  • Members—current group members
  • PendingMembers—users who asked or were invited to join the group
• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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 community group ID dynamically. To use the default community group ID, leave blank.

• 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).

• Link (String)

  Add a link to the member profile page’s Web form. This allows a user to click a link in the community group members list and be taken to a member’s profile page. Two 2 variables used within the link represent the user’s ID and name.

  • {0}—user ID
  • {1}— user name

  The link needs both variables. The Web form can be relative or absolute. For example:

  userprofilepage.aspx?gid={0}&gn={1}

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup LanguageControlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  The maximum number of items to fetch. 0 (zero) = unlimited.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• 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.

CommunityGroupProfile 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• DefaultGroupID (Long)

  The default community group ID for this control to use when no matching dynamic parameter value is passed.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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 community group ID dynamically. To use the default community group ID, leave blank.

• GroupAdminLink (String)

  Add a link to the administrator’s profile page. This lets a user click a link in the community group page's profile area and be directed to the administrator’s profile page. Two variables in the link identify the administrator.

  • {0}—administrator’s ID
  • {1}—administrator’s name

  Both variables must be in the link. The Web form can be relative or absolute. Below is an example.

  adminprofilepage.aspx?aid={0}&an={1}

• GroupAdminLinkTarget (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.
• 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).

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• SuppressWrapperTags (Boolean)

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

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

  Add a path to another Web form to create links for the tag text. The path can be relative or absolute. By providing the path to CommunitySearch server control, a user viewing the profile can click a tag and search for other groups with the same tag. Five parameters, which are automatically added to the link’s QueryString, let you pass information about the tag.

  • searchgrptag—the tag’s text for community groups
  • TagId—the tag’s ID
  • TagLanguage—the tag’s language
  • TagCount—the tag’s count. That is, the number of times a tag has been used.
  • TagType—the tag’s type: user or community group

  You can also add your own parameters by defining them in the path. If you do, these parameters will be appended to yours. See Also: Tagging Content, Library Items, Users, and Groups with Keywords

• TagTemplateTarget (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.
• 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 Static Content Block

A static content block displays one identified content block on a Web page. The following image shows a server control that retrieves content block ID=28 and displays it in the browser.

Using a Dynamic Content Block

Use a dynamic content block to display a content block whose ID is passed through a URL parameter. You would use this server control with a dynamic template.

The following example uses the ContentBlock server control to pass the id as a URL parameter. When a user clicks a link that passes the content block ID as a URL parameter, that content block appears. If that content block is not available, content block 1 appears

XML ContentBlock properties

Use an XML content block to display an XML content block on an Ektron Web page.

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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultContentID (Long)

  The ID of a content block that appears where you inserted this server control if no other content block is identified, or is not available. If you don’t know the ID number of the content block, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page. If you do not define the DisplayXslt property, the OverrideXslt property specifies an XSLT identified in the Edit Smart Form Configuration screen. See Also: Working with Smart Forms, Ektron KB article "HOW TO:Add acceptable XSLT files to the system"

  —Image—

  

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• 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)

  To make this content block dynamic, select id. When you do, this server control uses the content block passed as a URL parameter.

• 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).

• 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 ContentBlock Programmatically

The following code displays a content block:

NOTE: Before adding these lines of code, drag and drop a literal box on your Web form.

Dim MyContentBlock As New ContentBlock
  MyContentBlock.DefaultContentID = 8
  MyContentBlock.Page = Page
  MyContentBlock.Fill()
  Literal1.Text = MyContentBlock.EkItem.Html

To display a content block with the content block title:

NOTE: Before adding these lines of code, drag and drop a 2 literal boxes on your Web form.

Dim MyContentBlock As New ContentBlock
  MyContentBlock.DefaultContentID = 8
  MyContentBlock.Page = Page
  MyContentBlock.Fill()
  Literal1.Text = MyContentBlock.EkItem.Title
  Literal2.Text = MyContentBlock.EkItem.Html

• Define a content list in a content block's metadata. Then, assign that content block’s ID in the DefaultContentID property. See Also: Server Control Reference

  When using this option, an administrator typically sets up the Workarea portion of the process. Then, a developer adds the server control to a Web form and assigns the content block ID and the metadata name to the appropriate properties. Because the content list is assigned to a content’s metadata, you can pass the content ID dynamically in a Web form and display a list for each content block you defined.

• Assign a comma-delimited list of content blocks to the ContentIds property. See Also: Server Control Reference

  Using the ContentIds process, a developer adds the ContentList server control to Web form. Then, the developer defines a list of content IDs in the ContentIds property. If the server control or the list in the ContentIds property is deleted, it is not available and will have to be created again.

ContentList 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• ContentIds (String)

  A comma delimited list of content block IDs. See Also: Server Control Reference

• DefaultContentID (Long)

  Set content ID value. When set, content IDs are generated from the MetaTag value for this content.

• DisplayXslt (String)

  Determines how information appears on the page.

  • None—databind only
    
  • ecmNavigation—lists the title of each content block See Also: ecmNavigation Display Example
    
  • ecmTeaser—lists the title of each content block plus the content summary. See Also: ecmTeaser Display Example
    
  • ecmUnOrderedList—sorts the list in no particular order. Shows the title and content summary
    
  • Path to Custom Xslt—If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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)

  Uses the QueryString parameter to read a content ID dynamically.

  • None - Use Default—use the default content ID list.
    
  • ID—reads a content block’s ID dynamically.
    
  • ekfrm—reads a form block’s ID dynamically.
• GetAnalyticsData (Boolean)

  Set this property to True if you want the following information for each content in the list. Returns Content View Count, Content Rating, Content Rating Average. Create your own XSLT styles to display this data.

  IMPORTANT: This property only provides reliable data when the Business Analytics Feature is on. Analyzing Websites.

• GetHtml (Boolean)
  • True—retrieve and display content (html body) for all content blocks in the list summary. For example, to display content inside a Web server control such as a GridView.
    
  • False—Do not get and display HTML.
• 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.
• IncludeIcons (Boolean)

  Choose whether to display icons next to the content list’s links.

  IMPORTANT: This property works only when ecmSummary or ecmTeaser are used in the DisplayXslt property. When the [$ImageIcon] variable is used in an EkML file and that file is assigned to the MarkupLanguage property, this property acts as True.

  —Image—

  

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

  See Also: contentlist.ekml

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored. If the EkML file contains the [$ImageIcon] variable, the IncludeIcons property acts as True.

• MetaTag (String)

  Specify a Metadata definition whose type is Content Selector. When you do, the associated list of content items will appear where you place the server control.

  NOTE: You cannot insert other metadata types.

  This works with the DefaultContentID property. For more information about using metadata to assign a list of related content to a content item, see Creating and Deploying a Related Content Definition.

• OrderByDirection (Ektron.Cms.Controls.CmsWebService.ContentListOrderByDirection)

  Determines which direction to sort content determined by the OrderBy property.

  • ascending—items are arranged A, B, C or 1,2,3.
    
  • descending—items are arranged. Z,Y,X or 3,2,1.

  If sorting by date, descending puts the most recent first. When ascending is selected and the OrderBy property is set to OrderOfTheIds, the order of the IDs are preserved. When set to descending, the order is reversed.

• OrderBy (Ektron.Cms.Controls.CmsWebService.ContentListOrderBy)

  Sort the list by one of these values:

  • Title—alphabetically, by content title
    
  • DateModified—the last date content was modified
    
  • DateCreated—the date content was created
    
  • LastEditorFname—the last editor’s first name
    
  • LastEditorLname—the last editor’s last name
    
  • OrderOfTheIds—preserves content ID order based on ContentIds property
    
  • ContentRatingAverage—Business Analytics Content Rating
    
  • ContentViewCount—Business Analytics Content Views
• Random (Boolean)
  • True—randomly display one content block link from the content list. The content changes each time a user views the page.
    
  • False—display the content list normally.

  NOTE: If you use a custom XSLT or EkML file, the type of content displayed can be manipulated. For example, if you use an EkML file that has the [$Html] variable in it, the actual content appears instead of a link. See Also: Controlling Server Control Output with Ektron Markup Language and [$Html]

• SuppressWrapperTags (Boolean)

  This property is set to false because Ajax uses <div> tags to rewrite the region around the tag. You cannot change the value to true.

• 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.

ContentReview 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (Boolean)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• DefaultContentID (Long)

  The ID of a content block being rated by this server control. If you don’t know the ID number of the content block, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

• 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.

• DisplayXslt (String)

  Select the type of review to display, or enter the path to a custom XSLT. For additional information, see Using the DisplayXSLT Property. Choices are:

  • Ajax 5 Stars—a 5 star rating system utilizing Ajax for display.
  • Ajax 5 Stars Comment—a 5 star rating system utilizing Ajax for display. When you hover over the stars, a comment box appears. Comments that are added are submitted via an Ajax call.
  • Ajax 5 Stars with Increments—a 5 star rating system with half star increments that utilizes Ajax for display.
  • 5 Stars—a 5 star rating system that allows visitors to add text reviews of content.
  • 5 Stars with Increments—a 5 star rating system with half star increments that allows visitors to rate and add a text review of the page's content.
  • Review List—displays a list of reviews for content or a user. See Also: Server Control Reference and Server Control Reference.
  • Path to Custom Xslt—If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• DynamicParameter (String)

  To make this content review control dynamic, select id. When you do, this server control is attached to the content block passed as a URL parameter.

• DynamicUserParameter (String)

  When using this control to retrieve a user’s reviews, set this property to UserId to make the user’s ID dynamic.

• GetReviews (ReviewTypes)

  Returns a list of reviews for content or a user.

  • None—do not return reviews.
  • Content—returns reviews based on the content ID provided in the DefaultContentID property.
  • User—returns reviews based on the User ID provided in the UserId property.
• 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).

• MaxReviews (Integer)

  The number of reviews to retrieve if the GetReview property is set to Content or User. 0 (zero) = unlimited.

• Moderate (Boolean)

  Setting this property to True allows Ektron users to moderate reviews. See Also: Moderating Reviews

• RatingsMinimum (Integer)

  Sets a minimum number of reviews before displaying the average rating. When set to 0 (zero), the average rating appears as soon as content is rated.

• SuppressWrapperTags (Boolean)

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

  • True—Suppress wrap tags.
  • False (default)—Allow wrap tags.
• UserID (Long)

  The user ID for which to get reviews. If left blank, reviews from all users are returned. If a user ID is specified, only reviews for that user are returned.

  IMPORTANT: The GetReviews property must be set to User for the control to use this property.

• 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.

Retrieving the XML Structure of a ContentReview

Retrieving the XML structure of XML content allows for greater control over developing XSLs.

1. Open a new Web form.
2. Drag and drop a ContentReview server control onto it.
3. Set the DefaultContentID property.
4. Drag and drop a textbox on the Web form.
5. Set its TextMode property to MultiLine. You should set the width of the text box to at least 400px.
6. On the code-behind page, add the following line.
7. Textbox1.Text = ContentReview.XmlDoc.InnerXml
8. Build the project.
9. View the Web form in a browser. The XML structure of the collectionA list of Ektron content links for display on a Web page. appears in the textbox.

Directory 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AddItemFolderID (Long)

  Define the Ektron folder ID where content is stored when an item is added to the taxonomy via the Add Asset link or the Add Content link. To enable adding content items via the Directory server control, you must use an EkML file with the [$AddAsset] and [$AddArticle] variables. See Also: taxonomy.ekml

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

  NOTE: If the EnablePaging property is set to True, the CacheInterval property is disabled.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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.

• EnableAjax (Boolean)

  Set to true to enable Ajax searches. When enabled, the MaxResults property determines the maximum number of results per page.

  • True—Enable Ajax Search (default value)
  • False—Original HTML Search
• EnablePaging (Boolean)

  This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen. See example below.

  

  So, for example, if a taxonomy has 9 items and MaxResults is set to 3, the screen displays only the first 3 items. When the site visitor clicks [Next], he sees items 4, 5 and 6, and so on.

  IMPORTANT: If the EnablePaging property is set to True, the CacheInterval property is disabled.

• EnableSearch (Boolean)

  Set to True if you want a search box (shown below) to appear above this taxonomy display. A site visitor can use the search to find content within a taxonomy/category that includes terms of interest. To suppress the search box, set to False.

  —Image—

  

• GetAnalyticsData (Boolean)

  Set this property to True if you want the following information for each content in the list. Returns Content View Count, Content Rating, Content Rating Average. Create your own XSLT styles to display this data.

  IMPORTANT: This property provides reliable data only when the Business Analytics Feature is enabled. Analyzing Websites.

• 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.
• IncludeIcon (Boolean)

  Choose whether to display icons next to the taxonomy’s links.

  This property only works when ecmSummary or ecmTeaser are used in the DisplayXslt property. When the [$ImageIcon] variable is used in an EkML file and that file is assigned to the MarkupLanguage property, this property acts as True.

  

  • True—Show icons
  • False—Hide icons
• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

  See Also: taxonomy.ekml

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored. If the EkML file contains the [$ImageIcon] variable, the IncludeIcons property acts as True.

• MaxResults (Integer)

  Enter the maximum number of items to appear in the initial display of this server control. If you set this value to zero (0), the maximum is 50. To let site visitors view more than the maximum but limit the amount of space being occupied, enter the maximum number of results per page here. Then, set the EnablePaging property to True. If you do and more than the number of MaxResults are available, navigation aids appear below the last item to help the site visitor view additional items. See following example below.

  

• OrderItemsBy

  Specify the sort order of results. Choices are:

  • taxonomy_item_display_order—the order of taxonomy items as set in the Workarea. For additional information, see Reordering Content Assigned to a Taxonomy Category.
  • content_title—the content is listed in alphabetical order by title.
  • date_created—content is listed in the order by which it was created.
  • last_edit_date—content is listed in order, by its last edit date.
  • content_rating_average—Business Analytics Content Rating
  • content_view_count—Business Analytics Content Views

  Use the the SortDirection propertyYou can to specify the direction of the items with the SortDirection property.

• PreserveUrlParameters (Boolean)

  Set to true if this control needs to preserve the URL parameters on the page. For example, if a server control displays a list of content items, the URL parameter passes to the control the template names and id values that the template expects. Set to false if the server control does not need to pass the URL parameters to the server control. The default value is false.

• Recursive (Boolean)

  Set to True to include child folders of the parent folder.

• ShowAllChecked (Boolean)

  When set to True, a check box appears in the Show All check box.

• ShowCount (Boolean)

  Indicates if the number of taxonomy items appears next to each category when displayed in the website. (See example below.) Default value is false.

  —Image—

  

• ShowRoot (Boolean)
  • False—Top represents the first node of the taxonomy path
  • True—the name of the taxonomy path's first node appears instead of Top
  —Image—

  

• SortDirection (String)

  Select the direction of the ItemSortOrder property. Choose Ascending or Descending.

• TaxonomyCols (Integer)

  Enter the number of columns in which this taxonomy/category will appear on the page.

• TaxonomyDepth (Integer)

  Enter the number of taxonomy levels to retrieve below each taxonomy/category if you are accessing a taxonomy’s XML using code-behind. For example, if the taxonomy is Businesses > Restaurants > Pizza, and you set Taxonomy Depth to 2, only Business and Restaurants are available in code-behind. This setting has no effect on the display generated by the Directory server control, which always displays only one level below the current. To retrieve all categories for a taxonomy recursively, enter -1. The default value is 1.

  IMPORTANT: For a live site, leave this value at 1. Increasing this value can slow down your live Web server. However, for testing on a staging server, you can increase the depth.

• TaxonomyId (Long)

  Enter the ID number of the taxonomy or category to appear in this server control. If you don’t know the number, click the button and navigate to the taxonomy or category.

• TaxonomyItemCols (Integer)

  Enter the number of columns in which this taxonomy/category items (articles) will appear on the page.

• 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.

Adding a URL to Your Favorites

1. Log in and navigate to the profile page that hosts the Favorites control.
2. Click Add Link.
3. In the Name field, add a name for the URL link.
4. In the Link field, add the URL.
5. In the Description text area, add a description for the URL. This is optional.
6. Click OK.

After a URL is added, it appears on the control's Links list.

You also can add a URL to your Favorites by clicking the Add to Favorites link on the Social Bar server control. See Server Control Reference.

Grouping Favorites by Folder

The DisplayMode property controls whether a user’s Favorites are displayed as a basic list, or if they can be organized in folders. For example, a user groups all content created by a certain author in a folder with that author’s name. If you add a folder to a user’s favorites, content in the folder appear in the Content list; URLs in the folder appear in the Links list.

To move a Favorite to a folder:

1. Make sure the Favorites server control's DisplayMode property is set to Directory.
2. Log in to the website.
3. Navigate to your profile page or the page the contains the Favorites server control.
4. In the Favorites server control, click Add Folder.
5. Enter a Name and Description for the folder.
6. Optionally check one or more favorite items then click OK.
   —Image—

   

7. Click Move on the Favorites server control.
   —Image—

   

8. Select a folder to which the items will be moved.
   —Image—

   

9. Click OK. A dialog box appears asking you confirm moving the items. You can find the Favorite content in the folder. Click the folder to see all content in that folder.

Deleting a Favorites Folder

WARNING! Deleting a folder also deletes all content links and URL links in the folder. If you want to retain the links, move them out of the folder before deleting it. To remove a link from a folder, click the folder, check the link, and click MoveUp One Level. Deleting a folder also deletes all of its subfolders.

1. Navigate to your profile page or a page the contains a Favorites server control.
2. In the Favorites section of the screen, click Edit Folder () next to the folder’s title. A dialog box appears.
3. Click Delete. A confirmation box appears.
4. Click OK. The folder is deleted.

Favorites 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultUserID (Long)

  The default user ID for this control to use when there is no matching dynamic parameter value passed.

• DisplayMode (eDisplayMode)

  Select the way this control displays community group information. Choices are:

  • List—shows a list of Favorites sorted in alphabetical order.
  • Directory— groups favorites by folder. If this selection is chosen, the following menu items are added to the control:
  • Add Folder—allows a user to add a sub folder.
  • Move—allows a user to move content to a folder. This item only appears if at least one folder exists. See Also: Grouping Favorites by Folder
• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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 user ID dynamically. To use the default user ID, leave blank.

• FavoritesTitle (String)

  The title shown at the top of the control.

  

• 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)(missing snippet link)
• Link (String)

  Enter a link to the content Web page. This allows a user to click a link in the Favorites control and be taken to the content.

  • {0}—content ID
  • {1}—content language
  • {2}—content title

  The link must have all 3 variables. The Web form can be relative or absolute. Below is an example.

  contentpage.aspx?cid={0}&lang={1}&title={2}

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup LanguageControlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  The Maximum number of items to fetch. 0 (zero) = unlimited.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• 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.

Working with the Flex Menu Xslt File

This section explains some non-intuitive elements of the *.xslt file.

• MenuFragment

  <xsl:when test="/MenuDataResult/Info/menuFragment='false'">

  A flag that indicates the XML data is not complete. Instead, it’s a fragment that begins deeper than the top level (for example, a submenu fragment).

  Because the data is incomplete, the XSLT processes the fragment differently. For example, don’t generate JavaScript startup code.

• menuConst

  <xsl:attributename="id"><xsl:value-ofselect="$menuConst"/>0_ekflexmenu</xsl:attribute>

  Each menu generates several elements, which the client code (JavaScript) accesses via a unique ID. For example, JavaScript needs to identify the selected submenu or item when a user clicks on an element.

  menuConst is only used is when creating elements without a corresponding XML block, such as when creating a structure to hold the menu.

• #NoScroll

  <xsl:attribute name="href">#NoScroll </xsl:attribute>

  NoScroll is sent to the href portion of a link when there is nothing to put there (for example, when the link is supposed to run JavaScript).

  NoScroll prevents the page from refreshing, going to another page, or scrolling when it should not.

• event

  <xsl:attribute name="onkeydown">returnekFlexMenu.menuBtnKeyHdlr
(event);</xsl:attribute>

  To make the xslt cross-browser compatible, it must support different methods of obtaining/passing the event object. In this example, the global event object is passed to the handling function.

  NOTE: event corresponds to window.event. window. is implied.

How Flex Menu Determines Which Item is Selected

The Flex Menu server control can select (highlight) options in a Flex menu as site visitors navigate around the website. For example, a site visitor arrives at a Web page through a link in an email. If the QueryString matches the an item in a Flex menu, the item is shown as selected.

Below is the logic the Flex menu uses to decide when a menu item should show as selected. The list is presented in the order in which the code checks to see if an item should be highlighted.

If any menu item is selected, its parent menu is marked selected. If any menu is selected, all ancestor menus are selected. When all tests have been performed and no matches are found, the Flex menu is rendered with no items selected.

NOTE: As soon as one condition is satisfied, the item is shown as selected and the testing stops.

NOTE: Steps 2 through 8 are each repeated recursively throughout the menu data hierarchy until either a match is found or the end is reached. If there are no matches for a test, the control continues with the next one.

1. Inspects the QueryString to see if the ekxmensel parameter is present with a matching menu node ID. This parameter is used to specify the exact node a user clicked. The node, its parent, and ancestor menus are all marked as selected.
2. Inspects the QueryString to see if a Content ID parameter value matches a menu item. If the Content ID in the QueryString matches a menu item, it is highlighted. For example, the QueryString includes ExamplePage.aspx?id=123, and a menu item links to Content ID 123.
3. Inspects the QueryString to see if a Form ID parameter value matches a menu item. If the Form ID passed in the QueryString matches a Flex menu item, it is highlighted. For example, the QueryString includes ExamplePage.aspx?ekfrm=456, and a menu item links to Form ID of 456.
4. Inspects the QueryString for a direct match with a menu item link. If there is a match, the menu item is selected. For example, if the QueryString has ExamplePage.aspx and there is an item on the menu that matches, the menu item is shown as selected.
5. Inspects the QueryString for a id, ekfrm or pageid parameter. If one is found, the control looks for a folder association between submenus and the folder that contains the object with the given ID. If the association exists, the menu item is shown as selected.
6. Inspects the QueryString to see if there is a direct match with a menu button link. If there is a match, the menu button is selected. For example, the QueryString has ExamplePage.aspx and there is a button on the menu that matches.
7. Inspects the QueryString to see if there’s a template association with the filename. If there’s a match, the menu item is shown as selected.
8. Inspects the QueryString for the id or ekfrm parameter and whether a value greater than zero is associated with it. If so, the control checks menu buttons for use of LinkIt.aspx. If a button is using LinkIt.aspx and either id or ekfrm parameter matches, the menu button is selected.

Analyzing Flex Menu's Selection of Menu Items

The Flex Menu server control performs a complex sequence of tasks to determine which menu option to select. If you are unsure of a Flex Menu's behavior, you can view a log that lists the reasons for a menu selection. Use the log to troubleshoot issues with a Flex Menu.

Setting Up Log of Flex Menu Information

Follow these steps to set up the ability to view a log of Flex Menu display information.

1. Open your site root/web.config file.
2. Under system.diagnostics, set LogLevel to 4. Save and close web.config.
   —Image—

   

3. Edit the .aspx or .ascx page that hosts the Flex Menu control.
4. Set the control's LogInfo property to true and save the page.

   <CMS:FlexMenu ID="FlexMenu1" LogInfo="True" runat="server" /> 

   NOTE: It may be helpful to temporarily disable the menu's cache by setting CacheInterval="0".

5. Refresh the browser that contains the Flex Menu you edited in the Step 4.
   —Image—

   

6. Using the Windows Event Viewer, look for the newest information-level event that contains Message: Flex Menu (under the timestamp line).
   —Image—

   

The event message identifies the reason the menu node was selected. Or, if no matches were found, the message indicates that nothing is selected.

Flex Menu 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (Boolean)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• AutoCollapseBranches (Boolean)
  • True—whenever a new submenu opens, all other submenus close.
  • False—other submenus remain open when a new one opens.
• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultMenuID (Long)

  The ID of a menu that appears where you insert this server control if no other menu is identified or available. If you don’t know the ID number of the menu, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer

  NOTE: If you want to change the Default menu's Starting menu, use the StartMenuID property.

• 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. Flex menus are designed to use the xsl file to control the menu’s behavior, and the .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! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

• 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.

• EnableAjax (Boolean)

  Set to True to enable Ajax, which only downloads sub-menus as needed.

• EnableMouseOverPopup (Boolean)
  • True—submenus appear as soon as the cursor moves over them.
  • False—submenus only appear if a site visitor clicks them or a keyboard equivalent.
• EnableSmartOpen (Boolean)

  Lets you prevent submenus from opening by default. Under some circumstances, such submenus look cluttered.

  • True—submenu can open automatically. To learn how to do this, see Assigning a Folder or Template to a Menu.
  • False—even if all required conditions are present, submenus on a Flex Menu do not automatically open.
• IncludeJS (Boolean)
  • True—load the menu's JavaScript.
  • False—ignore the menu's JavaScript. This would be useful if you redefine the menu's output with an XSLTExtensible Stylesheet Language Transformations.
• MasterControlId (String)

  Only use this property if you are setting up a master/slave menu relationship, and this menu is the slave. If both are true, enter the ID of the master menu.

• MenuDepth (Integer)

  To let site visitors browse through all menu levels, enter zero (0). To restrict site visitors to a menu level, enter the number of the lowest level. In the following example, if you set this property to 1, a site visitor can browse through the About Us menu options but would not see the level 2 options (Company Profile and Careers).

  —Image—

  

• StartCollapsed (Boolean)

  If you set to True, when the menu first appears, all submenus are closed.

• StartLevel (Integer)

  Enter a number to indicate the level at which you want this menu to display when it first appears. To begin the menu display at the root level, enter zero (0). In the following example, the Home folder is level 0. The others are level 1.

  —Image—

  

  A site visitor can click a menu option to navigate to folders below the displayed level.

  NOTE: If you set a StartMenuID, the StartLevel property is ignored.

• StartMenuId (Integer)

  Use this property to have the default menu begin somewhere other than its root. That is, at any submenu under the default menu. For example, menu ID 46 (Products) is the default menu. However when that menu displays, you only want to show its submenus, beginning with Products Support (ID 58). In this case, enter 46 into the DefaultMenuID property and 58 into the StartMenuID property.

  NOTE: If you set a StartMenuID, the StartLevel property is ignored.

• Stylesheet (String)

  Enter the style sheet that will determine the appearance of the menus. Flex menus use an .xsl file to control their behavior, and a .css file to control their display. Ektron provides several sample menus, and each has a .css file. If this is a new menu, you may find it easier to copy and edit a .css file provided with a sample menu. See Also: SampleMenu

• SuppressAddEdit (Boolean)

  When set to True, suppress the Add and Edit buttons on the menu when a user is logged in to Ektron. The default is False.

  • True—suppress the Add and Edit button when a user is logged in to Ektron.
  • False—show the Add and Edit buttons when a user is logged in to Ektron.
• SuppressWrapperTags (Boolean)

  This property is set to false because Ajax uses <div> tags to rewrite the region around the tag. You cannot change the value to true.

• 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.

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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AddContentTitleToBreadcrumb (Boolean)

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

  Home > Content > Content_Title

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

  Home > Content

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• 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.

• 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 Folder Breadcrumb Server Control

Add the Folder Breadcrumb 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 Folder Breadcrumb server control.

1. In the Workarea, define breadcrumb information for a folder. See Also: Creating a Sitemap Breadcrumb Trail
2. Open a Web form for which you want to create a site map.
3. Drag and drop the Folder Breadcrumb 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—

   

FormBlock 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AddValidation (Boolean)

  The AddValidation property is obsolete and ignored. It has no effect. It is always true.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultFormID (Long)

  The ID of a FormBlock that appears where you inserted this server control if no other form block is identified. If you don’t know the ID number of the form block, use the CMS Explorer to browse to it.See Also: Browsing Your Ektron Site Using CMS Explorer.

• 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)

  To make this form block dynamic, select id. When you do, this server control uses the form block passed as a URL parameter.

• Fields (FormFieldCollection)

  Displays a list of fields that are defined in the form. These fields are read only. This is an excellent way of displaying the field names used on the form. With this list of names, you can create events using the fields without having to enter the Workarea to see the names.

• 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.
• IncludeTags (Boolean)

  Determines if tags are generated automatically of manually.

• Language (Integer)

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

• 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.

Forum 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AllowAnonymousPost (Boolean)

  Set to True to allow site visitors the option of posting anonymously to the forum. When true, a Post Anonymous checkbox appears above the text editor used to create a post.

  —Image—

  

  If a site visitor adds a check mark to this box, the word Anonymous appears where the Display Name normally appears. The default is True.

  • True—display Post Anonymous checkbox when site visitors create a post.
    
  • False—disable Post Anonymous checkbox.
• Authenticated (Boolean)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• BoardID (Long)

  The ID of the discussion board to display on this page if one is not defined in a query string parameter. If you don’t know the ID, click Ellipses (), then sign in and select a discussion board.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• CustomOrderBy (String)

  Provide a property’s Friendly Name to order search results by that property. For example, if you define DocAuthor, results will be sorted by the document’s author. Results can be ascending or descending based on OrderDirection. If you enter an invalid property, no search results are returned. If you specify both CustomOrderBy and OrderBy, the OrderBy property is ignored.

• DefaultObjectID (Long)

  The Static ID of a community group.

• DynamicForumParameter (String)

  Gets or sets the QueryString parameter to read a forum ID dynamically. The default is “f”. Note that a Forum resides one level below a discussion board.

• DynamicGroupParameter (String)

  Gets or sets the QueryString parameter to read a group’s ID dynamically. The default is “g”.

• DynamicObjectParameter (String)

  Dynamic Parameter for the community group id. Default is “id”.

• DynamicParameter (String)

  Gets or sets the QueryString parameter to read a discussion board’s ID dynamically. Set to None - Use Default—if you want to always display the default discussion board. Note that a discussion board is one level above a Forum.

  • boardid—reads a Threaded discussion board’s ID dynamically.
  • None - Use Default—use the default discussion board’s ID.
  • ID—reads a discussion board’s ID dynamically.
• DynamicThreadParameter (String)

  Gets or sets the QueryString parameter to read an individual thread’s ID dynamically. The default is “t”. Note that a Thread resides 2 levels below a discussion board and one level below a Forum.

• EditorCSS (String)

  Set the style sheet for the Editor when a site visitor creates or edits a post. By default, this property is blank. When a style sheet is not supplied, the style sheet defined in the Theme property is used.

• EditorToolbar (String)

  Enter a comma separated list of items that you want to appear on the Editor’s toolbar. The default is StyleMenu, FontMenu, ParagraphMenu, TextFormatMenu, LinkMenu, ClipBoardMenu, SymbolsMenu, EmoticonSelect, WMV, Table. See Also: Adding and Removing Toolbar Items From the Editor.

• EnableForumQuickSelect (Boolean)

  If you set this property to true, a drop-down list of all forums appears below the topic list. The site visitor can click a forum and jump immediately to it.

• EnableThreadRating (Boolean)

  If you set this property to true, a ContentReview server control appears on any topic screen run by this server control. The site visitor can use the control to rate the topic thread. An average rating for the thread appears next to each topic on the forum screen.

  —Image—

  

• ExcludeList (String)

  Enter a comma-separated list of custom user properties to exclude from the Forum’s profile page. For example, to suppress the Subscriptions field value, enter subscriptions.

• FilterXslt (String)

  Enter the path to an XSLTExtensible Stylesheet Language Transformations file used to filter forum content, such as, HTML Attributes, Tags and unwanted words in a user’s forum post. The path can be relative or absolute. The user’s post is filtered when the user clicks Submit. By default, this property points to <webroot>/siteroot/Workarea/Xslt/ForumFilter.xslt. This file removes hrefs with javascript:, vbscript: and “on” events in the link. You can modify this file or create a new one.

  WARNING! If you want to edit this file, make a copy, change its name and move it outside of your website’s Workarea folder. If you make changes to this file and do not move it out of the Workarea folder, this file and the changes will be lost when you upgrade.

  For additional sample code used to create a filter XSLTExtensible Stylesheet Language Transformations, see the following KB article: XSLT: Gallery of Templates

• 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.
• HideUserProfile (Boolean)
  • True—hide user profiles from non-administrator users.
    
  • False—display user profiles for non-administrator users.

  The default is True. An administrator can view a profile regardless of how this property is set.

  On the other hand, if the Private Profile is set to Private for any user, the profile information is not visible, regardless of this setting. If Private Profile is set to Colleagues, only colleagues can see profile information. When the profile is visible, only properties and their values not listed in the ExcludeList property (above) appear.

• JavascriptEditorHeight (Integer)

  Set the height in pixels for the eWebEdit400 editor. The default is 400. The minimum height is 300.

• JavascriptEditorWidth (Integer)

  Set the width in pixels for the eWebEdit400 editor. The default is 625. The minimum width is 500.

• Language (Integer)

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

  Set property to -1 if you want the Forum server control to display topics from all available languages.

• ObjectType (String)

  Describes the type of forum displayed by this server control.

  • CommunityGroup—Used for forums inside a Community page.
  • DiscussionBoard—Used for forums on templates that are not Community pages.
• OrderBy (String)

  The order of search results. For example, you want to sort search results by last modified date.

  • Title—Content title (alphabetical).
  • ID—Content ID number.
  • Date Created—Date the content was created.
  • Date Modified—Date the content was most recently modified.
  • Editor—User who last edited the content (alphabetical).
  • Rank—Rank assigned to the content.

  NOTE: The OrderDirection field determines the direction of the search results. For example, if you sort by ID and OrderDirection is set to Descending, the results sort by ContentID number with the highest number at the top of the list.

  IMPORTANT: Specifying a CustomOrderBy property overrides this property.

• OrderDirection (String)

  The direction in which search results are sorted. The default is Ascending.

  • Ascending—Alphabetical results from A to Z; numeric values low to high; dates from oldest to most recent
  • Descending—Alphabetical results from Z to A; numeric values high to low; dates from most recent to oldest
• ProfileLink (ItemLinkTargets)

  Enter a link to the user’s social networking profile page, a part of Ektron’s community platform. This allows a user to click another user’s name link or avatar and be taken to the user’s profile page. The link has 2 variables that represent the user’s ID and display name.

  • {0}—user ID
  • {1}—user display name

  You need to have both variables in the link. The Web form can be relative or absolute. For example:

  userprofilepage.aspx?uid={0}&dn={1}

  The default for this property is ?g=profileu={0}.

  When the default for this property is used, users are forwarded to a user’s profile page that is included with the forum control.

• ProfileLinkTarget

  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.
• ShowCategories (Boolean)

  If set to True, when this server control appears, the user see a Filter by Category option. This option helps a site visitor zero in on relevant content. If False, the Filter by Category option does not appear.

• SuppressWrapperTags (Boolean)

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

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

  Use this property to determine the number of columns on the Taxonomy screen available from this discussion board. In the illustration below, taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. categories are arranged in 3 columns (the default value).

  

• TaxonomyMarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

• Theme (String)

  Enter the custom theme’s folder name. The theme can be relative to the site root or located in the current folder. For example:

  • Relative—Theme=”/workarea/csslib/themes/winter”
  • Current Folder—Theme=”mytheme”

  If you do not specify a theme, the property uses the location defined by the discussion board’s CSS theme property in the Workarea. See Also: Using a Custom Theme

• 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.

Updating the Page Command

To prevent an error from appearing when a user posts a reply to the Web page that hosts the Forum server control:

1. Open the Web form onto which you inserted the Forum server control.
2. Access Source view.
3. Go to the top line of the Web form, which begins with @ Page.

   <%@ PageLanguage="VB"AutoEventWireup="false" 
   CodeFile="Default2.aspx.vb"Inherits="Default2" %>

4. Near the end of the line, enter validaterequest=false.
5. Build the page.

Using a Custom Theme

This property lets you specify a custom location for your themes. By doing so, you prevent them from being overwritten when you upgrade.

If you do not specify a theme in the server control, Ektron uses what is defined in the discussion board’s properties CSS Theme field.

To create a custom theme:

1. Create a new subfolder on your site. In this example, we use a winter theme:

   <web root>/<your site>/Workarea/csslib/winter.

2. Copy all files in the /Workarea/Threadeddisc/themes folder to the winter folder.
3. Change the image files to match your theme. To find the name of an image:
   1. Right click on it while viewing it in a browser.
   2. Select Properties. The name appears at the top of the dialog box.
4. Change the discussion board’s .css file to match your theme and save it with a custom name. (You do not need to do this if an existing .css file meets your theme’s needs.)

   IMPORTANT: Make sure the CSS theme property in the Workarea is pointing to the proper CSS file.

5. View the discussion board in a browser to see the changes.

Adding and Removing Toolbar Items From the Editor

IMPORTANT: You cannot create new buttons and add them to the Forum Editor. You can only add and remove existing buttons.

IMPORTANT: This section is only applicable if you are using the eWebEdit400 editor. See Also: Using the eWebEdit400 Editor

You can add and remove toolbar items on the Forum Editor by editing the EditorToolbar property. This property contains a series of string values that represent each item, listed below.

• StyleMenu—Display a list of paragraph styles. Users can select from the list to apply a style to selected text.
• FontMenu—Display a list of available font styles, sizes and colors.
• ParagraphMenu—Controls the display of buttons that affect a paragraph. This includes:
  • Numbered List
  • Bullet List
  • Outdent
  • Indent
  • Align Left
  • Align Center
  • Align Right
  • Justify
  • Horizontal Rule
• TextFormatMenu—Controls the display of buttons that format text. This includes:
  • Bold
  • Italics
  • Underline
• LinkMenu—Controls the display of buttons that allow a user to add and remove hyperlinks links and work with the library. This includes:
  • Hyperlink Manager
  • Remove Link
  • Library
• ClipBoardMenu—Controls clipboard buttons that allow a user to cut, copy, and paste content. This item also controls the Undo and Redo buttons.
• SymbolsMenu—Controls the display of the Symbol button, which allows users to insert symbols and special characters.
• EmoticonSelect—Controls the display of the Emoticon button.
• WMV—Controls the display of the Insert WMV button.
• Table—Controls the display of the Insert table button.

Friends 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• AvatarHeight (Integer)

  The display height in pixels of the avatar in the results box. 0 (zero) = unlimited.

• AvatarWidth (Integer)
• The display width in pixels of the avatar in the results box. 0 (zero) = unlimited.
• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

• DefaultUserID (Long)

  The default user ID for this control if no matching dynamic parameter value is passed.

• DisplayMode (eDisplayMode)

  Select the way this control displays colleagues. Choices are:

  • Directory—allows users to group colleagues by folders. In this mode, these menu items appear.
  • Add Folder—lets user add a folder.
  • Move—lets a user place colleagues in a folder. This option appears only if a folder exists.
  • List—lists colleagues in alphabetical order
  • Pending—lists users who have sent colleague requests to the logged-in user. The user can approve or decline these requests.
  • SentInvites—lists users to whom the logged-in user sent colleague requests. The user can cancel invitations that have not been accepted yet.
• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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 user ID dynamically. To use the default user ID, leave blank.

• FriendLabel (String)

  Set the singular text to be used as a title for the Friends server control. The default value is Colleague.

• FriendsLabel (String)

  Set the plural text to be used as a title for the Friends server control. The default value is Colleagues.

• 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).

• Link (String)

  Enter a link to the user profile page template. The path can be relative or absolute. This value is referenced when a user clicks another user in the Friends control. Upon clicking the link, the selected user’s profile page appears. The link requires these variables.

  • {0}—represents user ID
  • {1}—represents user display name

  For example: userprofilepage.aspx?uid={0}&dn={1}

• 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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

• MaxResults (Integer)

  The maximum number of colleagues to display in the control. 0 (zero) = unlimited.

• RenderOutput (Boolean)

  Lets you determine whether or not to generate output. If you do not, CSS and JS are not registered.

  • True (default)—The control's output is generated.
    
  • False—The control fetches data from the backend but generates no output. You are responsible for generating output using XML or DataClasses
• ShowSortingOptions (Boolean)

  Determines if sorting options appear on the control. If set to True, the following options appear:

  • Colleagues—all current colleagues
  • Pending—colleagues who sent you a colleague request that you have not yet accepted
  • Invited—colleagues to whom you have sent colleague requests
• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• 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.

ImageControl 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• DefaultImageID (Long)

  The image asset’s content ID you want to display. If you don’t know the ID number of the asset, use the CMS Explorer to browse to it.

• 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 an image asset’s ID dynamically. To have the default image ID used, leave blank.

• FolderID (Long)

  The ID of the folder where images are added. If you don’t know the ID number of the folder, use the CMS Explorer to browse to it.

• 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).

• SuppressWrapperTags (Boolean)

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

  • True—Suppress wrap tags.
  • False (default)—Allow wrap tags.
• TaxonomyID (long)

  The ID of the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. to which assets are added.

• Title (String)

  Set the image’s alt/title text. By default, the image file name is used.

• 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.

Invite 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• DisplayXslt (String)

  If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.
  
  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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.

• FriendMessageId (Long)

  The ID of the message to send in the link section of a FriendInvitation type email. This message is defined in the Workarea > Settings > Community Management > Messages. See Also: Generating email Invitations for Community Management. If set to 0 (zero), the server control uses the default message.

• 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.
• InviteMessageId (String)

  The ID of the message to send in the link section of a GroupInvitation or FriendInvitation email. This message is defined in the Workarea > Settings > Community Management > Messages. See Also: Generating email Invitations for Community Management. If set to 0 (zero), the server control uses the default message.

• Language (Integer)

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

• OptionalMessageText (String)

  The body text of the email message. The text appears in the Invite server control’s dialog box and can be edited by site visitors when they use the Invite control.

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• 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.

LanguageAPI 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• SiteLanguage (String)

  Sets the site language. Runs through the IsValid function to verify that the language is an active language in the system.

• SiteLanguageID (Integer)

  Numeric value of the site language. This is the property you will use if you are using code-behind to set the sites language ID.

  Example: 1036 = French

  For a list of supported languages, go to Workarea > Settings > Configuration > Language Settings.

LanguageAPI Code-Behind Only Properties and Methods

The following is a list can only be used programmatically.

• CurrentLanguage (String)

  Read only. Returns the current language.

• CurrentLanguageID (Integer)

  Read only. Returns the current language ID.

• DefaultLanguage (String)

  Read only. What the default language of the site is set to. For example, the demo site is “English (Standard)”.

• DefaultLanguageID (Integer)

  Read only. Returns the value that is the default language ID of the site. For example, the demo site is “1033” for English.

• GetLanguage (Integer Argument)

  This method returns a string. Pass in a valid language ID and it will return the language name.

• GetLanguageID (Sting Argument)

  This method returns an integer. Pass in a valid language name and it will return the language ID.

• IsValid (Argument)

  This method returns a boolean. You can pass in a language ID or a string and it will tell you if the system is supporting it.

• LanguageIdList (Array of Integers)

  Read only. Lists all the language IDs that are activated in Ektron. For information on how to enable languages, see Determining Which Languages are Available.

• LanguageTitleList (Array of Strings)

  Read only. Lists all the languages that are activated in Ektron.

• MultiLanguageEnabled (Boolean)

  Read only. Tells if the site supports multi-language mode.

  • True (default)—Multi-language enabled
  • False—Multi-language not enabled

Using LanguageAPI Programmatically

This example uses a logo that is not managed through Ektron. It retrieves the current language from the LanguageAPI control, and uses that information to choose the logo version to display. The code-behind looks like this.

Select Case LanguageAPI1.CurrentLanguageID
	Case 1031
	Image1.ImageUrl = "germanlogo.png"
	Case 1033
	Image1.ImageUrl = "englishlogo.png"
	Case 1036
	Image1.ImageUrl = "frenchlogo.png"
End Select

LanguageSelect 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• 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.

• 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.
• LabelName (String)

  Lets you define the label next to the language select drop-down box.

• Language (Integer)

  Set a language for the Language Select Box. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

• 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.

ListSummary 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• AddText (String)

  Override the control’s default text for the Add Content menu item.
  For example, you have a News website. You could change Add Content to Add News Item.

  —Image—

  

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• CacheInterval (Double)

  The number of seconds that a 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.’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

  NOTE: If the EnablePaging property is set to True, the CacheInterval property is disabled.

• ContentParameter (String)

  Checks the QueryString for this value and replaces the list summary with a content block when specified. Leave blank to always display the list summary.

• ContentType (String)

  Determines the type of content that appears in the list summary. The default is Content. Choices are:

  • AllTypes—all content types for the given folder
  • Content—a list of contenttypes of content include HTML, XML Smart Forms, forms, polls, surveys, DMS documents, Office documents, multimedia, blogs, Web calandars, discussion boards, assets, and content imported from Sharepoint. items.
  • Forms—forms appear in the list summary
  • Archive_Content—archivethe state of content upon reaching its end date. What happens next is determined by your choice at the content's Schedule tab > Action on End Date options field. Choices are * Archive and remove from site (expire) * Archive and remain on site * Add to CMS Refresh Reportd content blocks appear in the list summary
  • Archive_Forms—archived forms appear in the list summary
  • Assets—assets, such as offices documents, appear in the list summary
  • Archive_Assets—archived assets appear in the list summary
  • LibraryItem—library items appear in the list summary
  • Multimedia—multimedia items appear in the list summary
  • Archive_Media—archived multimedia items appear in the list summary
  • NonLibraryContent—all content types except library items.
  • DiscussionTopic—forum topics appear in the list summary.
  • CatalogEntry—displays all catalog entries (products) for a specified catalog.
• DisplayXslt (String)

  Determines how information on the page appears

  • None—databind only
  • ecmNavigation—lists the title of every content block in the folder See Also: Collection (deprecated)
  • ecmTeaser—lists the title of every content block in the folder plus the content summary See Also: ecmTeaser Display Example
  • Path to Custom Xslt—If desired, enter a relative or absolute path to an Xslt that determines the display of the page.

  WARNING! If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored.

• 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.

• EnablePaging (Boolean)

  This property, in conjunction with the MaxNumber property, lets site visitors view an unlimited number of items while controlling the amount of screen space. The MaxNumber property limits the number of items displayed. If you set this property to True, and the number of items exceeds MaxNumber, navigation aids appear below the last item, allowing the visitor to go to the next screen.

  See example below.

  

  So, for example, if a List Summary has 9 items and the MaxResults property is set to 3, the screen displays only the first 3 items. When the site visitor clicks [Next], he sees items 4, 5 and 6, and so on.

  • True—Use paging feature
  • False—Ignore paging feature

  NOTE: If the EnablePaging property is set to True, the CacheInterval property is disabled.

• FolderID (Long)

  The folder that contains the items which appear in the list summary. See Also: Browsing Your Ektron Site Using CMS Explorer. The Recursive property determines whether content blocks in this folder’s child folders also appear.

• GetHtml (Boolean)

  Set to True to display the HTML body for all content in the list summary. For example, to display content inside a Web server control such as a GridView.

  • True—Get and display HTML for each content block in the list summary
  • False—Do not get and display HTML.
• GetAnalyticsData (Boolean)

  Set this property to True if you want the following information for each content in the list. Returns Content View Count, Content Rating, Content Rating Average. Create your own XSLT styles to display this data.

  IMPORTANT: This property only provides reliable data when the Business Analytics Feature is on. Analyzing Websites.

• 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.
• IncludeIcons (Boolean)

  Choose whether to display icons next to the list summary’s links.

  IMPORTANT: This property works only when ecmSummary or ecmTeaser are used in the DisplayXslt property. When the [$ImageIcon] variable is used in an EkML file and that file is assigned to the MarkupLanguage property, this property acts as True. See Also: Controlling Server Control Output with Ektron Markup Language

  

• Language (Integer)

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

• LinkTarget (String)

  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.
• MarkupLanguage (String)

  Identify the template markup file that controls the display of the server control. For example, mymarkup.ekml. If the EkMLEktron Markup Language file is located in the same folder as the Web form containing the server control, just enter its name. Otherwise, the path to the file can be relative or absolute. See also: Controlling Server Control Output with Ektron Markup Language

  See Also: listsummary.ekml

  If you enter a valid EkML file at the MarkupLanguage property, the Displayxslt property value is ignored. If the EkML file contains the [$ImageIcon] variable, the IncludeIcons property acts as True.

• MaxResults (Integer)

  Enter the maximum number of items to appear in the initial display of this server control.

  If you enter no value or 0 (zero), the maximum is 50. This is done for performance reasons.

  To let site visitors view more than the maximum but limit the amount of space being occupied, enter the maximum number of results per page here. Then, set the EnablePaging property to True.

  If you do and more than the number of MaxResults are available, navigation aids appear below the last item to help the site visitor view additional items. See example below.

  

• OrderbyDirection (Ektron.Cms.Controls.CmsWebService.OrderByDirection)

  How to order the hyperlinks on the list. The sort field is determined by the OrderKey property.

  • ascending—hyperlinks are arranged A, B, C or 1,2,3.
  • descending—hyperlinks are arranged Z, Y, X or 3,2,1

  If sorting by date, descending puts the most recent first.

• OrderBy (Ektron.Cms.Controls.CmsWebService.TeasersOrderBy)

  NOTE: For releases 8.0.1 and later the OrderKey property has been deprecatedfunctionality that is being phased out and may become invalid or obsolete in future versions; migrate to the current and recommended version.. It has been replaced by this OrderBy property.

  Sort the list by one of the values.

  • Title—Content Title
  • DateModified—Date content last modified
  • DateCreated—Date content created
  • LastEditorFname—First name of user who last edited content
  • LastEditorLname—Last name of user who last edited content
  • Start Date—Go Live date of content
  • Rated—Business Analytics Content Rating
  • ContentViewCount—Business Analytics Content Views

• Random (Boolean)

  Set to True if you want to randomly display one content block in the specified folder. The content changes each time a user views the page.

  • True—randomly display one content block.
  • False—display the list summary normally.

  If you use a custom XSLT or EkML file, the type of content displayed can be manipulated. For example, if you use an EkML file that has the [$Html] variable in it, the actual content appears instead of a link. See Also: Controlling Server Control Output with Ektron Markup Language and [$Html]

• Recursive (Boolean)

  Determines if the display includes content in child folders of the selected folder.

  • True—include content from child folders.
  • False—do not include content from child folders.
• SelTaxonomyID (Integer)

  Set the ID of the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. that content will be associated with when a logged in site visitor uses the Silver Access Point’s Add HTML Content to add content to a list summary server control.

• 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.

Retrieving the XML Structure of a List Summary

Retrieving the XML structure of XML content allows for greater control over developing XSLs. The following example shows how to retrieve the XML structure.

1. Open a new Web form.
2. Drag and drop a ListSummary server control onto it.
3. Set the FolderID property.
4. Drag and drop a textbox on the Web form.
5. Set the TextMode property to MultiLine.

   NOTE: You should set the width of the text box to at least 400px.

6. On the code-behind page, add the following line.

   Textbox1.Text = ListSummary1.XmlDoc.InnerXml

7. Build the project.
8. View the Web form in a browser.
9. The ListSummary’s XML structure appears in the textbox.

Login 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Authenticated (String)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• AutoAddType (Common.EkEnumeration.AutoAddUserType)

  When using Single Signon, the Login Server Control can be used to add users to Ektron. In this scenario, when a user signs on with Active Directory credentials, that user is created within the Ektron database. Use this property to define the type of user that is automatically added to Ektron. See Also: Single Sign On

  • Author—Ektron user
  • Member— membership user
• AutoLogin (Boolean)

  If this property is set to true and Active Directory Integration is enabled, users are automatically logged in using Active Directory authentication. They do not need to enter a username or password. See Also: Single Sign On

  • True—Use Active Directory authentication when logging in.
    
  • False (default)—Do not use Active Directory authentication when logging in.
• 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.

• 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 the Login server control. This property shows results in design-time (in Visual Studio) and at run-time (in a browser).

• OnlyAllowMemberLogin (Boolean)

  Allows only membership users to log in. This property prevent users from logging as an Ektron user and accessing the Workarea. If an Ektron user tries to log in using this control, this message appears: “Only members are allowed to login here.” The default is False.

  • True—Only membership users can log in
    
  • False—Ektron users and membership users can log in
• PromptLogout (Boolean)

  When set to False, the logout process omits the Logout window (shown below).

  

  • True—Users must click Logout to log out.
  • False—The Logout window does not appear
• SuppressHelpButton (Boolean)

  Hides the Help button that appears below the Login button when set to true.

  • True—Do not display the Help button.

    

  • False (default)—Display Help button.

    

  If you are editing this server control from a text file and want to suppress the Help button, add the following code to the login tag source:

  <CMS:Login ID="Login1" runat="server" SuppressHelpButton="True" />

• 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.

Map Properties

Within Visual Studio, you cannot see the map in design mode. However, you can right mouse click the mouse and select View in Browser to see the effect of changing the properties.

You cannot place more than one map server control on a form.

Troubleshooting

• If Map does not render on Web page, change the VirtualEarthMap web.config element as follows:

  <add key="VirtualEarthMap" 
    value="https://dev.virtualearth.net/mapcontrol/
    mapcontrol.ashx?v=6.1&amp;s=1" />

• If a user must click a warning away before users can see map on page, upgrade Google Maps to a premier subscription. For more information, see Google Maps for Business.

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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.

• Address (String)

  To set a default map center, enter its address. The address appears in the Search field when the map first displays. If you only enter a zip code, the map centers on its post office. If you enter an address, the latitude and longitude properties are ignored.

  —Image—

  

• Authenticated (Boolean)

  Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

• ContentId (Long)

  Use this field in conjunction with the EnableSearchResult field to limit the map to a single content item. Here, you identify the content item to be mapped. Content must have latitude and longitude values to appear on a map.

• CustomIcon (Boolean)

  Use this field if you want the Category popup box to display an icon to the left of each category, as shown below.

  

  Prerequisite

  To use this value, open the webroot/Workarea/images/application/maps/tree folder. In that folder, create a new folder whose name is the same as the Taxonomy category assigned to the Map server control at the MapCategory property. (In the sample site, this Taxonomy’s name is MapCategory.) Then, place the icons in that folder by category title name with a .png extension. Use an underscore (_) to separate taxonomy levels. For example, the image for the category Restaurant > American must be named Restaurant_American.png.

• DateSearch (Boolean)

  Set to True to assign a date to content. This feature is helpful for date-related content, such as concerts, meetings, or sporting events. You can filter what appears on the map by date. If you set this property to true, assign a date to date-related content using the MapDate standard metadata field. Then, publish the content. When you click a map’s Display on Map button, the popup screen includes date criteria, as shown below. You can select map items by a single date or a range of dates.

  —Image—

  

• DisplayTextResult (Boolean)

  If you want to display a box of information about each map item to the right of a map, enter True. To suppress the text box, enter False.

• DistanceUnit (Unit)

  Enter the map's units of distance. Choices are miles and kilometers. The default value is miles.

• 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.

• EnableSearchResult (Boolean)

  Use to determine if the Map server control accesses the Ektron search to return results. True is the default value. You would change it to False if you want to display a map with only one content item, that is, a single location. Specify this item at the ContentID property. In this case, the map does not find other Ektron content whose longitude and latitude are within the map’s boundaries. Site visitors viewing the map can still use the Search and Directions tabs to get directions to the location. For example, your site features homes for sale, and you want a map to show a featured home of the week. To do so, set this property to False, and enter the content that describes that home in the ContentID field.

• FolderId (Long)

  Enter the ID number of the folder whose content is searched on this map. If the recursive property is true, folders below this folder are also searched.

• ForceCategory (Boolean)

  When set to true, this property causes the map to only show content associated with the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. category defined in the MapCategory property. When set to false, the map shows all content within the map’s boundaries. For example, if 5 content blocks appear on a map and 3 are assigned to a taxonomy, set this property to True and the MapCategory property to the ID of the taxonomy. When a user views the map, it displays the 3 content items associated with the taxonomy.

• GeoControl (Boolean)

  If you want to see a search box with tabs above a map, enter True. To suppress the text box, enter False. See Also: Server Control Reference

• 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).

• Latitude (Decimal)

  To set a default map center via latitude and longitude (as opposed to an address), enter the latitude here.

• Longitude (Decimal)

  To set a default map center via latitude and longitude (as opposed to an address), enter the longitude here.

• MapCategory (Long)

  Enter the ID number of the taxonomya content-level categorization system that uses one-to-many relationships (such as Ronald Reagan is to Actor, Governor, and President) to create a scalable organization of content. A taxonomy lets your site visitors navigate content independent of the folder structure. whose categories appear when up click this map’s Display on Map button. When a map first appears, all eligible content appears. If you click Display on Map, you can choose categories and limit the map to items assigned to them. For example, you could view restaurants only. As another example, a map could initially display all campuses in your state college system. Use the Display on Map pop-up window to limit the map to community colleges.

  While an OR relationship among categories is the most intuitive and common, you can set up an AND or NOT logical relationship among selected categories.

  —Image—

  

• MapProvider (Provider)

  Select the service that provides the map, either Google or Bing Maps for Enterprise. See Also: Configuring Google Maps

• MapStyle (Style)

  Enter the map’s display mode: Road, Satellite or Hybrid. This setting only affects Bing Maps for Enterprise maps.

• MarkupLanguage (String)
  

  Enter the template markup file that controls the map page display. For example, mymapmarkup.ekml. If you enter no EkML file, the default one at Workarea\Template\map\map.ekml is used. If the *.ekml file is located in the \workarea\template\map folder, just enter its name. If the file is in another folder, enter the path relative to site root. For example, \workarea\customfiles\markup\mymapmarkup.ekml See Also: Controlling Server Control Output with Ektron Markup Language and map.ekml

• MinZoomLevel (Integer)

  If you want to set a map zoom level below which map locations will not appear, enter that value. The default value is 4. Possible values are between 1 (most detailed) and 19.

• PageSize (Integer)

  Enter the number of locations that can appear on one page of the text box after a search is executed. See Also: Server Control Reference. If more than this number of locations are available, use [First] [Previous] [Next] [Last] at the bottom of the page to view additional locations.

  —Image—

  

• Recursive (Boolean)

  In the FolderID property, you specify a folder whose content is searched on this map. To extend the search to all folders below this folder, set this property to true.

• SelectedCategoryLogicalType (LogicalType)

  Use this property to determine the logical relationship among several categories on the Display on Map tab. (See Server Control Reference). There are 3 choices: OR, AND, and NOT.

  —Image—

  

  By default, an OR relationship exists among your selections. So, for example, if all 3 Restaurant categories are checked, then any restaurant that is defined as American, Chinese or Pizza appears on the map. If you change this property’s value to AND, only content to which all selected categories apply appear on the map. In the above example, only restaurants defined as American and Chinese and Pizza appear on the map.

  Alternatively, you can set the property’s value to NOT. In this case, only content to which the selected categories are not applied appear on the map. To continue the above example, if you select Chinese, only restaurants that are not assigned the Chinese category appear on the map.

• StartZoomLevel (Integer)

  Enter the zoom level at which the map initially appears. See Also: Server Control Reference. Zoom level 1 is the least detailed, showing the entire world. Zoom level 19 is the most detailed, showing the smallest streets. By default, maps in the sample site have a zoom level of 12, which shows an area of about 10 miles (16 kilometers). A site visitor can adjust the level using the zoom control (circled below).

  —Image—

  

• Stylesheet (String)

  Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  NOTE: If you enter a valid EkML file at the MarkupLanguage property, the Stylesheet property is ignored.

• SuppressWrapperTags (Boolean)

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

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

  Sets a QueryString parameter for the ID of users that are returned in the search results. This parameter is passed to the template page defined in the TemplateUserProfile property when a user clicks the Location (map) icon associated with a user.

• TemplateUserProfile (String)

  The URL path of the user profile template. The path can be relative or absolute.

• TypeControl (Boolean)

  If this map uses Bing Maps for Enterprise maps, this property enables or disables the zoom/direction/type control (highlighted below). It lets you zoom the map in and out, move the center in any direction, and change the display style (Road or Aerial).

  —Image—

  

  If this map uses Google Earth maps, this property enables or disables the type control (highlighted below). It lets you change the display style (Map, Satellite, or Hybrid). Use the ZoomControl property to display or suppress Google Earth’s zoom and direction controls.

  

• 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.
• ZoomControl (Boolean)

  Use this property to display or suppress the Google map zoom control (highlighted below). For Bing Maps for Enterprise maps, the TypeControl property determines the zoom control display.

  —Image—

  

Fields with a red asterisk (*) are required fields.

• First name—Enter your first name.
• Last Name—Enter your last name.
• Password—Enter a password.
• Confirm Password—Re-enter the password.
• E-Mail Address—Enter your email address. Notification email is sent to this address unless the Disable E-mail Notification field is checked. Also, this address identifies the user sending Instant email. See Also: Installing Ektron
• Display Name—Enter the name you want to display to others, which can be a nickname or title.
• User Language—Select from available languages.
• Address—Enter the address (or just the zip code) of where you are located.
• Latitude—This field is automatically determined by the address.
• Longitude—This field is automatically determined by the address.
• Avatar—Click Click to upload your Avatar and choose an image file that you want to associate with your profile. By default, the maximum file size of an avatar is 200 kilobytes. Also, the avatar's height and width cannot exceed 125 pixels preserving the aspect ratio.
  Change the avatar.

  Changing the Default File Size

  To change the file size limit, edit Siteroot\Workarea\Upload.aspx.vb. In this file, change the line below to the maximum file size you want to allow.

  If (numFileSize > 200) Then

  For example, to allow 500 kb files, change 200 to 500.

  NOTE: Remember, this number is in kilobytes.

  Changing the Default Height and Width

  To change the default height and width, edit YourSite\App_Code\VBCode\Utilities.vb. In this file, change the following lines to the size you wish to allow.

  Dim Width As Integer = 125
  Dim Height As Integer = 125

  For example, to set avatar's height and width to 166 pixels, change 125 to 166 in both lines.

• Content and Forum Editor—Choose eWebEdit400, Provider, or eWebEditPro. Choose Provider to use a third-party editor (if installed).
• Topics per Page—Select a number of topics to display on a page. If the number of topics exceeds the number you select, a scroll bar lets you see the additional topics. For example, if you select 10, and there are 25 topics, only 10 are displayed at one time, but you can scroll down to see all topics.
• Forum Signature—Click Edit to enter or modify a signature that appears below each post you make to a forum topic.

• Tags—Keywords that you can assign to content and library items, which allows for tag-based searching. For example, you can add the tag EAC (Employee Activity Committee), and tag users related to the EAC. In this way, you can search for the users to which the EAC tag is applied. A tag cannot exceed 25 characters, and can include only alphabetical or numeric characters, a hyphen, or an underscore.

Fields with a red asterisk (*) are required fields.

• Moderate—Check this box to give this user privileges on a message board to approve and delete posts. Regular users in a group message board can create and delete only their own posts.
• Features—Check this box to give the user an individual calendar. (There may be other features to grant also.)
• Private Profile—Choose one of these options:
  • Public—User information is accessible by others.
  • Private—User information is not accessible by others.
  • Colleagues—User information is accessible only by colleagues of the user.
• Title—Enter the title of the user.
• Department—Select the department to which this user belongs. The list contains any departments that you have created.
• Extension—Enter the user's telephone extension.
• Phone—Enter the user's company telephone number.
• Cell—Enter the user's cell phone number.
• Desk—Enter the value that identifies the location of the desk (or cubicle, or office), if your office identifies such things. This can be valuable in locating an employee on an office map.
• Reports to—Enter the person to whom the user reports. This can be valuable for developing organizational charts.
• Time Zone—Select the time zone where the user works.

By default, all activity is checked to display in the Activity Stream widget. By checking the boxes, you can select criteria for the types of content you want to see when colleagues or community groups create the content. You can also select (publish) the types of content that you want colleagues to see under the My Activities category. See Also: Sending Notifications to a Community

• SMS—A checked box indicates that the type of content will be sent to your cell phone Short Message Service (SMS).
• Activity Stream—A checked box indicates the type of content that will appear in the Activity Stream widget.
• Email—A checked box indicates that the type of content will be sent to your Email address, which is specified in the General tab of your profile.

The Category tab lets you select from a list of taxonomy categories with which you want to be associated. You determine which taxonomy appears on the tab by setting the TaxonomyID property.

IMPORTANT: The Category tab appears only when an ID is assigned to the TaxonomyID property.

Membership 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. You can find information about native .NET properties such as font, height, width and border style in Visual Studio^® help.