Creating a Control: the SetPrxMd Operation

Below is the example of using the SetPrxMd operation to create a control in a regular report. The request contains moniker of opened report instance, a pattern indicating whether a control must be created, and metadata that contains parameters of the new control. The result of the operation is updated information about all the controls in the regular report.

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

</tPrx>

</pattern>

<meta>

<its>

<it>

<UI>ComboBox</UI>

<value>Monday</value>

</value>

</binding>

</it>

</its>

</controls>

</meta>

</metaGet>

</tArg>

</SetPrxMd>

</s:Body>

</s:Envelope>

SOAP response:

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

<soapenv:Body>

</id>

<i>REPORT_1</i>

<n>Regular report</n>

</obDesc>

</obInst>

<its>

<it>

<value>

<dimId>

<id>S1!M!S!P2!Controls!1</id>

</dimId>

</value>

<size>

</size>

</dataSource>

<slice>

<id>Slice1</id>

<n>Slice1</n>

</slice>

<id>CALENDAR</id>

<n>Calendar</n>

</dimension>

</appearance>

<UI>DimCombo</UI>

<valueAttribute>ORDER</valueAttribute>

</value>

</binding>

</it>

<it>

<value>

<value>Monday</value>

</value>

<size>

</size>

</appearance>

<UI>ComboBox</UI>

<value>Monday</value>

</value>

</binding>

</it>

</its>

<its>

<it>

<order>

</order>

</it>

<it>

<order>

</order>

</it>

</its>

</sheetControlsOrders>

</controls>

</dataChange>

</meta>

</SetPrxMdResult>

</soapenv:Body>

</soapenv:Envelope>

JSON request:

{
 "SetPrxMd" : 
  {
   "tPrx" : 
    {
     "id" : "S1!M!S!P2"
    },
   "tArg" : 
    {

     "pattern" : 
      {
       "obInst" : "true",
       "controls" : "Add"
      },
     "meta" : 
      {
       "controls" : 
        {
         "its" :

          {
           "it" : 
            [
              {
               "k" : "0",
               "autoRecalc" : "true",
               "binding" : 
                {
                 "value" : 
                  {

                   "@type" : "q1:UiControlBindingComboBox",
                   "UI" : "ComboBox",
                   "value" : "Monday",
                   "listMode" : "true",
                   "items" : "Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday",
                   "separators" : "|"
                  }
                }
              }
            ]

          }
        }
      },
     "metaGet" : 
      {
       "obInst" : "true",
       "controls" : "Get"
      }
    }
  }
}

JSON response:

{
 "SetPrxMdResult" : 
  {
   "id" :

    {
     "id" : "S1!M!S!P2"
    },
   "meta" : 
    {
     "obInst" : 
      {
       "obDesc" : 
        {
         "@isShortcut" : "0",

         "@isLink" : "0",
         "i" : "REPORT_1",
         "n" : "Regular report",
         "k" : "6334",
         "c" : "2562",
         "p" : "6333",
         "h" : "0"
        }
      },
     "dirty" : "1",

     "controls" : 
      {
       "its" : 
        {
         "it" : 
          [
            {
             "k" : "1",
             "id" : "ITEM",
             "n" : "ITEM",

             "vis" : "1",
             "value" : 
              {
               "value" : "",
               "dt" : "0",
               "dimId" : 
                {
                 "id" : "S1!M!S!P2!Controls!1"
                }
              },

             "autoRecalc" : "1",
             "recalcOnChange" : "0",
             "size" : 
              {
               "width" : "-1",
               "height" : "-1",
               "units" : "DLU96"
              },
             "dimension" : 
              {

               "dataSource" : 
                {
                 "k" : "1",
                 "id" : "STD_CUBE",
                 "n" : "Cube",
                 "vis" : "1"
                },
               "slice" : 
                {
                 "k" : "1"

                 "id" : "Slice1",
                 "n" : "Slice1",
                 "vis" : "1"
                },
               "dimension" : 
                {
                 "k" : "112",
                 "id" : "CALENDAR",
                 "n" : "Calendar",
                 "vis" : "1"

                }
              },
             "appearance" : 
              {
               "report" : "1",
               "specificRecalc" : "1",
               "recalcAllSheets" : "1"
              },
             "multiSelect" : "1",
             "binding" :

              {
               "value" : 
                {
                 "@type" : "q1:UiControlBindingDimCombo",
                 "UI" : "DimCombo",
                 "mandatory" : "1",
                 "object" : "CALENDAR",
                 "valueAttribute" : "ORDER",
                 "levelAttribute" : "0{}",
                 "paramValues" : ""

                }
              }
            },
            {
             "k" : "2",
             "id" : "ITEM1",
             "n" : "ITEM1",
             "vis" : "1",
             "value" : 
              {

               "value" : "Monday",
               "dt" : "1"
              },
             "autoRecalc" : "1",
             "recalcOnChange" : "0",
             "size" : 
              {
               "width" : "-1",
               "height" : "-1",
               "units" : "DLU96"

              },
             "appearance" : 
              {
               "report" : "1",
               "specificRecalc" : "0"
              },
             "multiSelect" : "2",
             "binding" : 
              {
               "value" :

                {
                 "@type" : "q1:UiControlBindingComboBox",
                 "UI" : "ComboBox",
                 "value" : "Monday",
                 "listMode" : "1",
                 "items" : "Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday",
                 "separators" : "|"
                }
              }
            }

          ]
        },
       "sheetControlsOrders" : 
        {
         "its" : 
          {
           "it" : 
            [
              {
               "SheetKey" : "1",

               "SheetKey" : "2",
               "order" : 
                {
                 "it" : 
                  [
                    "1",
                    "2"
                  ]
                }
              }

            ]
          }
        }
      },
     "dataChange" : 
      {
       "isDataChanged" : "0"
      }
    }
  }
}

    public static SetPrxMdResult CreatePrxControl(PrxId moniker)
    {
        var somClient = new SomPortTypeClient(); //Proxy object for operation execution
        //Operation execution parameters
        var tArg = new SetPrxMd()
        {
            tArg = new SetPrxMdArg()
            {

                meta = new PrxMd()
                {
                    controls = new PrxControls()
                    {
                        its = new PrxControl[1]
                        { 
                            //Parameters of created control
                            new PrxControl()
                            {
                                autoRecalc = true

                                //Parameters of control editor
                                binding = new UiControlBinding()
                                {
                                    value = new UiControlBindingComboBox()
                                    {
                                        UI = "ComboBox",
                                        items = "Monday|Tuesday|Wednesday|Thursday|Friday|Saturday|Sunday",
                                        separators = "|",
                                        value = "Monday",
               listMode = true

                                    }
                                }
                            }
                        }
                    }
                },
                pattern = new PrxMdPattern()
                {
                    controls = ListOperation.Add,
                },

                metaGet = new PrxMdPattern()
                {
                    controls = ListOperation.Get
                }
            },
            tPrx = moniker
        };
        //Get data
        var result = somClient.SetPrxMd(tArg);
        return result;
    }