GridCell.SetTextColorRules(StringArray, Array) Method

 Top 

Description

Applies the matchValues string array and the matchColors array as rules so that whenever the value of the cell matches one of the matchValues array values, the corresponding matchColor is applied to the text in that cell. The size of the matchColors array must match the size of the matchValues string array. The cell's text color will default to GridCell.TextColor in the case where there are no matches.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

GridCell.SetTextColorRules(

StringArray matchValues,

Array rangeColors)

 

 

Arguments

matchValues

Description:

The string values to compare against for the applied rules.

 

 

rangeColors

Description:

The colors to apply when between threshold values.

 

 

 

Syntax

myGridCell1.SetTextColorRules(myStringArray1, myArray1);

 

 

Example 1

The script example below shows how to use the text color rules of a GridCell to match string values.

 

// Add a Value with a Range to the GridWindow

 

Spacecraft sc;

GridWindow gw;

gw.Show();

 

gw.NumberOfRows    = 1;

gw.NumberOfColumns = 1;

 

// Note that the color array is the same size as the string array

gw.GetCell(0, 0).SetTextColorRules({"This is Green", "This is Red"}, {ColorTools.Green, ColorTools.Red});

 

gw.GetCell(0, 0).SetValue("This is Green");

Pause 2;

gw.GetCell(0, 0).SetValue("This is Red");

 

 

 

 

See also

GridCell Object

GridCell.SetTextColorRules

GridWindow Guide