CommunitySearch Class

[DefaultProperty("DefaultCommunitySearchID"), ToolboxData("<{0}:CommunitySearch runat=server></{0}:CommunitySearch>")]
public class CommunitySearch : EkXsltWebPart, ICallbackEventHandler;

Visual Basic

<DefaultProperty("DefaultCommunitySearchID"), ToolboxData("<{0}:CommunitySearch runat=server></{0}:CommunitySearch>")>
Public Class CommunitySearch
Inherits EkXsltWebPart
Inherits ICallbackEventHandler

File

CommunitySearch.cs

Description

This is class Ektron.Cms.Controls.CommunitySearch.

Group

Classes

Topics

Name	Description
CommunitySearch Methods	The methods of the CommunitySearch class are listed here.
CommunitySearch Properties	The properties of the CommunitySearch class are listed here.

CommunitySearch Methods

	Name	Description
	Fill	Method that can be overridden and used to grab data from the back end for each server control.
	ToString	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.

CommunitySearch Properties

	Name	Description
	CacheInterval	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.
	CustomPropertyID	ID (or comma seperated IDs) of the Custom Property to render in the information box.
	DisplayXslt	The Xslt to use to render the Control (optional)
	EnableFilteringResults	If true, matching taxonomy categories are shown, allowing the user to narrow the resuls.
	EnableGroupResults	If false, groups are prevented from being returned in the results.
	EnableMap	Set to false to hide the map functionality in this control. This hides the Location tab when the control is displayed on a Web site and the map properties in Visual Studio.
	EnableMouseOutHidesInfo	When true, mousing away from a users name hides the pop-up info box.
	EnableMouseOver	When set to False, the profile pop-up is disabled when hovering over a display name in the search results. True = Enable the profile pop-up when hovering over a display name. False = Disable the profile pop-up when hovering over a display name.
	EnableUnauthorizedSearching	When set to True, a user does not need to be logged in to perform a user search. When set to False, a user must logged in to perform a user search, otherwise the control displays a message stating that log-in is required. True = a user does not need to be logged in to perform a user search. False = a user must be logged in to perform a user search.
	EnableUserResults	If false, users are prevented from being returned in the results.
	FriendsOnly	If true, only returns friends.
	GroupTaxonomyID	The taxonomy ID to use for the group-categories (if zero, then none shown). This category must be created through the taxonomy wizard.
	InfoBoxShowsEmail	Set true to include users email address values in the pop-up information box (visible by mousing over a users name in the search results).
	LoadingImage	Image to show while Ajax is fetching data. The default is ajax-loader_circle_lg.gif".
	MapControl	This property allows you to set properties for the Location Tab’s map. These properties are identical to the properties in the Map server control. The EnableMap property must be set to true to see the sub properties.
	MarkupLanguage	Enter the name of an EkML file that manages the display of this server control.
	MaxTagCount	The maximum number of personal tags to show for each user in the search results.
	MembersOnly	When set to True, this server control only returns Membership Users. When set to False, the control returns CMS400.NET Users and Membership Users.
	PageSize	The maximum number of user results to show per page.
	ResultProfile	Determines whether profile information is displayed. This is based on the state of the user performing the user search. Choices are: full - always show user profile information. nonprivate - display user profile information only when a user’s profile is not marked private. nonprivate-authenticated - display user profile information only when a user’s profile is not marked private and the user performing the search is logged in. none - never show user profile information.
	SearchPrivate	When set to False, this property prevents users with profiles marked as private from being returned with user search results.
	ShowNameEmail	When set to True, populates the drop down list with these additional options: First Name - perform searches based on a user’s first name. Last Name - perform searches based on a user’s last name. Email - perform searches based on a user’s email address. When set to False, the drop down list is populated with these properties: Tags - perform searches based on a user’s tags. Display Name - perform searches based on a user’s display name.
	StartingTab	Default tab that's selected when the server control is first rendered on the Web site. Choose from basic, advanced or location.
	Stylesheet	Specify the path to a style sheet for use with this sever control. The location can be relative or absolute. Leave blank to use the default style sheet.
	TemplateGroupProfile	The URL path of the community group template. This path can be relative or absolute.
	TemplateParamName	Gets or sets a Querystring parameter for the ID of users or groups that are returned in the search results. This parameter is passed to the template page defined in the TemplateUserProfile or TemplateGroupProfile property when a user clicks the Location (map) icon associated with a search result.
	TemplateTarget	Determines the type of window that appears on this Web form when a user clicks an a user name or tag. The default is _self. _self = opens in same window _top = opens in parent window _blank = opens in new window _parent = opens in the parent frame
	TemplateUserProfile	The URL path of the user profile template. This path can be relative or absolute.
	UseMsAjax	When true, uses Microsoft Ajax.
	UserTaxonomyID	The taxonomy ID to use for the user-categories (if zero, then none shown). This category must be created through the taxonomy wizard.
	XmlDoc	Returns the Xml object for the control.
	XsltDoc	Returns the Xsl object for the control.

Links

CommunitySearch Methods, CommunitySearch Properties, Classes, Legend, Members, Topics, CommunitySearch Methods, CommunitySearch Properties

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

Contents | Index | Home

What do you think about this topic? Send feedback!