GetTabRangeMetaData

Syntax

TabRangeMetaData GetTabRangeMetaData(string mon, TabRangeMetaData tArg)

Parameters

mon. Moniker for working with table cell range.

tArg. Operation execution parameters.

Description

The GetTabRangeMetaData operation gets cell range metadata.

Comments

The operation gets information about whether there are cell merges in the range and conditional formats applied to the cell range. To execute the operation, in the mon field specify moniker of regular report instance with the !Sheets!sheet key!range address postfix. In the tArg field set empty values or default values for the fields, which values should be obtained. Specify one element for collections. To get information about a specific element, specify its key in metadata. If -1 is specified as a key value, information about all elements of this type is obtained.

The operation results in the requested cell range parameters.

Example

Below is the example of getting cell range metadata. The request contains the cell range moniker, the response contains the requested information.

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">
<GetTabRangeMetaData xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!Sheets!1!A0:B3</mon>
<tArg xmlns="">
  <merged>0</merged>
<conditions>
<Condition>
  <k>-1</k>
  <id />
  <n />
  <Key>0</Key>
  <Type>Values</Type>
  <Details />
  </Condition>
  </conditions>
  </tArg>
  </GetTabRangeMetaData>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetTabRangeMetaDataResult 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">
  <merged xmlns="">0</merged>
<conditions xmlns="">
<Condition>
  <k>-1</k>
  <id />
  <n />
  <Key>0</Key>
  <Type>Values</Type>
  <Details />
  </Condition>
<Condition>
  <k>0</k>
  <Key>1</Key>
  <Type>CellContent</Type>
<Range>
  <left>0</left>
  <top>0</top>
  <width>2</width>
  <height>4</height>
  </Range>
  <Enabled>1</Enabled>
<Details>
<CellContent>
  <ContentType>0</ContentType>
  <CellValue>1000</CellValue>
  <SpecificText />
<Style>
  <Text HA="-1" VA="-1" WW="-1" M="-1 -1 -1 -1" />
  <Font S="10" C="#FF0000" B="true" H="15" />
  <Borders />
  <Hyperlink />
  </Style>
  <ValueCondition>4</ValueCondition>
  <TextCondition>0</TextCondition>
  <DateCondition>0</DateCondition>
  <MinValue />
  <MaxValue />
  </CellContent>
  </Details>
  </Condition>
<Condition>
  <k>1</k>
  <Key>0</Key>
  <Type>CellContent</Type>
<Range>
  <left>0</left>
  <top>0</top>
  <width>2</width>
  <height>4</height>
  </Range>
  <Enabled>1</Enabled>
<Details>
<CellContent>
  <ContentType>0</ContentType>
  <CellValue>100</CellValue>
  <SpecificText />
<Style>
  <Text HA="-1" VA="-1" WW="-1" M="-1 -1 -1 -1" />
  <Font S="10" B="true" H="15" />
  <Borders />
  <Hyperlink />
  </Style>
  <ValueCondition>4</ValueCondition>
  <TextCondition>0</TextCondition>
  <DateCondition>0</DateCondition>
  <MinValue />
  <MaxValue />
  </CellContent>
  </Details>
  </Condition>
  </conditions>
  </GetTabRangeMetaDataResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetTabRangeMetaData" : 
  {
   "mon" : "S1!M!S!P1!Sheets!1!A0:B3",
   "tArg" : 
    {
     "merged" : "0",
     "conditions" : 
      {
       "Condition" : 
        {
         "k" : "-1",
         "id" : "",
         "n" : "",
         "Key" : "0",
         "Type" : "Values",
         "Details" : ""
        }
      }
    }
  }
}

JSON response:

{
 "GetTabRangeMetaDataResult" : 
  {
   "merged" : "0",
   "conditions" : 
    {
     "Condition" : 
      [
        {
         "k" : "4294967295",
         "id" : "",
         "n" : "",
         "Key" : "0",
         "Type" : "Values",
         "Details" : ""
        },
        {
         "k" : "0",
         "Key" : "1",
         "Type" : "CellContent",
         "Range" : 
          {
           "left" : "0",
           "top" : "0",
           "width" : "2",
           "height" : "4"
          },
         "Enabled" : "1",
         "Details" : 
          {
           "CellContent" : 
            {
             "ContentType" : "0",
             "CellValue" : "1000",
             "SpecificText" : "",
             "Style" : 
              {
               "Text" : 
                {
                 "@VA" : "-1",
                 "@HA" : "-1",
                 "@M" : "-1 -1 -1 -1",
                 "@WW" : "-1"
                },
               "Font" : 
                {
                 "@B" : "true",
                 "@S" : "10",
                 "@C" : "#FF0000",
                 "@H" : "15"
                },
               "Borders" : "",
               "Hyperlink" : ""
              },
             "ValueCondition" : "4",
             "TextCondition" : "0",
             "DateCondition" : "0",
             "MinValue" : "",
             "MaxValue" : ""
            }
          }
        },
        {
         "k" : "1",
         "Key" : "0",
         "Type" : "CellContent",
         "Range" : 
          {
           "left" : "0",
           "top" : "0",
           "width" : "2",
           "height" : "4"
          },
         "Enabled" : "1",
         "Details" : 
          {
           "CellContent" : 
            {
             "ContentType" : "0",
             "CellValue" : "100",
             "SpecificText" : "",
             "Style" : 
              {
               "Text" : 
                {
                 "@VA" : "-1",
                 "@HA" : "-1",
                 "@M" : "-1 -1 -1 -1",
                 "@WW" : "-1"
                },
               "Font" : 
                {
                 "@B" : "true",
                 "@S" : "10",
                 "@H" : "15"
                },
               "Borders" : "",
               "Hyperlink" : ""
              },
             "ValueCondition" : "4",
             "TextCondition" : "0",
             "DateCondition" : "0",
             "MinValue" : "",
             "MaxValue" : ""
            }
          }
        }
      ]
    }
  }
}
public static TabRangeMetaData GetTabRangeMetaData(string moniker, string sheetKey, string adress)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tTab = new GetTabRangeMetaData()
    {
        mon = moniker + "!Sheets!" + sheetKey + '!' + adress,
        tArg = new TabRangeMetaData()
        {
            merged = new int(),
            conditions = new TabFormatCondition[1]
            {
                new TabFormatCondition ()
                {
                    k = ulong.MaxValue,
                    id = "",
                    n = "",
                    Type = new TabConditionType(),
                    Details = new TabFormatConditionDetails()
                }
            }
        }
    };
    // Get cell range metadata
    var result = somClient.GetTabRangeMetaData(tTab);
    return result;
}

See also:

Interactive Visual Components