The class to access Client relevant methods. More...

Public Member Functions
virtual void	CallOnUiThread (Action actionToBeInvoked)
	Use this method to ensure the action is executed on the UI thread. The method will first check if it is already executing on the UI thread and if not invoke the call.

virtual void	Close ()
	Reserved for internal use.

virtual Item	CreateTemporaryGroupItem (String name)
	Create a new Temporary View Group on top level in the Tree structure. The returned GroupItem will exists as long as the Smart Client is logged in to a server. The created item will be visible to the operator, unless the following property is set: groupItem.Properties["Visible"] = "False"; The returned GroupItem is an instance of a ConfigItem and support the AddChild and RemoveChild methods for managing ViewGroups on the next level. This method is used within the smart client.

virtual void	DeleteTemporaryGroupItem (Item groupItem)
	This method will delete a previously created GroupItem through the CreateTemporaryGroupItem method. This method is used within the smart client.

virtual AdminImageViewerControl	GenerateAdminImageViewerControl ()
	Creates a new instance of a AdminImageViewerControl.

virtual AudioPlayerControl	GenerateAudioPlayerControl ()
	This method is deprecated. Windows Forms controls are no longer supported. Use AudioPlayer instead. Creates a new instance of a AudioPlayerControl. This method is used for standalone application and Smart Client plugins. Upon return the generated audio player need to be added to a UserControl.Control collection.

virtual AudioPlayerControl	GenerateAudioPlayerControl (WindowInformation windowInformation)
	This method is deprecated. Windows Forms controls are no longer supported. Use AudioPlayer instead. Creates a new instance of a AudioPlayerControl. This method is used for Smart Client plugins. Upon return the generated audio player need to be added to a UserControl.Control collection. The WindowInformation class should be passed on from the ViewItemUserControl that this control will be added to. The main effect of adding the WindowInformation is that the AudioPlayer will run in live and playback mode just like the Smart Client usually do, e.g. flowing windows have different mode then the main window.

virtual ImageViewerControl	GenerateImageViewerControl ()
	This method is deprecated. Windows Forms controls are no longer supported. Use ImageViewerWpfControl instead. Creates a new instance of ImageViewerControl. This method is used within Smart Client and standalone plug-ins.

virtual ImageViewerControl	GenerateImageViewerControl (WindowInformation windowInformation)
	This method is deprecated. Windows Forms controls are no longer supported. Use ImageViewerWpfControl instead. Creates a new instance of ImageViewerControl. This method is used within Smart Client. The WindowInformation class should be passed on from the ViewItemUserControl that this control will be added to. The main effect of adding the WindowInformation is that the ImageViewer will run in live and playback mode just like the Smart Client usually do, e.g. floating windows have different mode then the main window.

virtual IAudioRecorder	GeneratePcAudioRecorder ()
	Generate a AudioRecorder instance that pick up audio from the PCs microphone.

virtual FQID	GeneratePlaybackController ()
	This method can be called when a standalone application would like to have multiple PlaybackControllers active at the same time. One default PlaybackController is build-in and addressed by sending messages with receive FQID = null. Each PlaybackController is addressed by sending messages to it with the receiver FQID equal to the return value of this method. Each of the ImageViewerControl's have one (and only one) PlaybackController that controls it. The default is the build-in BrowserController, but can be changed by setting the ImageViewerControl.PlaybackControllerFQID = result from this method.

virtual PlaybackUserControl	GeneratePlaybackUserControl ()
	This method is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead and use PlaybackWpfUserControl.ShowTallUserControl to control the size. Generates a new instance of a PlaybackUserControl.

virtual PlaybackUserControl	GeneratePlaybackUserControl (WindowInformation windowInformation)
	This method is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead and use PlaybackWpfUserControl.ShowTallUserControl to control the size. Generates a new instance of a PlaybackUserControl. This is intended to work together with one or more ImageViewerControl(s) and a PlaybackController (In Smart Client or for standalone application in the MIPSDK .Net Library).

virtual VideoControl	GenerateVideoControl ()
	Generates an instance of the VideoControl class.

virtual ViewControl	GenerateViewControl (List< ViewControlItem > items, List< Rectangle > viewLayout)
	Generates an instance of the ViewControl class.

virtual ViewControl	GenerateViewControl (List< ViewControlItem > items, List< Rectangle > viewLayout, WindowInformation windowInformation)
	Generates an instance of the ViewControl class.

virtual PlaybackController	GetPlaybackController (FQID fqid)
	This method will lookup the actual class handling the playback. Notice that not all methods are available for all Environments.

