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

 

Summary description for Friends (Colleague Server Control API)

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

Friends.cs

Name 
Description 
The methods of the Friends class are listed here. 
The properties of the Friends class are listed here. 
 
Name 
Description 
 
Fill 
Populates the data for the Friends.  
 
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 
 
Gets or Sets the avatar height. 0 is unlimited.  
 
Gets or Sets the avatar width. 0 is unlimited.  
 
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 default user ID for this control to use when there is no matching dynamic parameter value passed.  
 
Select the way this control displays colleagues. Choices are:
Directory - this selection allows users to group their colleagues 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 users into a folder. This item only appears when there is a folder.
List - shows a list colleagues in alphabetical order.
Pending - shows a list pending colleagues. This list is made up of users who have sent you colleagues requests.
SentInvites - shows a list... more 
 
Determines how information is displayed on the page. Enter the path to the XSL file. It can be relative or absolute. (optional).  
 
Gets or sets the Querystring parameter to read a user ID dynamically. To use the default user ID, leave blank.  
 
Gets or sets the text for a colleague.  
 
Gets or Sets the text for colleagues. Similar to FriendLabel, but is plural.  
 
Link 
Enter a link to the user profile page. This allows a user to click a link in the Colleagues control and be taken to the user’s profile page. There are two variables used within the link that represent the user’s ID and the user’s display name.
{0} - represents the user’s ID.
{1} - represents the user’s display name.
You need to have both variables in the link. The Web form can be relative or absolute. Below is an example.
userprofilepage.aspx?uid={0}&dn={1}  
 
Gets or Sets the target attribute for the user links.  
 
Enter name of a markup file that manages the display of this server control.  
 
Maximum number of results to be returned.  
 
Select wether the sorting options should be shown on the control. The following sorting options are available when this property is set to True:
  • Colleagues - a list of current colleagues.
  • Pending Colleagues - a list of colleagues who have sent you colleagues requests, but you have yet to accept.
  • Invited - a list of colleagues to whom you have sent colleague requests.
 
 
Specifies the Css to which this control will provide a link.  
 
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!