Sys.UI.Silverlight.Control

Collapse All

Silverlight

[Note: This topic is pre-release documentation and is subject to change in future releases. Blank topics are included as placeholders.]

Provides the client base type for the ASP.NET Silverlight server control.

Namespace: Sys.UI.Silverlight.

Inherits: Sys.UI.Control

Sys.UI.Silverlight.Control = function(domElement)

Usage

var a = new Sys.UI.Silverlight.Control(domElement);

Parameters

Parameter	Definition
domElement	A string that represents the DOM element that is a span element around the actual object or embed element. The control attaches to the actual object or embed element rather than the span. The span container is passed here because when the plug-in is not installed in Microsoft Internet Explorer, the object or embed element is not found although it is in the DOM. This results in an Ajax error that the control requires an element. If no Silverlight object is found within the span, the control attaches to the span so there is no error.

Parameter

Definition

domElement

A string that represents the DOM element that is a span element around the actual object or embed element.

The control attaches to the actual object or embed element rather than the span.

The span container is passed here because when the plug-in is not installed in Microsoft Internet Explorer, the object or embed element is not found although it is in the DOM. This results in an Ajax error that the control requires an element.

If no Silverlight object is found within the span, the control attaches to the span so there is no error.

Public Constructors

Name	Description
Sys.UI.Silverlight.Control Constructor	Creates a new instance of the Control class.

Members

Member	Description
Sys.UI.Silverlight.Control.scaleMode Property	Gets or sets how the Silverlight document should be scaled to fit in the Silverlight plug-in.
Sys.UI.Silverlight.Control.source Property	Gets or sets the file name of the source document of the Silverlight plug-in.
Sys.UI.Silverlight.Control.splashScreenSource Property	Gets or sets the file name of the splash screen image to render while the document that is referenced in the Sys.UI.Silverlight.Control.source property is loading.
Sys.UI.Silverlight.Control.addEventListener Method	Called to add an event handler function that listens to an event of a Silverlight element.
Sys.UI.Silverlight.Control.dispose Method	Disposes the control.
Sys.UI.Silverlight.Control.initialize Method	Initializes the control.
Sys.UI.Silverlight.Control.onPluginError Method	Called when a Silverlight plug-in error occurs.
Sys.UI.Silverlight.Control.onPluginFullScreenChanged Method	Called when full-screen mode is toggled.
Sys.UI.Silverlight.Control.onPluginLoaded Method	Called when Silverlight has loaded the specified source file.
Sys.UI.Silverlight.Control.onPluginResized Method	Called when the Silverlight plug-in content area has been resized.
Sys.UI.Silverlight.Control.pluginDispose Method	Called on disposal when Silverlight has been previously loaded.
Sys.UI.Silverlight.Control.removeEventListener Method	Called to remove an event handler function from listening to an event of a Silverlight element.
Sys.UI.Silverlight.Control.pluginError Event	Occurs when a Silverlight plug-in error is raised.
Sys.UI.Silverlight.Control.pluginFullScreenChanged Event	Occurs when the Silverlight full-screen mode changes.
Sys.UI.Silverlight.Control.pluginLoaded Event	Occurs when the Silverlight plug-in has loaded.
Sys.UI.Silverlight.Control.pluginResized Event	Occurs when the Silverlight plug-in has been resized.
Sys.UI.Silverlight.Control.pluginSourceDownloadComplete Event	Occurs when the document specified in the Sys.UI.Silverlight.Control.source property is completely downloaded.
Sys.UI.Silverlight.Control.pluginSourceDownloadProgressChanged Event	Occurs when there is a change in the percentage of referenced by the Sys.UI.Silverlight.Control.source property that has been downloaded.

Remarks

The Sys.UI.Silverlight.Control class represents the Silverlight plug-in in the browser. A Control class instance is rendered in the HTML markup from an .aspx page that has an ASP.NET Silverlight server control.

If an ASP.NET Web page has more than one Silverlight server control, there will be an instance of the Control for each Silverlight server control on the page.

Property values that are set for the Silverlight server control are passed to the client Control instance as the client object's initial property values.

You can modify the values of the Control properties and access its methods by using client script. You can write handlers for client events of the Control that run when those events occur at run time.

The Silverlight server control supports properties that indicate the name of a JavaScript function to run when a client event occurs on the Control client control. For example, you can set the value of the OnPluginLoaded()()() property of the Silverlight ASP.NET server control to the name of a JavaScript function that runs when the plug-in finishes loading.

Reference

Silverlight