Syncfusion.XlsIO.Base
Example 


ColorScale Property

Gets color scale conditional formatting rule. Read-only.
Syntax
'Declaration
 
ReadOnly Property ColorScale As IColorScale
'Usage
 
Dim instance As IConditionalFormat
Dim value As IColorScale
 
value = instance.ColorScale
IColorScale ColorScale {get;}
Remarks
Valid only if FormatType is set to ColorScale.
Example
ColorScale can be set by setting ExcelCFType.ColorScale to FormatType property. To customize criteria for applying color scale we have to set values for properties in IColorScale interface. Here for example, we set values for Criteria property and use SetConditionCount method.
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