C# / .Net API Library Reference  4.3.2-74-ge1d4cca
Public Functions | Properties | Events
IViewManager Interface Reference

The IViewManager interface manages the views streamed from the service application. Most calls may only be made in the UI thread unless otherwise specified. For more information, see the ViewManager class.

Public Functions

ViewImageFormat GetViewImageFormat (string viewName)
 
bool IsRenderAvailable (string viewName)
 
void RefreshViews ()
 
void RegisterView (string viewName, IRenderedView view)
 
void RenderViewDeferred (string viewName)
 
void RenderViewImmediate (string viewName)
 
void SetViewImageFormat (string viewName, ViewImageFormat format)
 
void SetViewInteracting (string viewName, bool isInteracting)
 
bool TryGetView (string viewName, out IRenderedView view)
 
bool UnregisterView (string viewName)
 

Properties

EncoderConfiguration DefaultEncoderConfiguration [get, set]
 
Deprecated
int MaxImageQuality [get, set]
 
int MinImageQuality [get, set]
 
int FullImageQuality [get, set]
 
int InteractiveImageQuality [get, set]
 

Events

EventHandler< EncoderConfigurationChangedEventArgsEncoderConfigurationChanged
 
EventHandler FullImageQualityChanged
 
EventHandler< ImageCompressionEventArgsImageEncoding
 
EventHandler InteractiveImageQualityChanged
 
EventHandler< PureWebKeyboardEventArgsKeyboardEvent
 
EventHandler MaxImageQualityChanged
 
EventHandler MinImageQualityChanged
 
EventHandler< PureWebMouseEventArgsMouseEvent
 
EventHandler< ViewRenderedEventArgsViewRendered
 

Usage Description

ViewImageFormat GetViewImageFormat ( string  viewName)
inherited

Returns the current view image format (pixel format, scan line order and alignment) for the specified view.

Implemented in ViewManager.

bool IsRenderAvailable ( string  viewName)

Returns true if the image bits are available for the specified view. May only be called on UI thread.

void RefreshViews ( )

Causes all views to be re-rendered. This method is called automatically when a client calls refresh on a view.

Implemented in ViewManager.

void RegisterView ( string  viewName,
IRenderedView  view 
)

Registers the specified view with StateManager.

Parameters
viewNameThe name that you want to give to the view. This name will act as a unique ID, and both the service and the client must use this name when referring to the view.
viewThe view that you are registering.

Implemented in ViewManager.

void RenderViewDeferred ( string  viewName)
inherited

Notifies StateManager that the image in the specified view has been updated and needs to be rendered. The view image bits will be acquired later via the view's IRenderedView interface (the timing of the call to RenderView is not configurable; this is handled automatically by PureWeb).

Implemented in ViewManager.

void RenderViewImmediate ( string  viewName)
inherited

Notifies StateManager that the image in the specified view has been updated needs to be rendered. The view image bits will be acquired immediately via the view's IRenderedView interface. This must be called on the UI thread.

Implemented in ViewManager.

void SetViewImageFormat ( string  viewName,
ViewImageFormat  format 
)
inherited

Sets the view image format (pixel format, scan line order and alignment) for the specified view.

The main purpose of this method is to overwrite framework defaults when needed.

Implemented in ViewManager.

void SetViewInteracting ( string  viewName,
bool  isInteracting 
)
inherited

Sets the interactive mode for the specified view to either true or false.

The SetViewInteracting method is used to notify StateManager when user interaction begins and when it stops. For example, you could set the interactive mode to true on a mouse down event, and set it back to false on a mouse up event. Once this is in place, you can configure the image quality values for the interactive and non-interactive modes using the client-side APIs.

Implemented in ViewManager.

bool TryGetView ( string  viewName,
out IRenderedView  view 
)

Tries to get the view with the specified name. May only be called on UI thread.

bool UnregisterView ( string  viewName)

Unregisters the specified view. Returns true if the view was successfully unregistered, or false otherwise.

Implemented in ViewManager.

Property Documentation

EncoderConfiguration DefaultEncoderConfiguration
getset

Returns the encoder configuration currently set as the default. This default is set by the client-side API when the client first connects.

int FullImageQuality
getset
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Gets or sets the value for the full (non-interactive) image quality. Can be accessed from any thread.

int InteractiveImageQuality
getset
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Gets or sets the value for the interactive image quality. Can be accessed from any thread.

int MaxImageQuality
getset
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Gets or sets the value for the maximum image quality.

int MinImageQuality
getset
Note
This method is deprecated, as image encoding and quality is now set using the client-side APIs.

Gets or sets the value for the minimum image quality.

Event Documentation

EventHandler<EncoderConfigurationChangedEventArgs> EncoderConfigurationChanged

This event fires when the value for the EncoderConfiguration changes.

EventHandler FullImageQualityChanged

This event fires when the value for the full (non-interactive) image quality changes.

EventHandler<ImageCompressionEventArgs> ImageEncoding

This event fires when the encoder configuration changed for a particular view and client.

EventHandler InteractiveImageQualityChanged

This event fires when the value for the interactive image quality changes.

EventHandler<PureWebKeyboardEventArgs> KeyboardEvent

This event fires when a keyboard event occurs. PureWeb listens to this event under the hood, and when it occurs, it automatically fires the PostKeyEvent method.

EventHandler MaxImageQualityChanged

This event fires when the value for the maximum image quality changes.

EventHandler MinImageQualityChanged

This event fires when the value for the minimum image quality changes.

EventHandler<PureWebMouseEventArgs> MouseEvent

This event fires when a mouse event occurs. PureWeb listens to this event under the hood, and when it occurs, it automatically fires the PostMouseEvent method.

EventHandler<ViewRenderedEventArgs> ViewRendered

This event fires when a view is rendered. Although you can register for this event, its main purpose is to manage views under the hood.