Frontend Hierarchy

AdvantageCSP hierarchy flows from the Masterpage/page level to “Layouts” that contain “zones”, to “Modules” that utilize a grid system to provide content.

AdvantageMasterPage : System.Web.UI.MasterPage

Optional ASP.NET MasterPage that inherits from System.Web.UI.Masterpage.

Has properties that interact with the AdvantageCSP framework:

• AdvantagePage -> reference to the AdvantagePageTemplate (page) that is being rendered.
• CurrentDomain -> reference to the current domain
• CurrentLanguage -> reference to the current language
• IsPreview -> returns if the page is currently a preview link

• ConfigurationEngine -> reference to the AdvantageConfigurationEngine
• ModuleEngine -> reference to the AdvantageModuleEngine

AdvantagePageTemplate: System.Web.UI.Page

ASP.NET page that inherits from System.Web.UI.Page.

Interacts with the AdvantageCSP framework:

• SiteSettings<T> -> provides access to the sitesettings module defined for the domain
• ConfigurationEngine -> reference to the AdvantageConfigurationEngine
• ModuleEngine -> reference to the AdvantageModuleEngine
• NavigationEngine -> reference to the AdvantageModuleEngine
• PageEngine -> reference to the AdvantageModuleEngine

• GetNavigations -> provides access to the navigations from the PageManagement
• CurrentDomain -> reference to the current domain
• CurrentLanguage -> reference to the current language
• CurrentSitePage -> reference to the SitePage (page content) that is being rendered
• CurrentNavigationPage -> reference to the Navigation that is being rendered
• CurrentSql -> reference to the current Advantage SQL connection context

AdvantageLayoutControl: System.Web.UI.UserControl

ASP.NET control that inherits from System.Web.UI.UserControl.  Provides the page layout for modules.  Used to create specialized rendering areas based on design/style requirements.  The Layout control defines “Zones” where AdvantageModules maybe “dropped” in from the admin screen when managing the page content.

• AdvantagePage -> reference to the AdvantagePageTemplate that is contained. 

AdvantageModule/AdvantageModuleRewrite : System.Web.UI.UserControl

ASP.NET control that inherits from System.Web.UI.Usercontrol.  When placed in a zone from the Sitemanager -> Manage Content, provides te display for elements on the front-end.

Interacts with the AdvantageCSP framework:

• SiteSettings<T> -> provides access to the sitesettings module defined for the domain
• ConfigurationEngine -> reference to the AdvantageConfigurationEngine
• ModuleEngine -> reference to the AdvantageModuleEngine

• GetNavigations -> provides access to the navigations from the PageManagement
• CurrentDomain -> reference to the current domain
• CurrentLanguage -> reference to the current language
• CurrentSitePage -> reference to the SitePage (page content) that is being rendered
• CurrentNavigationPage -> reference to the Navigation that is being rendered
• CurrentSql -> reference to the current Advantage SQL connection context
• Attributes ->access to methods to retrieve data set from the administrative->manage content.
• MyObject -> reference to the object instantiated via the URL during rewrite (AdvantageModuleRewrite only)

Modules may have an associated dialog control “AdvantageAttributeControl” that allows for customization or business logic to be determined at render. 

AdvantageAttributeControl: System.Web.UI.UserControl

ASP.NET control that inherits from System.Web.UI.Usercontrol.  This control can be registed and used as a dialog to allow customization of module content, or as a “Custom Properties” control that can be referenced for the domain, to enable custom logic to be implemented when an AdvantgePage is rendered.

Interacts with the AdvantageCSP framework:

• SiteSettings<T> -> provides access to the sitesettings module defined for the domain
• ConfigurationEngine -> reference to the CMSConfigurationEngine
• ModuleEngine -> reference to the AdvantageModuleEngine

• AdminDomain -> reference to the current domain
• AdminLanguage -> reference to the current language
• CurrentSitePage -> reference to the SitePage (page content) that is being rendered
• CurrentNavigationPage -> reference to the Navigation that is being rendered
• CurrentSql -> reference to the current Advantage SQL connection context
• CurrentUser -> reference to the current user logged in
• Attributes ->access to methods to set data.
• ShowStatus-> render message to the user