Skip to main content

TdxSpreadSheetCustomConditionalFormatting.Add(TdxSpreadSheetCustomConditionalFormattingRuleClass,Untyped) Method

Creates a new rule with an empty list of affected cell ranges.

Declaration

procedure Add(ARuleClass: TdxSpreadSheetCustomConditionalFormattingRuleClass; out ARule); overload;

Parameters

Name Type Description
ARuleClass TdxSpreadSheetCustomConditionalFormattingRuleClass

The reference to the required terminal TdxSpreadSheetCustomConditionalFormattingRule class descendant.

ARule

Returns the created rule as an untyped reference (in Delphi) or pointer (in C++Builder).

Pass an uninitialized reference (in Delphi) or pointer (in C++Builder) to an object of the conditional formatting rule type specified through the ARuleClass parameter.

Remarks

Call the Add procedure to create a new conditional formatting rule of the required type and add the rule to the conditional formatting controller. The created rule affects no cell range in the parent worksheet. Use the rule’s Areas property to specify target cell ranges.

Alternatively, you can call the constructor of the required rule class and pass the current conditional formatting controller as a parameter.

Tip

You can use the Rules property to access all rules created in the conditional formatting controller.

See Also