TabObjectsDelete

Syntax

bool TabObjectsDelete(TabSheetId tTabSheet, TabObjectsDeleteArg tArg)

Parameters

mon. Table moniker.

tArg. Operation execution parameters.

Description

The TabObjectsDelete operation deletes table objects.

Comments

The operation deletes one or several table objects with specified identifiers. To execute the operation, in the tTabSheet field specify table moniker, and in the tArg.ids field specify array of deleted object identifiers. The moniker can be based on the moniker of opened object instance, which table is worked with.

The operation results in the logical True if objects were deleted successfully.

Example

Below is the example of deleting two objects from regular report sheet. The request contains regular report sheet moniker and array of identifiers of deleted objects. The response contains whether deletion was successful.

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">
<TabObjectsDelete xmlns="http://www.fsight.ru/PP.SOM.Som">
<tTabSheet xmlns="">
  <id>S1!M!S!P1!1</id>
  </tTabSheet>
<tArg xmlns="">
<ids>
  <it>PrxPicture</it>
  <it>PrxChart</it>
  </ids>
  </tArg>
  </TabObjectsDelete>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "TabObjectsDelete" : 
  {
   "tTabSheet" : 
    {
     "id" : "S1!M!S!P1!1"
    },
   "tArg" : 
    {
     "ids" : 
      {
       "it" : 
        [
          "PrxPicture",
          "PrxChart"
        ]
      }
    }
  }
}

JSON response:

{
 "TabObjectsDeleteResult" : "1"
}
public static bool DeleteTabObjects(string moniker, string[] objects)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tTab = new TabObjectsDelete()
    {
        tTabSheet = new TabSheetId() { id = moniker },
        tArg = new TabObjectsDeleteArg()
        {
            ids = objects
        }
    };
    // Delete table objects
    var result = somClient.TabObjectsDelete(tTab);
    return result;
}

See also:

Table