SetDashboardGxPageSettings

Syntax

bool SetDashboardGxPageSettings(string mon, DashboardExportPageSettings tArg)

Parameters

mon. Moniker of opened dashboard instance.

tArg. Operation execution parameters.

Description

The SetDashboardGxPageSettings operation changes information panel print options.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance, and in the tArg field specify set print options. The moniker can be obtained on executing the OpenDashboard operation.

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

Example

Below is the example of changing information panel print options. The request contains moniker of opened information panel instance and set options. The response contains whether the settings were changed 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">
<SetDashboardGxPageSettings xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">DBKCMEPAFHGGGOAEOMNHDEKIAPJLIFDEKIHGCJBHPKMFNJEM!M!S!PDACBALPAFHGGGOAEICMCFDBNGDDKBIPEKLCGKIOKAKHGGDPG</mon>
<tArg xmlns="">
  <centerHorizontal>true</centerHorizontal>
  <centerVertical>true</centerVertical>
<scale>
  <value>0.8</value>
  <fitToPages>false</fitToPages>
  </scale>
  </tArg>
  </SetDashboardGxPageSettings>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <SetDashboardGxPageSettingsResult 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</SetDashboardGxPageSettingsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"SetDashboardGxPageSettings" :
{
"mon" : "DBKCMEPAFHGGGOAEOMNHDEKIAPJLIFDEKIHGCJBHPKMFNJEM!M!S!PDACBALPAFHGGGOAEICMCFDBNGDDKBIPEKLCGKIOKAKHGGDPG",
"tArg" :
{
"centerHorizontal" : "true",
"centerVertical" : "true",
"scale" :
{
"value" : "0.8",
"fitToPages" : "false"
}
}
}
}

JSON response:

{
"SetDashboardGxPageSettingsResult" : "1"
}
public static bool SetDashboardGxPageSettings(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tSet = new SetDashboardGxPageSettings()
{
// Moniker for working with visualizer
mon = moniker,
tArg = new DashboardExportPageSettings()
{
centerHorizontal = true,
centerVertical = true,
scale = new TabPrintScale()
{
fitToPages = false,
value = 0.8 // Zoom - 80%
}
}
};
// Change information panel print options
var result = somClient.SetDashboardGxPageSettings(tSet);
return result;
}

See also:

Working with Information Panels