Coherent.UI.Windows.Controls.BrowserViewControl Class Reference

Interface that allows clients to listen to Coherent::UI::ViewListener More...

Inherits UserControl.

Public Member Functions
	BrowserViewControl ()
	Creates a new view control More...
void	Dispose ()
	Destroys the view More...
void	ProcessKeyDown (KeyEventArgs e)
	Processes and forwards a key down event to the view More...
void	ProcessKeyUp (KeyEventArgs e)
	Processes and forwards a key up event to the view More...
void	ProcessKeyPress (TextCompositionEventArgs e)
	Processes and forwards a key press event to the view More...
void	ProcessMouseWheel (MouseWheelEventArgs e)
	Processes and forwards a mouse wheel event to the view More...
void	ProcessMouseDown (MouseButtonEventArgs e)
	Processes and forwards a mouse down event to the view More...
void	ProcessMouseUp (MouseButtonEventArgs e)
	Processes and forwards a mouse up event to the view More...
void	ProcessMouseMove (MouseEventArgs e)
	Processes and forwards a mouse move event to the view More...
void	Resize (uint width, uint height)
	Resize the view More...
delegate void	OnDrawMemory (int[] pixels, int width, int height)
	Delegate for drawing the view More...

Protected Member Functions
override void	OnKeyDown (KeyEventArgs e)
	Forwards a key down event More...
override void	OnKeyUp (KeyEventArgs e)
	Forwards a key up event More...
override void	OnTextInput (TextCompositionEventArgs e)
	Forwards a text input event More...
override void	OnMouseWheel (MouseWheelEventArgs e)
	Forwards a mouse wheel event More...
override void	OnMouseDown (MouseButtonEventArgs e)
	Forwards a mouse down event More...
override void	OnMouseUp (MouseButtonEventArgs e)
	Forwards a mouse up event More...
override void	OnMouseMove (MouseEventArgs e)
	Forwards a mouse move event More...

Properties
BrowserViewContext	Context [get, set]
	Which view context should be used by the view control. If null, a default view context will be used More...
int	ViewWidth [get, set]
	Width of the view More...
int	ViewHeight [get, set]
	Height of the view More...
string	InitialUrl [get, set]
	Initial URL to load More...
string	InitialScript [get, set]
	The script to execute when the view JavaScript engine is created More...
DisplayModes	DisplayMode [get, set]
	Display mode for the view More...
Coherent.UI.BrowserView	BrowserView [get]
	Get the wrapped Coherent UI view More...
bool	ForceSoftwareRendering [get, set]
	Whether this view should use software rendering More...
int	MaxFramerate [get, set]
	The maximum framerate for this view More...
bool	IsTransparent [get, set]
	Determines whether the image produced by Coherent UI supports transparency. When enabled, Coherent UI requires a little more processing time to fill in the alpha values. More...
bool	PreferD3DImageBackingStore [get, set]
	Specifies whether a shared Direct3D texture should be used as backing store for the surfaces transferred from Coherent UI Host. Available on Windows Vista SP2 and later. If the operating system does not support this option, Coherent UI falls back to using shared memory. Ignored when ForceSoftwareRendering is selected. More...

Events
Coherent.UI.ViewListener.CoherentUI_OnViewCreated	ViewCreated
	Fired when the requested More...
Coherent.UI.ViewListener.CoherentUI_OnFinishLoad	FinishLoad
	Fired when a frame has been successfully loaded. More...
Coherent.UI.ViewListener.CoherentUI_OnFailLoad	FailLoad
	Fired when a frame has been failed loading. More...
Coherent.UI.ViewListener.CoherentUI_OnURLRequest	URLRequest
	Fired before an URL request is made. The default implementation allows all requests. More...
Coherent.UI.ViewListener.CoherentUI_OnReadyForBindings	ReadyForBindings
	Fired when a frame is ready for bindings. More...
Coherent.UI.ViewListener.CoherentUI_OnBindingsReleased	BindingsReleased
	Fired when the bindings for frame are released. More...
Coherent.UI.ViewListener.CoherentUI_OnStartLoading	StartLoading
	Fired when a new path has started loading. More...
Coherent.UI.ViewListener.CoherentUI_OnStopLoading	StopLoading
	Fired when all load operations have completed. More...
Coherent.UI.ViewListener.CoherentUI_OnNavigateTo	NavigateTo
	Fired when the view starts navigation to a new path. More...
Coherent.UI.ViewListener.CoherentUI_OnError	Error
	Fired when an error occurs for this specific More...
Coherent.UI.ViewListener.CoherentUI_OnScriptMessage	ScriptMessage
	Fired when a message is sent from a script running in this specific More...
