SetTabSheetData: Operation

SetTabSheetDataResult SetTabSheetData(TabSheetId tTabSheet, SetTabSheetDataArg tArg)

Parameters

Description

Comments

To execute the operation, in the tTabSheet parameter determine table moniker, and in the tArg parameter determine parameters of data and metadata change. 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 change data or metadata. The changed data is specified in the tArg.TabSheetData field, while metadata is shown in the tArg.metaData field. The tArg.action filed may also contain additional actions to be executed in the table on executing the operation. If the tArg.getArg field is defined, the result of the operation is the changed data and metadata obtained after changing it in the table.

Example

Below is the example of using the SetTabSheetData operation to change data in the specified cell range in the express report table. The request contains table moniker, new data for the cell range, and the pattern indicating whether cell data must be changed. The response contains updated information about data in the specified cell range.

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>

<Cells>

</Cell>

</Cell>

</Cell>

</Cell>

</Cells>

</TabSheetData>

<range>

</range>

</setPattern>

</pattern>

<range>

</range>

</getArg>

</tArg>

</SetTabSheetData>

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

</TabSheetData>

</sheet>

</SetTabSheetDataResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetTabSheetData" : 
  {
   "tTabSheet" : 
    {
     "id" : "S1!M!S!E1!Tab"
    },
   "tArg" : 
    {
     "TabSheetData" : 
      {
       "Cells" : 
        {
         "Cell" : 
          [
            {
             "@T" : "1",
             "@SI" : "1",
             "@L" : "1",
             "CD" : 
              {
               "@V" : "13.8386357",
               "@FT" : "",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@SI" : "2",
             "@L" : "2",
             "CD" : 
              {
               "@V" : "13.4838968",
               "@FT" : "",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@SI" : "2",
             "@L" : "3",
             "CD" : 
              {
               "@V" : "13.4838968",
               "@FT" : "",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@SI" : "2",
             "@L" : "4",
             "CD" : 
              {
               "@V" : "13.4838968",
               "@FT" : "",
               "@VT" : "8"
              }
            }
          ]
        }
      },
     "range" : 
      {
       "left" : "1",
       "top" : "1",
       "width" : "4",
       "height" : "1"
      },
     "setPattern" : 
      {
       "data" : "true"
      },
     "getArg" : 
      {
       "pattern" : 
        {
         "data" : "true"
        },
       "range" : 
        {
         "left" : "1",
         "top" : "1",
         "width" : "4",
         "height" : "1"
        }
      }
    }
  }
}

JSON response:

{
 "SetTabSheetDataResult" : 
  {
   "id" : 
    {
     "id" : "S1!M!S!E1!Tab"
    },
   "sheet" : 
    {
     "TabSheetData" : 
      {
       "Cells" : 
        {
         "Cell" : 
          [
            {
             "@T" : "1",
             "@L" : "1",
             "@SI" : "1",
             "CD" : 
              {
               "@V" : "13.8386357",
               "@FT" : "13.8386357",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@L" : "2",
             "@SI" : "2",
             "CD" : 
              {
               "@V" : "13.4838968",
               "@FT" : "13.4838968",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@L" : "3",
             "@SI" : "2",
             "CD" : 
              {
               "@V" : "13.4838968",
               "@FT" : "13.4838968",
               "@VT" : "8"
              }
            },
            {
             "@T" : "1",
             "@L" : "4",
             "@SI" : "2",
             "CD" : 
              {
               "@V" : "13.4838968",
               "@FT" : "13.4838968",
               "@VT" : "8"
              }
            }
          ]
        }
      }
    }
  }
}

The ChangeTabData function changes data of the specified table range.
Input parameters:

eax. Opened express report moniker.
range. Range of cells, which values must be changed.
newData. New cell values.

        public static SetTabSheetDataResult ChangeTabData(EaxId eax, TabRange range, TabData newData)
        {
            var somClient = new SomPortTypeClient(); // Proxy object for task execution
            // Operation execution parameters
            var tSet = new SetTabSheetData()
            {
                tArg = new SetTabSheetDataArg()
                {
                    setPattern = new TabSheetPattern()
                    {

                        data = true,
                    },
                    //Changeable cell range
                    range = range,
                    //New cell data
                    TabSheetData = newData,
                    getArg = new GetTabSheetDataArg()
                    {
                        pattern = new TabSheetPattern()
                        {

                            data = true,
                        },
                        range = range
                    }
                },
                tTabSheet = new TabSheetId() { id = eax.id + "!Tab" }
            };
            // Change chart
            var result = somClient.SetTabSheetData(tSet);
            return result;
        }

SetTabSheetData

Syntax

Parameters

Description

Comments

Example

SOAP request:

SOAP response:

JSON request:

JSON response: