[AlarmElement] specifies the element of the object in which the point's alarm status is displayed. The options vary depending upon the tool. For example, with a Text Tool or the Ribbon Tool the alarm status can be shown in the foreground color (text), background color, or none. With a Linear Gauge Tool or Angular Gauge Tool the options are the pointer color or background color. If set to None, the alarm status is not shown. This property is not shown if the [StateColorMode] property is set to a value other than 1 — Single.

Alignment sets the horizontal text alignment within the boundary of the object. Options are 0 -Left, 1 -Center, and 2 -Right. Default depends on the object.

[AllowAlarmAck] enables display of the Acknowledge Alarm option on the Context Menu when the object’s point has an unacknowledged alarm. [DisplayAlarmAck] must also be set to true. Default is 1 — Yes.

AlternatePointValue is a script object that specifies the resolved point tag for the alternate point whose current value will be used for the SetPoint operation. Either ResolvedPointTag or FullyQualifiedTag must be configured. UseAlternatePointValue must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object.

AnalogMaximumPoint is a script object that specifies the resolved point tag for the alternate point to be used the maximum value of the value range for the target point to be modified for the SetPoint operation. Either ResolvedPointTag or FullyQualifiedTag must be configured. UseAnalogMaximumPoint must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object.

AnalogMaximumSpecificValue is a script property that specifies a specific maximum point value of the value range for the target point to be modified for the SetPoint operation. UseAnalogMaximumSpecificValue must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is variant.

AnalogMinimumPoint is a script object that specifies the resolved point tag for the alternate point to be used the minimum value of the value range for the target point to be modified for the SetPoint operation. Either ResolvedPointTag or FullyQualifiedTag must be configured. UseAnalogMinimumPoint must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object.

AnalogMinimumSpecificValue is a script property that specifies a specific minimum point value of the value range for the target point to be modified for the SetPoint operation. UseAnalogMinimumSpecificValue must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is variant.

AnalogSliderIncrement is a script property that specifies the increment applied to the slider position when the arrow keys are pressed or the slider thumb is dragged. The default value is 1. UseAnalogSlider must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is variant.

AutoSizeFont specifies whether the object’s font is automatically resized:

Shrink to Fit and Expand to Fit resize the font in Edit mode so that the text fits the boundary of the object. You can use these options to resize the font without using the object’s Font property to explicitly set the font size. In Run mode, the font is dynamically resized in Run mode to accommodate the [DisplayItem] or the tokens specified by the Text property.

• Shrink to Fit — reduces the font size so the text fits in the object boundary. If the object is resized in Run mode, the font size can never exceed the size specified by the object’s Font property.
• Expand to Fit — increases the font size so the text fills the object boundary. If the object is resized in Run mode, the font size can never be less than the size specified by the object’s Font property.
• Best Fit — resizes the font to best fit the text inside the object boundary. If the object is resized in Run mode, the font is also resized. This setting is a combination of Shrink to Fit and Expand to Fit.

Proportional and Proportional Fit resize the font in Run mode based on resizing of TheView.

• Proportional — resizes the font proportionally to TheView as TheView is resized.
• Proportional Fit — resizes the font proportionally to the object as the object is resized. This option reduces the font size only when necessary to view all of the text. This is the recommended option when font resizing is required.

Available AutoSizeFont options are 1 — Shrink to Fit, 2 — Expand to Fit, 3 — Best Fit, 4 — Proportional, and 5 — Proportional Fit. The default is 0 — No (no font resizing).

BackColor specifies a background color for the object or grid. Note that if an object’s [AlarmElement] property is set to Background Color and a primary point is assigned to the object, the background color will change in Run mode to reflect the point status.

The default is Automatic, which is the background color of TheView for most objects.

• For the Dynagraph Control, BackColor specifies the background color for the object, not the background color of the graph (plot area). See GraphBackgroundColor to change the background color of the graph. The default color is gray (RGB 240.240.240).
• For the GCM Nomination Grid, the default color is white (RGB 255.255.255).
• For the Group Grid Tool, BackColor specifies the background color for the object’s cell space. This does not affect the background color of the cells. To set the background color of the cells, enable UseCustomStateColors (Property Sheet, ActiveX page) and define the custom colors.
• For the SetPoint Button Tool, BackColor is a script property that specifies the background color of the value and the confirmation prompt dialog box for the SetPoint Button object. UsePrompt must be enabled for this setting to be recognized by the SetPoint Button object. Script subtype is long.
• For the Trend Tool, specifies the background color of a trend. Default is gray (RGB 240.240.240). Script subtype is long.