Coherent.UI.ViewListener.CoherentUI_OnCursorChanged	CursorChanged
	Fired when the cursor has changed internally in the More...
Coherent.UI.ViewListener.CoherentUI_OnCallback	Callback
	Fired by the UI when there is no registered handler for this event. More...
Coherent.UI.ViewListener.CoherentUI_OnJavaScriptMessage	JavaScriptMessage
	Fired when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog. More...
Coherent.UI.ViewListener.CoherentUI_OnGetAuthCredentials	GetAuthCredentials
	Fired when a view requires authentication credentials. More...
Coherent.UI.ViewListener.CoherentUI_OnCertificateError	CertificateError
	Fired when there is an error with the certificate of a particular URL. the certificate and response pointers are valid only for the duration of this call More...
Coherent.UI.ViewListener.CoherentUI_OnRequestMediaStream	RequestMediaStream
	Fired when the view requests access to a media stream. Media streams are the audio capture (microphone) and video capture (camera) devices on the system. More...
OnDrawMemory	DrawMemory
	Fired when the view should be drawn. This is only called when the view is not using D3DImage as backing store. More...

Detailed Description

Interface that allows clients to listen to Coherent::UI::ViewListener

Encapsulates Coherent UI view as a WPF control

Constructor & Destructor Documentation

Coherent.UI.Windows.Controls.BrowserViewControl.BrowserViewControl ( )

inline

Creates a new view control

Member Function Documentation

void Coherent.UI.Windows.Controls.BrowserViewControl.Dispose ( )

inline

Destroys the view

delegate void Coherent.UI.Windows.Controls.BrowserViewControl.OnDrawMemory	(	int[]	pixels,
		int	width,
		int	height
	)

Delegate for drawing the view

Parameters

pixels
width
height

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnKeyDown ( KeyEventArgs  e )

inlineprotected

Forwards a key down event

Parameters

e	key event arguments

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnKeyUp ( KeyEventArgs  e )

inlineprotected

Forwards a key up event

Parameters

e	key event arguments

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnMouseDown ( MouseButtonEventArgs  e )

inlineprotected

Forwards a mouse down event

Parameters

e	mouse event arguments

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnMouseMove ( MouseEventArgs  e )

inlineprotected

Forwards a mouse move event

Parameters

e	mouse event arguments

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnMouseUp ( MouseButtonEventArgs  e )

inlineprotected

Forwards a mouse up event

Parameters

e	mouse event arguments

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnMouseWheel ( MouseWheelEventArgs  e )

inlineprotected

Forwards a mouse wheel event

Parameters

e	mouse event arguments

override void Coherent.UI.Windows.Controls.BrowserViewControl.OnTextInput ( TextCompositionEventArgs  e )

inlineprotected

Forwards a text input event

Parameters

e	text composition event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessKeyDown ( KeyEventArgs  e )

inline

Processes and forwards a key down event to the view

Parameters

e	key event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessKeyPress ( TextCompositionEventArgs  e )

inline

Processes and forwards a key press event to the view

Parameters

e	key event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessKeyUp ( KeyEventArgs  e )

inline

Processes and forwards a key up event to the view

Parameters

e	key event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessMouseDown ( MouseButtonEventArgs  e )

inline

Processes and forwards a mouse down event to the view

Parameters

e	mouse event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessMouseMove ( MouseEventArgs  e )

inline

Processes and forwards a mouse move event to the view

Parameters

e	mouse event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessMouseUp ( MouseButtonEventArgs  e )

inline

Processes and forwards a mouse up event to the view

Parameters

e	mouse event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.ProcessMouseWheel ( MouseWheelEventArgs  e )

inline

Processes and forwards a mouse wheel event to the view

Parameters

e	mouse event arguments

void Coherent.UI.Windows.Controls.BrowserViewControl.Resize ( uint  width, uint  height  )

inline

Resize the view

Parameters

width
height

Property Documentation

Coherent.UI.BrowserView Coherent.UI.Windows.Controls.BrowserViewControl.BrowserView

get

Get the wrapped Coherent UI view

BrowserViewContext Coherent.UI.Windows.Controls.BrowserViewControl.Context

getset

Which view context should be used by the view control. If null, a default view context will be used

DisplayModes Coherent.UI.Windows.Controls.BrowserViewControl.DisplayMode

getset

Display mode for the view

bool Coherent.UI.Windows.Controls.BrowserViewControl.ForceSoftwareRendering

getset

Whether this view should use software rendering

string Coherent.UI.Windows.Controls.BrowserViewControl.InitialScript

getset

The script to execute when the view JavaScript engine is created

string Coherent.UI.Windows.Controls.BrowserViewControl.InitialUrl

