VideoOS.Platform.Search.SearchUserControlsPlugin Class Reference

Defines the search user controls plugin interface. Inherit this class to create custom UI controls to visualize SearchResultData and/or FilterConfigurationBase instances. More...

Public Member Functions
virtual void	Close ()
	Called by the Environment when the user log's off. Disposes of any resources.
virtual SearchFilterEditControl	CreateSearchFilterEditControl (FilterConfigurationBase filterConfiguration)
	Creates a SearchFilterEditControl used to allow the user to edit a search filter based on the given filter configuration.
virtual SearchResultUserControl	CreateSearchResultUserControl (Guid searchResultUserControlType)
	Creates a SearchResultUserControl which can visualize the given search result type.
virtual void	Init ()
	This method is called when the user has logged in and configuration is accessible. If a user logs out and in again, this method will be called at every login. This should be used if the plugin is accessing configuration items.

Properties
Guid	Id [get, protected set]
	Unique id of this plugin. If copying any of the sample plugins - be sure to replace this id with a new one.
string	Name [get, protected set]
	Name of the plugin.
IEnumerable< Type >	SearchFilterConfigurationTypes [get, protected set]
	Gets an enumerable of search filter configuration types (i.e. types deriving from FilterConfigurationBase) indicating which search filter types you wish to add a (or override the default) user control for.
IEnumerable< Guid >	SearchResultUserControlTypes [get, protected set]
	Gets an enumerable of search result user control types indicating which search results you wish to add a (or override the default) user control for.

Detailed Description

Defines the search user controls plugin interface. Inherit this class to create custom UI controls to visualize SearchResultData and/or FilterConfigurationBase instances.

Member Function Documentation

Close()

virtual void VideoOS.Platform.Search.SearchUserControlsPlugin.Close ( )

inlinevirtual

Called by the Environment when the user log's off. Disposes of any resources.

CreateSearchFilterEditControl()

virtual SearchFilterEditControl VideoOS.Platform.Search.SearchUserControlsPlugin.CreateSearchFilterEditControl ( FilterConfigurationBase filterConfiguration )

inlinevirtual

Creates a SearchFilterEditControl used to allow the user to edit a search filter based on the given filter configuration.

Parameters

filterConfiguration

The configuration of the search filter with which to create a SearchFilterEditControl.

Returns

User control to display the search filter edit control based on the provided filter configuration.

CreateSearchResultUserControl()

virtual SearchResultUserControl VideoOS.Platform.Search.SearchUserControlsPlugin.CreateSearchResultUserControl ( Guid searchResultUserControlType )

inlinevirtual

Creates a SearchResultUserControl which can visualize the given search result type.

Parameters

searchResultUserControlType

The search result user control type which to create a SearchResultUserControl.

Returns

User control to display a search result based on the provided search result user control type.

Init()

virtual void VideoOS.Platform.Search.SearchUserControlsPlugin.Init ( )

inlinevirtual

This method is called when the user has logged in and configuration is accessible. If a user logs out and in again, this method will be called at every login. This should be used if the plugin is accessing configuration items.

Property Documentation

Id

Guid VideoOS.Platform.Search.SearchUserControlsPlugin.Id

getprotected setabstract

Unique id of this plugin. If copying any of the sample plugins - be sure to replace this id with a new one.

Name

string VideoOS.Platform.Search.SearchUserControlsPlugin.Name

getprotected setabstract

Name of the plugin.

SearchFilterConfigurationTypes

IEnumerable<Type> VideoOS.Platform.Search.SearchUserControlsPlugin.SearchFilterConfigurationTypes

getprotected setabstract

Gets an enumerable of search filter configuration types (i.e. types deriving from FilterConfigurationBase) indicating which search filter types you wish to add a (or override the default) user control for.

SearchResultUserControlTypes

IEnumerable<Guid> VideoOS.Platform.Search.SearchUserControlsPlugin.SearchResultUserControlTypes

getprotected setabstract

Gets an enumerable of search result user control types indicating which search results you wish to add a (or override the default) user control for.