virtual FQID	GetPlaybackController (WindowInformation windowInformation)
	Get the default playback controller for a given window within the Smart Client. Please note that the FQID of the playback controller for the Smart Client main window is null. The ViewItemUserControl base class contains the WindowInformation to use as parameter.

virtual SmartClientProfileSetting	GetSmartClientProfileSetting (int smartClientProfileSettingKey)
	Gets the SmartClientProfileSetting for the provided key.

virtual List< Item >	GetSmartWallItems ()
	Get top list of all video wall view groups for this user. This method is used within the Smart Client.

virtual List< Item >	GetViewGroupItems ()
	Get top list of all accessible view groups for this user. Usually this will return a private group and one or more public groups. This method is used within the Smart Client.

virtual WindowState	GetWindowState (FQID window)
	Gets the state of the provided window FQID.

virtual List< Item >	GetWorkSpaceItems ()
	Gets a list of all available work spaces. This method is used within the Smart Client. These items can be used for selecting the active workspace via this class or via messages.

virtual void	Init ()
	Reserved for internal use.

delegate void	NewImageViewerControlHandler (ImageViewerAddOn imageViewerAddOn)

virtual void	Print (Bitmap bitmap, String name, String extraInformation)
	This method is deprecated. Windows Forms controls are no longer supported. Use Print(ImageSource, String, String) instead. Open a print dialog where user can enter a notes and issue preview and print.

virtual void	Print (Bitmap bitmap, String name, String extraInformation, string cameraName)
	This method is deprecated. Windows Forms controls are no longer supported. Use Print(ImageSource, String, String, string) instead. Open a print dialog where user can enter a notes and issue preview and print.

virtual void	Print (ImageSource imageSource, string name, string extraInformation)
	Open a print dialog where user can enter a note and issue preview and print.

virtual void	Print (ImageSource imageSource, string name, string extraInformation, string cameraName)
	Open a print dialog where user can enter a note and issue preview and print.

virtual void	RaiseKeyDownEvent (KeyEventArgs e)
	This method is deprecated. Windows Forms controls are no longer supported. For pure WPF plugins a method like this is not needed. Raise key down events in the Smart Client. Use this method to pass key down events received in ElementHost hosted WPF controls in the plugin. For pure Winforms plugins it should not be necessary to call this method.

virtual void	RegisterUIControlForAutoTheming (FrameworkElement uiControl)
	Register the provided UI control for auto theming. The SC theme will automatically be applied to registered controls. The theme is applied to the registered control and all child controls automatically. Current accepted control is System.Windows.FrameworkElement (WPF). All side panels, property panels and option configuration panels are automatically being themed according to the Theme definition. This method should be used for the main part of the ViewItem and any pop Forms you may have.

virtual void	RegisterUIControlForAutoTheming (object uiControl)
	This method is deprecated. Windows Forms controls are no longer supported. Use RegisterUIControlForAutoTheming(FrameworkElement) instead. Register the provided UI control for auto theming. The SC theme will automatically be applied to registered controls. The theme is applied to the registered control and all child controls automatically. Current accepted controls are System.Windows.Forms.Control (Windows Forms) and System.Windows.Controls.Control (WPF). All side panels, property panels and option configuration panels are automatically being themed accordingly to the Theme definition. This method should be used for the main part of the ViewItem and any pop Forms you may have.

virtual void	ReleasePlaybackController (FQID fqid)
	This method will dispose of a PlaybackController previous created from the GeneratePlaybackController() method.

virtual void	ShowHelp (Control control, int id)
	This method is deprecated. Windows Forms controls are no longer supported. Use ShowHelp(int) instead. Reserved for internal use.

virtual void	ShowHelp (int topicId)
	Opens the help at the given topic id. Help language is automatically resolved.

virtual void	UnInitialize ()
	Call this to uninitialize the ClientControl.

Static Public Attributes
static Guid	AccessControlBuildInWorkSpaceId = new Guid("CE411EB1-3593-4681-A3E1-1BA2D1A761B8")
	Guid defining the object id of the build in access control workspace item.

static Guid	AlarmManagementBuildInWorkSpaceId = new Guid("5A77E227-1A5E-4D7B-B345-46A7BB993037")
	Guid defining the object id of the build in alarm management workspace item.

static string	EmbeddedCameraFQIDProperty = "EmbeddedCameraFQID"
	Name of property that allows a MIP view item to specify which embedded camera it contains. Setting this property will ensure that the embedded camera is added to the timeline and can be exported.

static Guid	ExportBuildInWorkSpaceId = new Guid("7DB87263-F9AB-426D-B641-91D9E4BD7B86")
	Guid defining the object id of the build in export workspace item.

