TabRangeClear

Syntax

bool TabRangeClear(string mon, TabRangeClearArg tArg)

Parameters

mon. Moniker for working with table cell range.

tArg. Parameters for clearing cell range.

Description

The TabRangeClearArg operation clears the specified element of a cell range.

Comments

To execute the operation, in the mon field specify moniker of regular report instance with the !Sheets!sheet key!range address postfix, and in the tArg.type field specify the cell range element to be cleared.

The operation results in the logical True if cell range was cleared successfully.

Example

Below is the example of clearing formatting of the specified cell range. The request contains moniker for working with range. The response contains whether the operation is executed successfully.

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">
<TabRangeClear xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!Sheets!1!A20:B25</mon>
<tArg xmlns="">
  <type>1</type>
  </tArg>
  </TabRangeClear>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
  <TabRangeClearResult 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">1</TabRangeClearResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "TabRangeClear" : 
  {
   "mon" : "S1!M!S!P1!Sheets!1!A20:B25",
   "tArg" : 
    {
     "type" : "1"
    }
  }
}

JSON response:

{
 "TabRangeClearResult" : "1"
}
public static bool ClearRange(string moniker, string sheetKey, string address)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tTab = new TabRangeClear()
    {
        tArg = new TabRangeClearArg()
        {
            type = 1
        },
        mon = moniker + "!Sheets!" + sheetKey + '!' + address
    };
    // Clear range formatting
    var result = somClient.TabRangeClear(tTab);
    return result;
}

See also:

Table