GetDashboardControls

Syntax

Result GetDashboardControls(string mon, DashboardControls arg)

Parameters

mon. Moniker for working with information panel controls.

arg. Parameters for getting information about controls.

Description

The GetDashboardControls operation gets the list of controls created in information panel.

Comments

To execute the operation, in the mon field specify moniker of opened information panel instance with the !Controls postfix.

The moniker can be obtained on executing the OpenDashboard operation. In the arg.its field specify one collection element and set empty values or default values for the fields, which values should be obtained. Specify -1 as a key value.

The operation results in the requested settings of all information panel controls. To change the settings, use the SetDashboardControls operation.

Example

Below is the example of getting control settings. The request contains moniker for working with controls. The response contains the obtained 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">
<GetDashboardControls xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls</mon>
<arg xmlns="">
<its>
<it>
  <k>-1</k>
  <id />
  <title />
  <visualizerKey>-1</visualizerKey>
  <fieldKey>-1</fieldKey>
  <binding />
<slideKeys>
  <u>-1</u>
  </slideKeys>
<reciveKeys>
  <u>-1</u>
  </reciveKeys>
  </it>
  </its>
  </arg>
  </GetDashboardControls>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetDashboardControlsResult 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>1</k>
  <id>ITEM</id>
<title>
  <text>Calendar</text>
  <title>Calendar</title>
<font>
  <family>Microsoft Sans Serif</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: 'Microsoft Sans Serif'; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: 'Microsoft Sans Serif'; ">Calendar</span></span></htmlText>
  <htmlTitle><span style="font-weight: normal;font-size: 14pt;color: #54575b;background-color: #ffffff;text-align: left;font-family: 'Microsoft Sans Serif'; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: 'Microsoft Sans Serif'; ">Calendar</span></span></htmlTitle>
  <isControl>1</isControl>
  <autoHeight>0</autoHeight>
  <customFormat F="" FT="0" />
  </title>
  <visualizerKey>1</visualizerKey>
  <fieldKey>1</fieldKey>
  <binding>UI="DimCombo" ID="ITEM" SELECTIONMODE="MultiSelect" VALUE="DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls!1!Selection"</binding>
<slideKeys>
  <u>1</u>
  <u>2</u>
  </slideKeys>
<reciveKeys>
  <u>2</u>
  </reciveKeys>
  </it>
<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>
  </it>
  </its>
  </GetDashboardControlsResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetDashboardControls" : 
  {
   "mon" : "DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls",
   "arg" : 
    {
     "its" : 
      {
       "it" : 
        [
          {
           "k" : "-1",
           "id" : "",
           "title" : "",
           "visualizerKey" : "-1",
           "fieldKey" : "-1",
           "binding" : "",
           "slideKeys" : 
            {
             "u" : "-1"
            },
           "reciveKeys" : 
            {
             "u" : "-1"
            }
          }
        ]
      }
    }
  }
}

JSON response:

{
 "GetDashboardControlsResult" : 
  {
   "its" : 
    {
     "it" : 
      [
        {
         "k" : "1",
         "id" : "ITEM",
         "title" : 
          {
           "text" : "Calendar",
           "title" : "Calendar",
           "font" : 
            {
             "family" : "Microsoft Sans Serif",
             "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: 'Microsoft Sans Serif'; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: 'Microsoft Sans Serif'; ">Calendar</span></span>",
           "htmlTitle" : "<span style="font-weight: normal;font-size: 14pt;color: #54575b;background-color: #ffffff;text-align: left;font-family: 'Microsoft Sans Serif'; "><span style="color: #54575b;background-color: #ffffff;font-size: 14pt;font-weight: normal;font-family: 'Microsoft Sans Serif'; ">Calendar</span></span>",
           "isControl" : "1",
           "autoHeight" : "0",
           "customFormat" : 
            {
             "@F" : "",
             "@FT" : "0"
            }
          },
         "visualizerKey" : "1",
         "fieldKey" : "1",
         "binding" : "UI="DimCombo" ID="ITEM" SELECTIONMODE="MultiSelect" VALUE="DDAHEFONHJEHGOAEEDLJNELPBEBAIMJEJILGKJKBBPLABDMK!M!S!PMAMCNGONHJEHGOAEGHJFDCONGPFPHECEDKMIJJCJCFJDMONM!Controls!1!Selection"",
         "slideKeys" : 
          {
           "u" : 
            [
              "1",
              "2"
            ]
          },
         "reciveKeys" : 
          {
           "u" : "2"
          }
        },
        {
         "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"
          }
        }
      ]
    }
  }
}
public static DashboardControls GetDashboardControls(string moniker)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tGet = new GetDashboardControls()
    {
        arg = new DashboardControls()
        {
            its = new DashboardControl[]
            {
                new DashboardControl()
                {
                    binding = string.Empty,
                    fieldKey = uint.MaxValue,
                    id = string.Empty,
                    k = uint.MaxValue,
                    reciveKeys = new uint[] { uint.MaxValue },
                    slideKeys = new uint[] { uint.MaxValue },
                    visualizerKey = uint.MaxValue,
                    title = new GxTitle()
                }
            }
        },
        mon = moniker + "!Controls"
    };
    // Get information about controls
    var result = somClient.GetDashboardControls(tGet);
    return result;
}

See also:

Working with Information Panels