getset

Initial URL to load

bool Coherent.UI.Windows.Controls.BrowserViewControl.IsTransparent

getset

Determines whether the image produced by Coherent UI supports transparency. When enabled, Coherent UI requires a little more processing time to fill in the alpha values.

int Coherent.UI.Windows.Controls.BrowserViewControl.MaxFramerate

getset

The maximum framerate for this view

bool Coherent.UI.Windows.Controls.BrowserViewControl.PreferD3DImageBackingStore

getset

Specifies whether a shared Direct3D texture should be used as backing store for the surfaces transferred from Coherent UI Host. Available on Windows Vista SP2 and later. If the operating system does not support this option, Coherent UI falls back to using shared memory. Ignored when ForceSoftwareRendering is selected.

int Coherent.UI.Windows.Controls.BrowserViewControl.ViewHeight

getset

Height of the view

int Coherent.UI.Windows.Controls.BrowserViewControl.ViewWidth

getset

Width of the view

Event Documentation

Coherent.UI.ViewListener.CoherentUI_OnBindingsReleased Coherent.UI.Windows.Controls.BrowserViewControl.BindingsReleased

Fired when the bindings for frame are released.

Coherent.UI.ViewListener.CoherentUI_OnCallback Coherent.UI.Windows.Controls.BrowserViewControl.Callback

Fired by the UI when there is no registered handler for this event.

Coherent.UI.ViewListener.CoherentUI_OnCertificateError Coherent.UI.Windows.Controls.BrowserViewControl.CertificateError

Fired when there is an error with the certificate of a particular URL. the certificate and response pointers are valid only for the duration of this call

Coherent.UI.ViewListener.CoherentUI_OnCursorChanged Coherent.UI.Windows.Controls.BrowserViewControl.CursorChanged

Fired when the cursor has changed internally in the

OnDrawMemory Coherent.UI.Windows.Controls.BrowserViewControl.DrawMemory

Fired when the view should be drawn. This is only called when the view is not using D3DImage as backing store.

Coherent.UI.ViewListener.CoherentUI_OnError Coherent.UI.Windows.Controls.BrowserViewControl.Error

Fired when an error occurs for this specific

Coherent.UI.ViewListener.CoherentUI_OnFailLoad Coherent.UI.Windows.Controls.BrowserViewControl.FailLoad

Fired when a frame has been failed loading.

Coherent.UI.ViewListener.CoherentUI_OnFinishLoad Coherent.UI.Windows.Controls.BrowserViewControl.FinishLoad

Fired when a frame has been successfully loaded.

Coherent.UI.ViewListener.CoherentUI_OnGetAuthCredentials Coherent.UI.Windows.Controls.BrowserViewControl.GetAuthCredentials

Fired when a view requires authentication credentials.

Coherent.UI.ViewListener.CoherentUI_OnJavaScriptMessage Coherent.UI.Windows.Controls.BrowserViewControl.JavaScriptMessage

Fired when the view triggered a javascript message box, i.e. an alert, confirmation dialog or a prompt dialog.

Coherent.UI.ViewListener.CoherentUI_OnNavigateTo Coherent.UI.Windows.Controls.BrowserViewControl.NavigateTo

Fired when the view starts navigation to a new path.

Coherent.UI.ViewListener.CoherentUI_OnReadyForBindings Coherent.UI.Windows.Controls.BrowserViewControl.ReadyForBindings

Fired when a frame is ready for bindings.

Coherent.UI.ViewListener.CoherentUI_OnRequestMediaStream Coherent.UI.Windows.Controls.BrowserViewControl.RequestMediaStream

Fired when the view requests access to a media stream. Media streams are the audio capture (microphone) and video capture (camera) devices on the system.

Coherent.UI.ViewListener.CoherentUI_OnScriptMessage Coherent.UI.Windows.Controls.BrowserViewControl.ScriptMessage

Fired when a message is sent from a script running in this specific

Coherent.UI.ViewListener.CoherentUI_OnStartLoading Coherent.UI.Windows.Controls.BrowserViewControl.StartLoading

Fired when a new path has started loading.

Coherent.UI.ViewListener.CoherentUI_OnStopLoading Coherent.UI.Windows.Controls.BrowserViewControl.StopLoading

Fired when all load operations have completed.

Coherent.UI.ViewListener.CoherentUI_OnURLRequest Coherent.UI.Windows.Controls.BrowserViewControl.URLRequest

Fired before an URL request is made. The default implementation allows all requests.

Coherent.UI.ViewListener.CoherentUI_OnViewCreated Coherent.UI.Windows.Controls.BrowserViewControl.ViewCreated

Fired when the requested