static readonly string	ExportTimeIntervals = "ExportTimeIntervals"
	Name of property describing the time intervals for the export of an item instance.

static Guid	LiveBuildInWorkSpaceId = new Guid("B8C936BF-815D-4D5D-BAAF-1CEAFC7428C0")
	Guid defining the object id of the build in live workspace item.

static Guid	PlaybackBuildInWorkSpaceId = new Guid("DA486915-863C-4ECE-B301-5FC7FD80A2B0")
	Guid defining the object id of the build in playback workspace item.

static Guid	SequenceExplorerBuildInWorkSpaceId = new Guid("955323C5-2ECC-48CE-93A9-3CF1835A4A23")
	Guid defining the object id of the build in sequence explorer workspace item.

static Guid	SystemMonitorBuildInWorkSpaceId = new Guid("FFFA9495-2D44-4183-97CB-550837441294")
	Guid defining the object id of the build in system monitor workspace item.

static Guid	TransactBuildInWorkSpaceId = new Guid("952F54A2-08EE-44F7-B010-86DCA20BA2B2")
	Guid defining the object id of the build in transact workspace item.

Protected Member Functions
	ClientControl ()

virtual void	FireSignalKeyDownEvent (Keys keys)
	This method is deprecated. Windows Forms controls are no longer supported. For pure WPF plugins a method like this is not needed. Do not use this method. Use RaiseKeyDownEvent instead.

void	RaiseFlowDirectionChanged ()
	Raises the FlowDirectionChanged event.

void	RegisterReceivers ()
	Reserved for internal use.

Protected Attributes
PlaybackControllerBase	PlaybackControllerBase
	Used internally.

Properties
virtual System.Windows.FlowDirection	FlowDirection = CultureInfo.CurrentCulture.TextInfo.IsRightToLeft ? System.Windows.FlowDirection.RightToLeft : System.Windows.FlowDirection.LeftToRight `[get]`
	Gets the flow direction currently in use.

virtual bool	Initialized `[get]`
	Indicates if the ClientControl specific instance has been created for the executing Environment. When executing in the Smart Client, this is always initiated by the Smart Client, when executing as a standalone application, you can choose to call the VideoOS.Platform.SDK.UI.Environment.Initialize() method yourself, or let the MIPSDK do this automatically (New in MIP SDK v3).

static ClientControl	Instance `[get, set]`
	This Singleton item of this class. Only use the 'get' access method.

virtual TimeZoneInfo	SelectedTimeZoneInfo `[get, set]`
	This field indicates what timezone the user has selected to work in. This will by default be the local timezone for the PC, but can be changed to another zone by the user. The effect is that all UI components should display date/time information in this selected TimeZone. Setting this field is not recommended, as the value will not be persisted.

virtual Item	ShownWorkSpace `[get, set]`
	Gets or sets the current shown Smart Client work space.

virtual Theme	Theme `[get]`
	Return the currently select Theme details. This class is only useful for Smart Client plugins.

virtual WorkSpaceState	WorkSpaceState `[get, set]`
	Gets or sets the current Smart Client work space state. The state can be Normal or Setup for the current workspace, what another workspace is selected, the current workspace will go out of Setup, and be returned to Normal work space state.

Events
virtual EventHandler	ApplicationCloseEvent
	Subscribe to this event to be notified when the application is about to be shut down.

EventHandler	FlowDirectionChanged
	Event raised when the FlowDirection changes.

virtual NewImageViewerControlHandler	NewImageViewerControlEvent
	A background plug-in can subscribe to this event to be advised when a new ImageViewerControl has been created. The ImageViewerAddOn class passed as a parameter, can be used for controlling the ImageViewer's mode, and for adding overlay to the originators ImageViewerControl. This is intended for use by analytics overlay drawings and for retail text overlay.

Detailed Description

The class to access Client relevant methods.

Constructor & Destructor Documentation

◆ ClientControl()

VideoOS.Platform.ClientControl.ClientControl ( )

inlineprotected

Member Function Documentation

◆ CallOnUiThread()

virtual void VideoOS.Platform.ClientControl.CallOnUiThread ( Action actionToBeInvoked )

inlinevirtual

Use this method to ensure the action is executed on the UI thread.
The method will first check if it is already executing on the UI thread and if not invoke the call.

The below line will call the MuFillTextBox method on the UI thread.

   ClientControl.Instance.CallOnUiThread( () => MyFillTextBox("fill this text") );
 
private void MyFillTextBox(String s)
{
    _myTextBox.Text = s;
}

Parameters

actionToBeInvoked

