ShowConditionalFormattingRuleEditDialog(IdxDialogOwner,TdxSpreadSheetCustomConditionalFormattingRule) Method

Invokes the “Conditional Formatting Rule“ dialog for the specified control with conditional formatting support.

Declaration

function ShowConditionalFormattingRuleEditDialog(AOwner: IdxDialogOwner; var ARule: TdxSpreadSheetCustomConditionalFormattingRule): Boolean;

Parameters

Name	Type
AOwner	IdxDialogOwner
ARule	TdxSpreadSheetCustomConditionalFormattingRule

Returns

Type
Boolean

Remarks

Call this function to invoke the dialog that edits an existing conditional formatting rule or creates a new one. Use the AOwner parameter to pass a target control with support for conditional formatting (that is, a control that implements the IdxDialogOwner and IdxSpreadSheetConditionalFormatting interfaces); otherwise – a ShowConditionalFormattingRuleEditDialog function call has no effect. The ARule parameter either accepts a target rule to edit or returns a new rule.

The ShowConditionalFormattingRuleEditDialog function returns True if the “Conditional Formatting Rule” dialog is closed by an OK button click or an Enter keystroke; otherwise – False.

The second overloaded function variant is designed for use in C++Builder code, due to compiler limitations. This variant accepts a pointer to a control (AOwner) that has a conditional formatting functionality.

Note

A “Conditional Formatting Rules Manager“ dialog calls the ShowConditionalFormattingRuleEditDialog function to invoke the “Conditional Formatting Rule” dialog in response to a click on the “Edit Rule…” or “New Rule…” button.