public class SizeObject : JSObject
{
private const string PROP_WIDTH = "width";
private const string PROP_HEIGHT = "height";
// Public parameterless constructor
// to create the local object.
public SizeObject()
{ }
// Custom public constructor
// to create the local object.
public SizeObject( int width, int height )
{
this.Width = width;
this.Height = height;
}
// Special constructor called by Awesomium.NET
// to restore an instance of this object, after
// it has been passed to the web-page.
protected SizeObject( JSObject obj )
: base( obj )
{ }
public int Width
{
get
{
JSValue value = this[ PROP_WIDTH ];
if ( !value.IsNumber )
return -1;
return (int)value;
}
set
{
this[ PROP_WIDTH ] = value;
}
}
public int Height
{
get
{
JSValue value = this[ PROP_HEIGHT ];
if ( !value.IsNumber )
return -1;
return (int)value;
}
set
{
this[ PROP_HEIGHT ] = value;
}
}
}
[...]
private void OnDocumentReady( object sender, DocumentReadyEventArgs e )
{
// When ReadyState is Ready, you can execute JavaScript against
// the DOM but all resources are not yet loaded. Wait for Loaded.
if ( e.ReadyState == DocumentReadyState.Ready )
return;
// Create an instance of our custom JSObject and initialize it.
SizeObject size = new SizeObject( 400, 200 );
// Acquire the current window object from the web-page.
JSObject window = webControl.ExecuteJavascriptWithResult( "window" );
// Assign our object to a new property on window.
window[ "sizeVar" ] = size;
// Execute some JavaScript synchronously that will change the value
// of the width property of our object.
webControl.ExecuteJavascriptWithResult( "window.sizeVar.width = 300" );
// Reacquire the object from the web-page (it's now a new remote instance).
// Take some precautions and do not cast directly as JavaScript in the page
// may have deleted or changed the value type of the window.sizeVar property.
size = (JSObject)window[ "sizeVar" ] as SizeObject;
// All JSObjects implement IEnumerable to enumerate their
// properties, just as in JavaScript.
foreach ( var property in size )
System.Diagnostics.Debug.Print( property );
// Print the current size represented by our custom JSObject.
System.Diagnostics.Debug.Print( String.Format( "{0}x{1}", size.Width, size.Height ) );
}
var myObject = {};
Object.defineProperty(myObject, "name", { value: 'John', enumerable: true });
Object.defineProperty(myObject, "age", { value: 29, enumerable: false });
JSObject myObject = webView.ExecuteJavascriptWithResult( "myObject" );
if ( !myObject )
return;
foreach ( var property in myObject )
// Will print 'name' only.
Console.WriteLine( property );
String[] props = myObject.GetPropertyNames();
foreach ( var property in props )
// Will print 'name' and 'age'.
Console.WriteLine( property );
JSObject window = webView.ExecuteJavascriptWithResult( "window" );
if ( !window )
return;
// Notice the case. JavaScript is case-sensitive. There may be a property
// named 'Close' but this is not the 'close' method.
if ( !window.HasProperty( "Close" ) )
return;
// Attempt to get the value of the property and implicitly cast it to
// a JSFunction, assuming it's going to be a function member.
JSFunction closeMethod = window[ "Close" ];
// 'closeMethod' will be a special invalid (undefined) object if the
// property does not exist or if it is not a function member. When
// converted to Boolean, it will be 'false'. This check is enough, therefore
// the synchronous 'HasProperty' call above, is not needed.
if ( !closeMethod )
return;
Dim window As JSObject = webView.ExecuteJavascriptWithResult("window")
If Not window Then Return
' Notice the case. JavaScript is case-sensitive. There may be a property
' named 'Close' but this is not the 'close' method.
If Not window.HasProperty("Close") Then Return
' Attempt to get the value of the property and implicitly cast it to
' a JSFunction, assuming it's going to be a function member.
Dim closeMethod As JSFunction = window("Close")
' 'closeMethod' will be a special invalid (undefined) object if the
' property does not exist or if it is not a function member. When
' converted to Boolean, it will be 'False'. This check is enough, therefore
' the synchronous 'HasProperty' call above, is not needed.
If Not CBool(closeMethod) Then Return
JSObject window = webView.ExecuteJavascriptWithResult( "window" );
if ( !window )
return;
// Check if a function member named 'close' exists.
if ( !window.HasMethod( "close" ) )
return;
// Attempt to get the value of the property and implicitly cast it to
// a JSFunction, assuming it's going to be a function member.
JSFunction closeMethod = window[ "close" ];
// 'closeMethod' will be a special invalid (undefined) object if the
// property does not exist or if it is not a function member. When
// converted to Boolean, it will be 'false'. This check is enough, therefore
// the synchronous 'HasMethod' call above, is not needed.
if ( !closeMethod )
return;
Dim window As JSObject = webView.ExecuteJavascriptWithResult("window")
If Not window Then Return
' Check if a function member named 'close' exists.
If Not window.HasMethod("close") Then Return
' Attempt to get the value of the property and implicitly cast it to
' a JSFunction, assuming it's going to be a function member.
Dim closeMethod As JSFunction = window("close")
' 'closeMethod' will be a special invalid (undefined) object if the
' property does not exist or if it is not a function member. When
' converted to Boolean, it will be 'False'. This check is enough, therefore
' the synchronous 'HasMethod' call above, is not needed.
If Not CBool(closeMethod) Then Return
if ( !webView.IsLive )
return;
// Create and acquire a Global Javascript object.
// These object persist for the lifetime of the web-view.
using ( JSObject myGlobalObject = webView.CreateGlobalJavascriptObject( "myGlobalObject" ) )
{
// The handler is of type JavascriptMethodHandler. Here we define it
// using a lambda expression.
myGlobalObject.Bind( "myMethod", ( s, e ) =>
{
// Provide a response.
return "My response";
} );
}
If (Not webView.IsLive) Then Return
' Create and acquire a Global Javascript object.
' These object persist for the lifetime of the web-view.
Using myGlobalObject As JSObject = webView.CreateGlobalJavascriptObject("myGlobalObject")
' The handler is of type JavascriptMethodHandler. Here we define it
' using a lambda expression.
myGlobalObject.Bind("myMethod",
Function(s, e)
' Provide a response.
Return "My response"
End Function)
End Using
if ( !webView.IsLive )
return;
// Create and acquire a Global Javascript object. These object persist for the lifetime of the web-view.
// Notice that we need to explicitly cast to JSObject before assigning to a dynamic. Since all Awesomium
// Javascript Integration API members normally return JSValue, the CLR would not know what to assign to
// 'dynamic'. Only JSObject (and subclasses of it) support the DLR.
dynamic myGlobalObject = (JSObject)webView.CreateGlobalJavascriptObject( "myGlobalObject" );
// Make sure we have the object.
if ( !myGlobalObject )
return;
using ( myGlobalObject )
{
// Create and bind to a synchronous custom method dynamically.
myGlobalObject.myMethod = (JavascriptMethodDelegate)OnCustomJavascriptMethod;
// Our method can now be executed from JavaScript. It could be JavaScript already available in the page.
// For this sample, we will inject the JavaScript ourselves and execute it.
string jsResponse = webView.ExecuteJavascriptWithResult( "myGlobalObject.myMethod('This is a call from Javascript.');" );
if ( !String.IsNullOrEmpty( jsResponse ) )
// Print the response.
Debug.Print( String.Format( "And this is the response: {0}", jsResponse ) );
}
Option Strict Off
[...]
If Not webView.IsLive Then Return
' Create and acquire a Global Javascript object. These object persist for the lifetime of the web-view.
' Notice that we need to explicitly cast to JSObject before assigning to a dynamic. Since all Awesomium
' Javascript Integration API members normally return JSValue, the CLR would not know what to assign to
' Dim. Only JSObject (and subclasses of it) support the DLR.
Dim myGlobalObject = CType(webView.ExecuteJavascriptWithResult("myGlobalObject"), JSObject)
' Make sure we have the object.
If Not myGlobalObject Then
Return
End If
Using myGlobalObject
' Create and bind to a synchronous custom method dynamically.
myGlobalObject.myMethod = CType(AddressOf OnCustomJavascriptMethod, JavascriptMethodHandler)
' Our method can now be executed from JavaScript. It could be JavaScript already available in the page.
' For this sample, we will inject the JavaScript ourselves and execute it.
Dim jsResponse As String = webView.ExecuteJavascriptWithResult("myGlobalObject.myMethod('This is a call from Javascript.');")
If Not String.IsNullOrEmpty(jsResponse) Then
' Print the response.
Debug.Print(String.Format("And this is the response: {0}", jsResponse))
End If
End Using
if ( !webView.IsLive )
return;
// Create and acquire a Global Javascript object.
// These objects persist for the lifetime of the web-view.
using ( JSObject myGlobalObject = webView.CreateGlobalJavascriptObject( "myGlobalObject" ) )
{
// The method name is determined from the passed handler's name.
// Therefore we cannot pass a lambda expression to this overload.
myGlobalObject.Bind( myMethod );
}
private JSValue myMethod( object sender, JavascriptMethodEventArgs e )
{
// Provide a response.
return "My response";
}
If (Not webView.IsLive) Then Return
' Create and acquire a Global Javascript object.
' These object persist for the lifetime of the web-view.
Using myGlobalObject As JSObject = webView.CreateGlobalJavascriptObject("myGlobalObject")
' The method name is determined from the defined handler's name.
' Therefore we cannot pass a lambda expression to this overload.
myGlobalObject.Bind(myMethod)
End Using
Public Function myMethod(sender As Object, e As JavascriptMethodEventArgs) As JSValue
' Provide a response.
Return "My response"
End Function
if ( !webView.IsLive )
return;
// Create and acquire a Global Javascript object.
// These object persist for the lifetime of the web-view.
using ( JSObject myGlobalObject = webView.CreateGlobalJavascriptObject( "myGlobalObject" ) )
{
// The handler is of type JavascriptMethodHandler. Here we define it
// using a lambda expression.
myGlobalObject.Bind( "myMethod", ( s, e ) =>
{
// Provide a response.
return "My response";
} );
}
If (Not webView.IsLive) Then Return
' Create and acquire a Global Javascript object.
' These object persist for the lifetime of the web-view.
Using myGlobalObject As JSObject = webView.CreateGlobalJavascriptObject("myGlobalObject")
' The handler is of type JavascriptMethodHandler. Here we define it
' using a lambda expression.
myGlobalObject.Bind("myMethod",
Function(s, e)
' Provide a response.
Return "My response"
End Function)
End Using
if ( !webView.IsLive )
return;
// Create and acquire a Global Javascript object. These object persist for the lifetime of the web-view.
// Notice that we need to explicitly cast to JSObject before assigning to a dynamic. Since all Awesomium
// Javascript Integration API members normally return JSValue, the CLR would not know what to assign to
// 'dynamic'. Only JSObject (and subclasses of it) support the DLR.
dynamic myGlobalObject = (JSObject)webView.CreateGlobalJavascriptObject( "myGlobalObject" );
// Make sure we have the object.
if ( !myGlobalObject )
return;
using ( myGlobalObject )
{
// Create and bind to a synchronous custom method dynamically.
myGlobalObject.myMethod = (JavascriptMethodHandler)OnCustomJavascriptMethod;
// Our method can now be executed from JavaScript. It could be JavaScript already available in the page.
// For this sample, we will inject the JavaScript ourselves and execute it.
string jsResponse = webView.ExecuteJavascriptWithResult( "myGlobalObject.myMethod('This is a call from Javascript.');" );
if ( !String.IsNullOrEmpty( jsResponse ) )
// Print the response.
Debug.Print( String.Format( "And this is the response: {0}", jsResponse ) );
}
Option Strict Off
[...]
If Not webView.IsLive Then Return
' Create and acquire a Global Javascript object. These object persist for the lifetime of the web-view.
' Notice that we need to explicitly cast to JSObject before assigning to a dynamic. Since all Awesomium
' Javascript Integration API members normally return JSValue, the CLR would not know what to assign to
' Dim. Only JSObject (and subclasses of it) support the DLR.
Dim myGlobalObject = CType(webView.ExecuteJavascriptWithResult("myGlobalObject"), JSObject)
' Make sure we have the object.
If Not CBool(myGlobalObject) Then
Return
End If
Using myGlobalObject
' Create and bind to a synchronous custom method dynamically.
myGlobalObject.myMethod = CType(AddressOf OnCustomJavascriptMethod, JavascriptMethodHandler)
' Our method can now be executed from JavaScript. It could be JavaScript already available in the page.
' For this sample, we will inject the JavaScript ourselves and execute it.
Dim jsResponse As String = webView.ExecuteJavascriptWithResult("myGlobalObject.myMethod('This is a call from Javascript.');")
If Not String.IsNullOrEmpty(jsResponse) Then
' Print the response.
Debug.Print(String.Format("And this is the response: {0}", jsResponse))
End If
End Using
if ( !webView.IsLive )
return;
// Create and acquire a Global Javascript object.
// These objects persist for the lifetime of the web-view.
using ( JSObject myGlobalObject = webView.CreateGlobalJavascriptObject( "myGlobalObject" ) )
{
// The method name is determined from the passed handler's name.
// Therefore we cannot pass a lambda expression to this overload.
myGlobalObject.Bind( myMethod );
}
private JSValue myMethod( JSValue[] arguments )
{
// Provide a response.
return "My response";
}
If (Not webView.IsLive) Then Return
' Create and acquire a Global Javascript object.
' These object persist for the lifetime of the web-view.
Using myGlobalObject As JSObject = webView.CreateGlobalJavascriptObject("myGlobalObject")
' The method name is determined from the defined handler's name.
' Therefore we cannot pass a lambda expression to this overload.
myGlobalObject.Bind(myMethod)
End Using
Public Function myMethod(arguments() As JSValue) As JSValue
' Provide a response.
Return "My response"
End Function
using ( JSObject myObj = new JSObject() )
{
// Create a property and assign a value to it.
myObj[ "myProperty" ] = "Test";
// Prints 'Test'.
Debug.Print( myObj[ "myProperty" ] );
}
Using myObj As New JSObject()
' Create a property and assign a value to it.
myObj("myProperty") = "Test"
' Prints 'Test'.
Debug.Print(myObj("myProperty"))
End Using
private void OnDocumentReady( object sender, DocumentReadyEventArgs e )
{
// Create a global object and assign it to a dynamic.
dynamic myGlobalObject = (JSObject)webView.CreateGlobalJavascriptObject( "myGlobalObject" );
// Make sure we have the object.
if ( !myGlobalObject )
return;
// Create and bind a custom method dynamically. In a dynamic expression, use
// a JavascriptAsyncMethodHandler delegate to create a JavaScript method
// that does not return a value and is called asynchronously.
myGlobalObject.myMethod = (JSFunctionAsyncHandler)OnCustomJavascriptMethod;
}
// Asynchronous JavaScript method handler.
private static void OnCustomJavascriptMethod( JSValue[] arguments )
{
IWebView webView = (IWebView)sender;
if ( !webView.IsLive )
return;
// Access essential objects of the web-page's current JavaScript environment.
var global = Global.Current;
// We can have the same handler handling many remote methods.
// Check here the method that is calling the handler.
if ( e.MethodName == "myMethod" )
{
// Make another synchronous call.
var res = global.window.confirm( "Called from an asynchronous handler.\nDo you confirm?" );
}
}
Option Explicit Off
Private Sub OnDocumentReady(sender As Object, e As DocumentReadyEventArgs)
' Create a global object and assign it to a dynamic object.
Dim myGlobalObject As Object = DirectCast(webView.CreateGlobalJavascriptObject("myGlobalObject"), JSObject)
' Make sure we have the object.
If Not myGlobalObject Then
Return
End If
' Create and bind a custom method dynamically. In a dynamic expression, use
' the JavascriptAsyncMethodHandler delegate to create a Javascript method
' that does not return a value and is called asynchronously.
myGlobalObject.myMethod = DirectCast(AddressOf OnCustomJavascriptMethod, JSFunctionAsyncHandler)
End Sub
' Asynchronous JavaScript method handler.
Private Shared Sub OnCustomJavascriptMethod(arguments() As JSValue)
Dim webView As IWebView = DirectCast(sender, IWebView)
If Not webView.IsLive Then
Return
End If
' Access essential objects of the web-page's current JavaScript environment.
Dim js As [Global] = [Global].Current
' We can have the same handler handling many remote methods.
' Check here the method that is calling the handler.
If e.MethodName = "myMethod" Then
' Make another synchronous call.
Dim res = js.window.confirm("Called from an asynchronous handler." & vbLf & "Do you confirm?")
End If
End Sub
]]>
This is the code-behind of the ChildWindow:
/// Interaction logic for ChildWindow.xaml
///
public partial class ChildWindow : Window
{
public ChildWindow()
{
InitializeComponent();
// In this example, ShowCreatedWebView of all WebControls,
// is handled by a common handler.
webControl.ShowCreatedWebView += App.OnShowNewView;
}
protected override void OnClosed( EventArgs e )
{
base.OnClosed( e );
// Destroy the WebControl and its underlying view.
webControl.Dispose();
}
// This will be set to the target URL, when this ChildWindow does not
// host a created child view. The WebControl, is bound to this property.
public Uri Source
{
get { return this.GetValue( SourceProperty ) as Uri; }
set { SetValue( SourceProperty, value ); }
}
public static readonly DependencyProperty SourceProperty =
DependencyProperty.Register( "Source",
typeof( Uri ), typeof( ChildWindow ),
new UIPropertyMetadata( null ) );
// This will be set to the created child view that the WebControl will wrap,
// when ShowCreatedWebView is the result of 'window.open'. The WebControl,
// is bound to this property.
public IntPtr NativeView
{
get { return (IntPtr)this.GetValue( ChildWindow.NativeViewProperty ); }
internal set { this.SetValue( ChildWindow.NativeViewPropertyKey, value ); }
}
private static readonly DependencyPropertyKey NativeViewPropertyKey =
DependencyProperty.RegisterReadOnly( "NativeView",
typeof( IntPtr ), typeof( ChildWindow ),
new FrameworkPropertyMetadata( IntPtr.Zero ) );
public static readonly DependencyProperty NativeViewProperty =
NativeViewPropertyKey.DependencyProperty;
}
}
]]>
''' Interaction logic for ChildWindow.xaml
'''
Partial Public Class ChildWindow
Inherits Window
Public Sub New()
InitializeComponent()
' In this example, ShowCreatedWebView of all WebControls,
' is handled by a common handler.
AddHandler webControl.ShowCreatedWebView, AddressOf App.OnShowNewView
End Sub
Protected Overrides Sub OnClosed(ByVal e As EventArgs)
MyBase.OnClosed(e)
' Destroy the WebControl and its underlying view.
webControl.Dispose()
End Sub
' This will be set to the target URL, when this ChildWindow does not
' host a created child view. The WebControl, is bound to this property.
Public Property Source() As Uri
Get
Return TryCast(Me.GetValue(SourceProperty), Uri)
End Get
Set(ByVal value As Uri)
SetValue(SourceProperty, value)
End Set
End Property
Public Shared ReadOnly SourceProperty As DependencyProperty =
DependencyProperty.Register("Source", GetType(Uri),
GetType(ChildWindow), New UIPropertyMetadata(Nothing))
' This will be set to the created child view that the WebControl will wrap,
' when ShowCreatedWebView is the result of 'window.open'. The WebControl,
' is bound to this property.
Public Property NativeView() As IntPtr
Get
Return CType(Me.GetValue(ChildWindow.NativeViewProperty), IntPtr)
End Get
Friend Set(ByVal value As IntPtr)
Me.SetValue(ChildWindow.NativeViewPropertyKey, value)
End Set
End Property
Private Shared ReadOnly NativeViewPropertyKey As DependencyPropertyKey =
DependencyProperty.RegisterReadOnly("NativeView", GetType(IntPtr),
GetType(ChildWindow), New FrameworkPropertyMetadata(IntPtr.Zero))
Public Shared ReadOnly NativeViewProperty As DependencyProperty =
NativeViewPropertyKey.DependencyProperty
End Class
End Namespace
]]>
Below is the common
/// Interaction logic for App.xaml
///
public partial class App : Application
{
private void Application_Exit( object sender, ExitEventArgs e )
{
// Shutdown the Core.
WebCore.Shutdown();
}
// This static handler, will handle the ShowCreatedWebView event for both the
// WebControl of our main application window, as well as for any other windows
// hosting WebControls.
internal static void OnShowNewView( object sender, ShowCreatedWebViewEventArgs e )
{
WebControl webControl = sender as WebControl;
if ( webControl == null )
return;
if ( !webControl.IsLive )
return;
// Create an instance of our application's child window, that will
// host the new view instance, either we wrap the created child view,
// or we let the WebControl create a new underlying web-view.
ChildWindow newWindow = new ChildWindow();
// Treat popups differently. If IsPopup is true, the event is always
// the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
// Our application does not recognize user defined, non-standard specs.
// Therefore child views opened with non-standard specs, will not be presented as
// popups but as regular new windows (still wrapping the child view however -- se below).
if ( e.IsPopup && !e.IsUserSpecsOnly )
{
// JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Int32Rect screenRect = e.Specs.InitialPosition.GetInt32Rect();
// Set the created native view as the underlying view of the
// WebControl. This will maintain the relationship between
// the parent view and the child, usually required when the new view
// is the result of 'window.open' (JS can access the parent window through
// 'window.opener'; the parent window can manipulate the child through the 'window'
// object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance;
// Do not show in the taskbar.
newWindow.ShowInTaskbar = false;
// Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow;
// Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = e.Specs.Resizable ? ResizeMode.CanResizeWithGrip : ResizeMode.NoResize;
// If the caller has not indicated a valid size for the new popup window,
// let it be opened with the default size specified at design time.
if ( ( screenRect.Width > 0 ) && ( screenRect.Height > 0 ) )
{
// Assign the indicated size.
newWindow.Width = screenRect.Width;
newWindow.Height = screenRect.Height;
}
// Show the window.
newWindow.Show();
// If the caller has not indicated a valid position for the new popup window,
// let it be opened in the default position specified at design time.
if ( ( screenRect.Y > 0 ) && ( screenRect.X > 0 ) )
{
// Move it to the indicated coordinates.
newWindow.Top = screenRect.Y;
newWindow.Left = screenRect.X;
}
}
else if ( e.IsWindowOpen || e.IsPost )
{
// No specs or only non-standard specs were specified, but the event is still
// the result of 'window.open', or of an HTML form with tagret="_blank" and method="post".
// We will open a normal window but we will still wrap the new native child view,
// maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance;
// Show the window.
newWindow.Show();
}
else
{
// The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
// and method="post"., therefore it's most probably the result of a link with target='_blank'.
// We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
// create its own underlying view. Setting Cancel to true tells the core to destroy the
// created child view.
//
// Why don't we always wrap the native view passed to ShowCreatedWebView?
//
// - In order to maintain the relationship with their parent view,
// child views execute and render under the same process (awesomium_process)
// as their parent view. If for any reason this child process crashes,
// all views related to it will be affected. When maintaining a parent-child
// relationship is not important, we prefer taking advantage of the isolated process
// architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = true;
// Note that we only explicitly navigate to the target URL, when a new view is
// about to be created, not when we wrap the created child view. This is because
// navigation to the target URL (if any), is already queued on created child views.
// We must not interrupt this navigation as we would still be breaking the parent-child
// relationship.
newWindow.Source = e.TargetURL;
// Show the window.
newWindow.Show();
}
}
}
}
]]>
''' Interaction logic for App.xaml
'''
Partial Public Class App
Inherits Application
Private Sub Application_Exit(ByVal sender As Object, ByVal e As ExitEventArgs)
' Shutdown the Core.
WebCore.Shutdown()
End Sub
' This static handler, will handle the ShowCreatedWebView event for both the
' WebControl of our main application window, as well as for any other windows
' hosting WebControls.
Friend Shared Sub OnShowNewView(ByVal sender As Object, ByVal e As ShowCreatedWebViewEventArgs)
Dim webControl As WebControl = TryCast(sender, WebControl)
If webControl Is Nothing Then Return
If Not webControl.IsLive Then Return
' Create an instance of our application's child window, that will
' host the new view instance, either we wrap the created child view,
' or we let the WebControl create a new underlying web-view.
Dim newWindow As New ChildWindow()
' Treat popups differently. If IsPopup is true, the event is always
' the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
' Our application does not recognize user defined, non-standard specs.
' Therefore child views opened with non-standard specs, will not be presented as
' popups but as regular new windows (still wrapping the child view however -- se below).
If e.IsPopup AndAlso (Not e.IsUserSpecsOnly) Then
' JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Dim screenRect As Int32Rect = e.Specs.InitialPosition.GetInt32Rect()
' Set the created native view as the underlying view of the
' WebControl. This will maintain the relationship between
' the parent view and the child, usually required when the new view
' is the result of 'window.open' (JS can access the parent window through
' 'window.opener'; the parent window can manipulate the child through the 'window'
' object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance
' Do not show in the taskbar.
newWindow.ShowInTaskbar = False
' Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow
' Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = If(e.Specs.Resizable, ResizeMode.CanResizeWithGrip, ResizeMode.NoResize)
' If the caller has not indicated a valid size for the new popup window,
' let it be opened with the default size specified at design time.
If (screenRect.Width > 0) AndAlso (screenRect.Height > 0) Then
' Assign the indicated size.
newWindow.Width = screenRect.Width
newWindow.Height = screenRect.Height
End If
' Show the window.
newWindow.Show()
' If the caller has not indicated a valid position for the new popup window,
' let it be opened in the default position specified at design time.
If (screenRect.Y > 0) AndAlso (screenRect.X > 0) Then
' Move it to the indicated coordinates.
newWindow.Top = screenRect.Y
newWindow.Left = screenRect.X
End If
ElseIf (e.IsWindowOpen OrElse e.IsPost) Then
' No specs or only non-standard specs were specified, but the event is still
' the result of 'window.open' or of an HTML form with tagret="_blank" and method="post".
' We will open a normal window but we will still wrap the new native child view,
' maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance
' Show the window.
newWindow.Show()
Else
' The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
' and method="post"., therefore it's most probably the result of a link with target='_blank'.
' We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
' create its own underlying view. Setting Cancel to true tells the core to destroy the
' created child view.
'
' Why don't we always wrap the native view passed to ShowCreatedWebView?
'
' - In order to maintain the relationship with their parent view,
' child views execute and render under the same process (awesomium_process)
' as their parent view. If for any reason this child process crashes,
' all views related to it will be affected. When maintaining a parent-child
' relationship is not important, we prefer taking advantage of the isolated process
' architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = True
' Note that we only explicitly navigate to the target URL, when a new view is
' about to be created, not when we wrap the created child view. This is because
' navigation to the target URL (if any), is already queued on created child views.
' We must not interrupt this navigation as we would still be breaking the parent-child
' relationship.
newWindow.Source = e.TargetURL
' Show the window.
newWindow.Show()
End If
End Sub
End Class
End Namespace
]]>
For the complete sample, see the C# WebControlSample of the Awesomium.NET Samples solution, available with the SDK.
private void webView_NativeViewInitialized( object sender, WebViewEventArgs e )
{
INavigationInterceptor navigationInterceptor = webView.GetService( typeof( INavigationInterceptor ) ) as INavigationInterceptor;
if ( navigationInterceptor == null )
return;
CollectionChangeAction res;
// 1.
// This call will successfully add a Deny rule for the specified URL pattern.
res = navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 2.
// This call will be ignored, as it attempts to narrow an already wider rule (1).
res = navigationInterceptor.AddRule( @"http?://*admin.somedomain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 3.
// This call will replace the first (1) rule.
res = navigationInterceptor.AddRule( @"http?://*domain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 4.
// This call will successfully add an Allow rule for the specified URL pattern.
// Although the pattern narrows the one specified in the third (3) call, this call is not
// ignored as it specifies an Allow (Whitelist) rule.
res = navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Allow );
Debug.Print( res.ToString() );
// 5.
// This call will replace everything added so far, including the third (3) rule.
// Patterns must be unique irrespective of the rule applied. An Allow and Deny rule
// cannot be applied to the same pattern. The last rule added, replaces an existing
// rule with the same pattern.
res = navigationInterceptor.AddRule( @"http?://*domain.info/*", NavigationRule.Allow );
Debug.Print( res.ToString() );
}
Private Sub webView_NativeViewInitialized(sender As Object, e As WebViewEventArgs)
Dim navigationInterceptor As INavigationInterceptor = TryCast(webView.GetService(GetType(INavigationInterceptor)), INavigationInterceptor)
If navigationInterceptor Is Nothing Then
Return
End If
Dim res As CollectionChangeAction
' 1.
' This call will successfully add a Deny rule for the specified URL pattern.
res = navigationInterceptor.AddRule("http?://*.somedomain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 2.
' This call will be ignored, as it attempts to narrow an already wider rule (1).
res = navigationInterceptor.AddRule("http?://*admin.somedomain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 3.
' This call will replace the first (1) rule.
res = navigationInterceptor.AddRule("http?://*domain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 4.
' This call will successfully add an Allow rule for the specified URL pattern.
' Although the pattern narrows the one specified in the third (3) call, this call is not
' ignored as it specifies an Allow (Whitelist) rule.
res = navigationInterceptor.AddRule("http?://*.somedomain.info/*", NavigationRule.Allow)
Debug.Print(res.ToString())
' 5.
' This call will replace everything added so far, including the third (3) rule.
' Patterns must be unique irrespective of the rule applied. An Allow and Deny rule
' cannot be applied to the same pattern. The last rule added, replaces an existing
' rule with the same pattern.
res = navigationInterceptor.AddRule("http?://*domain.info/*", NavigationRule.Allow)
Debug.Print(res.ToString())
End Sub
Output:
Add
Remove
Refresh
Add
Refresh
private void webView_NativeViewInitialized( object sender, WebViewEventArgs e )
{
INavigationInterceptor navigationInterceptor = webView.GetService( typeof( INavigationInterceptor ) ) as INavigationInterceptor;
if ( navigationInterceptor == null )
return;
CollectionChangeAction res;
// 1.
// This call will successfully add a Deny rule for the specified URL pattern.
res = navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 2.
// This call will be ignored, as it attempts to narrow an already wider rule (1).
res = navigationInterceptor.AddRule( @"http?://*admin.somedomain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 3.
// This call will replace the first (1) rule.
res = navigationInterceptor.AddRule( @"http?://*domain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 4.
// This call will successfully add an Allow rule for the specified URL pattern.
// Although the pattern narrows the one specified in the third (3) call, this call is not
// ignored as it specifies an Allow (Whitelist) rule.
res = navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Allow );
Debug.Print( res.ToString() );
// 5.
// This call will replace everything added so far, including the third (3) rule.
// Patterns must be unique irrespective of the rule applied. An Allow and Deny rule
// cannot be applied to the same pattern. The last rule added, replaces an existing
// rule with the same pattern.
res = navigationInterceptor.AddRule( @"http?://*domain.info/*", NavigationRule.Allow );
Debug.Print( res.ToString() );
}
Private Sub webView_NativeViewInitialized(sender As Object, e As WebViewEventArgs)
Dim navigationInterceptor As INavigationInterceptor = TryCast(webView.GetService(GetType(INavigationInterceptor)), INavigationInterceptor)
If navigationInterceptor Is Nothing Then
Return
End If
Dim res As CollectionChangeAction
' 1.
' This call will successfully add a Deny rule for the specified URL pattern.
res = navigationInterceptor.AddRule("http?://*.somedomain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 2.
' This call will be ignored, as it attempts to narrow an already wider rule (1).
res = navigationInterceptor.AddRule("http?://*admin.somedomain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 3.
' This call will replace the first (1) rule.
res = navigationInterceptor.AddRule("http?://*domain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 4.
' This call will successfully add an Allow rule for the specified URL pattern.
' Although the pattern narrows the one specified in the third (3) call, this call is not
' ignored as it specifies an Allow (Whitelist) rule.
res = navigationInterceptor.AddRule("http?://*.somedomain.info/*", NavigationRule.Allow)
Debug.Print(res.ToString())
' 5.
' This call will replace everything added so far, including the third (3) rule.
' Patterns must be unique irrespective of the rule applied. An Allow and Deny rule
' cannot be applied to the same pattern. The last rule added, replaces an existing
' rule with the same pattern.
res = navigationInterceptor.AddRule("http?://*domain.info/*", NavigationRule.Allow)
Debug.Print(res.ToString())
End Sub
Output:
Add
Remove
Refresh
Add
Refresh
private void webView_NativeViewInitialized( object sender, WebViewEventArgs e )
{
INavigationInterceptor navigationInterceptor = webView.GetService( typeof( INavigationInterceptor ) ) as INavigationInterceptor;
if ( navigationInterceptor == null )
return;
CollectionChangeAction res;
// 1.
// This call will successfully add a Deny rule for the specified URL pattern.
res = navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 2.
// This call will be ignored, as it attempts to narrow an already wider rule (1).
res = navigationInterceptor.AddRule( @"http?://*admin.somedomain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 3.
// This call will replace the first (1) rule.
res = navigationInterceptor.AddRule( @"http?://*domain.info/*", NavigationRule.Deny );
Debug.Print( res.ToString() );
// 4.
// This call will successfully add an Allow rule for the specified URL pattern.
// Although the pattern narrows the one specified in the third (3) call, this call is not
// ignored as it specifies an Allow (Whitelist) rule.
res = navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Allow );
Debug.Print( res.ToString() );
// 5.
// This call will replace everything added so far, including the third (3) rule.
// Patterns must be unique irrespective of the rule applied. An Allow and Deny rule
// cannot be applied to the same pattern. The last rule added, replaces an existing
// rule with the same pattern.
res = navigationInterceptor.AddRule( @"http?://*domain.info/*", NavigationRule.Allow );
Debug.Print( res.ToString() );
}
Private Sub webView_NativeViewInitialized(sender As Object, e As WebViewEventArgs)
Dim navigationInterceptor As INavigationInterceptor = TryCast(webView.GetService(GetType(INavigationInterceptor)), INavigationInterceptor)
If navigationInterceptor Is Nothing Then
Return
End If
Dim res As CollectionChangeAction
' 1.
' This call will successfully add a Deny rule for the specified URL pattern.
res = navigationInterceptor.AddRule("http?://*.somedomain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 2.
' This call will be ignored, as it attempts to narrow an already wider rule (1).
res = navigationInterceptor.AddRule("http?://*admin.somedomain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 3.
' This call will replace the first (1) rule.
res = navigationInterceptor.AddRule("http?://*domain.info/*", NavigationRule.Deny)
Debug.Print(res.ToString())
' 4.
' This call will successfully add an Allow rule for the specified URL pattern.
' Although the pattern narrows the one specified in the third (3) call, this call is not
' ignored as it specifies an Allow (Whitelist) rule.
res = navigationInterceptor.AddRule("http?://*.somedomain.info/*", NavigationRule.Allow)
Debug.Print(res.ToString())
' 5.
' This call will replace everything added so far, including the third (3) rule.
' Patterns must be unique irrespective of the rule applied. An Allow and Deny rule
' cannot be applied to the same pattern. The last rule added, replaces an existing
' rule with the same pattern.
res = navigationInterceptor.AddRule("http?://*domain.info/*", NavigationRule.Allow)
Debug.Print(res.ToString())
End Sub
Output:
Add
Remove
Refresh
Add
Refresh
// 1.
navigationInterceptor.AddRule( @"http?://*.somedomain.info/*", NavigationRule.Deny );
// 2.
navigationInterceptor.AddRule( @"http?://*.somedomain.com/*", NavigationRule.Deny );
// 3.
navigationInterceptor.AddRule( @"http?://*admin.somedomain.info/*", NavigationRule.Allow );
// 4.
navigationInterceptor.AddRule( @"http?://*admin.somedomain.com/*", NavigationRule.Allow );
// 5.
// Rules 2 and 4 will be removed.
int res = navigationInterceptor.RemoveRules( @"http?://*domain.com/*" );
Console.WriteLine( res.ToString() );
Output:
2
private void OnDocumentReady( object sender, DocumentReadyEventArgs e )
{
// Create a global object and assign it to a dynamic.
dynamic myGlobalObject = (JSObject)webView.CreateGlobalJavascriptObject( "myGlobalObject" );
// Make sure we have the object.
if ( !myGlobalObject )
return;
// Create and bind a custom method dynamically. In a dynamic expression, use
// a JavascriptAsyncMethodHandler delegate to create a JavaScript method
// that does not return a value and is called asynchronously.
myGlobalObject.myMethod = (JavascriptAsyncMethodHandler)OnCustomJavascriptMethod;
}
// Asynchronous JavaScript method handler.
private static void OnCustomJavascriptMethod( object sender, JavascriptMethodEventArgs e )
{
IWebView webView = (IWebView)sender;
if ( !webView.IsLive )
return;
// Access essential objects of the web-page's current JavaScript environment.
var global = e.Environment;
// We can have the same handler handling many remote methods.
// Check here the method that is calling the handler.
if ( e.MethodName == "myMethod" )
{
// Make another synchronous call.
var res = global.window.confirm( "Called from an asynchronous handler.\nDo you confirm?" );
}
}
Option Explicit Off
Private Sub OnDocumentReady(sender As Object, e As DocumentReadyEventArgs)
' Create a global object and assign it to a dynamic object.
Dim myGlobalObject As Object = DirectCast(webView.CreateGlobalJavascriptObject("myGlobalObject"), JSObject)
' Make sure we have the object.
If Not myGlobalObject Then
Return
End If
' Create and bind a custom method dynamically. In a dynamic expression, use
' the JavascriptAsyncMethodHandler delegate to create a Javascript method
' that does not return a value and is called asynchronously.
myGlobalObject.myMethod = DirectCast(AddressOf OnCustomJavascriptMethod, JavascriptAsyncMethodHandler)
End Sub
' Asynchronous JavaScript method handler.
Private Shared Sub OnCustomJavascriptMethod(sender As Object, e As JavascriptMethodEventArgs)
Dim webView As IWebView = DirectCast(sender, IWebView)
If Not webView.IsLive Then
Return
End If
' Access essential objects of the web-page's current JavaScript environment.
Dim global = e.Environment
' We can have the same handler handling many remote methods.
' Check here the method that is calling the handler.
If e.MethodName = "myMethod" Then
' Make another synchronous call.
Dim res = global.window.confirm("Called from an asynchronous handler." & vbLf & "Do you confirm?")
End If
End Sub
]]>
This is the code-behind of the ChildWindow:
/// Interaction logic for ChildWindow.xaml
///
public partial class ChildWindow : Window
{
public ChildWindow()
{
InitializeComponent();
// In this example, ShowCreatedWebView of all WebControls,
// is handled by a common handler.
webControl.ShowCreatedWebView += App.OnShowNewView;
}
protected override void OnClosed( EventArgs e )
{
base.OnClosed( e );
// Destroy the WebControl and its underlying view.
webControl.Dispose();
}
// This will be set to the target URL, when this ChildWindow does not
// host a created child view. The WebControl, is bound to this property.
public Uri Source
{
get { return this.GetValue( SourceProperty ) as Uri; }
set { SetValue( SourceProperty, value ); }
}
public static readonly DependencyProperty SourceProperty =
DependencyProperty.Register( "Source",
typeof( Uri ), typeof( ChildWindow ),
new UIPropertyMetadata( null ) );
// This will be set to the created child view that the WebControl will wrap,
// when ShowCreatedWebView is the result of 'window.open'. The WebControl,
// is bound to this property.
public IntPtr NativeView
{
get { return (IntPtr)this.GetValue( ChildWindow.NativeViewProperty ); }
internal set { this.SetValue( ChildWindow.NativeViewPropertyKey, value ); }
}
private static readonly DependencyPropertyKey NativeViewPropertyKey =
DependencyProperty.RegisterReadOnly( "NativeView",
typeof( IntPtr ), typeof( ChildWindow ),
new FrameworkPropertyMetadata( IntPtr.Zero ) );
public static readonly DependencyProperty NativeViewProperty =
NativeViewPropertyKey.DependencyProperty;
}
}
]]>
''' Interaction logic for ChildWindow.xaml
'''
Partial Public Class ChildWindow
Inherits Window
Public Sub New()
InitializeComponent()
' In this example, ShowCreatedWebView of all WebControls,
' is handled by a common handler.
AddHandler webControl.ShowCreatedWebView, AddressOf App.OnShowNewView
End Sub
Protected Overrides Sub OnClosed(ByVal e As EventArgs)
MyBase.OnClosed(e)
' Destroy the WebControl and its underlying view.
webControl.Dispose()
End Sub
' This will be set to the target URL, when this ChildWindow does not
' host a created child view. The WebControl, is bound to this property.
Public Property Source() As Uri
Get
Return TryCast(Me.GetValue(SourceProperty), Uri)
End Get
Set(ByVal value As Uri)
SetValue(SourceProperty, value)
End Set
End Property
Public Shared ReadOnly SourceProperty As DependencyProperty =
DependencyProperty.Register("Source", GetType(Uri),
GetType(ChildWindow), New UIPropertyMetadata(Nothing))
' This will be set to the created child view that the WebControl will wrap,
' when ShowCreatedWebView is the result of 'window.open'. The WebControl,
' is bound to this property.
Public Property NativeView() As IntPtr
Get
Return CType(Me.GetValue(ChildWindow.NativeViewProperty), IntPtr)
End Get
Friend Set(ByVal value As IntPtr)
Me.SetValue(ChildWindow.NativeViewPropertyKey, value)
End Set
End Property
Private Shared ReadOnly NativeViewPropertyKey As DependencyPropertyKey =
DependencyProperty.RegisterReadOnly("NativeView", GetType(IntPtr),
GetType(ChildWindow), New FrameworkPropertyMetadata(IntPtr.Zero))
Public Shared ReadOnly NativeViewProperty As DependencyProperty =
NativeViewPropertyKey.DependencyProperty
End Class
End Namespace
]]>
Below is the common
/// Interaction logic for App.xaml
///
public partial class App : Application
{
private void Application_Exit( object sender, ExitEventArgs e )
{
// Shutdown the Core.
WebCore.Shutdown();
}
// This static handler, will handle the ShowCreatedWebView event for both the
// WebControl of our main application window, as well as for any other windows
// hosting WebControls.
internal static void OnShowNewView( object sender, ShowCreatedWebViewEventArgs e )
{
WebControl webControl = sender as WebControl;
if ( webControl == null )
return;
if ( !webControl.IsLive )
return;
// Create an instance of our application's child window, that will
// host the new view instance, either we wrap the created child view,
// or we let the WebControl create a new underlying web-view.
ChildWindow newWindow = new ChildWindow();
// Treat popups differently. If IsPopup is true, the event is always
// the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
// Our application does not recognize user defined, non-standard specs.
// Therefore child views opened with non-standard specs, will not be presented as
// popups but as regular new windows (still wrapping the child view however -- se below).
if ( e.IsPopup && !e.IsUserSpecsOnly )
{
// JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Int32Rect screenRect = e.Specs.InitialPosition.GetInt32Rect();
// Set the created native view as the underlying view of the
// WebControl. This will maintain the relationship between
// the parent view and the child, usually required when the new view
// is the result of 'window.open' (JS can access the parent window through
// 'window.opener'; the parent window can manipulate the child through the 'window'
// object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance;
// Do not show in the taskbar.
newWindow.ShowInTaskbar = false;
// Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow;
// Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = e.Specs.Resizable ? ResizeMode.CanResizeWithGrip : ResizeMode.NoResize;
// If the caller has not indicated a valid size for the new popup window,
// let it be opened with the default size specified at design time.
if ( ( screenRect.Width > 0 ) && ( screenRect.Height > 0 ) )
{
// Assign the indicated size.
newWindow.Width = screenRect.Width;
newWindow.Height = screenRect.Height;
}
// Show the window.
newWindow.Show();
// If the caller has not indicated a valid position for the new popup window,
// let it be opened in the default position specified at design time.
if ( ( screenRect.Y > 0 ) && ( screenRect.X > 0 ) )
{
// Move it to the indicated coordinates.
newWindow.Top = screenRect.Y;
newWindow.Left = screenRect.X;
}
}
else if ( e.IsWindowOpen || e.IsPost )
{
// No specs or only non-standard specs were specified, but the event is still
// the result of 'window.open', or of an HTML form with tagret="_blank" and method="post".
// We will open a normal window but we will still wrap the new native child view,
// maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance;
// Show the window.
newWindow.Show();
}
else
{
// The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
// and method="post"., therefore it's most probably the result of a link with target='_blank'.
// We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
// create its own underlying view. Setting Cancel to true tells the core to destroy the
// created child view.
//
// Why don't we always wrap the native view passed to ShowCreatedWebView?
//
// - In order to maintain the relationship with their parent view,
// child views execute and render under the same process (awesomium_process)
// as their parent view. If for any reason this child process crashes,
// all views related to it will be affected. When maintaining a parent-child
// relationship is not important, we prefer taking advantage of the isolated process
// architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = true;
// Note that we only explicitly navigate to the target URL, when a new view is
// about to be created, not when we wrap the created child view. This is because
// navigation to the target URL (if any), is already queued on created child views.
// We must not interrupt this navigation as we would still be breaking the parent-child
// relationship.
newWindow.Source = e.TargetURL;
// Show the window.
newWindow.Show();
}
}
}
}
]]>
''' Interaction logic for App.xaml
'''
Partial Public Class App
Inherits Application
Private Sub Application_Exit(ByVal sender As Object, ByVal e As ExitEventArgs)
' Shutdown the Core.
WebCore.Shutdown()
End Sub
' This static handler, will handle the ShowCreatedWebView event for both the
' WebControl of our main application window, as well as for any other windows
' hosting WebControls.
Friend Shared Sub OnShowNewView(ByVal sender As Object, ByVal e As ShowCreatedWebViewEventArgs)
Dim webControl As WebControl = TryCast(sender, WebControl)
If webControl Is Nothing Then Return
If Not webControl.IsLive Then Return
' Create an instance of our application's child window, that will
' host the new view instance, either we wrap the created child view,
' or we let the WebControl create a new underlying web-view.
Dim newWindow As New ChildWindow()
' Treat popups differently. If IsPopup is true, the event is always
' the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
' Our application does not recognize user defined, non-standard specs.
' Therefore child views opened with non-standard specs, will not be presented as
' popups but as regular new windows (still wrapping the child view however -- se below).
If e.IsPopup AndAlso (Not e.IsUserSpecsOnly) Then
' JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Dim screenRect As Int32Rect = e.Specs.InitialPosition.GetInt32Rect()
' Set the created native view as the underlying view of the
' WebControl. This will maintain the relationship between
' the parent view and the child, usually required when the new view
' is the result of 'window.open' (JS can access the parent window through
' 'window.opener'; the parent window can manipulate the child through the 'window'
' object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance
' Do not show in the taskbar.
newWindow.ShowInTaskbar = False
' Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow
' Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = If(e.Specs.Resizable, ResizeMode.CanResizeWithGrip, ResizeMode.NoResize)
' If the caller has not indicated a valid size for the new popup window,
' let it be opened with the default size specified at design time.
If (screenRect.Width > 0) AndAlso (screenRect.Height > 0) Then
' Assign the indicated size.
newWindow.Width = screenRect.Width
newWindow.Height = screenRect.Height
End If
' Show the window.
newWindow.Show()
' If the caller has not indicated a valid position for the new popup window,
' let it be opened in the default position specified at design time.
If (screenRect.Y > 0) AndAlso (screenRect.X > 0) Then
' Move it to the indicated coordinates.
newWindow.Top = screenRect.Y
newWindow.Left = screenRect.X
End If
ElseIf (e.IsWindowOpen OrElse e.IsPost) Then
' No specs or only non-standard specs were specified, but the event is still
' the result of 'window.open' or of an HTML form with tagret="_blank" and method="post".
' We will open a normal window but we will still wrap the new native child view,
' maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance
' Show the window.
newWindow.Show()
Else
' The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
' and method="post"., therefore it's most probably the result of a link with target='_blank'.
' We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
' create its own underlying view. Setting Cancel to true tells the core to destroy the
' created child view.
'
' Why don't we always wrap the native view passed to ShowCreatedWebView?
'
' - In order to maintain the relationship with their parent view,
' child views execute and render under the same process (awesomium_process)
' as their parent view. If for any reason this child process crashes,
' all views related to it will be affected. When maintaining a parent-child
' relationship is not important, we prefer taking advantage of the isolated process
' architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = True
' Note that we only explicitly navigate to the target URL, when a new view is
' about to be created, not when we wrap the created child view. This is because
' navigation to the target URL (if any), is already queued on created child views.
' We must not interrupt this navigation as we would still be breaking the parent-child
' relationship.
newWindow.Source = e.TargetURL
' Show the window.
newWindow.Show()
End If
End Sub
End Class
End Namespace
]]>
For the complete sample, see the C# WebControlSample of the Awesomium.NET Samples solution, available with the SDK.
window.open("file.html", "", "someFlag");
window.open("file.html", "", "background=black");
In the first example, the
window.open("file.html", "", "someFlag");
window.open("file.html", "", "background=black");
In the first example, the
window.open("file.html", "", "top=50,left=50,background=black,width=640,height=480");
In this example,
]]>
This is the code-behind of the ChildWindow:
/// Interaction logic for ChildWindow.xaml
///
public partial class ChildWindow : Window
{
public ChildWindow()
{
InitializeComponent();
// In this example, ShowCreatedWebView of all WebControls,
// is handled by a common handler.
webControl.ShowCreatedWebView += App.OnShowNewView;
}
protected override void OnClosed( EventArgs e )
{
base.OnClosed( e );
// Destroy the WebControl and its underlying view.
webControl.Dispose();
}
// This will be set to the target URL, when this ChildWindow does not
// host a created child view. The WebControl, is bound to this property.
public Uri Source
{
get { return this.GetValue( SourceProperty ) as Uri; }
set { SetValue( SourceProperty, value ); }
}
public static readonly DependencyProperty SourceProperty =
DependencyProperty.Register( "Source",
typeof( Uri ), typeof( ChildWindow ),
new UIPropertyMetadata( null ) );
// This will be set to the created child view that the WebControl will wrap,
// when ShowCreatedWebView is the result of 'window.open'. The WebControl,
// is bound to this property.
public IntPtr NativeView
{
get { return (IntPtr)this.GetValue( ChildWindow.NativeViewProperty ); }
internal set { this.SetValue( ChildWindow.NativeViewPropertyKey, value ); }
}
private static readonly DependencyPropertyKey NativeViewPropertyKey =
DependencyProperty.RegisterReadOnly( "NativeView",
typeof( IntPtr ), typeof( ChildWindow ),
new FrameworkPropertyMetadata( IntPtr.Zero ) );
public static readonly DependencyProperty NativeViewProperty =
NativeViewPropertyKey.DependencyProperty;
}
}
]]>
''' Interaction logic for ChildWindow.xaml
'''
Partial Public Class ChildWindow
Inherits Window
Public Sub New()
InitializeComponent()
' In this example, ShowCreatedWebView of all WebControls,
' is handled by a common handler.
AddHandler webControl.ShowCreatedWebView, AddressOf App.OnShowNewView
End Sub
Protected Overrides Sub OnClosed(ByVal e As EventArgs)
MyBase.OnClosed(e)
' Destroy the WebControl and its underlying view.
webControl.Dispose()
End Sub
' This will be set to the target URL, when this ChildWindow does not
' host a created child view. The WebControl, is bound to this property.
Public Property Source() As Uri
Get
Return TryCast(Me.GetValue(SourceProperty), Uri)
End Get
Set(ByVal value As Uri)
SetValue(SourceProperty, value)
End Set
End Property
Public Shared ReadOnly SourceProperty As DependencyProperty =
DependencyProperty.Register("Source", GetType(Uri),
GetType(ChildWindow), New UIPropertyMetadata(Nothing))
' This will be set to the created child view that the WebControl will wrap,
' when ShowCreatedWebView is the result of 'window.open'. The WebControl,
' is bound to this property.
Public Property NativeView() As IntPtr
Get
Return CType(Me.GetValue(ChildWindow.NativeViewProperty), IntPtr)
End Get
Friend Set(ByVal value As IntPtr)
Me.SetValue(ChildWindow.NativeViewPropertyKey, value)
End Set
End Property
Private Shared ReadOnly NativeViewPropertyKey As DependencyPropertyKey =
DependencyProperty.RegisterReadOnly("NativeView", GetType(IntPtr),
GetType(ChildWindow), New FrameworkPropertyMetadata(IntPtr.Zero))
Public Shared ReadOnly NativeViewProperty As DependencyProperty =
NativeViewPropertyKey.DependencyProperty
End Class
End Namespace
]]>
Below is the common
/// Interaction logic for App.xaml
///
public partial class App : Application
{
private void Application_Exit( object sender, ExitEventArgs e )
{
// Shutdown the Core.
WebCore.Shutdown();
}
// This static handler, will handle the ShowCreatedWebView event for both the
// WebControl of our main application window, as well as for any other windows
// hosting WebControls.
internal static void OnShowNewView( object sender, ShowCreatedWebViewEventArgs e )
{
WebControl webControl = sender as WebControl;
if ( webControl == null )
return;
if ( !webControl.IsLive )
return;
// Create an instance of our application's child window, that will
// host the new view instance, either we wrap the created child view,
// or we let the WebControl create a new underlying web-view.
ChildWindow newWindow = new ChildWindow();
// Treat popups differently. If IsPopup is true, the event is always
// the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
// Our application does not recognize user defined, non-standard specs.
// Therefore child views opened with non-standard specs, will not be presented as
// popups but as regular new windows (still wrapping the child view however -- se below).
if ( e.IsPopup && !e.IsUserSpecsOnly )
{
// JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Int32Rect screenRect = e.Specs.InitialPosition.GetInt32Rect();
// Set the created native view as the underlying view of the
// WebControl. This will maintain the relationship between
// the parent view and the child, usually required when the new view
// is the result of 'window.open' (JS can access the parent window through
// 'window.opener'; the parent window can manipulate the child through the 'window'
// object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance;
// Do not show in the taskbar.
newWindow.ShowInTaskbar = false;
// Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow;
// Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = e.Specs.Resizable ? ResizeMode.CanResizeWithGrip : ResizeMode.NoResize;
// If the caller has not indicated a valid size for the new popup window,
// let it be opened with the default size specified at design time.
if ( ( screenRect.Width > 0 ) && ( screenRect.Height > 0 ) )
{
// Assign the indicated size.
newWindow.Width = screenRect.Width;
newWindow.Height = screenRect.Height;
}
// Show the window.
newWindow.Show();
// If the caller has not indicated a valid position for the new popup window,
// let it be opened in the default position specified at design time.
if ( ( screenRect.Y > 0 ) && ( screenRect.X > 0 ) )
{
// Move it to the indicated coordinates.
newWindow.Top = screenRect.Y;
newWindow.Left = screenRect.X;
}
}
else if ( e.IsWindowOpen || e.IsPost )
{
// No specs or only non-standard specs were specified, but the event is still
// the result of 'window.open', or of an HTML form with tagret="_blank" and method="post".
// We will open a normal window but we will still wrap the new native child view,
// maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance;
// Show the window.
newWindow.Show();
}
else
{
// The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
// and method="post"., therefore it's most probably the result of a link with target='_blank'.
// We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
// create its own underlying view. Setting Cancel to true tells the core to destroy the
// created child view.
//
// Why don't we always wrap the native view passed to ShowCreatedWebView?
//
// - In order to maintain the relationship with their parent view,
// child views execute and render under the same process (awesomium_process)
// as their parent view. If for any reason this child process crashes,
// all views related to it will be affected. When maintaining a parent-child
// relationship is not important, we prefer taking advantage of the isolated process
// architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = true;
// Note that we only explicitly navigate to the target URL, when a new view is
// about to be created, not when we wrap the created child view. This is because
// navigation to the target URL (if any), is already queued on created child views.
// We must not interrupt this navigation as we would still be breaking the parent-child
// relationship.
newWindow.Source = e.TargetURL;
// Show the window.
newWindow.Show();
}
}
}
}
]]>
''' Interaction logic for App.xaml
'''
Partial Public Class App
Inherits Application
Private Sub Application_Exit(ByVal sender As Object, ByVal e As ExitEventArgs)
' Shutdown the Core.
WebCore.Shutdown()
End Sub
' This static handler, will handle the ShowCreatedWebView event for both the
' WebControl of our main application window, as well as for any other windows
' hosting WebControls.
Friend Shared Sub OnShowNewView(ByVal sender As Object, ByVal e As ShowCreatedWebViewEventArgs)
Dim webControl As WebControl = TryCast(sender, WebControl)
If webControl Is Nothing Then Return
If Not webControl.IsLive Then Return
' Create an instance of our application's child window, that will
' host the new view instance, either we wrap the created child view,
' or we let the WebControl create a new underlying web-view.
Dim newWindow As New ChildWindow()
' Treat popups differently. If IsPopup is true, the event is always
' the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
' Our application does not recognize user defined, non-standard specs.
' Therefore child views opened with non-standard specs, will not be presented as
' popups but as regular new windows (still wrapping the child view however -- se below).
If e.IsPopup AndAlso (Not e.IsUserSpecsOnly) Then
' JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Dim screenRect As Int32Rect = e.Specs.InitialPosition.GetInt32Rect()
' Set the created native view as the underlying view of the
' WebControl. This will maintain the relationship between
' the parent view and the child, usually required when the new view
' is the result of 'window.open' (JS can access the parent window through
' 'window.opener'; the parent window can manipulate the child through the 'window'
' object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance
' Do not show in the taskbar.
newWindow.ShowInTaskbar = False
' Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow
' Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = If(e.Specs.Resizable, ResizeMode.CanResizeWithGrip, ResizeMode.NoResize)
' If the caller has not indicated a valid size for the new popup window,
' let it be opened with the default size specified at design time.
If (screenRect.Width > 0) AndAlso (screenRect.Height > 0) Then
' Assign the indicated size.
newWindow.Width = screenRect.Width
newWindow.Height = screenRect.Height
End If
' Show the window.
newWindow.Show()
' If the caller has not indicated a valid position for the new popup window,
' let it be opened in the default position specified at design time.
If (screenRect.Y > 0) AndAlso (screenRect.X > 0) Then
' Move it to the indicated coordinates.
newWindow.Top = screenRect.Y
newWindow.Left = screenRect.X
End If
ElseIf (e.IsWindowOpen OrElse e.IsPost) Then
' No specs or only non-standard specs were specified, but the event is still
' the result of 'window.open' or of an HTML form with tagret="_blank" and method="post".
' We will open a normal window but we will still wrap the new native child view,
' maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance
' Show the window.
newWindow.Show()
Else
' The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
' and method="post"., therefore it's most probably the result of a link with target='_blank'.
' We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
' create its own underlying view. Setting Cancel to true tells the core to destroy the
' created child view.
'
' Why don't we always wrap the native view passed to ShowCreatedWebView?
'
' - In order to maintain the relationship with their parent view,
' child views execute and render under the same process (awesomium_process)
' as their parent view. If for any reason this child process crashes,
' all views related to it will be affected. When maintaining a parent-child
' relationship is not important, we prefer taking advantage of the isolated process
' architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = True
' Note that we only explicitly navigate to the target URL, when a new view is
' about to be created, not when we wrap the created child view. This is because
' navigation to the target URL (if any), is already queued on created child views.
' We must not interrupt this navigation as we would still be breaking the parent-child
' relationship.
newWindow.Source = e.TargetURL
' Show the window.
newWindow.Show()
End If
End Sub
End Class
End Namespace
]]>
For the complete sample, see the C# WebControlSample of the Awesomium.NET Samples solution, available with the SDK.
private void toolStripButton2_Click( object sender, EventArgs e )
{
if ( !webControl.IsLive )
return;
webControl.GoForward();
}
Private Sub ToolStripButton2_Click( sender As Object, e As EventArgs ) Handles ToolStripButton2.Click
If Not m_WebControl.IsLive Then Return
m_WebControl.GoForward()
End Sub
]]>
This is the code-behind of the ChildWindow:
/// Interaction logic for ChildWindow.xaml
///
public partial class ChildWindow : Window
{
public ChildWindow()
{
InitializeComponent();
// In this example, ShowCreatedWebView of all WebControls,
// is handled by a common handler.
webControl.ShowCreatedWebView += App.OnShowNewView;
}
protected override void OnClosed( EventArgs e )
{
base.OnClosed( e );
// Destroy the WebControl and its underlying view.
webControl.Dispose();
}
// This will be set to the target URL, when this ChildWindow does not
// host a created child view. The WebControl, is bound to this property.
public Uri Source
{
get { return this.GetValue( SourceProperty ) as Uri; }
set { SetValue( SourceProperty, value ); }
}
public static readonly DependencyProperty SourceProperty =
DependencyProperty.Register( "Source",
typeof( Uri ), typeof( ChildWindow ),
new UIPropertyMetadata( null ) );
// This will be set to the created child view that the WebControl will wrap,
// when ShowCreatedWebView is the result of 'window.open'. The WebControl,
// is bound to this property.
public IntPtr NativeView
{
get { return (IntPtr)this.GetValue( ChildWindow.NativeViewProperty ); }
internal set { this.SetValue( ChildWindow.NativeViewPropertyKey, value ); }
}
private static readonly DependencyPropertyKey NativeViewPropertyKey =
DependencyProperty.RegisterReadOnly( "NativeView",
typeof( IntPtr ), typeof( ChildWindow ),
new FrameworkPropertyMetadata( IntPtr.Zero ) );
public static readonly DependencyProperty NativeViewProperty =
NativeViewPropertyKey.DependencyProperty;
}
}
]]>
''' Interaction logic for ChildWindow.xaml
'''
Partial Public Class ChildWindow
Inherits Window
Public Sub New()
InitializeComponent()
' In this example, ShowCreatedWebView of all WebControls,
' is handled by a common handler.
AddHandler webControl.ShowCreatedWebView, AddressOf App.OnShowNewView
End Sub
Protected Overrides Sub OnClosed(ByVal e As EventArgs)
MyBase.OnClosed(e)
' Destroy the WebControl and its underlying view.
webControl.Dispose()
End Sub
' This will be set to the target URL, when this ChildWindow does not
' host a created child view. The WebControl, is bound to this property.
Public Property Source() As Uri
Get
Return TryCast(Me.GetValue(SourceProperty), Uri)
End Get
Set(ByVal value As Uri)
SetValue(SourceProperty, value)
End Set
End Property
Public Shared ReadOnly SourceProperty As DependencyProperty =
DependencyProperty.Register("Source", GetType(Uri),
GetType(ChildWindow), New UIPropertyMetadata(Nothing))
' This will be set to the created child view that the WebControl will wrap,
' when ShowCreatedWebView is the result of 'window.open'. The WebControl,
' is bound to this property.
Public Property NativeView() As IntPtr
Get
Return CType(Me.GetValue(ChildWindow.NativeViewProperty), IntPtr)
End Get
Friend Set(ByVal value As IntPtr)
Me.SetValue(ChildWindow.NativeViewPropertyKey, value)
End Set
End Property
Private Shared ReadOnly NativeViewPropertyKey As DependencyPropertyKey =
DependencyProperty.RegisterReadOnly("NativeView", GetType(IntPtr),
GetType(ChildWindow), New FrameworkPropertyMetadata(IntPtr.Zero))
Public Shared ReadOnly NativeViewProperty As DependencyProperty =
NativeViewPropertyKey.DependencyProperty
End Class
End Namespace
]]>
Below is the common
/// Interaction logic for App.xaml
///
public partial class App : Application
{
private void Application_Exit( object sender, ExitEventArgs e )
{
// Shutdown the Core.
WebCore.Shutdown();
}
// This static handler, will handle the ShowCreatedWebView event for both the
// WebControl of our main application window, as well as for any other windows
// hosting WebControls.
internal static void OnShowNewView( object sender, ShowCreatedWebViewEventArgs e )
{
WebControl webControl = sender as WebControl;
if ( webControl == null )
return;
if ( !webControl.IsLive )
return;
// Create an instance of our application's child window, that will
// host the new view instance, either we wrap the created child view,
// or we let the WebControl create a new underlying web-view.
ChildWindow newWindow = new ChildWindow();
// Treat popups differently. If IsPopup is true, the event is always
// the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
// Our application does not recognize user defined, non-standard specs.
// Therefore child views opened with non-standard specs, will not be presented as
// popups but as regular new windows (still wrapping the child view however -- se below).
if ( e.IsPopup && !e.IsUserSpecsOnly )
{
// JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Int32Rect screenRect = e.Specs.InitialPosition.GetInt32Rect();
// Set the created native view as the underlying view of the
// WebControl. This will maintain the relationship between
// the parent view and the child, usually required when the new view
// is the result of 'window.open' (JS can access the parent window through
// 'window.opener'; the parent window can manipulate the child through the 'window'
// object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance;
// Do not show in the taskbar.
newWindow.ShowInTaskbar = false;
// Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow;
// Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = e.Specs.Resizable ? ResizeMode.CanResizeWithGrip : ResizeMode.NoResize;
// If the caller has not indicated a valid size for the new popup window,
// let it be opened with the default size specified at design time.
if ( ( screenRect.Width > 0 ) && ( screenRect.Height > 0 ) )
{
// Assign the indicated size.
newWindow.Width = screenRect.Width;
newWindow.Height = screenRect.Height;
}
// Show the window.
newWindow.Show();
// If the caller has not indicated a valid position for the new popup window,
// let it be opened in the default position specified at design time.
if ( ( screenRect.Y > 0 ) && ( screenRect.X > 0 ) )
{
// Move it to the indicated coordinates.
newWindow.Top = screenRect.Y;
newWindow.Left = screenRect.X;
}
}
else if ( e.IsWindowOpen || e.IsPost )
{
// No specs or only non-standard specs were specified, but the event is still
// the result of 'window.open', or of an HTML form with tagret="_blank" and method="post".
// We will open a normal window but we will still wrap the new native child view,
// maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance;
// Show the window.
newWindow.Show();
}
else
{
// The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
// and method="post"., therefore it's most probably the result of a link with target='_blank'.
// We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
// create its own underlying view. Setting Cancel to true tells the core to destroy the
// created child view.
//
// Why don't we always wrap the native view passed to ShowCreatedWebView?
//
// - In order to maintain the relationship with their parent view,
// child views execute and render under the same process (awesomium_process)
// as their parent view. If for any reason this child process crashes,
// all views related to it will be affected. When maintaining a parent-child
// relationship is not important, we prefer taking advantage of the isolated process
// architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = true;
// Note that we only explicitly navigate to the target URL, when a new view is
// about to be created, not when we wrap the created child view. This is because
// navigation to the target URL (if any), is already queued on created child views.
// We must not interrupt this navigation as we would still be breaking the parent-child
// relationship.
newWindow.Source = e.TargetURL;
// Show the window.
newWindow.Show();
}
}
}
}
]]>
''' Interaction logic for App.xaml
'''
Partial Public Class App
Inherits Application
Private Sub Application_Exit(ByVal sender As Object, ByVal e As ExitEventArgs)
' Shutdown the Core.
WebCore.Shutdown()
End Sub
' This static handler, will handle the ShowCreatedWebView event for both the
' WebControl of our main application window, as well as for any other windows
' hosting WebControls.
Friend Shared Sub OnShowNewView(ByVal sender As Object, ByVal e As ShowCreatedWebViewEventArgs)
Dim webControl As WebControl = TryCast(sender, WebControl)
If webControl Is Nothing Then Return
If Not webControl.IsLive Then Return
' Create an instance of our application's child window, that will
' host the new view instance, either we wrap the created child view,
' or we let the WebControl create a new underlying web-view.
Dim newWindow As New ChildWindow()
' Treat popups differently. If IsPopup is true, the event is always
' the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
' Our application does not recognize user defined, non-standard specs.
' Therefore child views opened with non-standard specs, will not be presented as
' popups but as regular new windows (still wrapping the child view however -- se below).
If e.IsPopup AndAlso (Not e.IsUserSpecsOnly) Then
' JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Dim screenRect As Int32Rect = e.Specs.InitialPosition.GetInt32Rect()
' Set the created native view as the underlying view of the
' WebControl. This will maintain the relationship between
' the parent view and the child, usually required when the new view
' is the result of 'window.open' (JS can access the parent window through
' 'window.opener'; the parent window can manipulate the child through the 'window'
' object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance
' Do not show in the taskbar.
newWindow.ShowInTaskbar = False
' Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow
' Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = If(e.Specs.Resizable, ResizeMode.CanResizeWithGrip, ResizeMode.NoResize)
' If the caller has not indicated a valid size for the new popup window,
' let it be opened with the default size specified at design time.
If (screenRect.Width > 0) AndAlso (screenRect.Height > 0) Then
' Assign the indicated size.
newWindow.Width = screenRect.Width
newWindow.Height = screenRect.Height
End If
' Show the window.
newWindow.Show()
' If the caller has not indicated a valid position for the new popup window,
' let it be opened in the default position specified at design time.
If (screenRect.Y > 0) AndAlso (screenRect.X > 0) Then
' Move it to the indicated coordinates.
newWindow.Top = screenRect.Y
newWindow.Left = screenRect.X
End If
ElseIf (e.IsWindowOpen OrElse e.IsPost) Then
' No specs or only non-standard specs were specified, but the event is still
' the result of 'window.open' or of an HTML form with tagret="_blank" and method="post".
' We will open a normal window but we will still wrap the new native child view,
' maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance
' Show the window.
newWindow.Show()
Else
' The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
' and method="post"., therefore it's most probably the result of a link with target='_blank'.
' We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
' create its own underlying view. Setting Cancel to true tells the core to destroy the
' created child view.
'
' Why don't we always wrap the native view passed to ShowCreatedWebView?
'
' - In order to maintain the relationship with their parent view,
' child views execute and render under the same process (awesomium_process)
' as their parent view. If for any reason this child process crashes,
' all views related to it will be affected. When maintaining a parent-child
' relationship is not important, we prefer taking advantage of the isolated process
' architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = True
' Note that we only explicitly navigate to the target URL, when a new view is
' about to be created, not when we wrap the created child view. This is because
' navigation to the target URL (if any), is already queued on created child views.
' We must not interrupt this navigation as we would still be breaking the parent-child
' relationship.
newWindow.Source = e.TargetURL
' Show the window.
newWindow.Show()
End If
End Sub
End Class
End Namespace
]]>
For the complete sample, see the C# WebControlSample of the Awesomium.NET Samples solution, available with the SDK.
window.open("file.html","","location=0,toolbar=0,channelmode=1");
window.open("file.html","","location=1,toolbar=1,fullscreen=1");
window.open("file.html","","fullscreen=1");
JSValue windowVal = webView.ExecuteJavascriptWithResult( "window" );
if ( !windowVal )
return;
using ( dynamic window = (JSObject)windowVal )
{
JSValue childVal = window.open( "", "", "width=300, height=200, top=50, left=50" );
if ( !childVal )
return;
using ( dynamic childWindow = (JSObject)childVal )
{
//
}
}
JSObject window = webView.ExecuteJavascriptWithResult( "window" );
if ( !window )
return;
JSFunction closeFunction = webView.ExecuteJavascriptWithResult( "window.close" );
if ( !closeFunction )
return;
WebCore.Initialize( new WebConfig() { LogLevel = LogLevel.Verbose } );
WebCore.Initialize( New WebConfig() With { .LogLevel = LogLevel.Verbose } )
// Force native WebGL rendering.
WebCore.Initialize( new WebConfig() { AdditionalOptions = new string[] { "--use-gl=desktop" } } );
' Force native WebGL rendering.
WebCore.Initialize( New WebConfig() With { .AdditionalOptions = New String() { "--use-gl=desktop" } } )
using System;
using System.Linq;
using Awesomium.Core;
using System.Windows;
using System.Collections.Generic;
namespace WpfApplication1
{
///
/// Interaction logic for MainWindow.xaml
///
public partial class MainWindow : Window
{
public MainWindow()
{
// This may not be the only window in our application,
// but the WebCore can only be initialized once per process.
// Prevent attempting to re-initialize which would throw
// an exception, by checking for WebCore.IsInitialized.
if ( !WebCore.IsInitialized )
WebCore.Initialize( new WebConfig()
{
HomeURL = new Uri( "http://www.awesomium.com" ),
RemoteDebuggingPort = 2229,
LogLevel = LogLevel.Verbose
} );
InitializeComponent();
}
}
}
Imports System.Linq
Imports Awesomium.Core
Imports System.Windows
Imports System.Collections.Generic
Namespace WpfApplication1
'''
''' Interaction logic for MainWindow.xaml
'''
Public Partial Class MainWindow
Inherits Window
Public Sub New()
' This may not be the only window in our application,
' but the WebCore can only be initialized once per process.
' Prevent attempting to re-initialize which would throw
' an exception, by checking for WebCore.IsInitialized.
If Not WebCore.IsInitialized Then
WebCore.Initialize(New WebConfig() With { _
.HomeURL = New Uri("https://www.awesomium.com"), _
.RemoteDebuggingPort = 2229, _
.LogLevel = LogLevel.Verbose _
})
End If
InitializeComponent()
End Sub
End Class
End Namespace
using System;
using System.Linq;
using Awesomium.Core;
using System.Windows;
using System.Collections.Generic;
namespace WpfApplication1
{
///
/// Interaction logic for MainWindow.xaml
///
public partial class MainWindow : Window
{
public MainWindow()
{
// This may not be the only window in our application,
// but the WebCore can only be initialized once per process.
// Prevent attempting to re-initialize which would throw
// an exception, by checking for WebCore.IsInitialized.
if ( !WebCore.IsInitialized )
WebCore.Initialize( new WebConfig()
{
HomeURL = new Uri( "http://www.awesomium.com" ),
RemoteDebuggingPort = 2229,
LogLevel = LogLevel.Verbose
} );
InitializeComponent();
}
}
}
Imports System.Linq
Imports Awesomium.Core
Imports System.Windows
Imports System.Collections.Generic
Namespace WpfApplication1
'''
''' Interaction logic for MainWindow.xaml
'''
Public Partial Class MainWindow
Inherits Window
Public Sub New()
' This may not be the only window in our application,
' but the WebCore can only be initialized once per process.
' Prevent attempting to re-initialize which would throw
' an exception, by checking for WebCore.IsInitialized.
If Not WebCore.IsInitialized Then
WebCore.Initialize(New WebConfig() With { _
.HomeURL = New Uri("https://www.awesomium.com"), _
.RemoteDebuggingPort = 2229, _
.LogLevel = LogLevel.Verbose _
})
End If
InitializeComponent()
End Sub
End Class
End Namespace
SynchronizationContext syncCtx = SynchronizationContext.Current;
bool isValidSynchronizationContext = ( syncCtx != null ) && ( syncCtx.GetType() != typeof( SynchronizationContext ) );
Dim m_SyncCtx As SynchronizationContext = SynchronizationContext.Current
Dim m_IsValidSynchronizationContext As Boolean = ( syncCtx InNot Nothing ) AndAlso ( syncCtx.GetType() <> GetType( SynchronizationContext ) )
SynchronizationContext *syncCtx = SynchronizationContext->Current;
bool isValidSynchronizationContext = (syncCtx != nullptr) && (syncCtx->GetType() != SynchronizationContext::typeid);
using ( WebSession session = WebCore.CreateWebSession( new WebPreferences() { CustomCSS = "::-webkit-scrollbar { visibility: hidden; }" } ) )
{
using ( WebView view = WebCore.CreateWebView( 1280, 960, session ) )
{
bool finishedLoading = false;
view.LoadURL( new Uri( "http://www.awesomium.com" ) );
view.LoadingFrameComplete += ( s, e ) =>
{
if ( e.IsMainFrame )
finishedLoading = true;
};
while ( !finishedLoading )
{
Thread.Sleep( 100 );
WebCore.Update();
}
BitmapSurface surface = (BitmapSurface)view.Surface;
surface.SaveToPNG( "result.png", true );
}
}
Using session As WebSession = WebCore.CreateWebSession(New WebPreferences() With {.CustomCSS = "::-webkit-scrollbar { visibility: hidden; }"})
Using view As WebView = WebCore.CreateWebView(1280, 960, session)
Dim finishedLoading As Boolean = False
view.LoadURL(New Uri("http://www.awesomium.com"))
AddHandler view.LoadingFrameComplete, Sub(s, e)
If e.IsMainFrame Then
finishedLoading = True
End If
End Sub
Do While Not finishedLoading
Thread.Sleep(100)
WebCore.Update()
Loop
Dim surface As BitmapSurface = CType(view.Surface, BitmapSurface)
surface.SaveToPNG("result.png", True)
End Using
End Using
string dataPath = @"C:\SomePath";
WebSession session = WebCore.Sessions[ dataPath ] ?? WebCore.CreateWebSession( dataPath, WebPreferences.Default );
Technology specific
using ( WebSession session = WebCore.CreateWebSession( "C:\\MyCache", new WebPreferences() { CustomCSS = "::-webkit-scrollbar { visibility: hidden; }" } ) )
{
using ( WebView view = WebCore.CreateWebView( 1280, 960, session ) )
{
bool finishedLoading = false;
view.LoadURL( new Uri( "http://www.awesomium.com" ) );
view.LoadingFrameComplete += ( s, e ) =>
{
if ( e.IsMainFrame )
finishedLoading = true;
BitmapSurface surface = (BitmapSurface)view.Surface;
surface.SaveToPNG( "result.png", true );
};
if ( WebCore.UpdateState == WebCoreUpdateState.NotUpdating )
WebCore.Run();
}
}
Using session As WebSession = WebCore.CreateWebSession("C:\MyCache", New WebPreferences() With {.CustomCSS = "::-webkit-scrollbar { visibility: hidden; }"})
Using view As WebView = WebCore.CreateWebView(1280, 960, session)
Dim finishedLoading As Boolean = False
view.LoadURL(New Uri("http://www.awesomium.com"))
AddHandler view.LoadingFrameComplete, Sub(s, e)
If e.IsMainFrame Then
finishedLoading = True
End If
Dim surface As BitmapSurface = CType(view.Surface, BitmapSurface)
surface.SaveToPNG("result.png", True)
End Sub
If WebCore.UpdateState = WebCoreUpdateState.NotUpdating Then
WebCore.Run()
End If
End Using
End Using
bool isRunning = WebCore.UpdateState != WebCoreUpdateState.NotUpdating;
Dim isRunning As Boolean = WebCore.UpdateState <> WebCoreUpdateState.NotUpdating
private void toolStripButton2_Click( object sender, EventArgs e )
{
if ( !webControl.IsLive )
return;
webControl.GoForward();
}
Private Sub ToolStripButton2_Click( sender As Object, e As EventArgs ) Handles ToolStripButton2.Click
If Not m_WebControl.IsLive Then Return
m_WebControl.GoForward()
End Sub
]]>
This is the code-behind of the ChildWindow:
/// Interaction logic for ChildWindow.xaml
///
public partial class ChildWindow : Window
{
public ChildWindow()
{
InitializeComponent();
// In this example, ShowCreatedWebView of all WebControls,
// is handled by a common handler.
webControl.ShowCreatedWebView += App.OnShowNewView;
}
protected override void OnClosed( EventArgs e )
{
base.OnClosed( e );
// Destroy the WebControl and its underlying view.
webControl.Dispose();
}
// This will be set to the target URL, when this ChildWindow does not
// host a created child view. The WebControl, is bound to this property.
public Uri Source
{
get { return this.GetValue( SourceProperty ) as Uri; }
set { SetValue( SourceProperty, value ); }
}
public static readonly DependencyProperty SourceProperty =
DependencyProperty.Register( "Source",
typeof( Uri ), typeof( ChildWindow ),
new UIPropertyMetadata( null ) );
// This will be set to the created child view that the WebControl will wrap,
// when ShowCreatedWebView is the result of 'window.open'. The WebControl,
// is bound to this property.
public IntPtr NativeView
{
get { return (IntPtr)this.GetValue( ChildWindow.NativeViewProperty ); }
internal set { this.SetValue( ChildWindow.NativeViewPropertyKey, value ); }
}
private static readonly DependencyPropertyKey NativeViewPropertyKey =
DependencyProperty.RegisterReadOnly( "NativeView",
typeof( IntPtr ), typeof( ChildWindow ),
new FrameworkPropertyMetadata( IntPtr.Zero ) );
public static readonly DependencyProperty NativeViewProperty =
NativeViewPropertyKey.DependencyProperty;
}
}
]]>
''' Interaction logic for ChildWindow.xaml
'''
Partial Public Class ChildWindow
Inherits Window
Public Sub New()
InitializeComponent()
' In this example, ShowCreatedWebView of all WebControls,
' is handled by a common handler.
AddHandler webControl.ShowCreatedWebView, AddressOf App.OnShowNewView
End Sub
Protected Overrides Sub OnClosed(ByVal e As EventArgs)
MyBase.OnClosed(e)
' Destroy the WebControl and its underlying view.
webControl.Dispose()
End Sub
' This will be set to the target URL, when this ChildWindow does not
' host a created child view. The WebControl, is bound to this property.
Public Property Source() As Uri
Get
Return TryCast(Me.GetValue(SourceProperty), Uri)
End Get
Set(ByVal value As Uri)
SetValue(SourceProperty, value)
End Set
End Property
Public Shared ReadOnly SourceProperty As DependencyProperty =
DependencyProperty.Register("Source", GetType(Uri),
GetType(ChildWindow), New UIPropertyMetadata(Nothing))
' This will be set to the created child view that the WebControl will wrap,
' when ShowCreatedWebView is the result of 'window.open'. The WebControl,
' is bound to this property.
Public Property NativeView() As IntPtr
Get
Return CType(Me.GetValue(ChildWindow.NativeViewProperty), IntPtr)
End Get
Friend Set(ByVal value As IntPtr)
Me.SetValue(ChildWindow.NativeViewPropertyKey, value)
End Set
End Property
Private Shared ReadOnly NativeViewPropertyKey As DependencyPropertyKey =
DependencyProperty.RegisterReadOnly("NativeView", GetType(IntPtr),
GetType(ChildWindow), New FrameworkPropertyMetadata(IntPtr.Zero))
Public Shared ReadOnly NativeViewProperty As DependencyProperty =
NativeViewPropertyKey.DependencyProperty
End Class
End Namespace
]]>
Below is the common
/// Interaction logic for App.xaml
///
public partial class App : Application
{
private void Application_Exit( object sender, ExitEventArgs e )
{
// Shutdown the Core.
WebCore.Shutdown();
}
// This static handler, will handle the ShowCreatedWebView event for both the
// WebControl of our main application window, as well as for any other windows
// hosting WebControls.
internal static void OnShowNewView( object sender, ShowCreatedWebViewEventArgs e )
{
WebControl webControl = sender as WebControl;
if ( webControl == null )
return;
if ( !webControl.IsLive )
return;
// Create an instance of our application's child window, that will
// host the new view instance, either we wrap the created child view,
// or we let the WebControl create a new underlying web-view.
ChildWindow newWindow = new ChildWindow();
// Treat popups differently. If IsPopup is true, the event is always
// the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
// Our application does not recognize user defined, non-standard specs.
// Therefore child views opened with non-standard specs, will not be presented as
// popups but as regular new windows (still wrapping the child view however -- se below).
if ( e.IsPopup && !e.IsUserSpecsOnly )
{
// JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Int32Rect screenRect = e.Specs.InitialPosition.GetInt32Rect();
// Set the created native view as the underlying view of the
// WebControl. This will maintain the relationship between
// the parent view and the child, usually required when the new view
// is the result of 'window.open' (JS can access the parent window through
// 'window.opener'; the parent window can manipulate the child through the 'window'
// object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance;
// Do not show in the taskbar.
newWindow.ShowInTaskbar = false;
// Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow;
// Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = e.Specs.Resizable ? ResizeMode.CanResizeWithGrip : ResizeMode.NoResize;
// If the caller has not indicated a valid size for the new popup window,
// let it be opened with the default size specified at design time.
if ( ( screenRect.Width > 0 ) && ( screenRect.Height > 0 ) )
{
// Assign the indicated size.
newWindow.Width = screenRect.Width;
newWindow.Height = screenRect.Height;
}
// Show the window.
newWindow.Show();
// If the caller has not indicated a valid position for the new popup window,
// let it be opened in the default position specified at design time.
if ( ( screenRect.Y > 0 ) && ( screenRect.X > 0 ) )
{
// Move it to the indicated coordinates.
newWindow.Top = screenRect.Y;
newWindow.Left = screenRect.X;
}
}
else if ( e.IsWindowOpen || e.IsPost )
{
// No specs or only non-standard specs were specified, but the event is still
// the result of 'window.open', or of an HTML form with tagret="_blank" and method="post".
// We will open a normal window but we will still wrap the new native child view,
// maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance;
// Show the window.
newWindow.Show();
}
else
{
// The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
// and method="post"., therefore it's most probably the result of a link with target='_blank'.
// We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
// create its own underlying view. Setting Cancel to true tells the core to destroy the
// created child view.
//
// Why don't we always wrap the native view passed to ShowCreatedWebView?
//
// - In order to maintain the relationship with their parent view,
// child views execute and render under the same process (awesomium_process)
// as their parent view. If for any reason this child process crashes,
// all views related to it will be affected. When maintaining a parent-child
// relationship is not important, we prefer taking advantage of the isolated process
// architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = true;
// Note that we only explicitly navigate to the target URL, when a new view is
// about to be created, not when we wrap the created child view. This is because
// navigation to the target URL (if any), is already queued on created child views.
// We must not interrupt this navigation as we would still be breaking the parent-child
// relationship.
newWindow.Source = e.TargetURL;
// Show the window.
newWindow.Show();
}
}
}
}
]]>
''' Interaction logic for App.xaml
'''
Partial Public Class App
Inherits Application
Private Sub Application_Exit(ByVal sender As Object, ByVal e As ExitEventArgs)
' Shutdown the Core.
WebCore.Shutdown()
End Sub
' This static handler, will handle the ShowCreatedWebView event for both the
' WebControl of our main application window, as well as for any other windows
' hosting WebControls.
Friend Shared Sub OnShowNewView(ByVal sender As Object, ByVal e As ShowCreatedWebViewEventArgs)
Dim webControl As WebControl = TryCast(sender, WebControl)
If webControl Is Nothing Then Return
If Not webControl.IsLive Then Return
' Create an instance of our application's child window, that will
' host the new view instance, either we wrap the created child view,
' or we let the WebControl create a new underlying web-view.
Dim newWindow As New ChildWindow()
' Treat popups differently. If IsPopup is true, the event is always
' the result of 'window.open' (IsWindowOpen is also true, so no need to check it).
' Our application does not recognize user defined, non-standard specs.
' Therefore child views opened with non-standard specs, will not be presented as
' popups but as regular new windows (still wrapping the child view however -- se below).
If e.IsPopup AndAlso (Not e.IsUserSpecsOnly) Then
' JSWindowOpenSpecs.InitialPosition indicates screen coordinates.
Dim screenRect As Int32Rect = e.Specs.InitialPosition.GetInt32Rect()
' Set the created native view as the underlying view of the
' WebControl. This will maintain the relationship between
' the parent view and the child, usually required when the new view
' is the result of 'window.open' (JS can access the parent window through
' 'window.opener'; the parent window can manipulate the child through the 'window'
' object returned from the 'window.open' call).
newWindow.NativeView = e.NewViewInstance
' Do not show in the taskbar.
newWindow.ShowInTaskbar = False
' Set a border-style to indicate a popup.
newWindow.WindowStyle = System.Windows.WindowStyle.ToolWindow
' Set resizing mode depending on the indicated specs.
newWindow.ResizeMode = If(e.Specs.Resizable, ResizeMode.CanResizeWithGrip, ResizeMode.NoResize)
' If the caller has not indicated a valid size for the new popup window,
' let it be opened with the default size specified at design time.
If (screenRect.Width > 0) AndAlso (screenRect.Height > 0) Then
' Assign the indicated size.
newWindow.Width = screenRect.Width
newWindow.Height = screenRect.Height
End If
' Show the window.
newWindow.Show()
' If the caller has not indicated a valid position for the new popup window,
' let it be opened in the default position specified at design time.
If (screenRect.Y > 0) AndAlso (screenRect.X > 0) Then
' Move it to the indicated coordinates.
newWindow.Top = screenRect.Y
newWindow.Left = screenRect.X
End If
ElseIf (e.IsWindowOpen OrElse e.IsPost) Then
' No specs or only non-standard specs were specified, but the event is still
' the result of 'window.open' or of an HTML form with tagret="_blank" and method="post".
' We will open a normal window but we will still wrap the new native child view,
' maintaining its relationship with the parent window.
newWindow.NativeView = e.NewViewInstance
' Show the window.
newWindow.Show()
Else
' The event is not the result of 'window.open' or of an HTML form with tagret="_blank"
' and method="post"., therefore it's most probably the result of a link with target='_blank'.
' We will not be wrapping the created view; we let the WebControl hosted in ChildWindow
' create its own underlying view. Setting Cancel to true tells the core to destroy the
' created child view.
'
' Why don't we always wrap the native view passed to ShowCreatedWebView?
'
' - In order to maintain the relationship with their parent view,
' child views execute and render under the same process (awesomium_process)
' as their parent view. If for any reason this child process crashes,
' all views related to it will be affected. When maintaining a parent-child
' relationship is not important, we prefer taking advantage of the isolated process
' architecture of Awesomium and let each view be rendered in a separate process.
e.Cancel = True
' Note that we only explicitly navigate to the target URL, when a new view is
' about to be created, not when we wrap the created child view. This is because
' navigation to the target URL (if any), is already queued on created child views.
' We must not interrupt this navigation as we would still be breaking the parent-child
' relationship.
newWindow.Source = e.TargetURL
' Show the window.
newWindow.Show()
End If
End Sub
End Class
End Namespace
]]>
For the complete sample, see the C# WebControlSample of the Awesomium.NET Samples solution, available with the SDK.
<option>
<optgroup label="xxx">
using ( WebSession session = WebCore.CreateWebSession( "C:\\MyCache", new WebPreferences() { CustomCSS = "::-webkit-scrollbar { visibility: hidden; }" } ) )
{
using ( WebView view = WebCore.CreateWebView( 1280, 960, session ) )
{
bool finishedLoading = false;
view.LoadURL( new Uri( "http://www.awesomium.com" ) );
view.LoadingFrameComplete += ( s, e ) =>
{
if ( e.IsMainFrame )
finishedLoading = true;
BitmapSurface surface = (BitmapSurface)view.Surface;
surface.SaveToPNG( "result.png", true );
};
if ( WebCore.UpdateState == WebCoreUpdateState.NotUpdating )
WebCore.Run();
}
}
Using session As WebSession = WebCore.CreateWebSession("C:\MyCache", New WebPreferences() With {.CustomCSS = "::-webkit-scrollbar { visibility: hidden; }"})
Using view As WebView = WebCore.CreateWebView(1280, 960, session)
Dim finishedLoading As Boolean = False
view.LoadURL(New Uri("http://www.awesomium.com"))
AddHandler view.LoadingFrameComplete, Sub(s, e)
If e.IsMainFrame Then
finishedLoading = True
End If
Dim surface As BitmapSurface = CType(view.Surface, BitmapSurface)
surface.SaveToPNG("result.png", True)
End Sub
If WebCore.UpdateState = WebCoreUpdateState.NotUpdating Then
WebCore.Run()
End If
End Using
End Using