AdvantageAttributeControl Methods
The AdvantageAttributeControl type exposes the following members.
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.
|

