SilverlightHost Class
Reports details about the Silverlight-based application's instantiation settings, and exposes some of the HTML DOM values for the hosted Silverlight plug-in instance.
Namespace: System.Windows.Interop
Assembly: System.Windows (in System.Windows.dll)
The SilverlightHost type exposes the following members.
| Name | Description | |
|---|---|---|
|
SilverlightHost | Infrastructure. Initializes a new instance of the SilverlightHost class. |
| Name | Description | |
|---|---|---|
|
Background | Gets the background color value that was applied to the Silverlight plug-in as part of instantiation settings. |
|
|
Content | Gets the "Content" sub-object of this SilverlightHost. |
|
|
InitParams | Gets the initialization parameters that were passed as part of HTML initialization of a Silverlight plug-in. |
|
|
IsLoaded | Gets a value that indicates whether the hosted Silverlight plug-in has finished loading. |
|
|
NavigationState | Gets or sets a URI fragment that represents the current navigation state. |
|
|
Settings | Gets the "Settings" sub-object of this SilverlightHost. |
|
|
Source | Gets the URI of the package or XAML file that specifies the XAML content to render. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
|
|
GetType | Gets the Type of the current instance. (Inherited from Object.) |
|
|
IsVersionSupported | Returns a value that indicates whether the installed Silverlight plug-in supports the specified version. |
|
|
MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
|
|
ToString | Returns a string that represents the current object. (Inherited from Object.) |
Much of the information that is reported by a SilverlightHost object is the same information that could be obtained from properties of the Silverlight plug-in object in the JavaScript API of the Silverlight object model. For instance, the Background color that was set as part of the Silverlight plug-in instantiation can be obtained by getting the current SilverlightHost instance from the Application.Host property, and then getting the Background property.
The Content property returns a value of type Content, which represents the visual state of the plug-in. This type enables you to perform common tasks, such as display the plug-in in full-screen mode or retrieve its current size.
The Settings property returns a value of type Settings, which provides access to some plug-in configuration values.
The following code example demonstrates how to use this class.
// The Host object, which represents the host Silverlight plug-in. System.Windows.Interop.SilverlightHost host = Application.Current.Host; // The following code demonstrates how to use the Host object // to access other APIs in the System.Windows.Interop namespace. // The IsVersionSupported method. This method is useful when // you want to implement an upgrade experience in managed code. bool isSupported = host.IsVersionSupported("2.0.30908.0"); // Read-only properties of the Host object. System.Windows.Media.Color pluginBackground = host.Background; bool loaded = host.IsLoaded; Uri source = host.Source; // The Settings object, which represents Web browser settings. System.Windows.Interop.Settings settings = host.Settings; // Read/write properties of the Settings object. settings.EnableFrameRateCounter = true; settings.EnableRedrawRegions = true; settings.MaxFrameRate = 60; // Read-only properties of the Settings object. bool windowless = settings.Windowless; bool htmlAccessEnabled = settings.EnableHTMLAccess; // The Content object, which represents the plug-in display area. System.Windows.Interop.Content content = host.Content; // The read/write IsFullScreen property of the Content object. // See also the Content.FullScreenChanged event. bool isFullScreen = content.IsFullScreen; // Read-only properties of the Content object. These properties do // not contain meaningful values until after the Content.Resized // event occurs for the first time. double actualWidth = content.ActualWidth; double actualHeight = content.ActualHeight;
For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.
