AsyncControl Class

Provides an asynchronous display of the background thread worker log.

Inheritance Hierarchy

System.Object
  System.Web.UI.Control
    System.Web.UI.TemplateControl
      System.Web.UI.UserControl
        CMS.Base.Web.UI.AbstractUserControl
          CMS.Base.Web.UI.InlineUserControl
            CMS.UIControls.CMSUserControl
              CMS.UIControls.AsyncControl

Namespace: CMS.UIControls
Assembly: CMS.UIControls (in CMS.UIControls.dll) Version: 10.0.0

Syntax

public class AsyncControl : CMSUserControl, 
	ICallbackEventHandler, IPostBackEventHandler

The AsyncControl type exposes the following members.

Constructors

	Name	Description
Public method	AsyncControl

Properties

	Name	Description
Public property	AttachToRunningThread	If set, control tries to find already running thread to attach to on load
Public property	CancelAction	Action performed if Cancel button is pressed. If not specified then Cancel stops the worker.
Public property	CancelButton	Cancel button
Public property	ComponentName	Component name (Inherited from AbstractUserControl.)
Public property	ContinueOnAnyServer	If true, the async process and it's subsequent callbacks can finish on other server that executed the action. Disable with caution as there is no guarantee that non-sticky web farm will be switching between servers, and if it doesn't, the process continuation may hang. If possible, leverage ProcessData with serializable content (Data property) so that the process can continue on other server rather than using static variables to pass the data to the next request.
Public property	ControlContext	Control context. (Inherited from CMSUserControl.)
Public property	ControlGUID	Unique ID of the control within the given request. (Inherited from CMSUserControl.)
Public property	CurrentDocument	Current document (Inherited from AbstractUserControl.)
Public property	CurrentLog	Current log context.
Public property	CurrentPageInfo	Current page info (Inherited from AbstractUserControl.)
Public property	CurrentResolver	Control's resolver (Inherited from CMSUserControl.)
Public property	CurrentSite	Current site (Inherited from AbstractUserControl.)
Public property	CurrentUser	Current user (Inherited from AbstractUserControl.)
Public property	DisplayMode	Gets or sets display mode of the control. (Inherited from CMSUserControl.)
Public property	DocumentManager	Document manager control (Inherited from AbstractUserControl.)
Public property	EditedObject	Control's edited object (Inherited from CMSUserControl.)
Public property	FinishClientCallback	Name of the JS function called on client when the process finishes either successfully or with error
Public property	HeaderActions	Header actions control (Inherited from AbstractUserControl.)
Public property	IsCMSDesk	Determines whether the current control lies on the page that is currently located under the CMS Desk. (Inherited from CMSUserControl.)
Public property	IsLiveSite	Indicates if control is used on live site. (Inherited from AbstractUserControl.)
Public property	Item	Gets or sets the value of the column. (Inherited from InlineUserControl.)
Public property	Log	Gets the current log.
Public property	LogContext	Gets the current log.
Public property	LogContextNames	List of log context names separated by semicolon that should be received by this async control log from a general API call. Use empty string for context which logs messages that do not provide context. Direct logging to context always logs the message without checking the context.
Public property	LogPanel	Message panel where log is being displayed.
Public property	MaxLogLines	Maximum log length. (0 = unlimited)
Public property	MessagesPlaceHolder	Placeholder for messages (Inherited from AbstractUserControl.)
Public property	Parameter	Process parameter.
Public property	PostbackOnError	True if the postback should occur after error.
Public property	PostbackOnFinish	True if the postback should occur after finished.
Public property	ProcessData	Process messages
Public property	ProcessGUID	Process GUID.
Protected property	Properties	Control properties. (Inherited from InlineUserControl.)
Public property	ProvideLogContext	If true, the async process provides a log context
Public property	RelativePath	Page relative path. (Inherited from CMSUserControl.)
Public property Code example	ResourcePrefix	Prefix for the resource strings which are used for the localization by the control and its child controls. (Inherited from AbstractUserControl.)
Public property	ResourcePrefixes	List of cached resource prefixes for the parent hierarchy (Inherited from AbstractUserControl.)
Public property	ReversedLog	Indicates if the logging is reversed. Default is true.
Public property	ShortID	Short ID of the control. (Inherited from AbstractUserControl.)
Public property	Status	Gets the worker status.
Public property	StopProcessing	Indicates if the control should perform the operations. (Inherited from AbstractUserControl.)
Public property	TypeName	Returns the object type name. (Inherited from CMSUserControl.)
Public property	UIContext	Control's UI Context (Inherited from CMSUserControl.)
Public property	UseCMSDeskAccessDeniedPage	Gets or sets the value that indicates whether CMSDesk access denied page should be used. (Inherited from CMSUserControl.)
Public property	UseFileStrings	Indicates if the control should use the string from resource file.
Public property	UsesLocalMessagesPlaceHolder	Indicates if control uses local messages placeholder (Inherited from AbstractUserControl.)
Protected property	ViewState	ViewState - overridden for the Master page ViewState fix. (Inherited from InlineUserControl.)
Public property	Worker	Asynchronous worker.

Methods

	Name	Description
