Rocker Switch Tool – Properties, Events, and Methods

CygNet Studio > Using CygNet Studio Tools and Controls > Rocker Switch Tool > Properties, Events, and Methods

Rocker Switch Tool – Properties, Events, and Methods

The following tables list properties, events, and methods for the Rocker Switch Tool.

The first table lists normal properties, events, and ActiveX properties as they appear on the tool's Property Sheet.
The second table lists normal properties, normal methods, ActiveX properties, and ActiveX methods as they appear in the tool's Script Editor.

Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The column in the table below indicates whether or not a property or method is accessible using the X method.

Property Sheet

The following items are accessible by means of the control's Property Sheet in CygNet Studio. Click on any link for more information.

Normal

Events

ActiveX

[1:SiteService]

[3:Long Point ID]

[4:Facility ID]

[AllowAlarmAck]

[CommandPrompt]

[CustomStateColors]

[DisplayAlarmAck]

[ReferenceFacility]

[StateColorEvaluation]

[UseCustomStateColors]

EventCommandStatus

EventContextMenu

EventInitialize

EventOnBeforeNewOPCData

EventOnChangeUser

EventOnDblClick

EventOnKeyPress

EventOnMouseDown

EventOnMouseMove

EventOnNewOPCData

EventPointChange

EventPreToolTip

EventSendCommand

(OCXProperties)

BackGroundColor

IndicatorActiveColor

IndicatorMargin

MouseControlStyle

OptionSaveAllProperties

UpdateFrameRate

Back to top

Script Editor

The following items are accessible by means of the control's script editor in CygNet Studio. Click on any link for more information.

Properties

Properties

Methods

Methods

ActiveX Properties

ActiveX Properties

ActiveX Methods

ActiveX Methods

CygNetTagConfig

DisplayAlarmAck

ReferenceFacility

UseCustomStateColors

AlarmAcknowledge

PointConfigAlarmSettings

PointConfigAlarmSuppression

PointConfigComments

PointConfigQuestionable

RegisterPointForChangeNotice

ShowConfiguration

ShowCurrentValue

TrendRemovePoint

TrendSinglePoint

TrendSinglePointRollup

Active

AutoFrameRate

BackGroundColor

BorderMargin

BorderStyle

ComponentHandle

Enabled

Height

IndicatorActiveColor

IndicatorMargin

MouseControlStyle

OptionSaveAllProperties

ShowFocusRect

Transparent

UpdateFrameRate

Visible

Width

AboutBox

BeginUpdate

EndUpdate

GetBytesJPEG

GetBytesPNG

GetObjectPointer

GetOPCItemActive

GetOPCItemAutoConnect

GetOPCItemComputerName

GetOPCItemData

GetOPCItemGroupName

GetOPCItemItemName

GetOPCItemPropertyName

GetOPCItemQuality

GetOPCItemServerName

GetOPCItemTimeStamp

GetOPCItemUpdateRate

iPaintToDC

LoadPropertiesFromFile

Lock

OPCAddItem

OPCDeleteItem

OPCItemActivate

OPCItemActivateSuspend

OPCItemCount

OPCItemDeactivate

OPCItemLoaded

OPCItemUpdateResume

OPCItemUpdateSuspend

OPCRemoveAllItems

RepaintAll

SaveImageToBitmap

SaveImageToJPEG

SaveImageToMetaFile

SaveImageToPNG

SavePropertiesToFile

SetActiveNoEvent

SetOPCItemAutoConnect

SetOPCItemComputerName

SetOPCItemData

SetOPCItemGroupName

SetOPCItemItemName

SetOPCItemPropertyName

SetOPCItemServerName

SetOPCItemUpdateRate

ShowPropertyEditor

Unlock

Back to top

© 2020 Weatherford. All rights reserved.