Static Public Member Functions | Static Public Attributes | Properties | List of all members
VideoOS.Platform.UI.Util Class Reference

A utility class to collect all Icons used in the system for both plug-ins and for the Environment.
Lookup to an Icon is done via KindToImageIndex, and KindToCategory can be used for the default Category if an Kind. More...

Static Public Member Functions

static Image BuiltInItemToImage (Item item)
 Finetune a few of the Icons used for built-in items, e.g. camera PTZ icon instead of just a camera icon.
 
static int BuiltInItemToImageIndex (Item item)
 Finetune a few of the Icons used for built-in items, e.g. camera PTZ icon instead of just a camera icon.
 
static bool IsBuiltInKind (Guid kind)
 Validates if a specific kind is a built-in kind or from a plug-in.

 

Static Public Attributes

static Bitmap ActiveOverlay = null
 The little green arrow to place on top of other icons.
 
static int AlertIconIx = 2
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static Bitmap AttentionOverlay = null
 The little exclamation point to place on top of other icons.
 
static int CameraIconIx = 8
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int CameraPtzIx = 30
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int CustomEventIconIx = 9
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static Bitmap DisabledOverlay = null
 The little red cross to place on top of other icons.
 
static int FirstFreeIx = 33
 Index into ImageList property. Identify size of ImageList.
 
static int FolderIconIx = 1
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int GisMapLocationIx = 33
 Index of the GisMapLocation icon.
 
static int GroupIx = 14
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int HardwareIx = 28
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int InputIconIx = 3
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int InterConnectedIx = 29
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int MatrixIconIx = 5
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int MetadataIx = 31
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int MicrophoneIconIx = 11
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int OutputIconIx = 4
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int PluginIx = 19
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int PresetIconIx = 7
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int RecorderIconIx = 12
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int RoleIx = 24
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int SDK_GeneralIx = 21
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int SDK_ToolIx = 22
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int SDK_VSIx = 20
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int ServerIconIx = 0
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int SpeakerIconIx = 10
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int TimeProfileIx = 27
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int TransactIconIx = 6
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int UserIx = 25
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int VideoWallGroupIx = 15
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int VideoWallIx = 16
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int VideoWallPreset = 32
 Index to Video Wall Preset.
 
static int ViewGroupIx = 13
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int ViewItemIx = 18
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int ViewIx = 17
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int WindowIx = 23
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 
static int WorkSpaceIx = 26
 Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)
 

Properties

static ImageList ImageList [get]
 Returns a complete list of all Images for all Kinds.
 
static ImageList ImageList32 [get]
 Returns a complete list of all Images for all Kinds - in size 32, if available from plugin.
 
static ImageList ImageListClone [get]
 Returns a complete list of all Images for all Kinds.
 
static Dictionary< Guid, Category > KindToCategory [get]
 Returns a dictionary where the Category of all Kinds can be found.
 
static Dictionary< Guid, int > KindToImageIndex [get]
 Returns a dictionary where the index of the ImageList is index by kind.
 

Detailed Description

A utility class to collect all Icons used in the system for both plug-ins and for the Environment.
Lookup to an Icon is done via KindToImageIndex, and KindToCategory can be used for the default Category if an Kind.

Member Function Documentation

◆ BuiltInItemToImage()

static Image VideoOS.Platform.UI.Util.BuiltInItemToImage ( Item item)
inlinestatic

Finetune a few of the Icons used for built-in items, e.g. camera PTZ icon instead of just a camera icon.

Parameters
item
Returns

◆ BuiltInItemToImageIndex()

static int VideoOS.Platform.UI.Util.BuiltInItemToImageIndex ( Item item)
inlinestatic

Finetune a few of the Icons used for built-in items, e.g. camera PTZ icon instead of just a camera icon.

Parameters
item
Returns

◆ IsBuiltInKind()

static bool VideoOS.Platform.UI.Util.IsBuiltInKind ( Guid kind)
inlinestatic

Validates if a specific kind is a built-in kind or from a plug-in.

Parameters
kindThe Kind to check
Returns
True if the Kind is a built-in Kind

Member Data Documentation

◆ ActiveOverlay

Bitmap VideoOS.Platform.UI.Util.ActiveOverlay = null
static

The little green arrow to place on top of other icons.

◆ AlertIconIx

int VideoOS.Platform.UI.Util.AlertIconIx = 2
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ AttentionOverlay

Bitmap VideoOS.Platform.UI.Util.AttentionOverlay = null
static

The little exclamation point to place on top of other icons.

◆ CameraIconIx

