Favorites Server Control

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 Adding a Web Page URL to a Favorites Via the Social Bar.

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 Web site.
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.
   

   

7. Click Move on the Favorites server control.
   

   

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

   

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. ClickOK. The folder is deleted.

Favorites Server Control Properties

The following are Ektron-specific server control 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 the server control’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 EkML 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 Output with Ektron Markup LanguageControlling 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.

  WARNING! 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.