For Button Tool, DDS Editor Button, SetPoint Button, and UIS Command Button objects the Bitmap property specifies the image (.bmp or .jpg) to display on the button face. The only types of images supported for this option are bitmaps. For Radio Button and Check Button objects specify the image (.bmp or .jpg) to display in place of the standard check box or radio button when the button state is "on." The bitmap must be exactly 15x15 pixels. This property is only relevant when the BitmapOffState property is also configured. The default is None. Click … to view the Bitmap dialog box from where you can configure the image to use.

[BlinkColor] specifies the color that alternates with the alarm color when the [DisplayAlarmAck] property is set to 1 — Yes and the point’s alarm is unacknowledged. Default is Automatic. Be careful not to set the blink color to an alarm color or the blinking will not be visible. For example, if the blink color is red and the alarm color is red, the object will not appear to be blinking because the red blinking red will look like solid red.

Bottom specifies the distance (in pixels) from the top of TheView’s scroll region to the bottom of the object. You can dynamically change this value in Edit mode if you use the mouse to enlarge or shrink the object. See Sizing and Positioning Objects.

ButtonShape specifies the shape of the button. Default is 0 — Normal. Other options are 1 — Property Tab (Inactive) and 2 — Property Tab (Active).

CancelBackColor is a script property that specifies the background color of the Cancel button of the prompt dialog box of the SetPoint Button object using the Color dialog box. Script subtype is long.

CancelCaption is script property that specifies the text to use on the Cancel button of the prompt dialog box of the SetPoint Button object. The default text is "Cancel." Script subtype is string.

CancelFont is a script property that specifies the font to use on the Cancel button of the prompt dialog box of the SetPoint Button object. The object’s font takes precedence over (does not inherit) TheView’s font. Click Font… to view the Font dialog box from where you can configure the font to use. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

CancelForeColor is a script property that specifies the foreground color of the text to use on the Cancel button of the prompt dialog box of the SetPoint Button object. Default is black (RGB 0.0.0). Script subtype is long.

Caption specifies caption text in the following objects:

• For the LED Switch Tool, Caption is an ActiveX property that specifies the default label of the switch plate. In Run mode this is replaced by the item specified by the [DisplayItem] property.
• For the SetPoint Button Tool, Caption is a script property that specifies the title caption of the prompt dialog box. UsePrompt must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

ConfirmBackColor is a script property that specifies the background color of the Confirm button of the prompt dialog box of the SetPoint Button object using the Color dialog box. Script subtype is long.

ConfirmCaption is a script property that specifies the text to use on the Confirm button of the prompt dialog box of the SetPoint Button object. The default text is "Set." Script subtype is string.

ConfirmFont is a script property that specifies the font to use on the Confirm button of the prompt dialog box of the SetPoint Button object. The object’s font takes precedence over (does not inherit) TheView’s font. Click Font… to view the Font dialog box from where you can configure the font to use. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

ConfirmForeColor is a script property that specifies the foreground color of the text to use on the Confirm button of the prompt dialog box of the SetPoint Button object. Default is black (RGB 0.0.0). Script subtype is long.

[ContextMenu] specifies custom items for the object’s context menu. The Item Text is the text that appears on the Context menu. The Event ID must be unique. Each item requires script to specify its action. Click … to view the Context Menu Configuration dialog box from where you can configure the menu items. See Configuring a Context Menu.

ClearUnreliableBit is a script property that specifies whether to clear the unreliable status bit when setting a value for a target point being modified by a SetPoint operation. Script subtype is Boolean.

For TheView, CursorPointer selects the cursor icon that appears when you mouse over objects.

For objects, CursorPointer selects the cursor icon for the instance of the object. The object’s cursor pointer takes precedence over TheView’s cursor pointer.

The default is 0 — Default. For TheView, this is an arrow. For other objects, the icon configured for TheView is used. Other options are:

• 1 — Arrow
• 2 — IBeam
• 3 — Cross
• 4 — UpArrow
• 5 — NoDrop
• 6 — Help
• 99 — HotSpot
• 100 — Timer

Script subtype is long.

[CustomStateColors] specifies custom point state colors. Click … to view the Configure Point State Colors dialog box from where you can configure colors to use. See Customizing Point State Colors for more information.

• If defined for TheView, this property specifies the custom point state status colors that can be applied to all objects.
• If defined for an object, this property specifies the custom point status colors for the instance of the object. An object’s custom colors take precedence over those of TheView. If an object does not have its own custom state colors, TheView’s custom state colors will apply to the object. That is, TheView’s custom state colors serve as defaults.