int VideoOS.Platform.UI.Util.CameraIconIx = 8
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ CameraPtzIx

int VideoOS.Platform.UI.Util.CameraPtzIx = 30
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ CustomEventIconIx

int VideoOS.Platform.UI.Util.CustomEventIconIx = 9
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ DisabledOverlay

Bitmap VideoOS.Platform.UI.Util.DisabledOverlay = null
static

The little red cross to place on top of other icons.

◆ FirstFreeIx

int VideoOS.Platform.UI.Util.FirstFreeIx = 33
static

Index into ImageList property. Identify size of ImageList.

◆ FolderIconIx

int VideoOS.Platform.UI.Util.FolderIconIx = 1
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ GisMapLocationIx

int VideoOS.Platform.UI.Util.GisMapLocationIx = 33
static

Index of the GisMapLocation icon.

◆ GroupIx

int VideoOS.Platform.UI.Util.GroupIx = 14
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ HardwareIx

int VideoOS.Platform.UI.Util.HardwareIx = 28
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ InputIconIx

int VideoOS.Platform.UI.Util.InputIconIx = 3
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ InterConnectedIx

int VideoOS.Platform.UI.Util.InterConnectedIx = 29
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ MatrixIconIx

int VideoOS.Platform.UI.Util.MatrixIconIx = 5
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ MetadataIx

int VideoOS.Platform.UI.Util.MetadataIx = 31
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ MicrophoneIconIx

int VideoOS.Platform.UI.Util.MicrophoneIconIx = 11
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ OutputIconIx

int VideoOS.Platform.UI.Util.OutputIconIx = 4
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ PluginIx

int VideoOS.Platform.UI.Util.PluginIx = 19
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ PresetIconIx

int VideoOS.Platform.UI.Util.PresetIconIx = 7
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ RecorderIconIx

int VideoOS.Platform.UI.Util.RecorderIconIx = 12
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ RoleIx

int VideoOS.Platform.UI.Util.RoleIx = 24
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ SDK_GeneralIx

int VideoOS.Platform.UI.Util.SDK_GeneralIx = 21
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ SDK_ToolIx

int VideoOS.Platform.UI.Util.SDK_ToolIx = 22
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ SDK_VSIx

int VideoOS.Platform.UI.Util.SDK_VSIx = 20
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ ServerIconIx

int VideoOS.Platform.UI.Util.ServerIconIx = 0
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ SpeakerIconIx

int VideoOS.Platform.UI.Util.SpeakerIconIx = 10
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ TimeProfileIx

int VideoOS.Platform.UI.Util.TimeProfileIx = 27
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ TransactIconIx

int VideoOS.Platform.UI.Util.TransactIconIx = 6
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ UserIx

int VideoOS.Platform.UI.Util.UserIx = 25
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ VideoWallGroupIx

int VideoOS.Platform.UI.Util.VideoWallGroupIx = 15
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ VideoWallIx

int VideoOS.Platform.UI.Util.VideoWallIx = 16
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ VideoWallPreset

int VideoOS.Platform.UI.Util.VideoWallPreset = 32
static

Index to Video Wall Preset.

◆ ViewGroupIx

int VideoOS.Platform.UI.Util.ViewGroupIx = 13
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ ViewItemIx

int VideoOS.Platform.UI.Util.ViewItemIx = 18
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ ViewIx

int VideoOS.Platform.UI.Util.ViewIx = 17
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ WindowIx

int VideoOS.Platform.UI.Util.WindowIx = 23
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

◆ WorkSpaceIx

int VideoOS.Platform.UI.Util.WorkSpaceIx = 26
static

Index into ImageList property. (Consider to use method: BuiltInItemToImageIndex(Item) to get an Icon)

Property Documentation

◆ ImageList

ImageList VideoOS.Platform.UI.Util.ImageList
staticget

Returns a complete list of all Images for all Kinds.

◆ ImageList32

ImageList VideoOS.Platform.UI.Util.ImageList32
staticget

Returns a complete list of all Images for all Kinds - in size 32, if available from plugin.

◆ ImageListClone

ImageList VideoOS.Platform.UI.Util.ImageListClone
staticget

Returns a complete list of all Images for all Kinds.

◆ KindToCategory

Dictionary<Guid, Category> VideoOS.Platform.UI.Util.KindToCategory
staticget

Returns a dictionary where the Category of all Kinds can be found.

◆ KindToImageIndex

Dictionary<Guid, int> VideoOS.Platform.UI.Util.KindToImageIndex
staticget

Returns a dictionary where the index of the ImageList is index by kind.