◆ Close()

virtual void VideoOS.Platform.ClientControl.Close ( )

inlinevirtual

Reserved for internal use.

◆ CreateTemporaryGroupItem()

virtual Item VideoOS.Platform.ClientControl.CreateTemporaryGroupItem ( String name )

inlinevirtual

Create a new Temporary View Group on top level in the Tree structure.
The returned GroupItem will exists as long as the Smart Client is logged in to a server.
The created item will be visible to the operator, unless the following property is set:
groupItem.Properties["Visible"] = "False";

The returned GroupItem is an instance of a ConfigItem and support the AddChild and RemoveChild methods for managing ViewGroups on the next level. This method is used within the smart client.

Parameters

name	Name of the View Group

Returns: The new ViewGroupItem just created, as a ConfigItem.

◆ DeleteTemporaryGroupItem()

virtual void VideoOS.Platform.ClientControl.DeleteTemporaryGroupItem ( Item groupItem )

inlinevirtual

This method will delete a previously created GroupItem through the CreateTemporaryGroupItem method.
This method is used within the smart client.

Parameters

groupItem The GroupItem returned by the CreateTemporaryGroupItem

◆ FireSignalKeyDownEvent()

virtual void VideoOS.Platform.ClientControl.FireSignalKeyDownEvent ( Keys keys )

inlineprotectedvirtual

This method is deprecated. Windows Forms controls are no longer supported. For pure WPF plugins a method like this is not needed. Do not use this method. Use RaiseKeyDownEvent instead.

◆ GenerateAdminImageViewerControl()

virtual AdminImageViewerControl VideoOS.Platform.ClientControl.GenerateAdminImageViewerControl ( )

inlinevirtual

Creates a new instance of a AdminImageViewerControl.

This method is used within XProtect Management Client application.

Returns

◆ GenerateAudioPlayerControl() [1/2]

virtual AudioPlayerControl VideoOS.Platform.ClientControl.GenerateAudioPlayerControl ( )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use AudioPlayer instead. Creates a new instance of a AudioPlayerControl. This method is used for standalone application and Smart Client plugins.
Upon return the generated audio player need to be added to a UserControl.Control collection.

Returns: The new AudioPlayerControl

◆ GenerateAudioPlayerControl() [2/2]

virtual AudioPlayerControl VideoOS.Platform.ClientControl.GenerateAudioPlayerControl ( WindowInformation windowInformation )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use AudioPlayer instead. Creates a new instance of a AudioPlayerControl.
This method is used for Smart Client plugins.
Upon return the generated audio player need to be added to a UserControl.Control collection.
The WindowInformation class should be passed on from the ViewItemUserControl that this control will be added to.
The main effect of adding the WindowInformation is that the AudioPlayer will run in live and playback mode just like the Smart Client usually do, e.g. flowing windows have different mode then the main window.

Returns: The new AudioPlayerControl

◆ GenerateImageViewerControl() [1/2]

virtual ImageViewerControl VideoOS.Platform.ClientControl.GenerateImageViewerControl ( )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use ImageViewerWpfControl instead. Creates a new instance of ImageViewerControl. This method is used within Smart Client and standalone plug-ins.

Exceptions

System.IO.FileNotFoundException Is thrown when one of the dependencies is not found.

Returns: The new ImageViewerControl

◆ GenerateImageViewerControl() [2/2]

virtual ImageViewerControl VideoOS.Platform.ClientControl.GenerateImageViewerControl ( WindowInformation windowInformation )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use ImageViewerWpfControl instead. Creates a new instance of ImageViewerControl.
This method is used within Smart Client.
The WindowInformation class should be passed on from the ViewItemUserControl that this control will be added to.
The main effect of adding the WindowInformation is that the ImageViewer will run in live and playback mode just like the Smart Client usually do, e.g. floating windows have different mode then the main window.

Returns: The new ImageViewerControl

◆ GeneratePcAudioRecorder()

virtual IAudioRecorder VideoOS.Platform.ClientControl.GeneratePcAudioRecorder ( )

inlinevirtual

Generate a AudioRecorder instance that pick up audio from the PCs microphone.

Returns

◆ GeneratePlaybackController()

virtual FQID VideoOS.Platform.ClientControl.GeneratePlaybackController ( )

inlinevirtual

This method can be called when a standalone application would like to have multiple PlaybackControllers active at the same time.
One default PlaybackController is build-in and addressed by sending messages with receive FQID = null.
Each PlaybackController is addressed by sending messages to it with the receiver FQID equal to the return value of this method.
Each of the ImageViewerControl's have one (and only one) PlaybackController that controls it. The default is the build-in BrowserController, but can be changed by setting the ImageViewerControl.PlaybackControllerFQID = result from this method.

