SetTabObjectSettings

Syntax

bool SetTabObjectSettings(TabSheetId tTabSheet, TabObjectSettingsArg tArg)

Parameters

tTabSheet. Sheet moniker.

tArg. Operation execution parameters.

Description

The SetTabObjectSettings operation changes table object settings.

Comments

To execute the operation, in the tTabSheet field specify moniker of the sheet, which contains objects, and in the tArg field specify object settings to be determined. The moniker can be based on the moniker of opened object instance, with which the work is executed.

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

Example

Below is the example of changing settings of the chart located on a regular report sheet. The request contains moniker of the report sheet and chart settings to be determined. The response contains whether 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">
<SetTabObjectSettings xmlns="http://www.fsight.ru/PP.SOM.Som">
<tTabSheet xmlns="">
  <id>GELCPBJDAHMNFOAEOGANNOOIMCBDPMLEFKAFDIFHOKGGDEFD!M!S!PLBMFNEJDAHMNFOAEKCMNMAJAJPHAFBGEILMEHGGEFPOMHMFJ!Sheets!1</id>
  </tTabSheet>
<tArg xmlns="">
<its>
<it>
  <tot>Chart</tot>
  <tomm>5</tomm>
  <toam>2</toam>
  <prn>false</prn>
  <id>PrxChart1</id>
  </it>
  </its>
  </tArg>
  </SetTabObjectSettings>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
"SetTabObjectSettings" :
{
"tTabSheet" :
{
"id" : "GELCPBJDAHMNFOAEOGANNOOIMCBDPMLEFKAFDIFHOKGGDEFD!M!S!PLBMFNEJDAHMNFOAEKCMNMAJAJPHAFBGEILMEHGGEFPOMHMFJ!Sheets!1"
},
"tArg" :
{
"its" :
{
"it" :
[
{
"tot" : "Chart",
"tomm" : "5",
"toam" : "2",
"prn" : "false",
"id" : "PrxChart1"
}
]
}
}
}
}

JSON response:

{
"SetTabObjectSettingsResult" : "1"
}
public static bool SetTabObjectSettings(string reportMoniker, string sheetKey, string objectId)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tSet = new SetTabObjectSettings()
{
tArg = new TabObjectSettingsArg()
{
its = new TabObjectSettingsItem[]
{
new TabObjectSettingsItem()
{
id = objectId,
prn = false,
tomm = 5, // Move object with cells
toam = 2, // Activate on object double-click
tot = "Chart"
}
}
},
tTabSheet = new TabSheetId() { id = reportMoniker + "!Sheets!" + sheetKey}
};
// Change table object settings
var result = somClient.SetTabObjectSettings(tSet);
return result;
}

See also:

Table: Operations