DashboardControlsDelete

Syntax

bool DashboardControlsDelete(string mon, DashboardControl arg)

Parameters

mon. Moniker for working with information panel controls.

tArg. Deleted control.

Description

The DashboardControlsDelete operation deletes an information panel control.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Controls postfix, and in the arg.k field specify the key of the deleted control. The moniker can be obtained on executing the OpenDashboard operation.

The operation results in the logical true if the control was deleted successfully.

Example

Below is the example of deleting the control. The request contains moniker for working with controls. The response contains whether the control was deleted 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">
<DashboardControlsDelete xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls</mon>
<arg xmlns="">
  <k>2</k>
  </arg>
  </DashboardControlsDelete>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "DashboardControlsDelete" : 
  {
   "mon" : "DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls",
   "arg" : 
    {
     "k" : "2"
    }
  }
}

JSON response:

{
 "DashboardControlsDeleteResult" : "1"
}
public static bool DashboardControlsDelete(string moniker, uint controlKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tDel = new DashboardControlsDelete()
    {
        arg = new DashboardControl()
        {
            k = controlKey
        },
        mon = moniker + "!Controls"
    };
    // Delete control
    var result = somClient.DashboardControlsDelete(tDel);
    return result;
}

See also:

Working with Information Panels