SetPrxMetaJsPlugin

Syntax

bool SetPrxMetaJsPlugin(string mon, PrxMetaJsPlugin tArg)

Parameters

mon. Moniker for working with regular report sheet.

tArg. Sheet settings to be obtained .

Description

The SetPrxMetaJsPlugin operation changes settings of the regular report sheet created using a JS plugin.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the !Sheets!sheet key postfix, and in the tArg field specify sheet settings to be changed. Moniker of regular report instance can be obtained on executing the OpenPrxMeta operation.

The operation results in the logical True if the settings were changed successfully.

Example

Below is the example of changing settings of the sheet created using a JS plugin. The response contains sheet moniker and identifier of JS plugin to be installed. The response contains whether the settings are applied successfully.

SOAP request:

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
<s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<SetPrxMetaJsPlugin xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">GEMJCGFIGFENFOAEBGOFPOLHGGHEJKBELLCABGHLCFCOJLNN!M!S!PMNHKFJFIGFENFOAENKOBPFBMPBEAOCHEFJCELFBNBEJLDIGK!Sheets!2</mon>
<tArg xmlns="">
  <k>0</k>
  <pluginId>PP.Ui.Prx.PrxPlugin</pluginId>
  </tArg>
  </SetPrxMetaJsPlugin>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <SetPrxMetaJsPluginResult xmlns="http://www.fsight.ru/PP.SOM.Som" xmlns:q1="http://www.fsight.ru/PP.SOM.Som" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">1</SetPrxMetaJsPluginResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "SetPrxMetaJsPlugin" : 
  {
   "mon" : "GEMJCGFIGFENFOAEBGOFPOLHGGHEJKBELLCABGHLCFCOJLNN!M!S!PMNHKFJFIGFENFOAENKOBPFBMPBEAOCHEFJCELFBNBEJLDIGK!Sheets!2",
   "tArg" : 
    {
     "k" : "0",
     "pluginId" : "PP.Ui.Prx.PrxPlugin"
    }
  }
}

JSON response:

{
 "SetPrxMetaJsPluginResult" : "1"
}
public static bool SetPrxMetaJsPlugin(string moniker, string sheetKey, string plugin)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetPrxMetaJsPlugin()
    {
        tArg = new PrxMetaJsPlugin()
        {
            pluginId = plugin
        },
        mon = moniker + "!Sheets!" + sheetKey
    };
    // Change sheet settings
    var result = somClient.SetPrxMetaJsPlugin(tSet);
    return result;
}

See also:

Working with Regular Reports