Returns

◆ GeneratePlaybackUserControl() [1/2]

virtual PlaybackUserControl VideoOS.Platform.ClientControl.GeneratePlaybackUserControl ( )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead and use PlaybackWpfUserControl.ShowTallUserControl to control the size. Generates a new instance of a PlaybackUserControl.

This works together with one or more ImageViewerControl(s) and one PlaybackController. For standalone applications, you can use the PlaybackController controller and control it via your own user interface, and issue Message's to have it navigate.

This method only works within Smart Client.

Returns

◆ GeneratePlaybackUserControl() [2/2]

virtual PlaybackUserControl VideoOS.Platform.ClientControl.GeneratePlaybackUserControl ( WindowInformation windowInformation )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use PlaybackWpfUserControl instead and use PlaybackWpfUserControl.ShowTallUserControl to control the size. Generates a new instance of a PlaybackUserControl.
This is intended to work together with one or more ImageViewerControl(s) and a PlaybackController (In Smart Client or for standalone application in the MIPSDK .Net Library).

Parameters

windowInformation Identifies that the returned UserControl will be placed on the window identified by the WindowInformation.

Returns

◆ GenerateVideoControl()

virtual VideoControl VideoOS.Platform.ClientControl.GenerateVideoControl ( )

inlinevirtual

Generates an instance of the VideoControl class.

Only for use in Smart Client plugins.

Returns: The new VideoControl

◆ GenerateViewControl() [1/2]

virtual ViewControl VideoOS.Platform.ClientControl.GenerateViewControl	(	List< ViewControlItem >	items,
		List< Rectangle >	viewLayout )

inlinevirtual

Generates an instance of the ViewControl class.

Only for use in Smart Client plugins.

Parameters

items	The view control items to show in the view layout
viewLayout	The layout to use

Returns: The new ViewControl

◆ GenerateViewControl() [2/2]

virtual ViewControl VideoOS.Platform.ClientControl.GenerateViewControl	(	List< ViewControlItem >	items,
		List< Rectangle >	viewLayout,
		WindowInformation	windowInformation )

inlinevirtual

Generates an instance of the ViewControl class.

Only for use in Smart Client plugins.

Parameters

items	The view control items to show in the view layout
viewLayout	The layout to use
windowInformation	The window to show the view on

Returns: The new ViewControl

◆ GetPlaybackController() [1/2]

virtual PlaybackController VideoOS.Platform.ClientControl.GetPlaybackController ( FQID fqid )

inlinevirtual

This method will lookup the actual class handling the playback. Notice that not all methods are available for all Environments.

Parameters

fqid

Returns

◆ GetPlaybackController() [2/2]

virtual FQID VideoOS.Platform.ClientControl.GetPlaybackController ( WindowInformation windowInformation )

inlinevirtual

Get the default playback controller for a given window within the Smart Client.
Please note that the FQID of the playback controller for the Smart Client main window is null.
The ViewItemUserControl base class contains the WindowInformation to use as parameter.

This method only works within Smart Client.

Parameters

windowInformation

Returns

◆ GetSmartClientProfileSetting()

virtual SmartClientProfileSetting VideoOS.Platform.ClientControl.GetSmartClientProfileSetting ( int smartClientProfileSettingKey )

inlinevirtual

Gets the SmartClientProfileSetting for the provided key.

Only supported in Smart Client.

Parameters

smartClientProfileSettingKey Key identifying which SmartClientProfileSetting to fetch.

Returns: SmartClientProfileSetting instance associated with the provided key, or null if it does not exist.

◆ GetSmartWallItems()

virtual List< Item > VideoOS.Platform.ClientControl.GetSmartWallItems ( )

inlinevirtual

Get top list of all video wall view groups for this user.
This method is used within the Smart Client.

Returns

◆ GetViewGroupItems()

virtual List< Item > VideoOS.Platform.ClientControl.GetViewGroupItems ( )

inlinevirtual

Get top list of all accessible view groups for this user. Usually this will return a private group and one or more public groups. This method is used within the Smart Client.

Returns

◆ GetWindowState()

virtual WindowState VideoOS.Platform.ClientControl.GetWindowState ( FQID window )

inlinevirtual

Gets the state of the provided window FQID.

Parameters

window The window FQID to fetch the current state of.

Returns: WindowState of the provided window.

Exceptions

MIPException Thrown if the method is not supported in the environment from where it is called.

◆ GetWorkSpaceItems()

