GetEaxFormulaDescriptions

Syntax

GetEaxFormulaDescriptionsResult GetEaxFormulaDescriptions(string mon, EaxFormulaDescriptions tArg)

Parameters

mon. Moniker of opened regular report instance.

tArg. Operation execution parameters.

Description

The GetEaxFormulaDescriptions operation gets information about the formulas that are used to calculate table cell value.

Comments

The operation is relevant if calculation algorithms are used in report for calculation. The cell, which formulas should be obtained, should be selected first using the SetTabSheetData operation.

To execute the operation, in the mon field specify moniker of regular report instance. The moniker can be obtained on executing the OpenPrxMeta operation. The report should be calculated. In the tArg field specify empty values or default values for the fields, which values should be obtained.

The operation results in the obtained information about formulas.

Example

Below is the example of getting information about formulas that are used to calculate tale cell value. It is assumed that the cell with formulas is already selected on a report sheet. The request contains regular report moniker and the list of obtained fields. The response contains the obtained information about formulas.

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">
<GetEaxFormulaDescriptions xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ</mon>
<tArg xmlns="">
<its>
<it>
  <k>-1</k>
  <id />
  <n />
  <blockName />
  <formulaName />
  <type>2147483647</type>
<value>
  <v />
  </value>
  <formula />
  <errorText />
  </it>
  </its>
  </tArg>
  </GetEaxFormulaDescriptions>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetEaxFormulaDescriptionsResult 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">
<formulaDescriptions xmlns="">
<its>
<it>
  <k>1</k>
  <n>Calculation algorithm</n>
  <blockName>Calculation block</blockName>
  <formulaName>Calculation formula</formulaName>
  <type>0</type>
<value>
  <v>2</v>
  </value>
  <formula>@0 = @1 * @2</formula>
  <errorText />
  </it>
  </its>
  </formulaDescriptions>
  </GetEaxFormulaDescriptionsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetEaxFormulaDescriptions" :
{
"mon" : "NBNHEPFAALBBGOAEABGIFGOOMGCKMALEJKHEEKKJBGLAMNPH!M!S!PEICKDAGAALBBGOAEIBOHAGDMIAKHEAJEPILBICMEKJJOEBAJ",
"tArg" :
{
"its" :
{
"it" :
[
{
"k" : "-1",
"id" : "",
"n" : "",
"blockName" : "",
"formulaName" : "",
"type" : "2147483647",
"value" :
{
"v" : ""
},
"formula" : "",
"errorText" : ""
}
]
}
}
}
}

JSON response:

{
"GetEaxFormulaDescriptionsResult" :
{
"formulaDescriptions" :
{
"its" :
{
"it" :
[
{
"k" : "1",
"n" : "Calculation algorithm",
"blockName" : "Calculation block",
"formulaName" : "Calculation formula",
"type" : "0",
"value" :
{
"v" : "2"
},
"formula" : "@0 = @1 * @2",
"errorText" : ""
}
]
}
}
}
}
public static GetEaxFormulaDescriptionsResult GetEaxFormulaDescriptions(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetEaxFormulaDescriptions()
{
tArg = new EaxFormulaDescriptions()
{
its = new EaxFormulaDescription[]
{
new EaxFormulaDescription()
{
id = string.Empty,
k = uint.MaxValue,
n = string.Empty,
blockName = string.Empty,
errorText = string.Empty,
formula = string.Empty,
formulaName = string.Empty,
type = int.MaxValue,
value = new TypedValue()
{
v = string.Empty
}
}
}
},
mon = moniker
};
// Get information about formulas
var result = somClient.GetEaxFormulaDescriptions(tGet);
return result;
}

See also:

Working with Regular Reports