CygNet Studio > Using CygNet Studio Tools and Controls > Linear Gauge Tool > ActiveX Properties

Linear Gauge Tool - ActiveX Properties

The Linear Gauge Tool is an ActiveX control. As such, a Linear Gauge Tool object has an ActiveX page on the Property Sheet. Many of these properties are the object’s formatting properties. Values for the ActiveX Properties can be set directly on the ActiveX page or in the OCX Properties dialog box, which is accessed by clicking the (OCXProperties) property.

Property Description Related Properties

AutoCenter

Enables automatic centering of the component within its boundary. Default is 0 - No. If set to 0 - No, the component is aligned left in the boundary. OffsetX and OffsetY can be used to move the placement of the component in the boundary.

OffsetX

OffsetY

AutoFrameRate

Specifies whether the object controls its update rate. Default is 0 - No. When set to 1 - Yes, the object is repainted at the rate specified by the UpdateFrameRate property.

UpdateFrameRate

AutoScaleDesiredTicks

Specifies the desired TickMajorCount when AutoScaleEnabled is set to 1 - Yes. Default is 5. Due to the algorithm used to calculate the tick counts, the actual count may vary.

AutoScaleEnabled

AutoScaleEnabled

Enables auto scaling of the indicator. Default is 0 - No.

AutoScaleDesiredTicks

AutoScaleMaxTicks

AutoScaleStyle

AutoScaleMaxTicks

Specifies the maximum TickMajorCount when AutoScaleEnabled is set to 1 - Yes. Due to the algorithm used to calculate the tick counts, the actual count may vary. Default is 6.

AutoScaleEnabled

AutoScaleStyle

Specifies the style of adjustment for the PositionMin and PositionMax when AutoScaleEnabled is set to 1 - Yes. When set to 0 - iassAutoMinMax, PositionMin and PositionMax are adjusted so that the scale starts and stops on a major tick.

AutoScaleEnabled

BackGroundColor

Specifies the color of the object background. Default is gray (RGB 236.233.216). The background color is not shown if the Transparent property is set to 1 - Yes.

Transparent

[AlarmElement]

BackGroundPicture

Specifies the name of an image file to show on the background of the object. Default is blank.

 

BorderStyle

Specifies the border style of the object. Default is 0 - ibsNone. Other options are 1 - ibsRaised and 2 - ibsLowered.

 

CachedDrawing

Enables optimizing the display of the object. Default is 1 - Yes.

 

CurrentMax

Specifies the maximum value reached by the Position property. It is reset each time the Position value is greater than the CurrentMax value. The only way to access the value is programmatically (i.e., using script).

ShowMaxPointer

Position

CurrentMin

Specifies the minimum value reached by the Position property. It is reset each time the Position value is less than the CurrentMin value. The only way to access the value is programmatically (i.e., using script).

ShowMinPointer

Position

Enabled

Enables user interaction with the object. If set to 0 - No, the object is still shown but its context menu is disabled. Default is 1 - Yes.

 

EndsMargin

Specifies the margin (in pixels) between the indicator ends and the object boundary. Default is 10.

 

Height

Specifies the height (in pixels) of the object.

 

MaxPointerColor

Specifies the color of the max pointer. Default is cyan (RGB 0.255.255).

ShowMaxPointer

MinMaxFixed

Enables the Min and Max pointers to be fixed or track the range of the Position property. Default is 0 - No.

 

MinMaxedPointerMargin

Specifies the margin (in pixels) between the Min and Max pointers and the indicator. Default is 0.

 

MinMaxPointerSize

Specifies the size (in pixels) of the pointers. Default is 8.

 

MinMaxUserCanMove

Enables a user to move the Min and Max pointers in Run mode. Default is 1 - Yes.

 

MinPointerColor

Specifies the color of the Min pointer. Default is yellow (RGB 255.255.0).

ShowMinPointer

OffsetX

Specifies the offset of the indicator from the object’s x-axis. Default is 0.

 

OffsetY

Specifies the offset of the indicator from the object’s y-axis. Default is 0.

 

OptionSaveAllProperties

Enables the SaveAllPropertiesToFile method to save just the ActiveX Properties or all object properties. Default is 0 - No, which means that only ActiveX Properties are saved.

 

Orientation

Specifies the orientation of the indicator. The default is 0-ioVertical.

 

OrientationTickMarks

Specifies the location of the ticks marks in relation to the indicator. If the object orientation is vertical, the option is the left or right side. If it is horizontal, the option is top or bottom. Default is 0 - iosBottomRight.

 

PointerColor

Specifies the color of the pointer 0. Default is blue (RGB 0.0.255).

[AlarmElement]

PointerOffset

Specifies the offset between the Pointer and the axis of the tick marks. Default is 0.

 

PointerSize

Specifies the size in pixels of pointer 0. Default is 10.

 

PointerStyle

Specifies the style of pointer 0. Default is 0 - ilgpsPointer. Other options are 1 - ilgpsTriangle, 2-ilgpsLine, 3 - ilgpsColorBar.

 

