removeRule Method

Removes a rule object from the ConditionalFormats object.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new GC.Spread.Sheets.ConditionalFormatting.ConditionalFormats(worksheet);
var value; // Type: any
value = instance.removeRule(rule);

function removeRule( 
   rule : ConditionRuleBase
) : any;

Parameters

rule: The rule object to remove from the ConditionalFormats object.

Example

This example uses the removeRule method.

var style = new GC.Spread.Sheets.Style();
style.backColor = "red";
var rule = new GC.Spread.Sheets.ConditionalFormatting.NormalConditionRule();
rule.ruleType(GC.Spread.Sheets.ConditionalFormatting.RuleType.cellValueRule);
rule.ranges([new GC.Spread.Sheets.Range(0,0,5,1)]);
rule.operator(GC.Spread.Sheets.ConditionalFormatting.ComparisonOperators.between);
rule.style(style);
rule.value1(2);
rule.value2(100);
activeSheet.conditionalFormats.addRule(rule);
activeSheet.setValue(0,0,1,3);
activeSheet.setValue(1,0,45,3);
activeSheet.conditionalFormats.removeRule(rule);

Reference

ConditionalFormats type