virtual List< Item > VideoOS.Platform.ClientControl.GetWorkSpaceItems ( )

inlinevirtual

Gets a list of all available work spaces.
This method is used within the Smart Client.
These items can be used for selecting the active workspace via this class or via messages.

Returns

◆ Init()

virtual void VideoOS.Platform.ClientControl.Init ( )

inlinevirtual

Reserved for internal use.

◆ NewImageViewerControlHandler()

delegate void VideoOS.Platform.ClientControl.NewImageViewerControlHandler ( ImageViewerAddOn imageViewerAddOn )

Parameters

imageViewerAddOn

◆ Print() [1/4]

virtual void VideoOS.Platform.ClientControl.Print	(	Bitmap	bitmap,
		String	name,
		String	extraInformation )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use Print(ImageSource, String, String) instead. Open a print dialog where user can enter a notes and issue preview and print.

Parameters

bitmap	A bitmap to be placed at the top of the report.
name	Name of the report
extraInformation	Multiple lines of text can be provided

◆ Print() [2/4]

virtual void VideoOS.Platform.ClientControl.Print	(	Bitmap	bitmap,
		String	name,
		String	extraInformation,
		string	cameraName )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use Print(ImageSource, String, String, string) instead. Open a print dialog where user can enter a notes and issue preview and print.

Parameters

bitmap	A bitmap to be placed at the top of the report.
name	Name of the report
extraInformation	Multiple lines of text can be provided
cameraName	The name to display for the label 'camera'

◆ Print() [3/4]

virtual void VideoOS.Platform.ClientControl.Print	(	ImageSource	imageSource,
		string	name,
		string	extraInformation )

inlinevirtual

Open a print dialog where user can enter a note and issue preview and print.

Parameters

imageSource	An image to be placed at the top of the report.
name	Name of the report
extraInformation	Multiple lines of text can be provided

◆ Print() [4/4]

virtual void VideoOS.Platform.ClientControl.Print	(	ImageSource	imageSource,
		string	name,
		string	extraInformation,
		string	cameraName )

inlinevirtual

Open a print dialog where user can enter a note and issue preview and print.

Parameters

imageSource	An image to be placed at the top of the report.
name	Name of the report
extraInformation	Multiple lines of text can be provided
cameraName	The name to display for the label 'camera'

◆ RaiseFlowDirectionChanged()

void VideoOS.Platform.ClientControl.RaiseFlowDirectionChanged ( )

inlineprotected

Raises the FlowDirectionChanged event.

◆ RaiseKeyDownEvent()

virtual void VideoOS.Platform.ClientControl.RaiseKeyDownEvent ( KeyEventArgs e )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. For pure WPF plugins a method like this is not needed. Raise key down events in the Smart Client.
Use this method to pass key down events received in ElementHost hosted WPF controls in the plugin. For pure Winforms plugins it should not be necessary to call this method.

Parameters

e	The winform event args

◆ RegisterReceivers()

void VideoOS.Platform.ClientControl.RegisterReceivers ( )

inlineprotected

Reserved for internal use.

◆ RegisterUIControlForAutoTheming() [1/2]

virtual void VideoOS.Platform.ClientControl.RegisterUIControlForAutoTheming ( FrameworkElement uiControl )

inlinevirtual

Register the provided UI control for auto theming. The SC theme will automatically be applied to registered controls. The theme is applied to the registered control and all child controls automatically. Current accepted control is System.Windows.FrameworkElement (WPF).
All side panels, property panels and option configuration panels are automatically being themed according to the Theme definition. This method should be used for the main part of the ViewItem and any pop Forms you may have.

Parameters

uiControl The UI control to register

◆ RegisterUIControlForAutoTheming() [2/2]

virtual void VideoOS.Platform.ClientControl.RegisterUIControlForAutoTheming ( object uiControl )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use RegisterUIControlForAutoTheming(FrameworkElement) instead. Register the provided UI control for auto theming. The SC theme will automatically be applied to registered controls. The theme is applied to the registered control and all child controls automatically. Current accepted controls are System.Windows.Forms.Control (Windows Forms) and System.Windows.Controls.Control (WPF).
All side panels, property panels and option configuration panels are automatically being themed accordingly to the Theme definition. This method should be used for the main part of the ViewItem and any pop Forms you may have.

Parameters

uiControl The UI control to register

◆ ReleasePlaybackController()

virtual void VideoOS.Platform.ClientControl.ReleasePlaybackController ( FQID fqid )

inlinevirtual

This method will dispose of a PlaybackController previous created from the GeneratePlaybackController() method.

Parameters

fqid

◆ ShowHelp() [1/2]