Position

Specifies the position of indicator. Default is 0. If the object is associated with a point, the point’s value sets the position. If PositionPercent is specified, this value is calculated. If this value is specified, PositionPercent is calculated.

PositionMax

PositionMin

PositionPercent

CurrentMax

CurrentMin

PositionMax

Specifies the upper limit of the indicator level. Default is 100.

Position

PositionMin

PositionPercent

PositionMin

Specifies the lower limit of the indicator level. Default is 0.

Positio

PositionMax

PositionPercent

PositionPercent

Specifies the level of the indicator in terms of percent in regards to the range (PositionMax and PositionMin). If Position is specified, this value is calculated. If this value is specified, Position is calculated. Default is 0. Valid range is 0.00 (0%) and 1.00 (100%).

Position

PositionMax

PositionMin

PrecisionStyle

Specifies if the labels will show precision as significant digits (integers) or with decimal places. Default is 1 - ipsFixedDecimal Points, which enables the labels to show the number of decimal places specified by the TickLabelPrecision property.

TickLabelPrecision

ReverseScale

Enables reversing the scale. Normal scaling runs negative to positive left to right or bottom to top. Default is 0 - No.

 

SectionColor1

Specifies the color of Section 1. Default is green (RGB 0.128.0).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

 

SectionColor2

Specifies the color of Section 2. Default is yellow (RGB 255.255.0).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

 

SectionColor3

Specifies the color of Section 3. Default is red (RGB 255.0.0).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

 

SectionColor4

Specifies the color of Section 4. Default is yellow (RGB 255.255.0).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

 

SectionColor5

Specifies the color of Section 5. Default is yellow (RGB 255.255.0).

Note: In script, you can set this and other color properties using the VBScript function 'control.somecolor = RGB (255,0,0).'

 

SectionCount

Specifies the number of color sections. Default is 0.

 

SectionEnd1

Specifies the end value for Section 1. Default is 50.

 

SectionEnd2

Specifies the end value for Section 2. Default is 75.

 

SectionEnd3

Specifies the end value for Section 3. Default is 0.

 

SectionEnd4

Specifies the end value for Section 4. Default is 0.

 

ShowMaxPointer

Enables display of the Max Pointer. Default is 0 - No.

CurrentMax

MaxPointerColor

ShowMinPointer

Enables display of the Min Pointer. Default is 0 - No.

CurrentMin

MinPointerColor

ShowTickLabels

Enables display of the tick mark labels. Default is 1 - Yes.

 

ShowTickAxis

Enables display of the x-axis for the ticks. Default is 1 - Yes.

 

ShowTicksMajor

Enables display of the major tick marks. Default is 1 - Yes.

 

ShowTicksMinor

Enables display of the minor tick marks. Default is 1 - Yes.

 

TickLabelFont

Specifies the font for the tick labels. Default is MS Sans Serif (8 point).

 

TickLabelFontColor

Specifies the color of the tick mark labels. Default is black (RGB 0.0.0).

 

TickLabelMargin

Specifies the margin (in pixels) between the labels and major tick marks. Default is 5.

 

TickLabelPrecision

Specifies the number of decimal places for the tick labels. Default is 0. To use any value other than 0, TickLabelPrecison must be set to 1 - ipsFixedDecimal Points.

PrecisionStyle

TickMajorColor

Specifies the color of the major tick marks. Default is black (RGB 0.0.0).

 

TickMajorCount

Specifies the number of major tick marks displayed on the scale span. Default is 5.

 

TickMajorLength

Specifies the length (in pixels) of the major tick marks. Default is 20.

 

TickMajorStyle

Specifies the style of the major tick marks. Default is 2 - ibsLowered. Other options are 0 - ibsNone and 1 - ibsRaised.

 

TickMargin

Specifies the size of the margin (in pixels) between the tip of the pointer and the tick marks. Default is 0.

 

TickMinorAlignment

Specifies the alignment of the minor tick marks in relation to the major tick marks. Default is 0 - itmnaInside. Other options are 1 - itmnaCenter and 2 - itmnaOutside.

 

TickMinorColor

Specifies the number of minor tick marks displayed between major tick marks. Default is 4.

 

TickMinorCount

Specifies the number of minor tick marks displayed on the scale span. Default is 4.

 

TickMinorLength

Specifies the length (in pixels) of the minor tick marks. Default is 7.

 

TickMinorStyle

Specifies the style of the minor tick marks. Default is 0 - ibsNone. Other options are 1 - ibsRaised and 2 - ibsLowered.

 

Transparent

Enables transparency of the object background. Default is 0 - No.

 

UpdateFrameRate

Specifies the rate (in seconds) of repainting the object. Default is 60. Applicable only when AutoFrameRate is set to 1 - Yes.

AutoFrameRate

Visible

Enables the visibility of the object on TheView. Default is 1 - Yes.

 

Width

Specifies the width (in pixels) of the object.

 
Back to top

Let us know how we can improve this topic.

CygNet at weatherford.com

© 2020 Weatherford. All rights reserved.