AsyncControl Class |
Namespace: CMS.UIControls
public class AsyncControl : CMSUserControl, ICallbackEventHandler, IPostBackEventHandler
The AsyncControl type exposes the following members.
Name | Description | |
---|---|---|
AsyncControl |
Name | Description | |
---|---|---|
AttachToRunningThread |
If set, control tries to find already running thread to attach to on load
| |
CancelAction |
Action performed if Cancel button is pressed. If not specified then Cancel stops the worker.
| |
CancelButton |
Cancel button
| |
ComponentName |
Component name
(Inherited from AbstractUserControl.) | |
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.
| |
ControlContext |
Control context.
(Inherited from CMSUserControl.) | |
CurrentDocument |
Current document
(Inherited from AbstractUserControl.) | |
CurrentLog |
Current log context.
| |
CurrentPageInfo |
Current page info
(Inherited from AbstractUserControl.) | |
CurrentResolver |
Control's resolver
(Inherited from CMSUserControl.) | |
CurrentSite |
Current site
(Inherited from AbstractUserControl.) | |
CurrentUser |
Current user
(Inherited from AbstractUserControl.) | |
DisplayMode |
Gets or sets display mode of the control.
(Inherited from CMSUserControl.) | |
DocumentManager |
Document manager control
(Inherited from AbstractUserControl.) | |
EditedObject |
Control's edited object
(Inherited from CMSUserControl.) | |
FinishClientCallback |
Name of the JS function called on client when the process finishes either successfully or with error
| |
HeaderActions |
Header actions control
(Inherited from AbstractUserControl.) | |
IsCMSDesk |
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.) | |
IsLiveSite |
Indicates if control is used on live site.
(Inherited from AbstractUserControl.) | |
Item |
Gets or sets the value of the column.
(Inherited from InlineUserControl.) | |
Log |
Gets the current log.
| |
LogContext |
Gets the current log.
| |
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.
| |
LogPanel |
Message panel where log is being displayed.
| |
MaxLogLines |
Maximum log length. (0 = unlimited)
| |
MessagesPlaceHolder |
Placeholder for messages
(Inherited from AbstractUserControl.) | |
Parameter |
Process parameter.
| |
PostbackOnError |
True if the postback should occur after error.
| |
PostbackOnFinish |
True if the postback should occur after finished.
| |
ProcessData |
Process messages
| |
ProcessGUID |
Process GUID.
| |
Properties |
Control properties.
(Inherited from InlineUserControl.) | |
ProvideLogContext |
If true, the async process provides a log context
| |
ResourcePrefix |
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.) | |
ResourcePrefixes |
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.) | |
ReversedLog |
Indicates if the logging is reversed. Default is true.
| |
ShortID |
Short ID of the control.
(Inherited from AbstractUserControl.) | |
Status |
Gets the worker status.
| |
StopProcessing |
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.) | |
UIContext |
Control's UI Context
(Inherited from CMSUserControl.) | |
UseCMSDeskAccessDeniedPage |
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.) | |
UseFileStrings |
Indicates if the control should use the string from resource file.
| |
UsesLocalMessagesPlaceHolder |
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.) | |
ViewState |
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.) | |
Worker |
Asynchronous worker.
|
Name | Description | |
---|---|---|
AddConfirmation |
Adds confirmation text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddError |
Adds error text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddHeaderAction |
Adds specified action to the page header actions.
(Inherited from AbstractUserControl.) | |
AddInformation |
Adds information text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddLog |
Adds the log information.
| |
AddMessage |
Adds message text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AddWarning |
Adds warning text to existing message on the page.
(Inherited from AbstractUserControl.) | |
AttachToThread |
Attaches to the given asynchronous process.
| |
CreateChildControls |
Creates the child controls
(Overrides ControlCreateChildControls.) | |
EnsureControls |
Interface for control that is able to explicitly ensure its child controls
(Inherited from AbstractUserControl.) | |
EnsureLog |
Ensures the logging context.
| |
Eval(String) |
Evaluates the given value
(Inherited from AbstractUserControl.) | |
Eval(String, Boolean) |
Evaluates the item data (safe version), with html encoding.
(Inherited from AbstractUserControl.) | |
EvalBool |
Evaluates the item data and converts it to the bool.
(Inherited from AbstractUserControl.) | |
EvalDateTime |
Evaluates the item data and converts it to the date time.
(Inherited from AbstractUserControl.) | |
EvalDecimal |
Evaluates the item data and converts it to the decimal.
(Inherited from AbstractUserControl.) | |
EvalDouble |
Evaluates the item data and converts it to the double.
(Inherited from AbstractUserControl.) | |
EvalGuid |
Evaluates the item data and converts it to the guid.
(Inherited from AbstractUserControl.) | |
EvalHTML |
Evaluates the item data and doesn't encode it. Method should be used for columns with html content.
(Inherited from AbstractUserControl.) | |
EvalHtmlAttribute |
Evaluates the item data, encodes it to be used in HTML attribute.
(Inherited from AbstractUserControl.) | |
EvalInteger |
Evaluates the item data and converts it to the integer.
(Inherited from AbstractUserControl.) | |
EvalJSString |
Evaluates the item data, encodes it to be used in javascript code and encapsulates it with "'".
(Inherited from AbstractUserControl.) | |
EvalText(String) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
EvalText(String, Boolean) |
Evaluates the item data and encodes it. Method should be used for columns with string nonhtml content.
(Inherited from AbstractUserControl.) | |
GetAccessDeniedPageUrl |
Returns access denied page with dependence on current setting.
(Inherited from CMSUserControl.) | |
GetCallbackResult |
Returns the result of a callback.
| |
GetCancelScript |
Gets the script which cancels the execution of the worker
| |
GetFlagIconUrl |
Returns resolved path to the flag image for the specified culture.
(Inherited from AbstractUserControl.) | |
GetImagePath |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetImageUrl |
Gets UI image relative path.
(Inherited from AbstractUserControl.) | |
GetString |
Returns localized string.
(Overrides AbstractUserControlGetString(String, String).) | |
GetValue(String) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
GetValueReturnType(String, ReturnType) |
Returns the value of the given property.
(Inherited from InlineUserControl.) | |
HasValue |
Returns true if the value of the given property is set.
(Inherited from InlineUserControl.) | |
LoadUserControl |
Loads the user control based on the given path
(Inherited from AbstractUserControl.) | |
LogAndShowError |
Logs the exception and
(Inherited from AbstractUserControl.) | |
OnContentLoaded |
Method that is called when the control content is loaded.
(Inherited from InlineUserControl.) | |
OnInit |
Init event handler.
(Inherited from AbstractUserControl.) | |
OnLoad |
OnLoad event handler
(Overrides AbstractUserControlOnLoad(EventArgs).) | |
OnPreRender |
PreRender event handler
(Overrides AbstractUserControlOnPreRender(EventArgs).) | |
RaiseCallbackEvent |
Raises the callback event.
| |
RaiseCancel |
Raises the Cancel event.
| |
RaiseError |
Raises the Error event.
| |
RaiseFinished |
Raises the finished event.
| |
RaisePostBackEvent |
Processes the postback event
| |
RedirectToAccessDenied(String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(Int32, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToAccessDenied(String, String) |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
RedirectToUIElementAccessDenied |
Redirects the user to Access denied page.
(Inherited from CMSUserControl.) | |
ReleaseContext |
Releases the control context.
(Inherited from CMSUserControl.) | |
Render |
Render event handler.
(Inherited from AbstractUserControl.) | |
ResolveUrl |
Resolves the given URL
(Inherited from AbstractUserControl.) | |
RunAsync |
Runs the asynchronous action.
| |
SetContext |
Sets the control context.
(Inherited from CMSUserControl.) | |
SetValue |
Sets the property value of the control, setting the value affects only local property value.
(Inherited from InlineUserControl.) | |
ShowChangesSaved |
Shows the general changes saved message.
(Inherited from AbstractUserControl.) | |
ShowConfirmation |
Shows the general confirmation message.
(Inherited from AbstractUserControl.) | |
ShowError |
Shows the specified error message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowInformation |
Shows the given information on the page, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowMessage(MessageTypeEnum, String, String, String, Boolean, Boolean) |
Shows the specified message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
ShowWarning |
Shows the specified warning message, optionally with a tooltip text.
(Inherited from AbstractUserControl.) | |
Stop |
Stops the worker.
| |
TrackViewState |
Tracks the view state.
(Inherited from InlineUserControl.) | |
WorkerExists |
Returns true if the worker for current control exists.
|
Name | Description | |
---|---|---|
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.) | |
GetString |
Gets the string by the specified resource key
(Defined by ControlsExtensions.) |
Name | Description | |
---|---|---|
OnCancel |
Cancel event handler.
| |
OnError |
Error event handler.
| |
OnFinished |
Finished event handler.
| |
OnRequestLog |
Request log event handler.
|