Click or drag to resize
AsyncControl Properties

The AsyncControl type exposes the following members.

Properties
  NameDescription
Public propertyAttachToRunningThread
If set, control tries to find already running thread to attach to on load
Public propertyCancelAction
Action performed if Cancel button is pressed. If not specified then Cancel stops the worker.
Public propertyCancelButton
Cancel button
Public propertyComponentName
Component name
(Inherited from AbstractUserControl.)
Public propertyContinueOnAnyServer
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 propertyControlContext
Control context.
(Inherited from CMSUserControl.)
Public propertyCurrentDocument
Current document
(Inherited from AbstractUserControl.)
Public propertyCurrentLog
Current log context.
Public propertyCurrentPageInfo
Current page info
(Inherited from AbstractUserControl.)
Public propertyCurrentResolver
Control's resolver
(Inherited from CMSUserControl.)
Public propertyCurrentSite
Current site
(Inherited from AbstractUserControl.)
Public propertyCurrentUser
Current user
(Inherited from AbstractUserControl.)
Public propertyDisplayMode
Gets or sets display mode of the control.
(Inherited from CMSUserControl.)
Public propertyDocumentManager
Document manager control
(Inherited from AbstractUserControl.)
Public propertyEditedObject
Control's edited object
(Inherited from CMSUserControl.)
Public propertyFinishClientCallback
Name of the JS function called on client when the process finishes either successfully or with error
Public propertyHeaderActions
Header actions control
(Inherited from AbstractUserControl.)
Public propertyIsCMSDesk
Determines whether the current control lies on the page that is currently located under the CMS Desk.
(Inherited from CMSUserControl.)
Public propertyIsLiveSite
Indicates if control is used on live site.
(Inherited from AbstractUserControl.)
Public propertyItem
Gets or sets the value of the column.
(Inherited from InlineUserControl.)
Public propertyLog
Gets the current log.
Public propertyLogContext
Gets the current log.
Public propertyLogContextNames
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 propertyLogPanel
Message panel where log is being displayed.
Public propertyMaxLogLines
Maximum log length. (0 = unlimited)
Public propertyMessagesPlaceHolder
Placeholder for messages
(Inherited from AbstractUserControl.)
Public propertyParameter
Process parameter.
Public propertyPostbackOnError
True if the postback should occur after error.
Public propertyPostbackOnFinish
True if the postback should occur after finished.
Public propertyProcessData
Process messages
Public propertyProcessGUID
Process GUID.
Protected propertyProperties
Control properties.
(Inherited from InlineUserControl.)
Public propertyProvideLogContext
If true, the async process provides a log context
Public propertyRelativePath Obsolete.
Page relative path.
(Inherited from CMSUserControl.)
Public propertyCode exampleResourcePrefix
Prefix for the resource strings which are used for the localization by the control and its child controls.
(Inherited from AbstractUserControl.)
Public propertyResourcePrefixes
List of cached resource prefixes for the parent hierarchy
(Inherited from AbstractUserControl.)
Public propertyReversedLog
Indicates if the logging is reversed. Default is true.
Public propertyShortID
Short ID of the control.
(Inherited from AbstractUserControl.)
Public propertyStatus
Gets the worker status.
Public propertyStopProcessing
Indicates if the control should perform the operations.
(Inherited from AbstractUserControl.)
Public propertyTypeName Obsolete.
Returns the object type name.
(Inherited from CMSUserControl.)
Public propertyUIContext
Control's UI Context
(Inherited from CMSUserControl.)
Public propertyUseCMSDeskAccessDeniedPage
Gets or sets the value that indicates whether CMSDesk access denied page should be used.
(Inherited from CMSUserControl.)
Public propertyUseFileStrings
Indicates if the control should use the string from resource file.
Public propertyUsesLocalMessagesPlaceHolder
Indicates if control uses local messages placeholder
(Inherited from AbstractUserControl.)
Protected propertyViewState
ViewState - overridden for the Master page ViewState fix.
(Inherited from InlineUserControl.)
Public propertyWorker
Asynchronous worker.
Top
See Also