GetTabSheetData: Operation

GetTabSheetDataResult GetTabSheetData(TabSheetId tTabSheet, GetTabSheetDataArg tArg)

Parameters

Description

Comments

To execute the operation, specify table moniker in the tTabSheet parameter, and parameters of data and metadata extraction in the tArg parameter. The moniker can be based on the moniker of opened object instance, with the table of which the user is working, following these rules:

In the tArg.pattern field specify the pattern to be used to extract data and metadata. In the tArg.range/ranges field specify cell range(s), for which the operation must be executed. The tArg.action filed may also contain additional actions to be executed in the table on executing the operation. The result of the operation is the requested information and operations execution results if the tArg.action field was defined.

Example

Below is the example of using the GetTabSheetData operation to get data from the specified cell range in the express report table. The request contains table moniker and data extraction pattern. The response contains requested data.

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">

</tTabSheet>

</pattern>

<range>

</range>

</tArg>

</GetTabSheetData>

</s:Body>

</s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">

<soapenv:Body>

</id>

<Cells>

</Cell>

</Cell>

</Cell>

</Cell>

</Cells>

</Style>

</Borders>

</Style>

</Borders>

</Style>

</Styles>

</TabSheetData>

</sheet>

</GetTabSheetDataResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "GetTabSheetData" : 
  {
   "tTabSheet" : 
    {
     "id" : "S1!M!S!E1!Tab"
    },
   "tArg" : 
    {
     "pattern" : 
      {
       "data" : "true",
       "styles" : "Get"
      },
     "range" : 
      {
       "left" : "1",
       "top" : "1",
       "width" : "4",
       "height" : "1"
      }
    }
  }
}

JSON response:

{
 "GetTabSheetDataResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!E1!Tab"
    },
   "sheet" : 
    {
     "TabSheetData" : 
      {
       "Cells" : 
        {
         "Cell" : 
          [
            {
             "@T" : "1",
             "@L" : "1",
             "@SI" : "1",
             "CD" : 
              {
               "@V" : "1.38386357",
               "@FT" : "1,38",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@L" : "2",
             "@SI" : "2",
             "CD" : 
              {
               "@V" : "1.34838968",
               "@FT" : "1,35",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@L" : "3",
             "@SI" : "2",
             "CD" : 
              {
               "@V" : "1.34838968",
               "@FT" : "1,35",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@L" : "4",
             "@SI" : "2",
             "CD" : 
              {
               "@V" : "1.34838968",
               "@FT" : "1,35",
               "@VT" : "8"
              }
            }
          ]
        },
       "Styles" : 
        {
         "Style" : 
          [
            {
             "@B" : "",
             "Text" : 
              {
               "@VA" : "1",
               "@HA" : "0",
               "@M" : "7.56 5.67 7.56 5.67",
               "@WW" : "1"
              },
             "NumberFormat" : 
              {
               "@F" : "#,##0.00",
               "@FT" : "1"
              },
             "Fill" : 
              {
               "@C" : "#FFFFFF"
              },
             "Font" : 
              {
               "@A" : "0",
               "@S" : "8",
               "@C" : "#000000",
               "@F" : "Arial"
              },
             "Borders" : "",
             "Hyperlink" : 
              {
               "@A" : "",
               "@C" : "#000000",
               "@T" : "",
               "@E" : "false",
               "@U" : "true",
               "@ST" : "false",
               "@HT" : "0"
              }
            },
            {
             "@B" : "",
             "Text" : 
              {
               "@VA" : "1",
               "@HA" : "0",
               "@M" : "7.56 5.67 7.56 5.67",
               "@WW" : "1"
              },
             "NumberFormat" : 
              {
               "@F" : "#,##0.00",
               "@FT" : "1"
              },
             "Fill" : 
              {
               "@C" : "#FFFFFF"
              },
             "Font" : 
              {
               "@A" : "0",
               "@S" : "8",
               "@C" : "#000000",
               "@F" : "Arial"
              },
             "Borders" : 
              {
               "Border" : 
                [
                  {
                   "@S" : "0",
                   "@C" : "#BBBBBB",
                   "@W" : "2",
                   "@I" : "2"
                  },
                  {
                   "@S" : "0",
                   "@C" : "#BBBBBB",
                   "@W" : "2",
                   "@I" : "3"
                  }
                ]
              },
             "Hyperlink" : 
              {
               "@A" : "",
               "@C" : "#000000",
               "@T" : "",
               "@E" : "false",
               "@U" : "true",
               "@ST" : "false",
               "@HT" : "0"
              }
            },
            {
             "@B" : "",
             "Text" : 
              {
               "@VA" : "1",
               "@HA" : "0",
               "@M" : "7.56 5.67 7.56 5.67",
               "@WW" : "1"
              },
             "NumberFormat" : 
              {
               "@F" : "#,##0.00",
               "@FT" : "1"
              },
             "Fill" : 
              {
               "@C" : "#FFFFFF"
              },
             "Font" : 
              {
               "@A" : "0",
               "@S" : "8",
               "@C" : "#000000",
               "@F" : "Arial"
              },
             "Borders" : 
              {
               "Border" : 
                [
                  {
                   "@S" : "0",
                   "@C" : "#BBBBBB",
                   "@W" : "2",
                   "@I" : "2"
                  }
                ]
              },
             "Hyperlink" : 
              {
               "@A" : "",
               "@C" : "#000000",
               "@T" : "",
               "@E" : "false",
               "@U" : "true",
               "@ST" : "false",
               "@HT" : "0"
              }
            }
          ]
        }
      }
    }
  }
}

The GetTabData function extracts data of the specified table range.
Input parameters:

eax. Opened express report moniker.

        public static GetTabSheetDataResult GetTabData(EaxId eax)
        {
            var somClient = new SomPortTypeClient(); // Proxy object for operation execution
            // Operation execution parameters
            var tGet = new GetTabSheetData()
            {

                tArg = new GetTabSheetDataArg()
                {
                    pattern = new TabSheetPattern()
                    {
                        data = true,
                        styles = ListOperation.Get
                    },
                    range = new TabRange() 
                    {
                        left = 1,

                        top = 1,
                        height = 1,
                        width = 4
                    }
                },
                tTabSheet = new TabSheetId() { id = eax.id + "!Tab" }
            };
            // Get chart
            var result = somClient.GetTabSheetData(tGet);
            return result;
        }

GetTabSheetData

Syntax

Parameters

Description

Comments

Example

SOAP request:

SOAP response:

JSON request:

JSON response: