AdvantageCMS.Core.Common.BaseClasses Namespace
Build With Advantage

AdvantageAttributeControl Methods

The AdvantageAttributeControl type exposes the following members.

Methods


  Name Description
Protected method Cancel
Cancels this instance.
Protected method 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.
Public method DisableActions
Disables the actions.
Public method EnableActions
Enables the actions.
Public method getModuleByID
Gets the module by identifier.
(Inherited from CMSBaseUserControl.)
Public method GetPageSessionObject(String)
Gets the page session object.
(Inherited from CMSBaseUserControl.)
Public method GetPageSessionObject<(Of <<'(T>)>>)(String)
Gets the page session object.
(Inherited from CMSBaseUserControl.)
Public method GetParameter
Gets the parameter.
(Inherited from CMSBaseUserControl.)
Protected method InitalizeDocumentEditor
Initalizes the document editor.
(Inherited from CMSBaseUserControl.)
Protected method InitializeImageEditor
Initializes the image editor.
(Inherited from CMSBaseUserControl.)
Protected method InitializeRadEditor
Initializes the RAD editor.
(Inherited from CMSBaseUserControl.)
Public method LoadData
Loads the data.
Protected method LoadDataFromObject
Loads the data from object.
Protected method 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.
Protected method OnPostCancel
Hook fired after Cancel()()()() runs but before the dialog closes. Returning false does NOT prevent the close; a non-empty message is surfaced.
Protected method 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.
Protected method 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.
Protected method OnPreCancel
Hook fired before Cancel()()()() runs. Return false to abort the cancel (the dialog stays open); a non-empty message is surfaced.
Protected method 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.
Protected method OnPreRender
Raises the PreRender event.
Protected method 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.
Public method OnValidateSave
Validates the data before saving. Override to add custom validation logic.
Public method PageSessionObjectExists
Determines whether a page session object exists for the specified key.
(Inherited from CMSBaseUserControl.)
Public method ReceiveAdvantageAttributes
Receives and processes the advantage attribute arguments, initializing the toolbar and loading data.
Protected method RefreshSections
Refreshes the sections.
(Inherited from CMSBaseUserControl.)
Public method RegisterBottomScript(Literal)
Registers the bottom script.
(Inherited from CMSBaseUserControl.)
Public method RegisterBottomScript(PlaceHolder)
Registers the bottom script.
(Inherited from CMSBaseUserControl.)
Public method RegisterBottomScript(String, String)
Registers the bottom script
(Inherited from CMSBaseUserControl.)
Public method RegisterTopScript(String, String)
Registers the top script
(Inherited from CMSBaseUserControl.)
Public method RegisterTopScript(Literal)
Registers the top script.
(Inherited from CMSBaseUserControl.)
Public method RegisterTopScript(PlaceHolder)
Registers the top script.
(Inherited from CMSBaseUserControl.)
Public method SafeBool
Safely converts an object to a boolean value, returning the default if the object is null.
Protected method SafeContent
Safely casts an object to an AdvantageAdaptiveContent, returning defaults if the object is null.
Protected method SafeImage
Safely casts an object to an AdvantageImage, returning defaults if the object is null.
Protected method SafeString
Safely converts an object to a string, returning an empty string if the object is null.
Public method SaveData
Saves the data.
Protected method SaveDataToObject
Saves the current form field values into the Attributes object. Implement in derived classes.
Protected method SaveViewState
Saves any user control view-state changes that have occurred since the last page postback.
Public method SendStatusMessage(eCMSEngineEventStatus, String)
Sends the status message.
Public method SendStatusMessage(eCMSEngineEventStatus, String, String, String)
Sends the status message to the underlying CMSBasePage if it exists.
(Inherited from CMSBaseUserControl.)
Public method setNavigationSubTitle
Sets the navigation sub title.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Int32)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, String)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, DateTime)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Decimal)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Double)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Boolean)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Byte)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, SByte)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Int64)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Int16)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, UInt16)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, UInt64)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Single)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Char)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject(String, Guid)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method SetPageSessionObject<(Of <<'(T>)>>)(String, T)
Sets the page session object.
(Inherited from CMSBaseUserControl.)
Public method ShowStatus(EngineEventArgs)
Shows the status.
(Inherited from CMSBaseUserControl.)
Public method ShowStatus(String)
Shows the status.
(Inherited from CMSBaseUserControl.)
Public method ShowStatus(String, String)
Shows the status.
(Inherited from CMSBaseUserControl.)
Public method ShowStatus(String, eCMSEngineEventStatus)
Shows the status.
(Inherited from CMSBaseUserControl.)
Public method ShowStatus(String, String, eCMSEngineEventStatus)
Shows the status.
(Inherited from CMSBaseUserControl.)
Protected method Undo
Undoes this instance.
Public method ValidateSave Obsolete.
Validates the data before saving. Override to add custom validation logic.