Extension Reference - Legacy | SpreadsheetWeb Help
ExtensionsLegacy platform

Extension Reference

This page contains extension references in the form of methods and their explanations, for building an extension in a SpreadsheetWEB application.

  • 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 queryStrings_,     ref Dictionary inputs_,     out Dictionary> outputs_ )

Value_Changed

public string Value_Changed(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     ref Dictionary inputs_,     out Dictionary> outputs_,     out bool executeSSWeb )

After_Value_Changed

public string After_Value_Changed(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     Dictionary inputs_,     out Dictionary> outputs_ )

Before_Button_Click

public string Before_Button_Click(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     ref Dictionary inputs_,     out Dictionary> outputs_ )

Button_Click

.NET

public string Button_Click(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     ref Dictionary inputs_,     out Dictionary> outputs_,     out bool executeSSWeb )

After_Button_Click

public string After_Button_Click(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     Dictionary inputs_,     out Dictionary> outputs_ )

Before_Tab_Changed

public string Before_Tab_Changed(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     ref Dictionary inputs_,     out Dictionary> outputs_ )

Tab_Changed

public string Tab_Changed(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     ref Dictionary inputs_,     out Dictionary> outputs_,     out bool executeSSWeb )

After_Tab_Changed

public string After_Tab_Changed(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     Dictionary inputs_,     out Dictionary> outputs_ )

Application_Init

public string Application_Init(     string vjsClientId_,     string sender_,     Dictionary queryStrings_,     ref Dictionary inputs_,     out Dictionary> 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
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
Values of all inputs
outputs_
Type: Dictionary>
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.

 Extension  Extension  Extension  false  true  false  false  true  false  false  true  false  false  false  Extension.dll