CustomTimestamp is a script property that specifies an absolute date/time or a relative date/time/day to be used when setting a value for a target point being modified by a SetPoint operation. See Selecting Date and Time for more information. UseCustomTimestamp must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

CustomTimeStampAsDate is a script property that specifies a VBScript DATE object that represents an absolute date/time. UseCustomTimestamp must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is variant.

CygNetTag is a script property that returns a control's resolved point tag. It returns an empty string if the control has not yet retrieved point data (for instance, during EventInitialize) or if the control failed to retrieve point data. This property is read only.

CygNetTagConfig is a script property that returns a control's current point tag configuration. The current point tag configuration might not reflect the point displayed on the control if the control's point tag configuration has changed but TheView has not been restarted. This property is read only.

Default enables the button as the active button when the Enter key is pressed. In Edit mode the button with this property set to true (1 — Yes) is shown with a black border. Only enabled one button as the default. Default is 0 — No.

DefaultValue is a script property that returns the properties of the default value for the resolved target point to be modified by a SetPoint operation. The default value for the target point can be specified explicitly, retrieved from the current value of another point, or retrieved from a point attribute of another point. The default value can also be limited to a particular point data type. Note that the SetPoint operation will fail if the value being sent doesn’t resolve to the correct point data type.

• See Configuring Default Value for more information about configuring this value.
• See Scripting SetPoint Properties for information about using this property in script.

[DisplayAlarmAck] enables the display of the unacknowledged alarm state. If set to true, the object will blink when the object’s point has an unacknowledged alarm. The default is 0 — No. When this property is enabled and the condition is true, the user can acknowledge the alarm from the object’s Context Menu if the [AllowAlarmAck] property is set to 1 — Yes.

When blinking is enabled, the method in which the blink is displayed is determined by the value of the blink attribute configured in the PointSchemes element of the CvsMetadata file. See Understanding the CVS Metadata File for more information about the elements and attributes that define a CygNet Point Scheme.

[DisplayElement] specifies the element of the object in which the [DisplayItem] is shown. Available options are Text and None; the default is Text.

If None is selected, the object is displayed but its [DisplayItem] is not.

Other options:

• Completely hide the object in Run mode using the Visible property.
• Display the object and its [DisplayItem] but disable user interaction using the Enable property.

DisplayFont returns the current, resized font values for the object. The correct font size is returned only if AutoSizeFont is enabled. For tools other than Text Tool, DDS Editor Button, SetPoint Button, and UIS Command Button DisplayFont is identical to the Font property, except that this is a font interface object instead of a string.

This property is read only.

[DisplayFormat] displays the data with custom formatting. Make sure that the format string is applicable for the [DisplayItem]. Click … to view the Display Format dialog box.

• For numbers, formats can use # and 0, with a period (.) as the decimal separator and comma (,) as the thousands separator. A dollar ($) sign can also be used. 0 will add a leading or trailing 0; # will not. For example, if the value is 8.230 and this property is set to 00.0, the result would be 08.2. If this property is set to ##.#, the result would be 8.2.
• For dates, formats can use d, h, m, s, a/p, AM/PM. For example, if the time is 06/28/2022 11:25:56.124 and the display format is hh:mm a/p, the result would be 11:25 a.
• Named formats can also be used. Examples: Long Date, Short Date, Long Time, Medium Time. If using the named formats Yes/No, True/False, On/Off, any non-zero value is Yes, True, On.
• Two specially named formats, FeetInchesFromFeet and FeetInchesFromInches, convert decimal values to feet and inches format. For example, 12.55 would be displayed as 12'6" and 150.0 would be 12'6" respectively.

[DisplayItem] specifies the type of data the object is to display. Options include Text, properties of the point configuration record (Description, Units, UDC, etc.), properties of the CVS point record (Value, Timestamp, etc.), and facility attributes (Facility Description, Facility ID, attributes). Default setting is Value. If set to Text, the display will show the text defined using the Text property. Click … to view the Select a Display Item dialog box from where you can select what to display for the object.

DisplayUnits is a script property that indicates that the points units will be displayed on the prompt dialog box of the SetPoint Button object. The units are displayed next to the value box for display purposes only. Either UseTargetPointUnits or UseSpecificUnits must be configured. Script subtype is Boolean.

Enable specifies whether the user is able to interact with the object. Options are 0 — No and 1 — Yes. The default is 1 — Yes. If set to 0 — No, the object is still visible but its context menu is disabled.

Other options:

• Completely hide the object in run mode using the Visible property.
• Display the object but hide its [DisplayItem] using the [DisplayElement] property.

