Search Knowledge Base by Keyword

Extension Reference

Created On
bySerap bas
You are here:
  • Event Methods
    • Before_Value_Changed
    • Value_Changed
    • After_Value_Changed
    • Before_Button_Click
    • Button_Click
    • After_Button_Click
    • Before_Tab_Changed
    • Tab_Changed
    • After_Tab_Changed
    • Application_Init
    • Parameters
    • Return Value
  • Extension Config File

Event Methods

Before_Value_Changed
public string Before_Value_Changed(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    ref Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_
)
Value_Changed
public string Value_Changed(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    ref Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_, 
    out bool executeSSWeb
)
After_Value_Changed
public string After_Value_Changed(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_
)
Before_Button_Click
public string Before_Button_Click(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    ref Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_
)
Button_Click
.NET
public string Button_Click(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    ref Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_, 
    out bool executeSSWeb
)
After_Button_Click
public string After_Button_Click(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_
)
Before_Tab_Changed
public string Before_Tab_Changed(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    ref Dictionary<string, string> inputs_, 
    out Dictionary<string, 
    Dictionary<string, string>> outputs_
)
Tab_Changed
public string Tab_Changed(
    string vjsClientId_,
    string sender_,
    Dictionary<string, string> queryStrings_,
    ref Dictionary<string, string> inputs_,
    out Dictionary<string, Dictionary<string, string>> outputs_,
    out bool executeSSWeb
)
After_Tab_Changed
public string After_Tab_Changed(
    string vjsClientId_,
    string sender_,
    Dictionary<string, string> queryStrings_,
    Dictionary<string, string> inputs_,
    out Dictionary<string, Dictionary<string, string>> outputs_
)
Application_Init
public string Application_Init(
    string vjsClientId_, 
    string sender_, 
    Dictionary<string, string> queryStrings_, 
    ref Dictionary<string, string> inputs_, 
    out Dictionary<string, Dictionary<string, string>> outputs_
)
Parameters
vjsClientId_
Type: System.String
VisualJS client ID as a session ID
sender_
Type: System.String
The name of the control, which send the event
queryStrings_
Type: Dictionary<string, string>
Parameters of the application:

  • TabIndex – index of the tab
  • RecordId – ID of the record
  • Action – name of action: New, Edit, Export etc.
  • ApplicationId – ID of the application
inputs_
Type: Dictionary<string, string>
Values of all inputs
outputs_
Type: Dictionary<string, Dictionary<string, string>>
Outputs with properties of the controls
executeSSWEB
Type: System.Boolean
Right after the event, execute SSWeb Engine
Return Value
Type: System.String
String allow creating message boxes for warning the user, in case of an exception or debugging.

 

Extension Config File

Event methods and Debug Mode can be controlled with the config file. XML file should be saved as a .config file and placed in the extension’s .zip package.

<?xml version="1.0" encoding="utf-8" ?>
<ExtensionConfig>
 <Type>Extension</Type>
 <Namespace>Extension</Namespace>
 <Class>Extension</Class>
 <Before_Value_Changed>false</Before_Value_Changed>
 <Value_Changed>true</Value_Changed>
 <After_Value_Changed>false</After_Value_Changed>
 <Before_Button_Click>false</Before_Button_Click>
 <Button_Click>true</Button_Click>
 <After_Button_Click>false</After_Button_Click>
 <Before_Tab_Changed>false</Before_Tab_Changed>
 <Tab_Changed>true</Tab_Changed>
 <After_Tab_Changed>false</After_Tab_Changed>
 <Application_Init>false</Application_Init>
 <Debug>false</Debug>
 <DebugFile>Extension.dll</DebugFile>
</ExtensionConfig>