DeleteTabNamedRegion: Operation

The DeleteTabNamedRegion operation deletes named range from a regular report sheet.

Comments

To execute the operation, in the nrMon field specify regular report instance moniker with the !Sheets!Sheet key!NamedRegions postfix, and in the Arg field specify named range deletion parameters. The moniker can be obtained on executing the OpenPrxMeta operation.

The operation results in the logical True if the named range is deleted successfully.

Example

Below is the example of named range deletion. The request contains moniker for working with named ranges and name of deleted range. The response contains whether removal was successful.

SOAP JSON C#

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

<id>ILBNJNHKDBCAGOAEGGMCAJHIOKJPOKMEOIOADBDOFONILPAG!M!S!PAJBBFBIKDBCAGOAEJOAGHLNCNALCNCJEOLBLLFIDBFHIGLPO!Sheets!1!NamedRegions</id>

</nrMon>

<name>Totals</name>

</Arg>

</DeleteTabNamedRegion>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "DeleteTabNamedRegion" : 
  {
   "nrMon" : 
    {
     "id" : "ILBNJNHKDBCAGOAEGGMCAJHIOKJPOKMEOIOADBDOFONILPAG!M!S!PAJBBFBIKDBCAGOAEJOAGHLNCNALCNCJEOLBLLFIDBFHIGLPO!Sheets!1!NamedRegions"
    },
   "Arg" : 
    {
     "name" : "Totals"
    }
  }
}

JSON response:

{
 "DeleteTabNamedRegionResult" : "1"
}

public static bool DeleteTabNamedRegion(string moniker, string deletedRegionName)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tDel = new DeleteTabNamedRegion()
    {
        nrMon = new NamedRegionsId() { id = moniker + "!Sheets!1!NamedRegions" },
        Arg = new TabRegionIdentArg()
        {
            name = deletedRegionName
        }
    };
    // Delete named range
    var result = somClient.DeleteTabNamedRegion(tDel);
    return result;
}

DeleteTabNamedRegion

Syntax