TTMSFNCFilterRuleActions.Add Method

Adds a new action item to the collection and returns it.

API unit family: TMS.TMSFNCFilterRulesManager Declaring type: TTMSFNCFilterRuleActions

Overloads

Overload 1

Adds a new action item to the collection and returns it.

TMS.TMSFNCFilterRulesManager.hppPascalC++

function Add: TTMSFNCFilterRuleAction; reintroduce; overload;

HIDESBASE TTMSFNCFilterRuleAction* __fastcall Add()/* overload */;

Returns

The newly added action item.

Overload 2

Adds an action that writes AMatchValue to ATargetPath when the filter matches; returns Self for chaining.

TMS.TMSFNCFilterRulesManager.hppPascalC++

function Add(const ATargetPath: string; const AMatchValue: TTMSFNCValue): TTMSFNCFilterRuleActions; overload;

HIDESBASE TTMSFNCFilterRuleActions* __fastcall Add(const System::UnicodeString ATargetPath, const TTMSFNCValue &AMatchValue)/* overload */;

Parameters

Name	Description
ATargetPath	RTTI path on the item to write (for example Visible or Font.Color).
AMatchValue	Value written when the filter matches.

Overload 3

Adds an action with match and no-match values; returns Self for chaining.

TMS.TMSFNCFilterRulesManager.hppPascalC++

function Add(const ATargetPath: string; const AMatchValue: TTMSFNCValue; const ANoMatchValue: TTMSFNCValue): TTMSFNCFilterRuleActions; overload;

HIDESBASE TTMSFNCFilterRuleActions* __fastcall Add(const System::UnicodeString ATargetPath, const TTMSFNCValue &AMatchValue, const TTMSFNCValue &ANoMatchValue)/* overload */;

Parameters

Name	Description
ATargetPath	RTTI path on the item to write.
AMatchValue	Value written when the filter matches.
ANoMatchValue	Value written when the filter does not match.

Overload 4

Adds an action covering match, no-match and inactive states; returns Self for chaining.

TMS.TMSFNCFilterRulesManager.hppPascalC++

function Add(const ATargetPath: string; const AMatchValue: TTMSFNCValue; const ANoMatchValue: TTMSFNCValue; const AInactiveValue: TTMSFNCValue): TTMSFNCFilterRuleActions; overload;

HIDESBASE TTMSFNCFilterRuleActions* __fastcall Add(const System::UnicodeString ATargetPath, const TTMSFNCValue &AMatchValue, const TTMSFNCValue &ANoMatchValue, const TTMSFNCValue &AInactiveValue)/* overload */;

Parameters

Name	Description
ATargetPath	RTTI path on the item to write.
AMatchValue	Value written when the filter matches.
ANoMatchValue	Value written when the filter does not match.
AInactiveValue	Value written when the rule is inactive.