EnforcePointDataType is a script property that indicates that the default value of the target point to be modified for the SetPoint operation must be one of the point data types specified by PointDataType. Script subtype is Boolean.

[4:Facility ID] specifies the Facility ID of the point for which the object is to display information. This property must be used in conjunction with [5:UDC]. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. If both TheView and an object have their Facility property defined, the object’s property takes precedence. Click … to view the Select a Facility ID dialog box from where you can select a Facility ID to use. Script subtype is string.

OverrideFacilityId must be enabled (set to true) in order for this setting to be recognized by the SetPoint button object.

FlexHorizontal specifies whether the object moves or resizes horizontally or is unchanged when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

FlexVertical specifies whether the object moves or resizes vertically when TheFrame is resized. Options are:

• 0 — None (no resizing occurs)
• 1 — Shift (the object is shifted)
• 2 — Expand (the object expands or shrinks the same number of pixels as TheFrame)
• 3 — Proportional (the object expands or shrinks proportionally to TheFrame)

Default is 0 — None.

Font specifies the font for the object.

For TheView, this property specifies the default font for text-based objects.

For other objects, it specifies the font for the instance of the object. The object’s font takes precedence over the font set for TheView.

Click … to view the Font dialog box, which you can use to configure the font. The default is MS Shell Dlg (MS Sans Serif, regular, 8 pt). Script subtype is string.

ForeColor specifies the foreground color for the object. The default is Automatic, which, for most objects is black. Note that if the object’s [AlarmElement] is set to Foreground Color and a primary point has been assigned to the object, the foreground color will change in Run mode to reflect the point status.

FullyQualifiedTag is a script property that specifies a fully qualified point tag in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

UseFullyQualifiedTag must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

Group groups objects into a discrete sequence that can be navigated using the arrow keys.

Options are 0 — No and 1 — Yes. The default is 0 — No.

To use this property:

1. Add objects that use the Group property to a screen.

2. Position them as you like (typically in a spatial configuration that reflects the order in which they were added to the screen).

3. Decide where in the spatial configuration logical groups begin and end.

4. Mark the beginning of a group by setting the Group property to 1 — Yes for the first object in the group.

5. Set Group set to 0 — No for other objects in the group.

The group is made up of all objects that 1) are added sequentially after an object with a Group property set to 1 — Yes and 2) that use a Group property set to 0 — No. A group's arrow navigation sequence reflects the order in which its objects were added to a screen.

This property is not related to the Draw > Group option in the CygNet Studio menu bar. This property might not be suited for use with all tools that include the Group property.

Script subtype is long.

Specifies the GroupID of the object group.

Returns a Boolean value to confirm a CygNet-aware tool is associated with a valid CygNet tag. This property may not be suited for use with all tools that include the HasValidTag property. See also CygNet-Aware Tools. Script subtype is Boolean.

HelpContextID specifies the object’s help identifier for context-sensitive help. TheFrame’s WhatsThisHelp must be enabled.

Script subtype is long.

InitializationDelayInMilliSeconds is a script property that specifies the number of milliseconds to delay initialization for the status point for the SetPoint operation. Default is 1000 milliseconds. UseInitializationDelay must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is integer.

InitialValue is a script property that specifies the initial value for the status point when doing a SetPoint operation. UseInitialValue must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is variant.

Returns a Boolean value that confirms that an object is a CygNet-aware tool. This property might not be suited for use with all tools that include the IsCygNetAware property. Script subtype is Boolean. See also CygNet-Aware Tools.

Layer identifies the layer on which the object resides. Script subtype is Boolean.

LayerId is a script property that specifies the layer on which the object resides. Options vary depending on the names of existing layers. Default is Default.

Layout specifies the position of the image within the object’s boundaries. Default is 0 — Center. Other options are 1 — Left, 2 — Right, 3 — Top, and 4 — Bottom.

Left specifies the distance (in pixels) from the left edge of TheView’s scroll region to the left edge of the object. See Sizing and Positioning Objects.

[3:Long Point ID] specifies the Long Point ID of the tag for which the object is to display information. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. Click … to view the Select a Long Point ID dialog box from where you can select a point to use. Script subtype is string.

Message is a script property that specifies the instructional message to display on the prompt dialog box. UsePrompt must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

ModifyPointValue is a script property that indicates that the point value for the target point can be modified by the SetPoint operation. Script subtype is Boolean.

(ObjectCode) specifies a unique identifier of the object. You can enter up to 39 characters. Valid characters are A-Z, 0-9, and underscore (_). Spaces are not allowed. The default is the object name and the numeric instance. Script subtype is string.

OverrideFacilityId is a script property that indicates an override for the inherited facility ID in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

FacilityID must be configured. Script subtype is Boolean.

OverrideSiteService is a script property that indicates an override for the inherited Site.Service in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

SiteService must be configured. Script subtype is Boolean.

OverrideUdc is a script property that indicates an override for the inherited UDC in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

Udc must be configured. Script subtype is Boolean.

PointAttributeValue is a script property that specifies the point attribute value for the default value of the target point to be modified for the SetPoint operation. Options include General 1-3 (general data fields), Indexed 1-3 (indexed fields), or Initial Value. UsePointAttributeValue must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

PointDataType is a script property that specifies the point type data of the default value of the target point to be modified for the SetPoint operation. Options include Analog I/O, Digital I/O, Enumeration I/O, or String I/O. EnforcePointDataType must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

[2:Point ID] specifies the Point ID of the tag for which the object is to display information. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. Click … to view the Select a Point ID dialog box from where you can select a point to use. Script subtype is string.

PointTag is a script property that returns a PointTag object. The object can be used to parse a constituent part from a resolved point tag for a given CygNet-aware tool. For instance, the PointTag object would enable you to parse LongPointId from the tag Site.Service.PointId:LongPointId. Note that the resolved tag might differ from the configured tag.

The PointTag property is similar in functionality to the CygNetTag property; however, the CygNetTag property returns an entire point tag.

This property is read only.

PreserveUnreliableBit is a script property that specifies whether to leave the unreliable status bit in its current state (set or not set) when setting a value for a target point being modified by a SetPoint operation. Script subtype is Boolean.

Prompt is a script property that returns the properties of the value and confirmation prompt that can be optionally configured when executing a SetPoint operation.

• See Configuring a Prompt for more information about configuring this property.
• See Scripting SetPoint Properties for information about using this property in script.

[ReferenceFacility] specifies the Facility ID or facility tag of a referenced facility for which the object is to display information. The referenced facility can resolve from either a Source Attribute or a Facility Rule. Click … and choose either Select a Source Attribute or Specify Facility Rule Filter from the drop-down menu. See Configuring a Reference Facility for more information.

ResolvedPointTag is a script object that specifies the resolved point tag in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

UseInheritedTag must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. The ResolvedPointTag object is a CxScript.PointTag object. See CxScript.PointTag for more information.

Right specifies the distance (in pixels) from the left edge of TheView’s scroll region to the right edge of the object. See Sizing and Positioning Objects.

Causes the object to rotate clockwise the specified number of degrees. You can rotate an object directly by using the Rotate option on the Draw menu. For details, see Rotating an Object.

Service is a script property that specifies the name of the CVS that contains the resolved target point to be modified, or that specifies the alternate point whose current value will be used, for the SetPoint operation. Script subtype is string.

[SetPoint] specifies the properties of the SetPoint Button object, including the target point, default value, status point, and prompt, etc. Click … to view the SetPoint Properties dialog box from where you configure the button's properties.

SetPointCompleteWhenTargetPoint ValueMatchesStatusCompletionValues is a script property that indicates that the SetPoint operation is complete when the status point value matches any of the values specified in the defined StatusCompletionValues property. Script subtype is Boolean.

SetPointCompleteWhenTargetPoint ValueMatchesStatusPointValue is a script property that indicates that the SetPoint operation is complete when the status point value matches the target point value. Script subtype is Boolean.

SetPointTimeoutInSeconds is a script property that specifies the number of seconds to wait for the target point’s current value timestamp to match the timestamp submitted, that is, for the SetPoint operation to complete before marking the operation as failed. Default value is 5 seconds. UseSetPointTimeout must be enabled (set to true) in order for this timeout setting to be recognized by the SetPoint Button object. Script subtype is Integer.

SetUnreliableBit is a script property that specifies whether to set the unreliable status bit to true when setting a value for a target point being modified by a SetPoint operation. Script subtype is Boolean.

ShowConfirmationWhenSetPointCompletes is a script property used to display a message to confirm the SetPoint operation was issued successfully to the CVS.

• You will always get a confirmation message regardless of whether a timeout is set.
• If a confirmation message is enabled and a timeout is set, a message will confirm the SetPoint operation completed successfully. If the SetPoint operation doesn’t complete successfully, a message will display noting that the SetPoint operation timed out before completion.

Script subtype is Boolean.

Site is a script property the specifies the name of the CygNet site that contains the CVS of the resolved target point to be modified, or that specifies the alternate point whose current value will be used, for the SetPoint operation. Script subtype is string.

[SiteService] identifies the CVS, Facility Service, or Group Service for the settings. The format for the value is Site.Service.

If this field is blank, the Site.Service specified for TheView is used. If Site.Service is defined for both TheView and the object, the value specified for the object is used.

OverrideSiteService must be enabled (set to true) in order for this setting to be recognized by the SetPoint button object.

SpacerWidth specifies the margin between the text and the aligned border. Applicable only if the Alignment property is set to 0 — Left or to 2 — Right. Default is 5.

SpecificUnits is a script property that specifies a custom (different) set of units for the target point to be modified by the SetPoint operation. UseSpecificUnits must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is string.

SpecificValue is a script property that specifies a specific default point value for the target point to be modified for the SetPoint operation. UseSpecificValue must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is variant.

[StateColorEvaluation] specifies whether the object’s color is based on its point state or its alarm state. Options are 0 — Point State and 1 — Alarm State or 1 — ePOINT_STATE and 2 — eALARM_CONDITION. The default is 0 — Point State or 1 — ePOINT_STATE.

[StateColorMode] Specifies if and how the object will show the alarm point’s state color: shown in a single color (1 — Single), dual colors (2 — Dual), or not at all (0 — Off). The default is Single. Options include:

• Off (0 — eSTATECOLORMODE_OFF)
• Single Color (1 — eSTATECOLORMODE_SINGLE)
• Dual Colors (2 — eSTATECOLORMODE_DUAL)

Most tools have a Single mode. That is, they can reflect the point state color in a single element. The element is defined by an object’s [AlarmElement] property to specify if the state color will be shown in the object’s foreground or background. Objects that have [AlarmElement] options of both Foreground Color and Background Color, such as the Text Tool or a closed shape (ellipse, rectangle, polyline), can be configured using the [StateColorMode] property to show the point state color in dual mode; that is, both the Foreground and Background. For tools with a Dual mode, you must select the foreground and background colors using the [UseCustomStateColors] property. The default is 1 — eOFF. Options include:

• 1 — eOFF
• 2 — eSINGLE_FOREGROUND
• 3 — eSINGLE_BACKGROUND
• 4 — eDUAL

Status is a script property that returns the properties of the status point that can be configured to monitor the status of a SetPoint operation as it completes.

• See Configuring a Status Point for more information about configuring this value.
• See Scripting SetPoint Properties for information about using this property in script.

StatusCompletionValues is a script property that specifies a list of completion values used when SetPointCompleteWhenTargetPointValue MatchesStatusCompletionValues is configured. Subtype is variant.

StatusPoint is a script object that specifies the resolved status point used to monitor the status of a SetPoint operation as it completes for the SetPoint Button object. Either ResolvedPointTag or FullyQualifiedTag must be configured. UseStatusPoint must be enabled (set to true) in order for this timeout setting to be recognized by the SetPoint Button object.

StatusPointEnablesDisablesButton is a script property that indicates whether the Status Point enables and disables the SetPoint Button. The button will remain disabled as long as the SetPoint operation is in the queue. Script subtype is Boolean.

Tabstop specifies whether the focus stops on the object when you use the Tab key to navigate between objects (in other words, enables the object as a tab stop). Options are 0 — No and 1 — Yes. Default is 1 — Yes.

Script subtype is long.

See also Group and Tab Order.

Tag is an extra field for application-specific purposes. Does not specify a CygNet point. Default is blank. Script subtype is string.

TargetTag is a script property that returns the point tag properties of the resolved target point to be modified by a SetPoint Button object. The target point can be very explicitly defined allowing a templated point tag, inheriting some or all of the point identifier properties from the button properties or from a reference facility. Alternatively a fully qualified point tag may be specified. Either ResolvedPointTag or FullyQualifiedTag must be configured.

• See Configuring General Properties for more information about configuring this value.
• See Scripting SetPoint Properties for information about using this property in script.

Text specifies the text (label) of the object. A maximum of 80 characters can be specified. The object’s [DisplayItem] property must be set to Text in order for the text specified in this property to be displayed. If the object has a primary point and its [DisplayItem] property is set to a value other than Text, then in Run mode the text defined by this property will be replaced by the [DisplayItem].

For some objects and buttons (Button, DDS Editor Button, LED Switch, Sliding Scale, Text, and UIS Command Button Tools), the text can be dynamic, static, or a combination. Dynamic text is built using tokens, which can represent point configuration, facility, and CVS point record properties. Data formatting can be specified. See Using Text Tokens for more information about building dynamic text using tokens.

