Types of binding properties

One or more of the following properties may be included with various binding types.

  • actionArgument

    This property is used with certain widgetEvents to specify the action to take when the widgetEvent is triggered. For example, a mouseEvent (such as a “click”) on a widget can change a boolean status from “true” to “false” or prompt the user to select a setting. Argument options, like the widgetEvents, themselves, are context sensitive, depending on widget and binding type.

  • degradeBehavior

    This option allows you to specify how the object behaves when binding communications are not available. If a binding is not usable, then this property allows the designer to choose how the UI is gracefully degraded. For example, if the user doesn't have permission to invoke a specific action, then a button that is bound to that action can be dimmed or hidden entirely. To preserve backward compatibility, the default degradeBehavior is none.

  • extent

    This spectrum binding property represents the total range of the bound value which maps from low to high.

  • highColor

    This spectrum binding property specifies the color that is used for the highest value assignment for a spectrum color binding. The high color displays when the bound target is greater than setpoint+extent/2. As the bound value decreases below the maximum value specified, the color approaches the color set by the Mid Color property.

  • hyperlink

    This property provides a link to another object. When the field is completed, the hyperlink is active in the browser or in the Px viewer.

  • icon

    This property value specifies an icon, if desired, to appear in the top left corner of a popup window. The icon property is not available with the popup binding.

  • increment

    This property is a value that can be set to increment (increase) or decrement (decrease) a current value by the assigned amount. A positive number in this property field increments a value; a negative number in this field decrements a value.

  • lowColor

    This spectrum binding property specifies the color that is used for the lowest value assignment for a spectrum color binding. The low color displays when the bound target value is less than setpoint-extent/2. As the value bound to this property increases above the minimum value specified, the color approaches the color set by the Mid Color property.

  • midColor

    This spectrum binding property specifies the color that is used for the middle value assignment for a spectrum color binding. This color is displayed when the bound value is exactly at the setpoint. As the binding value increases above this point, the displayed color approaches the color set by the High Color property. As the bound value decreases below this point, the displayed color approaches the color set by the Low Color property.

  • modal

    This property applies to Popup Bindings (see About Popup Bindings). When the modal property is set to true, the popup window associated with the Popup Binding is a modal window.

     

    NOTE: A modal window is a child (or secondary) window that appears in front of a parent window and typically does not allow interaction with the parent window. The modal window created using this property is always on top but does not prevent a user from interacting with the parent window.
     

  • ord

    This property specifies the ORD that is bound to the widget. This field must have a value if you want the widget to be bound. In a Popup binding this is the path that designates the component view that is displayed in the popup window.

  • popupEnabled

    This property has true or false options and allows you to specify if you want to allow a secondary popup (right-click) menu (see 48. Example popup (right-click) menu) to appear when a user clicks on this label from a browser or Px viewer.



    Figure 48.   Example popup (right-click) menu
    Image

    If the option is set to false then the popup action menu is not available. You may use this if you want to prevent actions from being executed at a control point from a specific Px graphic while still allowing access to the action from a different Px graphic or property sheet.

     

    NOTE: Other ways to make actions unavailable include:
    • Hiding the action slot on the component makes the action unavailable but it would apply to every point of access in the station.
    • Actions can also be assigned operator or admin permission requirements to limit the access.

     
  • position

    This property is used to designate an initial screen position for a popup window.

  • setpoint

    This binding property specifies the value that is used for displaying the Mid Color. For example, if you set this value to “70”, then the color that you define for Mid Color will be displayed when the bound value is “70”.

  • size

    This property is used to designate an initial screen size for a popup window.

  • statusEffect

    this property provides the following three options for enabling or disabling status effects.

    • Color

      choose this option to enable a background color change when the bound value status changes.

    • Color and blink

      choose this option to enable a background color change and a blinking effect when the bound value status changes.

    • None

      choose this option to disable any effects based on bound value status changes.

  • summary

    This property allows you to specify a display name for the widget in text or by means of a script.

  • title

    This property value specifies the text that appears in a popup window title bar.

  • widgetEvent

    This property allows you to specify one of several possible events: actionPerformed, focusEvent, invokeAction, keyEvent, mouseEvent. Possible actions are dependent on the type of widget and action. Some widgetEvents allow you to specify an actionArgument, as described, above.

  • widgetProperty

    This property allows you to specify the property that you are targeting in the binding’s parent widget. For example, you can use a spectrum binding that has a bound label parent to change the background property of that parent label by selecting “background” in the Widget Property options field. Or, you can change the foreground color by choosing “foreground”. You can target only one value per binding but you may add additional bindings if you want to target more that one property in the parent widget.