GaugeAddTrendpoint method (WinStudio scripts)

Applies To

IWSFormComponent interface

Definition

This method adds a trend point to a gauge component, using line elements to define the trend point attributes.

Syntax

Dim trendpointName As Trendpoint

trendpointName.attributeX = valueX

gauge.GaugeAddTrendpoint( trendpointName )

  Part     Description    
trendpointName Required. Specifies the name by which the trend point is to be identified.  
attributeX Optional. Specifies the name of a trend point attribute.
valueX One required for each attribute specified. Specifies the value to be assigned to attirbuteX.

Remarks

You should declare and name the trend point and its attributes before you attempt to use this method to add the trend point to the gauge. It is also a good practice to employ the GaugeClearTrendpoints method before you declare and use this one.

You can use this method to define multiple trend points.

For a complete list and description of the trend point attributes available for scripting, see Specifying trend point settings for gauges.

Example

This example shows how the trend point should first be defined/declared and the attributes specified before the trend point is actually added to the gauge.

This example is given in Visual Basic. 

gauge.GaugeClearTrendpoints()

Dim trendpoint As Trendpoint
trendpoint.StartValue = 7
trendpoint.Color = "FFFFFF"
trendpoint.Dashed = True
trendpoint.DisplayValue = "Target"
gauge.GaugeAddTrendpoint(trendpoint)
Related topics