User control used to visualize a given SearchResultData. More...

Inheritance diagram for VideoOS.Platform.Search.SearchResultUserControl:

Public Member Functions
virtual void	Close ()
	Closes the control.

void	Init (SearchResultData searchResultData)
	Initializes the user control with the provided SearchResultData.

Protected Member Functions
virtual void	OnPropertyChanged (string propertyName)
	Raises the PropertyChanged event with the provided propertyName in the event args.

Properties
Thickness	DefaultLoadingVisualizationMargin = new Thickness() `[get, set]`
	Margin for default visualization of the loading progress. Override this property to adjust placement of the default visualization. Default placement is center of the control.

bool	IsLoading `[get, protected set]`
	Indicates whether or not a general loading visualization should be visible. Set this property to True if the content of your result view is not displayed instantly, and set it back to False when the view is done loading.

bool	SuppressDefaultLoadingVisualization `[get, set]`
	Set to `true`/`false` to disable/enable general "loading in progress"-visualization.

Events
EventHandler	IsLoadingChanged
	Event which is fired whenever the IsLoading property changes.

PropertyChangedEventHandler	PropertyChanged
	Event which is fired whenever a property changes. This is primarily used for UI bindings.

Detailed Description

User control used to visualize a given SearchResultData.

Inherit this class to create your own visualization of a SearchResultData. In order to use the type you create, you must also add a SearchUserControlsPlugin to your plugin definition.

Member Function Documentation

◆ Close()

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

inlinevirtual

Closes the control.

◆ Init()

void VideoOS.Platform.Search.SearchResultUserControl.Init ( SearchResultData searchResultData )

abstract

Initializes the user control with the provided SearchResultData.

Parameters

searchResultData Search result to visualize.

◆ OnPropertyChanged()

virtual void VideoOS.Platform.Search.SearchResultUserControl.OnPropertyChanged ( string propertyName )

inlineprotectedvirtual

Raises the PropertyChanged event with the provided propertyName in the event args.

Parameters

propertyName The property for which to raise a PropertyChanged event.

Property Documentation

◆ DefaultLoadingVisualizationMargin

Thickness VideoOS.Platform.Search.SearchResultUserControl.DefaultLoadingVisualizationMargin = new Thickness()

getset

Margin for default visualization of the loading progress. Override this property to adjust placement of the default visualization. Default placement is center of the control.

◆ IsLoading

bool VideoOS.Platform.Search.SearchResultUserControl.IsLoading

getprotected set

Indicates whether or not a general loading visualization should be visible. Set this property to True if the content of your result view is not displayed instantly, and set it back to False when the view is done loading.

To suppress default visualization, call SuppressDefaultLoadingVisualization

◆ SuppressDefaultLoadingVisualization

bool VideoOS.Platform.Search.SearchResultUserControl.SuppressDefaultLoadingVisualization

getsetprotected

Set to true/false to disable/enable general "loading in progress"-visualization.

Event Documentation

◆ IsLoadingChanged

EventHandler VideoOS.Platform.Search.SearchResultUserControl.IsLoadingChanged

Event which is fired whenever the IsLoading property changes.

◆ PropertyChanged

PropertyChangedEventHandler VideoOS.Platform.Search.SearchResultUserControl.PropertyChanged

Event which is fired whenever a property changes. This is primarily used for UI bindings.

Public Member Functions

Protected Member Functions

Properties

Events