BrowserInteropHelper.HostScript Property

.NET Framework (current version)
 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets a script object that provides access to the HTML window object, custom script functions, and global variables for the HTML page, if the XAML browser application (XBAP) is hosted in a frame.

Namespace:   System.Windows.Interop
Assembly:  PresentationFramework (in PresentationFramework.dll)

Public Shared ReadOnly Property HostScript As Object

Property Value

Type: System.Object

A script object that provides access to the HTML window object, custom script functions, and global variables for the HTML page, if the XAML browser application (XBAP) is hosted in a frame; otherwise, null.

With the returned HostScript object, you can access the properties, methods, and events of the HTML window object, call a script function directly, or access a global variable. The syntax to access these items uses the familiar dot notation.

For more information about the window object, see window object in the Dynamic HTML (DHTML) documentation.

The HostScript property returns null if the frame is navigated to from a cross-domain location.

This feature can be turned off for Internet Explorer by setting the ScriptInteropDisallow registry value. For more information, see Security (WPF).

The following example demonstrates how to retrieve the HostScript object and close the browser window.

<Grid>
   <Button Width="160" Height="60" Click="Button_Click" Content="Close Browser Window" />
 </Grid>
Private Sub Button_Click(ByVal sender As Object, ByVal e As RoutedEventArgs)
    ' Retrieve the script object  The XBAP must be hosted in a frame or
    ' the HostScript object will be null.
    Dim scriptObject = BrowserInteropHelper.HostScript

    ' Call close to close the browser window.
    scriptObject.Close()
End Sub

.NET Framework
Available since 4.0
Return to top
Show: