SetPoint Button Tool – Properties, Events, and Methods

CygNet Studio > Using CygNet Studio Tools and Controls > SetPoint Button Tool > SetPoint Button Tool – Properties, Events, and Methods

SetPoint Button Tool – Properties, Events, and Methods

The following tables list properties, events, and methods for the SetPoint Button 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.

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
(ObjectCode) [1:SiteService] [2:Point ID] [3:Long Point ID] [4:Facility ID] [5:UDC] [AlarmElement] [AllowAlarmAck] [BlinkColor] [ContextMenu] [CustomStateColors] [DisplayAlarmAck] [DisplayElement] [DisplayFormat] [DisplayItem] [ReferenceFacility] [SetPoint] [StateColorEvaluation] [StateColorMode] [UnknownTag] [UseCustomStateColors] Alignment AutoSizeFont BackColor Bitmap Bottom ButtonShape CursorPointer Default Enable FlexHorizontal FlexVertical Font ForeColor Group HelpContextID Layer Layout Left Right SpacerWidth Tabstop Tag Text ToolTipText Top Visible	EventContextMenu EventInitialize EventItemChange EventMouseDown EventMouseMove EventMouseUp EventOnStatusValueChange EventPointChange EventPostSetPoint EventPreSetPoint EventPreToolTip	N/A

Normal

Events

ActiveX

[StateColorEvaluation]

[StateColorMode]

[UnknownTag]

[UseCustomStateColors]

EventOnStatusValueChange

N/A

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	Methods	ActiveX Properties	ActiveX Methods
Alignment AutoSizeFont BackColor Bitmap Bottom ButtonShape Code CursorPointer CygNetTag CygNetTagConfig Default DefaultValue Click to see the properties contained in SetPointButton.DefaultValue: AlternatePointValue — The AlternatePointValue object contains the same set of properties as TargetTag: Click to see the properties contained in SetPointButton.DefaultValue.AlternatePointValue.: FacilityId FullyQualifiedTag OverrideFacilityId OverrideSiteService OverrideUdc ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method: Facility IsValid (method) LongPointID PointID Site Service SiteService Tag UDC SiteService Udc UseFullyQualifiedTag UseInheritedTag UseReferenceFacilityTag ClearUnreliableBit CustomTimestamp CustomTimeStampAsDate EnforcePointDataType ModifyPointValue PointAttributeValue PointDataType PreserveUnreliableBit SetUnreliableBit SpecificValue UseAlternatePointValue UseCurrentTimestamp UseCustomTimestamp UsePointAttributeValue UseSpecificValue DisplayFont Enable Facility Font ForeColor Group GroupID HasValidTag HelpContextID IsCygNetAware LayerID Layout Left LongPointId PointId PointTag Prompt Click to see the properties contained in SetPointButton.Prompt: AnalogMaximumPoint — The AnalogMaximumPoint object contains the same set of properties as TargetTag: Click here to see the properties contained in SetPointButton.Prompt.AnalogMaximumPoint.: FacilityId FullyQualifiedTag OverrideFacilityId OverrideSiteService OverrideUdc ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method: Facility IsValid (method) LongPointID PointID Site Service SiteService Tag UDC SiteService Udc UseFullyQualifiedTag UseInheritedTag UseReferenceFacilityTag AnalogMaximumSpecificValue AnalogMinimumPoint — The AnalogMaximumPoint object contains the same set of properties as TargetTag: Click here to see the properties contained in SetPointButton.Prompt.AnalogMinimumPoint.: FacilityId FullyQualifiedTag OverrideFacilityId OverrideSiteService OverrideUdc ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method: Facility IsValid (method) LongPointID PointID Site Service SiteService Tag UDC SiteService Udc UseFullyQualifiedTag UseInheritedTag UseReferenceFacilityTag AnalogMinimumSpecificValue AnalogSliderIncrement BackColor CancelBackColor CancelCaption CancelFont CancelForeColor Caption ConfirmBackColor ConfirmCaption ConfirmFont ConfirmForeColor DisplayUnits Message SpecificUnits TimestampDisplayStyle UnreliableBitDisplayStyle UseAnalogMaximumPoint UseAnalogMaximumSpecificValue UseAnalogMaximumTargetPoint UseAnalogMinimumPoint UseAnalogMinimumSpecificValue UseAnalogMinimumTargetPoint UseAnalogOptions UseAnalogSlider UsePrompt UseSpecificUnits UseTargetPointUnits ValueDisplayStyle ReferenceFacility Right RotateAngle SetPointTimeoutInSeconds ShowConfirmationWhenSetPointCompletes SiteService SpacerWidth StateColorEvaluation StateColorMode Status Click to see the properties contained in SetPointButton.Status: InitializationDelayInMilliSeconds InitialValue SetPointCompleteWhenTargetPointValueMatchesStatusCompletionValues SetPointCompleteWhenTargetPointValueMatchesStatusPointValue StatusCompletionValues StatusPoint — The StatusPoint object contains the same set of properties as TargetTag: Click to see the properties contained in SetPointButton.Status.StatusPoint.: FacilityId FullyQualifiedTag OverrideFacilityId OverrideSiteService OverrideUdc ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method: Facility IsValid (method) LongPointID PointID Site Service SiteService Tag UDC SiteService Udc UseFullyQualifiedTag UseInheritedTag UseReferenceFacilityTag StatusPointEnablesDisablesButton TimeoutInSeconds ToggleManualMode UseInitializationDelay UseInitialValue UseStatusPoint TabStop Tag TargetTag Click to see the properties contained in SetPointButton.TargetTag: FacilityId FullyQualifiedTag OverrideFacilityId OverrideSiteService OverrideUdc ResolvedPointTag — The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information. The PointTag object contains the following properties and method: Facility IsValid (method) LongPointID PointID Site Service SiteService Tag UDC SiteService Udc UseFullyQualifiedTag UseInheritedTag UseReferenceFacilityTag Text ToolTipText ToolType Top UDC UnknownTag UseCustomStateColors UseSetPointTimeout Visible	AlarmAcknowledge CaptureMouse ClearMenu FacilityConfig GetDlgCtrlID GetGroup HistoryAlarms HistoryValues IsSelected LayerName Move OnUpdate OnUpdateResize OnUpdateStyle PointConfigAlarmSettings PointConfigAlarmSuppression PointConfigAll PointConfigComments PointConfigQuestionable RemoveMenuItem RegisterPointForChangeNotice RunClick RunInitialize RunPumpData Select SetFocus SetMenuItem SetSubMenuItem ShowConfiguration ShowCurrentValue TrendAddPoint TrendRemovePoint TrendSinglePoint TrendSinglePointRollup	N/A	N/A

Properties