AdvantageModule Methods
The AdvantageModule type exposes the following members.
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.
Recieves the event.
|
|
|
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()()()() |
Sites the settings.
|
|
|
SiteSettings<(Of <<'(T>)>>)()()()() |
Pass through to AdvantagePageTemplate SiteSettings
|