AdvantageAttributeControl Members
The AdvantageAttributeControl type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
AdvantageAttributeControl |
Initializes a new instance of the AdvantageAttributeControl class.
|
Methods
| Name | Description | |
|---|---|---|
|
|
Cancel |
Cancels this instance.
|
|
|
CreateChildControls |
Called by the ASP.NET page framework to notify server controls that use composition-based implementation to create any child controls they contain in preparation for posting back or rendering.
|
|
DisableActions |
Disables the actions.
|
|
|
EnableActions |
Enables the actions.
|
|
|
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.) |
|
|
InitalizeDocumentEditor |
Initalizes the document editor.
(Inherited from CMSBaseUserControl.) |
|
|
InitializeImageEditor |
Initializes the image editor.
(Inherited from CMSBaseUserControl.) |
|
|
InitializeRadEditor |
Initializes the RAD editor.
(Inherited from CMSBaseUserControl.) |
|
|
LoadData |
Loads the data.
|
|
|
LoadDataFromObject |
Loads the data from object.
|
|
|
OnInit |
Raises the Init event. Adds the toolbar (if visible)
and the read-only warning label as child controls, and wires the toolbar's
save/cancel/undo events to the handlers on this control.
|
|
|
OnPostCancel |
Hook fired after Cancel()()()() runs but before the dialog closes. Returning
false does NOT prevent the close; a non-empty message is surfaced.
|
|
|
OnPostLoad |
Hook fired at the end of ReceiveAdvantageAttributes(AdvantageAttributeArgs), after
LoadDataFromObject(AdvantageAttributeArgs) has populated the form. Returning false does
NOT roll back the load; a non-empty message is surfaced.
|
|
|
OnPostSave |
Hook fired after SendAdvantageAttributes has been raised but before the
dialog closes. Returning false does NOT roll back the save — the data is already
persisted by the consumer — but a non-empty message is surfaced.
|
|
|
OnPreCancel |
Hook fired before Cancel()()()() runs. Return false to abort the cancel
(the dialog stays open); a non-empty message is surfaced.
|
|
|
OnPreLoad |
Hook fired at the start of ReceiveAdvantageAttributes(AdvantageAttributeArgs), before any
state on this control is mutated. Return false to reject the incoming payload
(the control is left untouched); a non-empty message is surfaced.
|
|
|
OnPreRender |
Raises the PreRender event.
|
|
|
OnPreSave |
Hook fired after ValidateSave(String%) passes and form values have been pulled
into Attributes via SaveDataToObject()()()(), but before the
consumer receives SendAdvantageAttributes. Return false to abort
the save (the dialog stays open); a non-empty message is surfaced
to the user.
|
|
|
OnValidateSave |
Validates the data before saving. Override to add custom validation logic.
|
|
|
PageSessionObjectExists |
Determines whether a page session object exists for the specified key.
(Inherited from CMSBaseUserControl.) |
|
|
ReceiveAdvantageAttributes |
Receives and processes the advantage attribute arguments, initializing the toolbar and loading data.
|
|
|
RefreshSections |
Refreshes the sections.
(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.) |
|
|
SafeBool |
Safely converts an object to a boolean value, returning the default if the object is null.
|
|
|
SafeContent |
Safely casts an object to an AdvantageAdaptiveContent, returning defaults if the object is null.
|
|
|
SafeImage |
Safely casts an object to an AdvantageImage, returning defaults if the object is null.
|
|
|
SafeString |
Safely converts an object to a string, returning an empty string if the object is null.
|
|
|
SaveData |
Saves the data.
|
|
|
SaveDataToObject |
Saves the current form field values into the Attributes object. Implement in derived classes.
|
|
|
SaveViewState |
Saves any user control view-state changes that have occurred since the last page postback.
|
|
|
SendStatusMessage(eCMSEngineEventStatus, String) |
Sends the status message.
|
|
|
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.) |
|
|
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.) |
|
|
Undo |
Undoes this instance.
|
|
|
ValidateSave | Obsolete.
Validates the data before saving. Override to add custom validation logic.
|
Properties
| Name | Description | |
|---|---|---|
|
ActionsEnabled |
Gets or sets a value indicating whether [actions enabled].
|
|
|
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.) |
|
|
Attributes |
Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
|
|
|
CMSUsers |
Gets the CMS users.
(Inherited from CMSBaseUserControl.) |
|
|
ConfigurationEngine |
Gets the configuration engine.
(Inherited from CMSBaseUserControl.) |
|
|
Content |
Gets or sets the content.
|
|
|
CSPNonce |
Gets the nonce value for Content-Security-Policy
(Inherited from CMSBaseUserControl.) |
|
|
cssFiles |
Gets or sets the CSS files.
|
|
|
CurrentNavigation |
Gets the current navigation.
|
|
|
CurrentSitepage |
Gets the current sitepage.
|
|
|
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.) |
|
|
Enabled |
Gets or sets a value indicating whether this AdvantageAttributeControl is enabled.
|
|
|
HideToolBar |
Gets or sets a value indicating whether the toolbar is hidden.
|
|
|
ModuleEngine |
Gets the module engine.
(Inherited from CMSBaseUserControl.) |
|
|
NavigationEngine |
Gets the navigation engine.
(Inherited from CMSBaseUserControl.) |
|
|
PreviewKey |
Gets the preview key.
(Inherited from CMSBaseUserControl.) |
|
|
ScriptManager |
Gets the ScriptManager instance for the current page.
(Inherited from CMSBaseUserControl.) |
|
|
TaskEngine |
Gets the task engine.
(Inherited from CMSBaseUserControl.) |
|
|
TemplateUrl |
Gets or sets the template URL.
|
|
|
TitleSection |
Gets or sets a value indicating whether [title section].
|
|
|
ToolBar |
Gets the toolbar dialog control, loading it on first access.
|
|
|
ToolBarCssClass |
Gets or sets the tool bar CSS class.
|
|
UniqueID |
Gets the unique, hierarchically qualified identifier for the server control.
|
|
|
UserEngine |
Gets the user engine.
(Inherited from CMSBaseUserControl.) |
Events
| Name | Description | |
|---|---|---|
|
CloseAdvantageAttributeControl |
Occurs when [close advantage attribute control].
|
|
|
SendAdvantageAttributes |
Occurs when [send advantage attributes].
|