In/Out Password

This control allows to set or display a password.

Triggers

Following triggers can be used for this object display:

  • com.atvise.setActive – Can be used to enable or disable the object display.

  • setValue – The object display connects to this trigger. Therefore, it is possible to set the value from the outside.

  • valuechanged – Fired on value changes, e.g. by user input.

//Disable the object display
webMI.trigger.fire("com.atvise.setActive", false, "myDisplayID");

//Set password
webMI.trigger.fire("setValue", "MyNewPassword", "myDisplayID");

//Respond to value changes
webMI.trigger.connect("valuechanged", function(e) { console.log("password has been changed"); }, "myDisplayID");

Hint

Additional undocumented triggers are internally used by atvise. Their functionality may be changed in future atvise releases.

Parameters

  • base – The password of this address will be set/displayed.

  • alarm address – Optional additional address of an alarm to be shown.

  • allow direct input – Select "Yes" if you want to directly enter characters in the control without opening the SVG Keyboard (default: Yes).

  • enable status monitoring – Switch monitoring of current value status on or off. (default: Yes)

  • fire status trigger – Instead of the status display a here defined trigger can be fired globally.

  • keyboard display – On-screen keyboard for string input (default: alphanumerical keyboard).

  • small message dialog display – Dialog for showing messages, information or warnings (default: small message dialog object display).

Font:

  • family – Font family which will be applied to the value (default: Arial).

  • size – Font size which will be applied to the value (default: 12).

  • color – Color which will be applied to the value (default: global parameter atvFontColor (advanced), #000000 (standard)).

Appearance:

  • fill color – Fill color of background areas (default: global parameter atvFillColor (advanced), #d0d0d0 (standard)).

  • Standard fill color not editable – Fill color if checkbox is not editable (default: #8c8c8c).

  • Standard fill color when inactive – Fill color if not active (default: #8c8c8c).

  • Standard button fill color – Fill color of the button (default: #000000).

  • Standard symbol fill color – Fill color of the symbol (default: #d0d0d0).

  • Advanced value field fill color – Fill color of the value field (default: #ffffff).

  • Advanced value field fill color not editable – Fill color of the value field when not editable (default: #f2f2f2).

  • Advanced value field fill color inactive – Fill color of the text field when not active (default: global parameter atvInactiveColor).

  • Advanced symbol color – Symbol's fill color (default: global parameter atvSymbolColor).

  • focus stroke color – Stroke color on focus (default: #ffffff).

  • Advanced border color – Color of the border around the control (default: global parameter atvBorderColor).

  • status indication – Specify the status' display through a defined global list (default: global parameter atvStatusIndication).

  • alarm indication – Specify the alarm's display through a defined global list (default: global parameter atvAlarmIndication).

Security:

  • editable – If set to "No" the values will only be displayed but it is not possible to enter a value (default: Yes). This only applies to direct user inputs, changes via script (setValue) or trigger are still possible.

  • necessary right – The user must have this right to activate this control, i.e. to enter values.

  • activation address – If the value of this address equals to "activation value", then the control will be active, i.e. can be used as input field.

  • activation value – Value which activates the control.

Hint

If only the activation address or the activation value is being entered then the input field will be active, as these both parameters only work together.

  • show access control notification – Defines if the icon for showing access control notifications shall be displayed (default: true).

Options:

  • password mode – Hides characters and shows asterisks instead. This parameter exists only because of compatibility reasons. The password mode is always active for this display (default: Yes).

  • alternative output address – If specified, only this address will be set ("base" will not be set).

  • consistency group – Name of the consistency group.

  • tab index – Defines the order for changing between the object displays by using the tab key.

  • tooltip – Displays a tooltip box with the entered text (standard HTML-Elements can be entered).

  • select text on focus – Selects the text in if the direct input is allowed (default: false).

Attention

The alternative output address does not work in combination with the consistency group.

Menu:

  • menu positioning – The position the menu symbol is shown at (top-left, top-right, bottom-left, bottom-right).

  • menu mouseover active – Symbol is only shown on mouseover.

  • menu symbol offset x – Relative offset of the menu symbol to the anchor point on the x axis in pixel.

  • menu symbol offset y – Relative offset of the menu symbol to the anchor point on the y axis in pixel.

  • context menu click frame – Defines the size of the click frame for opening the context menu.