VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup Class Referenceabstract

Represents a workspace toolbar plug-in group. Used for grouping workspace toolbar plug-ins. If there are no plug-ins or sub groups under a group, then the group won't be shown. More...

Inheritance diagram for VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup:
VideoOS.Platform.Client.PropertyClass

Static Public Attributes

static readonly string PropertyNameTitle = "Title"
 The title property name. Used in the PropertyChanged event.
 
static readonly string PropertyNameTooltip = "Tooltip"
 The tooltip property name. Used in the PropertyChanged event.
 

Properties

Guid Id [get]
 Gets the unique id identifying this plug-in group.
 
virtual ? Guid ParentGroupId [get]
 Gets parent group id of this workspace toolbar plug-in group. If it has a value, this group will be put under the group with this id as a subgroup. If it is null(default) or a group with this id is not defined, then the group won't be put under any other group. When having sub-groups under groups, it is recommended NOT to have more than the depth of 3 levels, as it will provide poor user experience in Smart Client.
 
string Title [get, protected set]
 Gets and sets the toolbar plug-in group title.
 
string Tooltip [get, protected set]
 Gets and sets the toolbar plug-in group tooltip.
 

Events

PropertyChangedEventHandler PropertyChanged
 Event indicating that one of the properties has changed.
 

Additional Inherited Members

- 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)
 
- 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

Represents a workspace toolbar plug-in group. Used for grouping workspace toolbar plug-ins. If there are no plug-ins or sub groups under a group, then the group won't be shown.

Member Data Documentation

◆ PropertyNameTitle

readonly string VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.PropertyNameTitle = "Title"
static

The title property name. Used in the PropertyChanged event.

◆ PropertyNameTooltip

readonly string VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.PropertyNameTooltip = "Tooltip"
static

The tooltip property name. Used in the PropertyChanged event.

Property Documentation

◆ Id

Guid VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.Id
getabstract

Gets the unique id identifying this plug-in group.

◆ ParentGroupId

virtual ? Guid VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.ParentGroupId
get

Gets parent group id of this workspace toolbar plug-in group. If it has a value, this group will be put under the group with this id as a subgroup. If it is null(default) or a group with this id is not defined, then the group won't be put under any other group. When having sub-groups under groups, it is recommended NOT to have more than the depth of 3 levels, as it will provide poor user experience in Smart Client.

◆ Title

string VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.Title
getprotected set

Gets and sets the toolbar plug-in group title.

◆ Tooltip

string VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.Tooltip
getprotected set

Gets and sets the toolbar plug-in group tooltip.

Event Documentation

◆ PropertyChanged

PropertyChangedEventHandler VideoOS.Platform.Client.WorkSpaceToolbarPluginGroup.PropertyChanged

Event indicating that one of the properties has changed.