AdvantageModule Members
The AdvantageModule type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
|
AdvantageModule |
Initializes a new instance of the AdvantageModule class.
|
Methods
| Name | Description | |
|---|---|---|
|
|
BroadcastEvent |
Allows broadcasting of information between modules rendered in an AdvantageTemplatePage. One module can broadcast a message with an event ID and arguments, other modules that override the "ReceiveEvent" virtual method will receive the message.
Messages should be broadcast PRIOR to the "PreRender Event" so that other modules may act upon the message.
|
|
|
Client_ObjectClearLocks |
Unlocks all object specified by the unique lock key.
|
|
|
Client_ObjectLock |
Requests an object lock for a specified user and master identifier. This will attempt to lock the record on the server and return the status. It will generate the javascript client code to poll for refresh/locking. Successful API requests will return the status of the lock : { Status: 0, Message: '', UserName: '' }. Status
Message
UserName
|
|
|
Client_UnObjectLock |
Object unlock. Unlocks a specific object.
|
|
|
GetNavigations |
Pass through to AdvantagePageTemplate GetNavigations
|
|
|
ReceiveEvent |
Virtual method that can be overridden to receive messages that are broadcast via the "BroadcastEvent" method
|
|
|
RecieveEvent | Obsolete.
Receives the event. This method is obsolete; use ReceiveEvent(String, Hashtable) instead.
|
|
|
RegisterBottomScript(Literal) |
Registers content to the bottom of the page
|
|
|
RegisterBottomScript(String, Literal) |
Registers content to the bottom of the page
|
|
|
RegisterBottomScript(PlaceHolder) |
Registers content to the bottom of the page
|
|
|
RegisterBottomScript(String, PlaceHolder) |
Registers content to the bottom of the page
|
|
|
RegisterBottomScript(String, String) |
Registers content to the bottom of the page
|
|
|
RegisterBottomScript(String) |
Registers content to the bottom of the page
|
|
|
RegisterTopScript(Literal) |
Registers content to the top of the page.
|
|
|
RegisterTopScript(String, Literal) |
Registers content to the top of the page
|
|
|
RegisterTopScript(PlaceHolder) |
Registers content to the top of the page
|
|
|
RegisterTopScript(String, PlaceHolder) |
Registers content to the top of the page
|
|
|
RegisterTopScript(String, String) |
Registers content to the top of the page
|
|
|
RegisterTopScript(String) |
Registers content to the top of the page
|
|
|
RenderControlContent |
Renders the content of the control.
|
|
|
SearchIndexUsingBrowserInstance |
[AdvantagePageTemplate.SearchIndexUsingBrowserInstance]
|
|
|
SetOpenGraph |
Sets the open graph.
|
|
|
SiteSettings()()()() |
Pass through to AdvantagePageTemplate SiteSettings (non-generic).
|
|
|
SiteSettings<(Of <<'(T>)>>)()()()() |
Pass through to AdvantagePageTemplate SiteSettings
|
Properties
| Name | Description | |
|---|---|---|
|
Attributes |
Gets a collection of all attribute name and value pairs declared in the user control tag within the .aspx file.
|
|
|
ClassName |
The CSS class configured for this module's content.
|
|
|
ConfigurationEngine |
Gets the configuration engine.
|
|
|
ContainerPanel |
Gets the ASP Panel that wraps the module. Used for controls that have absolute positioning or special requirements.
|
|
|
CSPNonce |
Gets the nonce value for Content-Security-Policy
|
|
|
CurrentDomain |
Pass through to AdvantagePageTemplate CurrentDomain
|
|
|
CurrentLanguage |
Pass through to AdvantagePageTemplate CurrentLanguage
|
|
|
CurrentNavigationPage |
Pass through to AdvantagePageTemplate CurrentNavigationPage.
|
|
|
CurrentSql |
Pass through to AdvantagePageTemplate CurrentSql
|
|
|
DatabaseCacheManager |
Gets the database cache manager, which allows for domain/language-scoped storage of items by ID.
|
|
|
IsActive |
Is the module active (available)
|
|
|
IsEditDraggable |
Overridable property to determine if a module is draggable in the visual editor.
|
|
|
IsInlineEdit |
Gets a value indicating whether this instance is inline edit.
|
|
|
IsPostBack |
Gets a value indicating whether the user control is being loaded in response to a client postback, or if it is being loaded and accessed for the first time.
|
|
|
IsPreview |
Property retrieved from AdvantagePageTemplate.
|
|
|
IsSearchAgent |
Property retrieved from AdvantagePageTemplate.
|
|
|
ModifierTitle |
Title added in SitePage.
|
|
|
ModuleContent |
Managed content
|
|
|
ModuleEngine |
Pass through to AdvantagePageTemplate ModuleEngine
|
|
|
ModuleID |
Id of the module referenced in Global Configuration->Modules.
|
|
|
Name |
Name of the module referenced in Global Configuration->Modules.
|
|
|
PageMetaDescription |
Pass through to AdvantagePageTemplate PageMetaDescription
|
|
|
PageMetaKeywords |
Pass through to AdvantagePageTemplate PageMetaKeywords
|
|
|
PageTitle |
Pass through to AdvantagePageTemplate PageTitle
|
|
|
RenderMode |
Property retrieved from AdvantagePageTemplate.
|
|
|
SortOrder |
Historical usage, no longer active.
|
|
|
Span |
The span configured for this modules content
|
|
|
WebCacheManager |
Gets the web cache manager, which allows for domain/language-scoped storage of items by ID.
|