ToolControl<(Of <(<'T>)>)> Members
The ToolControl<(Of <(<'T>)>)> type exposes the following members.
Methods
| Name | Description | |
|---|---|---|
|
Cancel | (Inherited from ToolControlBase.) |
|
|
CreateEvent(String, String, eCMSEngineEventStatus, String, List<(Of <<'(EngineEventArgs>)>>)) | (Inherited from ActionControlBase.) |
|
|
CreateEvent(String, String, eCMSEngineEventStatus) | (Inherited from ActionControlBase.) |
|
DisableActions |
Disables the actions.
(Inherited from ToolControlBase.) |
|
|
EnableActions |
Enables the actions.
(Inherited from ToolControlBase.) |
|
|
EnableControls | (Inherited from ToolControlBase.) |
|
|
getModuleByID |
Gets the module by identifier.
(Inherited from CMSBaseUserControl.) |
|
|
GetPageSessionObject(String) |
Gets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
GetPageSessionObject<(Of <<'(T>)>>)(String) |
Gets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
GetParameter |
Gets the parameter.
(Inherited from CMSBaseUserControl.) |
|
|
GetPrimaryObjectByMasterId<(Of <<'(T>)>>) |
Returns the Primary record for the item. It may be Draft, Publish, Historical Status.
(Inherited from ActionControlBase.) |
|
|
GetPrimaryObjects<(Of <<'(T>)>>) |
Gets all primary records for the object type based on the publish status selected.
(Inherited from ActionControlBase.) |
|
|
InitalizeDocumentEditor | (Inherited from CMSBaseUserControl.) |
|
|
InitializeImageEditor | (Inherited from CMSBaseUserControl.) |
|
|
InitializeRadEditor | (Inherited from CMSBaseUserControl.) |
|
|
LoadDataFromObject | (Inherited from ToolControlBase.) |
|
|
PageSessionObjectExists |
Pages the session object exists.
(Inherited from CMSBaseUserControl.) |
|
|
ProcessAction |
Processes the action.
|
|
|
ReceiveActionArgs |
Event handler to implement for receiving system events
|
|
|
RefreshSections | (Inherited from CMSBaseUserControl.) |
|
|
RegisterBottomScript(Literal) |
Registers the bottom script.
(Inherited from CMSBaseUserControl.) |
|
|
RegisterBottomScript(PlaceHolder) |
Registers the bottom script.
(Inherited from CMSBaseUserControl.) |
|
|
RegisterBottomScript(String, String) |
Registers the bottom script
(Inherited from CMSBaseUserControl.) |
|
|
RegisterTopScript(String, String) |
Registers the top script
(Inherited from CMSBaseUserControl.) |
|
|
RegisterTopScript(Literal) |
Registers the top script.
(Inherited from CMSBaseUserControl.) |
|
|
RegisterTopScript(PlaceHolder) |
Registers the top script.
(Inherited from CMSBaseUserControl.) |
|
|
SaveDataToObject | (Inherited from ToolControlBase.) |
|
|
SendStatusMessage(eCMSEngineEventStatus, String, String) |
Sends the status message.
(Inherited from ToolControlBase.) |
|
|
SendStatusMessage(eCMSEngineEventStatus, String, String, String) |
Sends the status message to the underlying CMSBasePage if it exists.
(Inherited from CMSBaseUserControl.) |
|
|
setNavigationSubTitle |
Sets the navigation sub title.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Int32) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, String) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, DateTime) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Decimal) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Double) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Boolean) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Byte) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, SByte) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Int64) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Int16) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, UInt16) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, UInt64) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Single) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Char) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject(String, Guid) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetPageSessionObject<(Of <<'(T>)>>)(String, T) |
Sets the page session object.
(Inherited from CMSBaseUserControl.) |
|
|
SetToolBarLocation |
Sets the toolbar control
(Inherited from ToolControlBase.) |
|
|
ShowStatus(EngineEventArgs) |
Shows the status.
(Inherited from CMSBaseUserControl.) |
|
|
ShowStatus(String) |
Shows the status.
(Inherited from CMSBaseUserControl.) |
|
|
ShowStatus(String, String) |
Shows the status.
(Inherited from CMSBaseUserControl.) |
|
|
ShowStatus(String, eCMSEngineEventStatus) |
Shows the status.
(Inherited from CMSBaseUserControl.) |
|
|
ShowStatus(String, String, eCMSEngineEventStatus) |
Shows the status.
(Inherited from CMSBaseUserControl.) |
Properties
| Name | Description | |
|---|---|---|
|
ActionsEnabled |
Gets or sets a value indicating whether [actions enabled].
(Inherited from ToolControlBase.) |
|
|
ActiveDomains |
Gets the active domains.
(Inherited from CMSBaseUserControl.) |
|
|
AdminDomain |
Gets the admin domain.
(Inherited from CMSBaseUserControl.) |
|
|
AdminEngine |
Gets the admin engine.
(Inherited from CMSBaseUserControl.) |
|
|
AdminIsSSL |
Gets a value indicating whether [admin is SSL].
(Inherited from CMSBaseUserControl.) |
|
|
AdminLanguage |
Gets the admin language.
(Inherited from CMSBaseUserControl.) |
|
|
AdminLanguageID |
Gets the admin language identifier.
(Inherited from CMSBaseUserControl.) |
|
|
CMSUsers |
Gets the CMS users.
(Inherited from CMSBaseUserControl.) |
|
|
ConfigurationEngine |
Gets the configuration engine.
(Inherited from CMSBaseUserControl.) |
|
|
CSPNonce |
Gets the nonce value for Content-Security-Policy
(Inherited from CMSBaseUserControl.) |
|
|
CurrentSiteSettings |
The current site settings
(Inherited from CMSBaseUserControl.) |
|
|
CurrentSql |
Gets the current SQL.
(Inherited from CMSBaseUserControl.) |
|
|
CurrentUser |
Gets the current user.
(Inherited from CMSBaseUserControl.) |
|
|
DomainEngine |
Gets the domain engine.
(Inherited from CMSBaseUserControl.) |
|
LockForEdit | (Inherited from ToolControlBase.) |
|
|
ModuleEngine |
Gets the module engine.
(Inherited from CMSBaseUserControl.) |
|
|
MyObject |
Gets or sets my object.
|
|
|
NavigationEngine |
Gets the navigation engine.
(Inherited from CMSBaseUserControl.) |
|
|
ObjectTypeID |
Gets the object type identifier.
(Inherited from ToolControlBase.) |
|
|
PreviewKey |
Gets the preview key.
(Inherited from CMSBaseUserControl.) |
|
|
TaskEngine |
Gets the task engine.
(Inherited from CMSBaseUserControl.) |
|
|
ToolBar |
Converts to olbar.
(Inherited from ToolControlBase.) |
|
|
ToolBarLocation |
Overrideable property to set the relative path location for a custom user control that inherits from ToolActions
(Inherited from ToolControlBaseControl.) |
|
|
UserEngine |
Gets the user engine.
(Inherited from CMSBaseUserControl.) |
Events
| Name | Description | |
|---|---|---|
|
EngineEventArgs |
Event to implement for binding display to front end.
(Inherited from ActionControlBase.) |
|
|
SendActionArgs |
Event to implement to bind sending system events
|
|
|
SendToolActionArgs |
Occurs when [send tool action arguments].
|