virtual void VideoOS.Platform.ClientControl.ShowHelp	(	Control	control,
		int	id )

inlinevirtual

This method is deprecated. Windows Forms controls are no longer supported. Use ShowHelp(int) instead. Reserved for internal use.

Parameters

control
id

◆ ShowHelp() [2/2]

virtual void VideoOS.Platform.ClientControl.ShowHelp ( int topicId )

inlinevirtual

Opens the help at the given topic id.
Help language is automatically resolved.

Parameters

topicId The id of the help topic.

◆ UnInitialize()

virtual void VideoOS.Platform.ClientControl.UnInitialize ( )

inlinevirtual

Call this to uninitialize the ClientControl.

Member Data Documentation

◆ AccessControlBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.AccessControlBuildInWorkSpaceId = new Guid("CE411EB1-3593-4681-A3E1-1BA2D1A761B8")

static

Guid defining the object id of the build in access control workspace item.

◆ AlarmManagementBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.AlarmManagementBuildInWorkSpaceId = new Guid("5A77E227-1A5E-4D7B-B345-46A7BB993037")

static

Guid defining the object id of the build in alarm management workspace item.

◆ EmbeddedCameraFQIDProperty

string VideoOS.Platform.ClientControl.EmbeddedCameraFQIDProperty = "EmbeddedCameraFQID"

static

Name of property that allows a MIP view item to specify which embedded camera it contains. Setting this property will ensure that the embedded camera is added to the timeline and can be exported.

◆ ExportBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.ExportBuildInWorkSpaceId = new Guid("7DB87263-F9AB-426D-B641-91D9E4BD7B86")

static

Guid defining the object id of the build in export workspace item.

◆ ExportTimeIntervals

readonly string VideoOS.Platform.ClientControl.ExportTimeIntervals = "ExportTimeIntervals"

static

Name of property describing the time intervals for the export of an item instance.

◆ LiveBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.LiveBuildInWorkSpaceId = new Guid("B8C936BF-815D-4D5D-BAAF-1CEAFC7428C0")

static

Guid defining the object id of the build in live workspace item.

◆ PlaybackBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.PlaybackBuildInWorkSpaceId = new Guid("DA486915-863C-4ECE-B301-5FC7FD80A2B0")

static

Guid defining the object id of the build in playback workspace item.

◆ PlaybackControllerBase

PlaybackControllerBase VideoOS.Platform.ClientControl.PlaybackControllerBase

protected

Used internally.

◆ SequenceExplorerBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.SequenceExplorerBuildInWorkSpaceId = new Guid("955323C5-2ECC-48CE-93A9-3CF1835A4A23")

static

Guid defining the object id of the build in sequence explorer workspace item.

◆ SystemMonitorBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.SystemMonitorBuildInWorkSpaceId = new Guid("FFFA9495-2D44-4183-97CB-550837441294")

static

Guid defining the object id of the build in system monitor workspace item.

◆ TransactBuildInWorkSpaceId

Guid VideoOS.Platform.ClientControl.TransactBuildInWorkSpaceId = new Guid("952F54A2-08EE-44F7-B010-86DCA20BA2B2")

static

Guid defining the object id of the build in transact workspace item.

Property Documentation

◆ FlowDirection

virtual System.Windows.FlowDirection VideoOS.Platform.ClientControl.FlowDirection = CultureInfo.CurrentCulture.TextInfo.IsRightToLeft ? System.Windows.FlowDirection.RightToLeft : System.Windows.FlowDirection.LeftToRight

get

Gets the flow direction currently in use.

◆ Initialized

virtual bool VideoOS.Platform.ClientControl.Initialized

get

Indicates if the ClientControl specific instance has been created for the executing Environment.
When executing in the Smart Client, this is always initiated by the Smart Client, when executing as a standalone application, you can choose to call the VideoOS.Platform.SDK.UI.Environment.Initialize() method yourself, or let the MIPSDK do this automatically (New in MIP SDK v3).

◆ Instance

ClientControl VideoOS.Platform.ClientControl.Instance

staticgetset

This Singleton item of this class. Only use the 'get' access method.

◆ SelectedTimeZoneInfo

virtual TimeZoneInfo VideoOS.Platform.ClientControl.SelectedTimeZoneInfo

getset

This field indicates what timezone the user has selected to work in.
This will by default be the local timezone for the PC, but can be changed to another zone by the user.
The effect is that all UI components should display date/time information in this selected TimeZone.
Setting this field is not recommended, as the value will not be persisted.

◆ ShownWorkSpace

virtual Item VideoOS.Platform.ClientControl.ShownWorkSpace