TimeoutInSeconds is a script property that specifies the number of seconds to wait for the SetPoint status operation to complete before marking the operation as failed. Default value is 1 second. Script subtype is integer.

TimestampDisplayStyle is a script property that specifies the display setting for the Timestamp fields on the prompt dialog box of the SetPoint Button object.

Options include:

• Editable — Display the settings on the prompt dialog box and allow the user to make ad hoc changes.
• Read-Only — Display the settings on the prompt dialog box but make them read-only (grayed out).
• Hidden — Do not display the settings in the prompt dialog box.

Script subtype is string.

ToggleManualMode is a script property that toggles manual update mode while initializing the value of the status point. Script subtype is Boolean.

TooltipText identifies text that is displayed when the mouse hovers over the object in Run mode. For some objects, tooltip text can be dynamic, static, or a combination. You build dynamic text with tokens that can represent point configuration, facility, and CVS point record properties. You can also specify data formatting. Click … to view the Edit Tooltip Text dialog box you use to configure the text.

For information about building dynamic text using tokens, see Using Text Tokens.

Script subtype is string.

Returns a CygNet-defined string value that describes the object type. This value appears in the Status Bar when you hover over a default control in its tool palette. You can also display the value using a script. This property is read only. See also Rule-Based Substitution.

Script subtype is string.

Top specifies the distance (in pixels) from the top of TheView’s scroll region to the top of the object. See Sizing and Positioning Objects.

[5:UDC] specifies the Uniform Data Code (UDC) of the point for which the object is to display information. This property must be used in conjunction with [4:Facility ID] or [Facility]. The Site.Service of the point must be specified using the [1:SiteService] or [SiteService] property. For ActiveX command tools, this property specifies the point that contains the default position for the indicator. Click … to view the Select UDC by Category dialog box from where you can select a UDC to use. Script subtype is string.

OverrideUdc must be enabled (set to true) in order for this setting to be recognized by the SetPoint button object.

[UnknownTag] specifies how the object will be displayed if the primary point does not exist in the system. Options include None and Hide. The default is None.

• If set to None, the object is displayed with an "unknown" status, and its color is set to the Unreliable color (meaning that the value is not trustworthy).
• If set to Hide, the object is not shown at all.

If the tag is simply invalid (for example, missing the UDC/PointID/LongPointID entirely), the object will be displayed and set to the Unreliable color. "Unknown" means that the tag appears to be valid and CygNet Studio tried to get data for it, but the service indicated the tag does not exist.

The [ReferenceFacility] property adds an additional twist to "unknown" status. If CygNet Studio believes that the tag is only invalid because of a failure to resolve the reference facility, it will treat the tag as "unknown" instead. Note that the above example of a missing UDC/PointID/LongPointID would still be invalid because ReferenceFacility doesn’t affect UDC/PointID/LongPointID, but if you are missing a Site.Service or Facility and have a ReferenceFacility rule that doesn’t reference external Source Attributes, it would assume that the rule simply couldn’t find a match and consider that "unknown."

UnreliableBitDisplayStyle is a script property that specifies the display setting for the Unreliable bit fields on the prompt dialog box of the SetPoint Button object.

Options include:

• Editable — Display the settings on the prompt dialog box and allow the user to make ad hoc changes.
• Read-Only — Display the settings on the prompt dialog box but make them read-only (grayed out).
• Hidden — Do not display the settings in the prompt dialog box.

Script subtype is string.

UseAlternatePointValue is a script property that indicates that the default value of the target point to be modified for the SetPoint operation is the current value of another point specified by AlternatePointValue. Script subtype is Boolean.

UseAnalogMaximumPoint is a script property that indicates that the maximum value of the value range of the target point to be modified for the SetPoint operation is the current value of another point specified by AnalogMaximumPoint. Script subtype is Boolean.

UseAnalogMaximumSpecificValue is a script property that indicates the use of a specific maximum point value of the value range for the target point to be modified for the SetPoint operation. The default maximum value is 100. AnalogMaximumSpecificValue must be configured. Script subtype is Boolean.

UseAnalogMaximumTargetValue is a script property that indicates the use of the maximum value of the value range of the target point stored in its point configuration record on the Analog page to be modified for the SetPoint operation. Script subtype is Boolean.

UseAnalogMinimumPoint is a script property that indicates that the minimum value of the value range of the target point to be modified for the SetPoint operation is the current value of another point specified by

AnalogMinimumPoint. Script subtype is Boolean.

UseAnalogMinimumSpecificValue is a script property that indicates the use of a specific minimum value of the value range for the target point to be modified for the SetPoint operation. The default minimum value is 0. AnalogMinimumSpecificValue must be configured. Script subtype is Boolean.

