You are here: Ektron Namespace > Server Controls API > Ektron.Cms Namespace > Ektron.Cms.Controls Namespace > Classes > Favorites Class
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
Favorites Class

 

Summary description for Favorites 

 

C#
[DefaultProperty("DefaultUserID"), ToolboxData("<{0}:Favorites runat=server></{0}:Favorites>")]
public class Favorites : EkXsltWebPart, ICallbackEventHandler;
Visual Basic
<DefaultProperty("DefaultUserID"), ToolboxData("<{0}:Favorites runat=server></{0}:Favorites>")>
Public Class Favorites
Inherits EkXsltWebPart
Inherits ICallbackEventHandler

Favorites.cs

Name 
Description 
The methods of the Favorites class are listed here. 
The properties of the Favorites class are listed here. 
 
Name 
Description 
 
Fill 
Populates the data for the Favorites.  
 
Wraps the resulting collection with the Ektron Toolbars, which will only display when a user is logged in.  
 
Wrap 
Method that can be overridden and used to wrap an Ektron toolbar corresponding to a particular Control around some Html text.  
 
Name 
Description 
 
Sets the amount of time the server control’s data is cached. The default is 0 (zero). This is the amount of time, in seconds, a control’s data is cached. For example, if you want to cache the data for five minutes, you set the CacheInterval property to 300 (three hundred).  
 
The ID for the community group that the control will use.  
 
Select the way this control displays community group information. Choices are:
List - shows a list of Favorites sorted in alphabetical order.
Directory - this selection allows users to group their favorites by folders. When 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 into a folder. This item only appears when there is a folder.
 
 
Select the type of review to display, or enter the path to a custom XSLT. (optional).  
 
Determines how information is displayed on the page. Enter the path to the XSL file. It can be relative or absolute. Leave blank to always display the list summary.  
 
The title to show at the top of the control.  
 
The title to show at the top of the control.  
 
Link 
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. There are three variables used within the link that represent the content’s ID, the language and the content’s title.
  • {0} - represents the content’s ID.
  • {1} - represents the content’s language.
  • {2} - represents the content’s title.
You need to have all three variables in the link. The Web form can be relative or absolute. Below is an example.
contentpage.aspx?cid={0}&lang={1}&title={2}  
 
Determines the type of window that appears on this Web form when a user clicks an item in the Favorites control. The default is _self.  
 
Enter name of a markup file that manages the display of this server control.  
 
Maximum number of results to be returned. If set to zero, there is no limit.  
 
Specify the path to a style sheet for use with the sever control. The location can be relative or absolute. Leave blank to use the default style sheet.  
 
Returns the Xslt object for the collection.  
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!