getset

Gets or sets the current shown Smart Client work space.

◆ Theme

virtual Theme VideoOS.Platform.ClientControl.Theme

get

Return the currently select Theme details.
This class is only useful for Smart Client plugins.

◆ WorkSpaceState

virtual WorkSpaceState VideoOS.Platform.ClientControl.WorkSpaceState

getset

Gets or sets the current Smart Client work space state.
The state can be Normal or Setup for the current workspace, what another workspace is selected, the current workspace will go out of Setup, and be returned to Normal work space state.

Event Documentation

◆ ApplicationCloseEvent

virtual EventHandler VideoOS.Platform.ClientControl.ApplicationCloseEvent

Subscribe to this event to be notified when the application is about to be shut down.

Generally it is a better idea to do cleanup in the Close() methods as these will be called whenever the application is no longer logged on to the VMS and thus configuration might no longer be valid, but if you have some cleanup that should only be done when the application is actually shutting down, this is the place to do it.

Only do basic cleanup here. Don't attempt to access any UI or utilize MIP functionality in general here, as a lot of that will already be gone at this point.

The event is only supported in Smart Client and Management Client.

◆ FlowDirectionChanged

EventHandler VideoOS.Platform.ClientControl.FlowDirectionChanged

Event raised when the FlowDirection changes.

◆ NewImageViewerControlEvent

virtual NewImageViewerControlHandler VideoOS.Platform.ClientControl.NewImageViewerControlEvent

A background plug-in can subscribe to this event to be advised when a new ImageViewerControl has been created. The ImageViewerAddOn class passed as a parameter, can be used for controlling the ImageViewer's mode, and for adding overlay to the originators ImageViewerControl.
This is intended for use by analytics overlay drawings and for retail text overlay.

Note that the content of the ImageViewerAddOn may not be filled when this event is fired, and the receiving class should register on the ImageViewerAddOn's PropertyChangedEvent to keep the receiver in sync with the correct e.g. CameraId and other properties.

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Constructor & Destructor Documentation

◆ ClientControl()

Member Function Documentation

◆ CallOnUiThread()

◆ Close()

◆ CreateTemporaryGroupItem()

◆ DeleteTemporaryGroupItem()

◆ FireSignalKeyDownEvent()

◆ GenerateAdminImageViewerControl()

◆ GenerateAudioPlayerControl() [1/2]

◆ GenerateAudioPlayerControl() [2/2]

◆ GenerateImageViewerControl() [1/2]

◆ GenerateImageViewerControl() [2/2]

◆ GeneratePcAudioRecorder()

◆ GeneratePlaybackController()

◆ GeneratePlaybackUserControl() [1/2]

◆ GeneratePlaybackUserControl() [2/2]

◆ GenerateVideoControl()

◆ GenerateViewControl() [1/2]

◆ GenerateViewControl() [2/2]

◆ GetPlaybackController() [1/2]

◆ GetPlaybackController() [2/2]

◆ GetSmartClientProfileSetting()

◆ GetSmartWallItems()

◆ GetViewGroupItems()

◆ GetWindowState()

◆ GetWorkSpaceItems()

◆ Init()

◆ NewImageViewerControlHandler()

◆ Print() [1/4]

◆ Print() [2/4]

◆ Print() [3/4]

◆ Print() [4/4]

◆ RaiseFlowDirectionChanged()

◆ RaiseKeyDownEvent()

◆ RegisterReceivers()

◆ RegisterUIControlForAutoTheming() [1/2]

◆ RegisterUIControlForAutoTheming() [2/2]

◆ ReleasePlaybackController()

◆ ShowHelp() [1/2]

◆ ShowHelp() [2/2]

◆ UnInitialize()

Member Data Documentation

◆ AccessControlBuildInWorkSpaceId

◆ AlarmManagementBuildInWorkSpaceId

◆ EmbeddedCameraFQIDProperty

◆ ExportBuildInWorkSpaceId

◆ ExportTimeIntervals

◆ LiveBuildInWorkSpaceId

◆ PlaybackBuildInWorkSpaceId

◆ PlaybackControllerBase

◆ SequenceExplorerBuildInWorkSpaceId

◆ SystemMonitorBuildInWorkSpaceId

◆ TransactBuildInWorkSpaceId

Property Documentation

◆ FlowDirection

◆ Initialized

◆ Instance

◆ SelectedTimeZoneInfo

◆ ShownWorkSpace

◆ Theme

◆ WorkSpaceState

Event Documentation

◆ ApplicationCloseEvent

◆ FlowDirectionChanged

◆ NewImageViewerControlEvent