UseAnalogMinimumTargetValue is a script property that indicates the use of the minimum value of the value range of the target point stored in its point configuration record on the Analog page to be modified for the SetPoint operation. Script subtype is Boolean.

UseAnalogOptions is a script property that indicates the use of a minimum and maximum value range for the target point to be modified for the SetPoint operation. The SetPoint Prompt prompt dialog box will interpret the value entered as numeric and will perform numeric range checking based on the limits provided. The value range may consist of the following: a specific value, the mimimum/maximum value of the target point, or the current value of another point. Script subtype is Boolean.

UseAnalogSlider is a script property that indicates the use of a slider control on the prompt dialog box which can be manipulated to set a hard-coded numeric value within the specified range. The range of the slider is set by the minimum and maximum values specified by UseAnalogMaximumPoint, UseAnalogMaximumSpecificValue, or UseAnalogMaximumTargetPoint and UseAnalogMinimumPoint, UseAnalogMinimumSpecificValue, or UseAnalogMinimumTargetPoint. The increment is specified by AnalogSliderIncrement. Script subtype is Boolean.

UseCurrentTimestamp is a script property that indicates the use of the current time of the host computer when setting a value for a target point being modified by a SetPoint operation. Note that if a timeout is configured, the SetPoint operation will use the time of the client machine. Script subtype is Boolean.

[UseCustomStateColors] enables the use of the [CustomStateColors].

• For TheView, this property enables use of TheView’s [CustomStateColors]. Default is 1 — Yes.
• For objects, this property enables use of the object’s [CustomStateColors]. Default is 1 — Yes.

If this property is set to 0 — No for an object and is set to 1 — Yes for TheView, the object will use the custom state colors of TheView.

UseCustomTimestamp is a script property that indicates the use of a custom time when setting the value for the target point. CustomTimestamp or CustomTimeStampAsDate must be configured. Script subtype is Boolean.

UseFullyQualifiedTag is a script property that indicates the use of a fully qualified point tag in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

FullyQualifiedTag must be configured. Script subtype is Boolean.

UseInheritedTag is a script property that indicates the use of an inherited point tag from the configured button properties in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

ResolvedPointTag must be configured. Script subtype is Boolean.

UseInitializationDelay is a script property that indicates the use of an initialization delay for the status point for the SetPoint operation. InitializationDelayInMilliseconds must be configured. Script subtype is Boolean.

UseInitialValue is a script property that indicates the use of an initial value for the status point for the SetPoint operation. InitialValue must be configured. Script subtype is Boolean.

UsePointAttributeValue is a script property that indicates the use of a point attribute value for the default value of the target point to be modified for the SetPoint operation. PointAttributeValue must be configured. Script subtype is Boolean.

UsePrompt is a script property that indicates the use of a value and confirmation prompt dialog box for the SetPoint Button object. Script subtype is Boolean.

UseReferenceFacilityTag is a script property that indicates the use of an inherited reference facility tag in one of the following use cases for the SetPoint operation:

• for the target point to be modified
• for the alternate point whose current value will be used
• for the status point
• for the alternate analog point whose current minimum value will be used
• for the alternate analog point whose current maximum value will be used

ReferenceFacility must be configured. Script subtype is Boolean.

UseSetPointTimeout is a script property that indicates whether to use a timeout when attempting to set a value for the SetPoint operation. SetPointTimeoutInSeconds must be configured. Script subtype is Boolean.

UseSpecificUnits is a script property that indicates whether to use specific (different) units when attempting to set a value for the SetPoint operation. DisplayUnits must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. SpecificUnits must be configured. Script subtype is Boolean.

UseSpecificValue is a script property that indicates the use of a specific default point value for the target point to be modified for the SetPoint operation. SpecificValue must be configured. Script subtype is Boolean.

UseStatusPoint is a script property that indicates the use of a status point for the SetPoint operation. StatusPoint must be configured. Script subtype is Boolean.

UseTargetPointUnits is a script property that indicates that the primary units of the target point will be used when updating the point. DisplayUnits must be enabled (set to true) in order for this setting to be recognized by the SetPoint Button object. Script subtype is Boolean.

ValueDisplayStyle is a script property that specifies the display setting for the Value fields on the prompt dialog box of the SetPoint Button object.

Options include:

• Editable — Display the settings on the prompt dialog box and allow the user to make ad hoc changes.
• Read-Only — Display the settings on the prompt dialog box but make them read-only (grayed out).
• Hidden — Do not display the settings in the prompt dialog box.

Script subtype is string.