Public method	AddConfirmation	Adds confirmation text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddError	Adds error text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddHeaderAction	Adds specified action to the page header actions. (Inherited from AbstractUserControl.)
Public method	AddInformation	Adds information text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddLog	Adds the log information.
Public method	AddMessage	Adds message text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AddWarning	Adds warning text to existing message on the page. (Inherited from AbstractUserControl.)
Public method	AttachToThread	Attaches to the given asynchronous process.
Protected method	CreateChildControls	Creates the child controls (Overrides Control.CreateChildControls().)
Public method	EnsureControls	Interface for control that is able to explicitly ensure its child controls (Inherited from AbstractUserControl.)
Public method	EnsureLog	Ensures the logging context.
Public method	Eval(String)	Evaluates the given value (Inherited from AbstractUserControl.)
Public method	Eval(String, Boolean)	Evaluates the item data (safe version), with html encoding. (Inherited from AbstractUserControl.)
Public method	EvalBool	Evaluates the item data and converts it to the bool. (Inherited from AbstractUserControl.)
Public method	EvalDateTime	Evaluates the item data and converts it to the date time. (Inherited from AbstractUserControl.)
Public method	EvalDouble	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalGuid	Evaluates the item data and converts it to the guid. (Inherited from AbstractUserControl.)
Public method	EvalHTML	Evaluates the item data and doesn't encode it. Method should be used for columns with html content. (Inherited from AbstractUserControl.)
Public method	EvalHtmlAttribute	Evaluates the item data, encodes it to be used in HTML attribute. (Inherited from AbstractUserControl.)
Public method	EvalInteger	Evaluates the item data and converts it to the integer. (Inherited from AbstractUserControl.)
Public method	EvalJSString	Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'". (Inherited from AbstractUserControl.)
Public method	EvalText(String)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Public method	EvalText(String, Boolean)	Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content. (Inherited from AbstractUserControl.)
Protected method	GetAccessDeniedPageUrl	Returns access denied page with dependence on current setting. (Inherited from CMSUserControl.)
Public method	GetCallbackResult	Returns the result of a callback.
Public method	GetCancelScript	Gets the script which cancels the execution of the worker
Public method	GetFlagIconUrl	Returns resolved path to the flag image for the specified culture. (Inherited from AbstractUserControl.)
Public method	GetImagePath	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetImageUrl	Gets UI image relative path. (Inherited from AbstractUserControl.)
Public method	GetString	Returns localized string. (Overrides AbstractUserControl.GetString(String, String).)
Public method	GetValue(String)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	GetValue<ReturnType>(String, ReturnType)	Returns the value of the given property. (Inherited from InlineUserControl.)
Public method	HasValue	Returns true if the value of the given property is set. (Inherited from InlineUserControl.)
Public method	LoadUserControl	Loads the user control based on the given path (Inherited from AbstractUserControl.)
Public method	LogAndShowError	Logs the exception and (Inherited from AbstractUserControl.)
Public method	OnContentLoaded	Method that is called when the control content is loaded. (Inherited from InlineUserControl.)
Protected method	OnInit	Init event handler. (Inherited from AbstractUserControl.)
Protected method	OnLoad	OnLoad event handler (Overrides CMSUserControl.OnLoad(EventArgs).)
Protected method	OnPreRender	PreRender event handler (Overrides AbstractUserControl.OnPreRender(EventArgs).)
Public method	RaiseCallbackEvent	Raises the callback event.
Public method	RaiseCancel	Raises the Cancel event.
Public method	RaiseError	Raises the Error event.
Public method	RaiseFinished	Raises the finished event.
Public method	RaisePostBackEvent	Processes the postback event
Public method	RedirectToAccessDenied(String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(Int32, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToAccessDenied(String, String)	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Protected method	RedirectToUIElementAccessDenied	Redirects the user to Access denied page. (Inherited from CMSUserControl.)
Public method	ReleaseContext	Releases the control context. (Inherited from CMSUserControl.)
Protected method	Render	Render event handler. (Inherited from AbstractUserControl.)
Public method	ResolveUrl	Resolves the given URL (Inherited from AbstractUserControl.)
Public method	RunAsync	Runs the asynchronous action.
Public method	SetContext	Sets the control context. (Inherited from CMSUserControl.)
Public method	SetValue	Sets the property value of the control, setting the value affects only local property value. (Inherited from InlineUserControl.)
Public method	ShowConfirmation	Shows the general confirmation message. (Inherited from AbstractUserControl.)
Public method	ShowError	Shows the specified error message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowChangesSaved	Shows the general changes saved message. (Inherited from AbstractUserControl.)
Public method	ShowInformation	Shows the given information on the page, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowMessage(MessageTypeEnum, String, String, String, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Protected method	ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean)	Shows the specified message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	ShowWarning	Shows the specified warning message, optionally with a tooltip text. (Inherited from AbstractUserControl.)
Public method	Stop	Stops the worker.
Protected method	TrackViewState	Tracks the view state. (Inherited from InlineUserControl.)
Protected method	WorkerExists	Returns true if the worker for current control exists.

Extension Methods

	Name	Description
Public Extension Method	CallHandled	Calls the method handled by the exception handler. If the call doesn't succeed, the problem is reported through parent IExceptionHandler control instead of throwing unhandled exception for the entire page. Returns true, if the call succeeded, otherwise returns false. (Defined by ControlsExtensions.)
Public Extension Method	GetString	Gets the string by the specified resource key (Defined by ControlsExtensions.)

Events

	Name	Description
Public event	OnCancel	Cancel event handler.
Public event	OnError	Error event handler.
Public event	OnFinished	Finished event handler.
Public event	OnRequestLog	Request log event handler.