GetTabFormatCondition

Syntax

TabFormatCondition GetTabFormatCondition(string mon)

Parameters

mon. Moniker of the range for working with its conditional formats.

Description

The GetTabFormatCondition operation gets conditional format settings for cell range.

Comments

To execute the operation, in the mon field specify regular report instance moniker with the !Sheets!sheet key!range address!FormatConditions!conditional format index postfix.

The operation results in the conditional format settings.

Example

Below is the example of getting conditional format settings. The request contains conditional format moniker, 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">
<GetTabFormatCondition xmlns="http://www.fsight.ru/PP.SOM.Som">
  <mon xmlns="">S1!M!S!P1!Sheets!1!A0:B3!FormatConditions!0</mon>
  </GetTabFormatCondition>
  </s:Body>
  </s:Envelope>

SOAP response:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/">
<soapenv:Body>
<GetTabFormatConditionResult 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">
  <k xmlns="">0</k>
  <Key xmlns="">0</Key>
  <Type xmlns="">CellContent</Type>
<Range xmlns="">
  <left>0</left>
  <top>0</top>
  <width>2</width>
  <height>4</height>
  </Range>
  <Enabled xmlns="">1</Enabled>
<Details xmlns="">
<CellContent>
  <ContentType>0</ContentType>
  <CellValue>100</CellValue>
  <SpecificText />
<Style UNS="2">
  <Text HA="-1" VA="-1" WW="-1" M="-1 -1 -1 -1" Mmm="-1.00 -1.00 -1.00 -1.00" />
  <Font S="10" B="true" H="15" />
  <Borders />
  <Hyperlink />
  </Style>
  <ValueCondition>4</ValueCondition>
  <TextCondition>0</TextCondition>
  <DateCondition>0</DateCondition>
  <MinValue />
  <MaxValue />
  </CellContent>
  </Details>
  </GetTabFormatConditionResult>
  </soapenv:Body>
  </soapenv:Envelope>

JSON request:

{
 "GetTabFormatCondition" : 
  {
   "mon" : "S1!M!S!P1!Sheets!1!A0:B3!FormatConditions!0"
  }
}

JSON response:

{
 "GetTabFormatConditionResult" : 
  {
   "k" : "0",
   "Key" : "0",
   "Type" : "CellContent",
   "Range" : 
    {
     "left" : "0",
     "top" : "0",
     "width" : "2",
     "height" : "4"
    },
   "Enabled" : "1",
   "Details" : 
    {
     "CellContent" : 
      {
       "ContentType" : "0",
       "CellValue" : "100",
       "SpecificText" : "",
       "Style" : 
        {
         "@UNS" : "2",
         "Text" : 
          {
           "@VA" : "-1",
           "@Mmm" : "-1.00 -1.00 -1.00 -1.00",
           "@HA" : "-1",
           "@M" : "-1 -1 -1 -1",
           "@WW" : "-1"
          },
         "Font" : 
          {
           "@B" : "true",
           "@S" : "10",
           "@H" : "15"
          },
         "Borders" : "",
         "Hyperlink" : ""
        },
       "ValueCondition" : "4",
       "TextCondition" : "0",
       "DateCondition" : "0",
       "MinValue" : "",
       "MaxValue" : ""
      }
    }
  }
}
public static TabFormatCondition GetFormatCondition(string moniker, string sheetKey, string address, string formatKey)
{
    var somClient = new SomPortTypeClient(); // Proxy object for operation execution
    // Operation execution parameters
    var tTab = new GetTabFormatCondition()
    {
        mon = moniker + "!Sheets!" + sheetKey + '!' + address+ "!FormatConditions!" + formatKey
    };
    // Get conditional format parameters
    var result = somClient.GetTabFormatCondition(tTab);
    return result;
}

See also:

Table