SetTabFormatConditions

Syntax

bool SetTabFormatConditions(string mon, TabFormatConditionsEx tArg)

Parameters

mon. Moniker to work with conditional formats of analytical data area table.

tArg. Updated conditional formats settings.

Description

The SetTabFormatConditions operation changes settings of conditional formats for analytical data area table.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the !DataArea!Views!«table key»!EaxTableStyle!InternalFormatConditions postfix, and in the tArg field specify conditional format parameters to be applied. Conditional formats must not be bound to any cell range (the Range field in each format settings must be null).

The operation results in the logical True if the settings were changed successfully.

Example

Below is the example of changing conditional formats settings. The request contains range moniker and new settings of conditional formats. The response contains whether change is executed 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">
<SetTabFormatConditions xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!E1!DataArea!Views!1!EaxTableStyle!InternalFormatConditions</mon>
<tArg xmlns="">
<conditions>
<Condition>
  <k>0</k>
  <Key>0</Key>
  <Type>Values</Type>
  <Enabled>true</Enabled>
<Details>
<Values>
  <Style>0</Style>
  <MinValueType>0</MinValueType>
  <MinValue />
  <MinValueColor>#FF0000</MinValueColor>
  <MaxValueType>1</MaxValueType>
  <MaxValue />
  <MaxValueColor>#00FF00</MaxValueColor>
  <MidValueType>3</MidValueType>
  <MidValue>50</MidValue>
  <MidValueColor>#FFFF00</MidValueColor>
<Points>
<Point>
  <Type>3</Type>
  <Value>20</Value>
  <Condition>1</Condition>
  </Point>
<Point>
  <Type>3</Type>
  <Value>40</Value>
  <Condition>1</Condition>
  </Point>
<Point>
  <Type>3</Type>
  <Value>60</Value>
  <Condition>1</Condition>
  </Point>
<Point>
  <Type>3</Type>
  <Value>80</Value>
  <Condition>1</Condition>
  </Point>
  </Points>
  <IconType>Circles</IconType>
  <ShowValues>true</ShowValues>
  <ReverseIcons>false</ReverseIcons>
  </Values>
  </Details>
  </Condition>
  </conditions>
  </tArg>
  </SetTabFormatConditions>
  </s:Body>
  </s:Envelope>

SOAP response:

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

JSON request:

{
 "SetTabFormatConditions" : 
  {
   "mon" : "S1!M!S!E1!DataArea!Views!1!EaxTableStyle!InternalFormatConditions",
   "tArg" : 
    {
     "conditions" : 
      {
       "Condition" : 
        {
         "k" : "0",
         "Key" : "0",
         "Type" : "Values",
         "Enabled" : "true",
         "Details" : 
          {
           "Values" : 
            {
             "Style" : "0",
             "MinValueType" : "0",
             "MinValue" : "",
             "MinValueColor" : "#FF0000",
             "MaxValueType" : "1",
             "MaxValue" : "",
             "MaxValueColor" : "#00FF00",
             "MidValueType" : "3",
             "MidValue" : "50",
             "MidValueColor" : "#FFFF00",
             "Points" : 
              {
               "Point" : 
                [
                  {
                   "Type" : "3",
                   "Value" : "20",
                   "Condition" : "1"
                  },
                  {
                   "Type" : "3",
                   "Value" : "40",
                   "Condition" : "1"
                  },
                  {
                   "Type" : "3",
                   "Value" : "60",
                   "Condition" : "1"
                  },
                  {
                   "Type" : "3",
                   "Value" : "80",
                   "Condition" : "1"
                  }
                ]
              },
             "IconType" : "Circles",
             "ShowValues" : "true",
             "ReverseIcons" : "false"
            }
          }
        }
      }
    }
  }
}

JSON response:

{
 "SetTabFormatConditionsResult" : "1"
}
public static bool SetFormatConditions(string moniker, string viewKey, TabFormatConditionsEx formats)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tTab = new SetTabFormatConditions()
    {
        mon = moniker + "!DataArea!Views!" + viewKey + "!EaxTableStyle!InternalFormatConditions",
        tArg = formats
    };
    // Change conditional format parameters
    var result = somClient.SetTabFormatConditions(tTab);
    return result;
}

See also:

Table