TabRangeDelete

Syntax

bool TabRangeDelete(string mon, TabRangeShiftArg tArg)

Parameters

mon. Moniker for working with table cell range.

tArg. Parameters for shifting rows/columns on deleting cell range.

Description

The TabRangeDelete operation deletes cell range with shifting of other table elements.

Comments

The operation shifts table rows and columns by deleting the corresponding number of rows/columns in the range area passed in the moniker. To execute the operation, in the mon field specify moniker of regular report instance with the !Sheets!sheet key!range address postfix. The operation results in the logical True if cell merge was canceled successfully.

Example

Below is the example of deleting the range on the regular report sheet with shifting rows up. 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">
<TabRangeDelete xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!Sheets!1!A25:B30</mon>
<tArg xmlns="">
  <shift>4</shift>
  </tArg>
  </TabRangeDelete>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "TabRangeDelete" : 
  {
   "mon" : "S1!M!S!P1!Sheets!1!A25:B30",
   "tArg" : 
    {
     "shift" : "4"
    }
  }
}

JSON response:

{
 "TabRangeDeleteResult" : "1"
}
public static bool DeleteRange(string moniker, string sheetKey, string address)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tTab = new TabRangeDelete()
    {
        tArg = new TabRangeShiftArg()
        {
            shift = 4
        },
        mon = moniker + "!Sheets!" + sheetKey + '!' + address
    };
    // Delete range
    var result = somClient.TabRangeDelete(tTab);
    return result;
}

See also:

Table