SetPen

SetPen

These functions configures a pen in the trend object with the specified parameters.

Function Definition:

void SetPenDescription(string tagName, string description);

void SetPenLineStyle(string tagName, int lineStyle);

void SetPenThickness(string tagName, double thickness);

void SetPenColor(string tagName, string penColor);

void SetPenInterpolated(string tagName, bool interpol);

void SetPenMin(string tagName, double min);

void SetPenMax(string tagName, double max);

void SetPenMarker(string tagName, int marker);

void SetPenShowLegend(string tagName, bool showLegend);

.     String tagName: A string parameter containing the pen tag name that will be tracked.

.     String description: A string parameter containing a desciption of the pen.

.     String penColor: A string parameter containing the color of pen.

.     Integer lineStyle: An int indicating the pen line style. The values can be: 0 - Solid, 1 - Dash, 2 - DashDot, 3 - DashDotDot, 4 - Dot

.     double thickness: A double parameter indicating the pen line thickness.

.     bool interpol: A bool parameter indicating the pen is interpolated or not.

.     int marker: An int indicating the pen marker. The values can be: 0 - None, 1 - Circle, 2 - Triangle

.     bool showLegend: A bool parameter indicating if the pen will show legend or not.

.     double min: A double parameter indicating the min.

.     double max: A double parameter indicating the max.

To configure this property, follow the steps below:

1.   In an object event, configure the AddPen function: TrendObjectName.SetPenColor(tagName, penColor);

2.   During the execution of RunTime, run the configured event.

Example with SetPenColor(string tagName, string penColor):

In the graphic document, the user has one Trend object (named as Trend1). In a Button object (named as Button1) the user configures the MouseUp event with the following event:

Trend1.SetPenColor("NewTag1","Red");

In this event, the "NewTag1" pen will set its line color to red.