Syncfusion.XlsIO.Base
Example 


Criteria Property

Gets a collection of individual IColorConditionValue objects. Read-only.
Syntax
'Declaration
 
ReadOnly Property Criteria As IList(Of IColorConditionValue)
'Usage
 
Dim instance As IColorScale
Dim value As IList(Of IColorConditionValue)
 
value = instance.Criteria
IList<IColorConditionValue> Criteria {get;}
Remarks
The default size of the criteria list is 2 and it can be changed using SetConditionCount method. To know more about Conditional formatting Types refer this link.
Example
The criteria for applying color scale can be accessed from the Criteria Property. The following code illustrates how to access the IColorConditionValue objects from the criteria list and change the properties FormatColorRGB, Type and Value by accessing each criterio from the Criteria list.
using Syncfusion.XlsIO;
using System.Drawing;
            
class Example
{
    static void Main()
    {
        //Create a worksheet.        
        ExcelEngine excelEngine = new ExcelEngine();
        IApplication application = excelEngine.Excel;
        application.DefaultVersion = ExcelVersion.Excel2013;
        IWorkbook workbook = application.Workbooks.Create(1);
        IWorksheet worksheet = workbook.Worksheets[0];
            
        //Load data to Apply Conditional Formatting.
        worksheet["A1"].Text = "ColorScale";
        worksheet["A2"].Number  =  10;
        worksheet["A3"].Number  =  20;
        worksheet["A4"].Number  =  30;
        worksheet["A5"].Number  =  40;
        worksheet["A6"].Number  =  50;
        worksheet["A7"].Number  =  60;
        worksheet["A8"].Number  =  70;
        worksheet["A9"].Number  =  80;
        worksheet["A10"].Number =  90;
        worksheet["A11"].Number =  100;
        
        //Create instance of IConditonalFormat and IConditionalFormats.
        IConditionalFormats formats = worksheet["A2:A11"].ConditionalFormats;
        IConditionalFormat format = formats.AddCondition();
            
        //Set FormatType as ColorScale.
        format.FormatType = ExcelCFType.ColorScale;
        IColorScale colorScale = format.ColorScale;
            
        //Set 3 as count for color scale
        colorScale.SetConditionCount(3);
        
        //Set Criteria for applying ColorScale
        colorScale.Criteria[0].FormatColorRGB = Color.White;
        colorScale.Criteria[0].Type = ConditionValueType.Percentile;
        colorScale.Criteria[0].Value = "0";
            
        colorScale.Criteria[1].FormatColorRGB = Color.Red;
        colorScale.Criteria[1].Type = ConditionValueType.Percentile;
        colorScale.Criteria[1].Value = "50";
            
        colorScale.Criteria[2].FormatColorRGB = Color.Blue;
        colorScale.Criteria[2].Type = ConditionValueType.Percentile;
        colorScale.Criteria[2].Value = "100";
        
        //Save and Dispose.
        workbook.SaveAs("ConditionalFormats.xlsx");
        workbook.Close();
        excelEngine.Dispose();
    }
}
AssemblyVersion

Syncfusion.XlsIO.Base: 17.1460.0.32

See Also