SetDashboardControls

Syntax

DashboardControls SetDashboardControls(string mon, DashboardControls arg)

Parameters

mon. Moniker for working with information panel controls.

arg. Control settings that should be determined.

Description

The SetDashboardControls operation changes settings of controls in information panel.

Comments

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

The operation results in the updated settings of the controls, for which the operation was executed. To get the settings, use the GetDashboardControls operation.

Example

Below is the example of changing control settings in information panel. The request contains moniker for working with controls and the settings that should be determined. The response contains the updated control settings.

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">
<SetDashboardControls xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls</mon>
<arg xmlns="">
<its>
<it>
  <k>2</k>
  <id>ITEM1</id>
<title>
  <text>City</text>
  <title>City</title>
  </title>
  <visualizerKey>1</visualizerKey>
  <fieldKey>2</fieldKey>
  <binding>UI="DimCombo" ID="ITEM1" SELECTIONMODE="MultiSelect" VALUE="DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls!2!Selection"</binding>
<slideKeys>
  <u>1</u>
  </slideKeys>
<reciveKeys>
  <u>2</u>
  </reciveKeys>
<font>
  <family>Roboto</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>14</height>
  <units>Pt</units>
  </size>
  </font>
  <textColor>#54575B</textColor>
  <backgroundColor>#FFFFFF</backgroundColor>
  </it>
  </its>
  </arg>
  </SetDashboardControls>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<SetDashboardControlsResult 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">
<its xmlns="">
<it>
  <k>2</k>
  <id>ITEM1</id>
<title>
  <text>City</text>
  <title>City</title>
<font>
  <family>Roboto</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>14</height>
  <units>Pt</units>
  </size>
  </font>
  <textColor>#54575B</textColor>
  <backgroundColor>#FFFFFF</backgroundColor>
  <textAlignment>Near</textAlignment>
  <verticalTextAlignment>Center</verticalTextAlignment>
<size>
  <width>-1</width>
  <height>8000</height>
  <units>Mkm</units>
  </size>
  <visible>1</visible>
  <htmlText><span style="font-weight: normal;font-size: 14pt;color: #54575b;background-color: #ffffff;text-align: left;font-family: Roboto; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: Roboto; ">City</span></span></htmlText>
  <htmlTitle><span style="font-weight: normal;font-size: 14pt;color: #54575b;background-color: #ffffff;text-align: left;font-family: Roboto; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: Roboto; ">City</span></span></htmlTitle>
  <isControl>1</isControl>
  <autoHeight>0</autoHeight>
  <customFormat F="" FT="0" />
  </title>
  <visualizerKey>1</visualizerKey>
  <fieldKey>2</fieldKey>
  <binding>UI="DimCombo" ID="ITEM1" SELECTIONMODE="MultiSelect" VALUE="DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls!2!Selection"</binding>
<slideKeys>
  <u>1</u>
  </slideKeys>
<reciveKeys>
  <u>2</u>
  </reciveKeys>
<font>
  <family>Roboto</family>
<style>
  <it>Regular</it>
  </style>
<size>
  <width>-1</width>
  <height>14</height>
  <units>Pt</units>
  </size>
  </font>
  <textColor>#54575B</textColor>
  <backgroundColor>#FFFFFF</backgroundColor>
  </it>
  </its>
  </SetDashboardControlsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "SetDashboardControls" : 
  {
   "mon" : "DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls",
   "arg" : 
    {
     "its" : 
      {
       "it" : 
        [
          {
           "k" : "2",
           "id" : "ITEM1",
           "title" : 
            {
             "text" : "City",
             "title" : "City"
            },
           "visualizerKey" : "1",
           "fieldKey" : "2",
           "binding" : "UI="DimCombo" ID="ITEM1" SELECTIONMODE="MultiSelect" VALUE="DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls!2!Selection"",
           "slideKeys" : 
            {
             "u" : "1"
            },
           "reciveKeys" : 
            {
             "u" : "2"
            },
           "font" : 
            {
             "family" : "Roboto",
             "style" : 
              {
               "it" : "Regular"
              },
             "size" : 
              {
               "width" : "-1",
               "height" : "14",
               "units" : "Pt"
              }
            },
           "textColor" : "#54575B",
           "backgroundColor" : "#FFFFFF"
          }
        ]
      }
    }
  }
}

JSON response:

{
 "SetDashboardControlsResult" : 
  {
   "its" : 
    {
     "it" : 
      [
        {
         "k" : "2",
         "id" : "ITEM1",
         "title" : 
          {
           "text" : "City",
           "title" : "City",
           "font" : 
            {
             "family" : "Roboto",
             "style" : 
              {
               "it" : "Regular"
              },
             "size" : 
              {
               "width" : "-1",
               "height" : "14",
               "units" : "Pt"
              }
            },
           "textColor" : "#54575B",
           "backgroundColor" : "#FFFFFF",
           "textAlignment" : "Near",
           "verticalTextAlignment" : "Center",
           "size" : 
            {
             "width" : "-1",
             "height" : "8000",
             "units" : "Mkm"
            },
           "visible" : "1",
           "htmlText" : "<span style="font-weight: normal;font-size: 14pt;color: #54575b;background-color: #ffffff;text-align: left;font-family: Roboto; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: Roboto; ">City</span></span>",
           "htmlTitle" : "<span style="font-weight: normal;font-size: 14pt;color: #54575b;background-color: #ffffff;text-align: left;font-family: Roboto; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: Roboto; ">City</span></span>",
           "isControl" : "1",
           "autoHeight" : "0",
           "customFormat" : 
            {
             "@F" : "",
             "@FT" : "0"
            }
          },
         "visualizerKey" : "1",
         "fieldKey" : "2",
         "binding" : "UI="DimCombo" ID="ITEM1" SELECTIONMODE="MultiSelect" VALUE="DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls!2!Selection"",
         "slideKeys" : 
          {
           "u" : "1"
          },
         "reciveKeys" : 
          {
           "u" : "2"
          },
         "font" : 
          {
           "family" : "Roboto",
           "style" : 
            {
             "it" : "Regular"
            },
           "size" : 
            {
             "width" : "-1",
             "height" : "14",
             "units" : "Pt"
            }
          },
         "textColor" : "#54575B",
         "backgroundColor" : "#FFFFFF"
        }
      ]
    }
  }
}
public static DashboardControls SetDashboardControls(string moniker, DashboardControl[] controls)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tSet = new SetDashboardControls()
    {
        arg = new DashboardControls()
        {
            its = controls
        },
        mon = moniker + "!Controls"
    };
    // Change information about controls
    var result = somClient.SetDashboardControls(tSet);
    return result;
}

See also:

Working with Information Panels