GetPrxAllNamedRegions

Syntax

PrxAllNamedRegionsResult GetPrxAllNamedRegions(PrxId prxMon)

Parameters

prxMon. Moniker of opened regular report instance.

Description

The GetPrxAllNamedRegions operation gets the collection of named ranges created on regular report sheets.

Comments

To execute the operation, in the nrMon field specify moniker of regular report instance. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the obtained collection of named ranges.

Example

Below is the example of getting all named ranges created in regular report. The request contains moniker of opened regular report instance. The response contains the obtained list of named ranges.

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">
<GetPrxAllNamedRegions xmlns="http://www.fsight.ru/PP.SOM.Som">
<prxMon xmlns="">
  <id>ILBNJNHKDBCAGOAEGGMCAJHIOKJPOKMEOIOADBDOFONILPAG!M!S!PAJBBFBIKDBCAGOAEJOAGHLNCNALCNCJEOLBLLFIDBFHIGLPO</id>
  </prxMon>
  </GetPrxAllNamedRegions>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetPrxAllNamedRegionsResult 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">
<sar xmlns="">
<shk>
  <k>1</k>
  </shk>
<regs>
<its>
<it>
  <left>1</left>
  <top>1</top>
  <width>10</width>
  <height>2</height>
  <k>7</k>
  <backgroundColor>16054268</backgroundColor>
  <backgroundOpacity>0</backgroundOpacity>
  <borderColor>0</borderColor>
  <borderOpacity>0</borderOpacity>
  <borderStyle>0</borderStyle>
  <borderWeight>2</borderWeight>
  <name>Header</name>
  </it>
<it>
  <left>1</left>
  <top>3</top>
  <width>10</width>
  <height>10</height>
  <k>8</k>
  <backgroundColor>16054268</backgroundColor>
  <backgroundOpacity>0</backgroundOpacity>
  <borderColor>0</borderColor>
  <borderOpacity>0</borderOpacity>
  <borderStyle>0</borderStyle>
  <borderWeight>2</borderWeight>
  <name>Data</name>
  </it>
  </its>
  </regs>
  </sar>
  </GetPrxAllNamedRegionsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
"GetPrxAllNamedRegions" :
{
"prxMon" :
{
"id" : "ILBNJNHKDBCAGOAEGGMCAJHIOKJPOKMEOIOADBDOFONILPAG!M!S!PAJBBFBIKDBCAGOAEJOAGHLNCNALCNCJEOLBLLFIDBFHIGLPO"
}
}
}

JSON response:

{
"GetPrxAllNamedRegionsResult" :
{
"sar" :
{
"shk" :
{
"k" : "1"
},
"regs" :
{
"its" :
{
"it" :
[
{
"left" : "1",
"top" : "1",
"width" : "10",
"height" : "2",
"k" : "7",
"backgroundColor" : "16054268",
"backgroundOpacity" : "0",
"borderColor" : "0",
"borderOpacity" : "0",
"borderStyle" : "0",
"borderWeight" : "2",
"name" : "Header"
},
{
"left" : "1",
"top" : "3",
"width" : "10",
"height" : "10",
"k" : "8",
"backgroundColor" : "16054268",
"backgroundOpacity" : "0",
"borderColor" : "0",
"borderOpacity" : "0",
"borderStyle" : "0",
"borderWeight" : "2",
"name" : "Data"
}
]
}
}
}
}
}
public static PrxAllNamedRegionsResult GetPrxAllNamedRegions(string moniker)
{
var somClient = new SomPortTypeClient(); // Proxy object for operation execution
// Operation execution parameters
var tGet = new GetPrxAllNamedRegions()
{
prxMon = new PrxId() { id = moniker }
};
// Get all named ranges
var result = somClient.GetPrxAllNamedRegions(tGet);
return result;
}

See also:

Working with Regular Reports