CygNet Studio > Using CygNet Studio Tools and Controls > Knob Tool > ActiveX Properties

Knob Tool - ActiveX Properties

The Knob Tool is an ActiveX control. As such, a Knob 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

AutoFrameRate

Enables the object to control 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 can 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 can vary. Default is 6.

AutoScaleEnabled

AutoScaleStyle

Specifies the style for adjusting the PositionMin and PositionMax when AutoScale is enabled. Option is either 0 - iassAutoMinMax or 1 - iassFixMinMax. Default is 0 - iassAutoMinMax.

PositionMin

PositionMax

AutoScaleEnabled

AutoSize

Enables automatic adjustment of the knob radius based on the object boundary size.

 

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.

Note: Although Windows Metafile (.wmf) is listed as a format option, this file format is not supported.

[AlarmElement]

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 Knob 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).

 

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).

 

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.

 

Height

Specifies (in pixels) the height of the object.

 

IndicatorActiveColor

Specifies the color of the pointer when it is being moved. Default is cyan (RGB 0.255.255).

IndicatorInactiveColor

IndicatorInactiveColor

Specifies the color of the pointer when it is idle. Default is red (RGB 255.0.0).

IndicatorActiveColor

IndicatorMargin

Specifies (in pixels) the margin between the indicator and the edge of the knob. Default is 5.

 

IndicatorSize

Specifies the size (in pixels) of the indicator. Default is 4.

 

IndicatorStyle

Specifies the style of the indicator. Default is 0 - ikisDotLowered. Other options are 1 - ikisDotRaised, 2 - ikisDot, 3 - ikisLineCenter, 4 - ikisLineCustom, 5 -  ikisTriangle.

IndicatorSize

IndicatorActiveColor

IndicatorInactiveColor

KeyArrowStepSize

Specifies the increment applied to the knob position when the arrow keys are pressed. Default is 0.1.

 

KeyPageStepSize

Specifies the increment applied to the knob position when the Page Up or Page Down keys are pressed. Default is 1.

 

KnobEdgeWidth

Specifies (in pixels) the width of the knob edge. Default is 3.

 

KnobRadius

Specifies (in pixels) the radius of the knob. Default is 3. AutoSize must be set to 0 - No to manually set the radius.

AutoSize

KnobStyle

Specifies the style of the knob. Default is 0 - iksRaisedEdge. Other options are 1 - iksRaised, 2 - iksSunken, and 3 - iksSunkenEdge.

 

MinMaxFixed

Not applicable for this tool. Specifies whether the minimum and maximum pointers are fixed or will track the range of the Position property. Default is 0 - No.

 

MouseWheelStepSize

Specifies the adjustment to the knob position when the mouse wheel is moved one increment. Default is 1.

 

OffsetX

Specifies the offset of the object from its x-axis. Default is 0.

 

OffsetY

Specifies the offset of the object from its 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 P\properties are saved.

 

OuterMargin

Specifies the margin (in pixels) between the knob and the object boundary when AutoSize is enabled.

AutoSize

Position

Specifies the starting position of the indicator. Default is 0. In Run mode the position is determined by the point associated with the object.

PositionMax

PositionMin

PositionPercent

PositionDisplayFont

Specifies the font for the value shown in the center of the knob when  ShowPositionDisplay is enabled. Default is MS Sans Serif (8 point).

ShowPositionDisplay

PositionDisplayFontColor

Specifies the color of the position display. Default is black (RGB 0.0.0).

PositionDisplayFont

PositionDisplayPrecision

Specifies the precision of the position display value. Default is 1.

ShowPositionDisplay

PositionDisplayUnits

Specifies a text string to be appended position display. Typically engineering units are used.

ShowPositionDisplay

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.

Position

PositionMax

PositionPercent

PositionPercent

Specifies the level of the indicator in terms of percent in regards to the range (PositionMax and PositionMin). This value is calculated. Default is 0. Valid range is 0.00 (0%) and 1.00 (100%). The only way to access the value is programmatically (i.e., using script).

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

RotationMaxDegrees

Specifies the number of degrees the Knob can rotate. Default is 270.

RotationStartDegrees

RotationStartDegrees

Specifies the degree for the PositionMin. That is, the position at which the knob starts its clockwise rotation. Default is 225.

PositionMin

RotationMaxDegrees

ShowFocusRect

Enables display of the focus rectangle.

Tabstop

ShowPositionDisplay

Enables the indicator position to be shown in the center of the knob. Default is 0 - No.

 

ShowTickLabels

Enables display of the tick mark labels. 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 size of the margin (in pixels) between the labels and the tick marks. Default is 15.

 

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 7.

 

TickMargin

Specifies the size of the margin (in pixels) between the knob and the tick marks. Default is 5.

 

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 color of the minor tick marks. Default is black (RGB 0.0.0).

 

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 3.

 

Transparent

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

BackGroundColor

BackGroundPicture

UpdateFrameRate

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

AutoFrameRate

UseKeyboard

Enables whether the knob responds to keyboard actions. Default is 1 - Yes.

 

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.