The abstract base class a MIP plugin can implement for having a WorkSpace tab available in the Smart Client. More...

Inheritance diagram for VideoOS.Platform.Client.WorkSpacePlugin:

Public Member Functions
void	Close ()
	Called by the Environment when the user log's off.

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 plug-in is accessing configuration items.

bool	LoadProperties (bool userPrivate)
	Get the stored properties from the connected server.

bool	SaveProperties (bool userPrivate)
	Saves the values in the Properties on the connected server. When userPrivate is true, the content is for own use only. When userPrivate is false, the content is shared for all users connected to a server.

virtual void	ViewItemConfigurationModified (int index)
	Called when a view item configuration for one of the view items in the workspace view has been modified.

	WorkSpacePlugin ()

Public Member Functions inherited from VideoOS.Platform.Client.PropertyClass
void	ClearProperties ()
	Clear property table.

virtual void	Deserialize (XmlNode xmlNode)
	Deserializes the class item from xml format.

string	GetProperty (string key)
	Gets a named (key) property value from the property list. Null is returned of the property does not exists.

ICollection	GetPropertyKeys ()
	Gets all the keys in the property collection.

object	GetTemporaryProperty (string key)
	Gets a named (key) temporary property value from the property list. Null is returned of the property does not exists.

	PropertyClass ()
	Constructs a PropertyClass item.

virtual void	Serialize (System.Xml.XmlTextWriter xmlTextWriter)
	Serializes the class item into xml format.

virtual String	SerializeToString ()
	Create a XmlNode containing the property dictionary, returned as a String.

virtual XmlNode	SerializeToXmlNode ()
	Create a XmlNode containing the property dictionary, returned as a String.

void	SetProperty (string key, string value)
	Sets a named (key) property value in the property list. The property value is updated if the property exists.

void	SetTemporaryProperty (string key, object value)
	Sets a named (key) temporary property value in the property list. The property value is updated if the property exists. Temporary will not be serialized (stored)

Properties
virtual Image	Icon `[get]`
	This property is deprecated. Windows Forms controls are no longer supported. Use IconSource instead. The icon representing this workspace.

virtual VideoOSIconSourceBase	IconSource `[get]`
	The icon representing this workspace.

Guid	Id `[get]`
	Gets the unique id identifying this plug-in component. This property is accessed from WorkSpacePlugin constructor. So ensure that it returns the valid ID even though the constructor of the derived implementation has not been called.

virtual bool	IsSetupStateSupported `[get]`
	Indicates whether this work space plugin supports setup state or not.

virtual bool	Live `[get]`
	Indicates whether this work space plugin is in live mode or not. The default value is true.

String	Name `[get]`
	The name of this plug-in.

WorkSpaceNotification	Notification `[get, set]`
	The current work space notification. The work space implementation sets this to a new instance of WorkSpaceNotification every time its notification state changes. Set to null to indicate that no notification should be shown for the work space plugin.

virtual bool	ShowTimeline `[get]`
	Indicates whether to show the timeline when in playback mode or not. The default value is true.

ViewAndLayoutItem	ViewAndLayoutItem `[get]`
	The ViewAndLayoutItem shown in the WorkSpace.

Events
EventHandler	NotificationChangedEvent

Additional Inherited Members
Protected Attributes inherited from VideoOS.Platform.Client.PropertyClass
SortedList	_properties = new SortedList()
	The key-value collection holding the properties.

SortedList	_temporaryProperties = new SortedList()
	The key-value collection holding the temporary properties. Temporary will not be serialized (stored)

Package Functions inherited from VideoOS.Platform.Client.PropertyClass

Detailed Description

The abstract base class a MIP plugin can implement for having a WorkSpace tab available in the Smart Client.

Constructor & Destructor Documentation

◆ WorkSpacePlugin()

VideoOS.Platform.Client.WorkSpacePlugin.WorkSpacePlugin ( )

inline

Member Function Documentation

◆ Close()

void VideoOS.Platform.Client.WorkSpacePlugin.Close ( )

abstract

Called by the Environment when the user log's off.

◆ Init()

void VideoOS.Platform.Client.WorkSpacePlugin.Init ( )

abstract

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 plug-in is accessing configuration items.

◆ LoadProperties()

bool VideoOS.Platform.Client.WorkSpacePlugin.LoadProperties ( bool userPrivate )

inline

Get the stored properties from the connected server.

Parameters

userPrivate set to true when properties are save for each user

Returns: true if Properties where found and false if this is a first time

◆ SaveProperties()

bool VideoOS.Platform.Client.WorkSpacePlugin.SaveProperties ( bool userPrivate )

inline

Saves the values in the Properties on the connected server.
When userPrivate is true, the content is for own use only.
When userPrivate is false, the content is shared for all users connected to a server.

Parameters

userPrivate

Returns

◆ ViewItemConfigurationModified()

virtual void VideoOS.Platform.Client.WorkSpacePlugin.ViewItemConfigurationModified ( int index )

inlinevirtual

Called when a view item configuration for one of the view items in the workspace view has been modified.

Parameters

index The index of the modified view item

Property Documentation

◆ Icon

virtual Image VideoOS.Platform.Client.WorkSpacePlugin.Icon

get

This property is deprecated. Windows Forms controls are no longer supported. Use IconSource instead. The icon representing this workspace.

◆ IconSource

virtual VideoOSIconSourceBase VideoOS.Platform.Client.WorkSpacePlugin.IconSource

get

The icon representing this workspace.

◆ Id

Guid VideoOS.Platform.Client.WorkSpacePlugin.Id

getabstract

Gets the unique id identifying this plug-in component. This property is accessed from WorkSpacePlugin constructor. So ensure that it returns the valid ID even though the constructor of the derived implementation has not been called.

◆ IsSetupStateSupported

virtual bool VideoOS.Platform.Client.WorkSpacePlugin.IsSetupStateSupported

get

Indicates whether this work space plugin supports setup state or not.

◆ Live

virtual bool VideoOS.Platform.Client.WorkSpacePlugin.Live

get

Indicates whether this work space plugin is in live mode or not. The default value is true.

◆ Name

String VideoOS.Platform.Client.WorkSpacePlugin.Name

getabstract

The name of this plug-in.

◆ Notification

WorkSpaceNotification VideoOS.Platform.Client.WorkSpacePlugin.Notification

getset

The current work space notification. The work space implementation sets this to a new instance of WorkSpaceNotification every time its notification state changes. Set to null to indicate that no notification should be shown for the work space plugin.

◆ ShowTimeline

virtual bool VideoOS.Platform.Client.WorkSpacePlugin.ShowTimeline

get

Indicates whether to show the timeline when in playback mode or not. The default value is true.

◆ ViewAndLayoutItem

ViewAndLayoutItem VideoOS.Platform.Client.WorkSpacePlugin.ViewAndLayoutItem

get

The ViewAndLayoutItem shown in the WorkSpace.

Event Documentation

◆ NotificationChangedEvent

EventHandler VideoOS.Platform.Client.WorkSpacePlugin.NotificationChangedEvent

Public Member Functions

Properties

Events

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ WorkSpacePlugin()

Member Function Documentation

◆ Close()

◆ Init()

◆ LoadProperties()

◆ SaveProperties()

◆ ViewItemConfigurationModified()

Property Documentation

◆ Icon

◆ IconSource

◆ Id

◆ IsSetupStateSupported

◆ Live

◆ Name

◆ Notification

◆ ShowTimeline

◆ ViewAndLayoutItem

Event Documentation

◆ NotificationChangedEvent