WebUpdateController Members

WebUpdateController overview

Public Constructors

WebUpdateController Constructor

Initializes a new instance of the WebUpdateController class.

Public Properties

AccessKey (inherited from WebControl)

Keyboard shortcut used by the control.

ApplicationId

Gets or sets a Guid that is used to uniquely identify the application that is being updated. Must match the ID used in the update project that creates the updatees downloaded and applied by the control.

AppRelativeTemplateSourceDirectory (inherited from Control)

The virtual directory of the Page or UserControl that contains this control.

Attributes (inherited from WebControl)

Tag attributes of the control.

AutoDetectProxy

Gets or sets a value that specifies whether the controller will automatically detect proxy settings.

BackColor (inherited from WebControl)

Color of the background of the control.

BorderColor (inherited from WebControl)

Color of the border around the control.

BorderStyle (inherited from WebControl)

Style of the border around the control.

BorderWidth (inherited from WebControl)

Width of the border around the control.

BypassProxyOnLocal

Gets or sets a value that specifies whether to bypass using a proxy server for local addresses.

ClientID (inherited from Control)

The ID of the control that is rendered for the client.

ControlledRolloutEnabled

Gets or sets a value that specifies whether controlled rollouts are enabled for updates received by the controller. When controlled rollouts are enabled, clients are updated over the amount of time specified in the ControlledRolloutHours property.

ControlledRolloutHours

Gets or sets the period of time over which clients will be updated when controlled rollouts are enabled.

Controls (inherited from Control)

The collection of child controls owned by the control.

ControlStyle (inherited from WebControl)

The style associated with the control.

ControlStyleCreated (inherited from WebControl)

Whether the style associated with the control has been created.

CssClass (inherited from WebControl)

CSS Class name applied to the control.

DisableControllerIpc

Gets or sets a value determining whether or not Update Controller IPC is enabled.

ElevationType

Gets or sets a value that specifies the level of elevation used to apply updates.

EnableAutoChaining

Gets or sets a value determining whether multiple updates can be chained together.

Enabled (inherited from WebControl)

Enabled state of the control.

EnableViewState (inherited from Control)

Whether the control automatically saves its state for use in round-trips.

Font (inherited from WebControl)

The font used for text within the control.

ForeColor (inherited from WebControl)

Color of the text within the control.

Height (inherited from WebControl)

The height of the control.

ID (inherited from Control)

Programmatic name of the control.

NamingContainer (inherited from Control)

The containing control or page within which ID is unique.

Page (inherited from Control)

The page containing the control.

Parent (inherited from Control)

The control containing this control.

ProxyAddress

Gets or sets the address of the proxy server the WebUpdateController will use when connecting to the update location.

ProxyDomain

Gets or sets the domain used for authentication on the proxy server.

ProxyPassword

Gets or sets the password used for authentication on the proxy server.

ProxyUseDefaultCredentials

Gets or sets a value that specifies whether the WebUpdateController will use the credentials of the currently logged on user when accessing the proxy server.

ProxyUserName

Gets or sets the user name used for authentication on the proxy server.

PublicKeyToken

Gets or sets the public key token of the strong name key used to create the updates that will be downloaded and applied by the control. If an update cannot be validated using this key, it will not be applied.

Site (inherited from Control)

Site of the control.

Style (inherited from WebControl)

Low-level access to control styles.

TabIndex (inherited from WebControl)

The tab order of the control.

TemplateControl (inherited from Control)

The TemplateControl that hosts this control.

TemplateSourceDirectory (inherited from Control)

The virtual directory of the Page or UserControl that contains this control.

ToolTip (inherited from WebControl)

The tooltip displayed when the mouse is over the control.

UniqueID (inherited from Control)

The unique ID of the control within the page.

UpdateCompletionNotificationPath

Gets or sets a relative file path on the web server where completion Notifications can be written. Notification Actions executed in the update process writes the notifications, and the Web Update Controller uses the notification file to detect the completion of the update process. If a location is not specified, the Web Update controller will not attempt to detect completion of the update process.

UpdateLocation

Gets or sets the network location of the updates for the application. Any UNC, HTTP, or FTP location can be specified.

UpdateLocationDomain

Gets or sets a domain user name to use to log in to access the location specified in UpdateLocation.

UpdateLocationPassword

Gets or sets a password to use to log in to access the location specified in UpdateLocation.

UpdateLocationUserName

Gets or sets a user name to use to log in to access the location specified in UpdateLocation.

Version

Gets or sets the current version number of the application used for update purposes.

Visible (inherited from Control)

Indicates whether the control is visible and rendered.

Width (inherited from WebControl)

The width of the control.

Public Methods

BeginApplyUpdate

This method starts an ApplyUpdate() operation.

BeginCheckForUpdate

This method starts a CheckForUpdate() operation. The method returns immediately and the proxy updater performs the operation asynchronously. BeginCheckForUpdate() returns an object that can be passed to GetOperationStatus() to retrieve information about the CheckForUpdate() operation. This identity will also be assigned to the UpdateInformation that represents the found update, if one is found. Since multiple WebUpdateControllers can call BeginCheckForUpdate(), each using different properties (such as UpdateLocation), this identity can be used to verify that the UpdateInformation you choose to download is the correct one. Only one asynchronous operation can be in progress at once; until the BeginCheckForUpdate() operation is finished (either CompleteOrUnknown or Failed), BeginCheckForUpdate(), BeginDownloadUpdate(), and BeginApplyUpdate() cannot be called. Use CancelOperation(), passing the identity returned by BeginCheckForUpdate(), to cancel the check.

BeginDownloadUpdate

This method starts a DownloadUpdate() operation. The method returns immediately and the update controller performs the operation asynchronously.

CancelOperation

This method cancels the operation specified by operationIdentity, if that operation is currently in progress (Working). BeginCheckForUpdate() and BeginDownloadUpdate() start operations that can be cancelled.

GetCurrentUpdate

This method immediately returns an UpdateInformation instance containing information about the update found by the proxy updater. If the proxy updater has not found an update, GetCurrentUpdate() returns null. UpdateInformation contains the same information as Kjs.AppLife.Controller.UpdateInformation, with an additional property that contains the identity for the CheckForUpdate operation that was used to retrieve the UpdateInformation.

GetOperationStatus

This method is used to immediately retrieve information about a known long-running operation on the proxy updater. It can be used for information about the current operation or a previously completed operation; however, information about previously completed operations is periodically discarded by the proxy updater.

GetStatus

This method immediately returns a ControllerStatus instance that contains information about the controller.

Public Events

DataBinding (inherited from Control)

Fires when the control's data binding expressions are to be evaluated.

Disposed (inherited from Control)

Fires when the control has been disposed.

Init (inherited from Control)

Fires when the page has been initialized.

Load (inherited from Control)

Fires when the page has been loaded.

PreRender (inherited from Control)

Fires before the page is rendered.

Unload (inherited from Control)

Fires when the page is unloaded.

UpdateFound

Raised when an update is found. In this handler, an updates avialbility can be manipulated based on local information, such as licensing.

Protected Properties

ViewState (inherited from Control)

Current viewstate of the control.

Protected Methods

LoadControlState

Overridden. Restores control-state information from a previous page request that was saved by the SaveControlState method.

OnInit

Overridden. Raises the Init event.

SaveControlState

Overridden. Saves any server control state changes that have occurred since the time the page was posted back to the server.

See Also

WebUpdateController Class | Kjs.AppLife.Update.Web Namespace