IconRuleCollection.AddStringRule Method

IconRuleCollection AddStringRule Method

TIBCO Spotfire 6.0 API Reference

Adds a string color rule to the end of the collection.

Namespace: Spotfire.Dxp.Application.Visuals.Miniatures
Assembly: Spotfire.Dxp.Application (in Spotfire.Dxp.Application.dll) Version: 13.19.7018.3940 (13.19.7018.3940)

Syntax

C++

Copy to Clipboard Print

public IconRule AddStringRule(
	StringComparisonOperator comparisonOperator,
	ConditionValue value,
	Color color,
	MarkerShape shape
)

public IconRule AddStringRule(
	StringComparisonOperator comparisonOperator,
	ConditionValue value,
	Color color,
	MarkerShape shape
)

Parameters

comparisonOperator: Type: Spotfire.Dxp.Application.Visuals.ConditionalColoring StringComparisonOperator
The comparison operator.

value: Type: Spotfire.Dxp.Application.Visuals.ConditionalColoring ConditionValue
The value.

color: Type: System.Drawing Color
The color of the icon rendered if the rule matches.

shape: Type: Spotfire.Dxp.Application.Visuals MarkerShape
The shape of the icon rendered if the rule matches.

Return Value

Type: IconRule
The rule that was added.