Vision - Roster Management
Component Palette Icon:
Description​
The user management panel provides a built-in way to edit rosters from a client.
note
The Alarm Notification module is required in order to use the Roster Management component.
Properties​
| Name | Description | Property Type | Scripting | Category |
|---|---|---|---|---|
| Border | The border surrounding this component. Options are No border, Etched (Lowered), Etched (Raised), Bevel (Lowered), Bevel (Raised), Bevel (Double), and Field Border. Note: The border is unaffected by rotation. Changed in 8.1.21 As of 8.1.21, the "Button Border" and "Other Border" options are removed. | Border | .border | Common |
| Enabled | If disabled, a component cannot be used. | boolean | .componentEnabled | Common |
| Name | The name of this component. | String | .name | Common |
| Quality | The data quality code for any Tag bindings on this component. | QualityCode | .quality | Data |
| Styles | Contains the component's styles. | Dataset | .styles | Appearance |
| Table Color | New in 8.1.14 Changes the background color of the table rows. When a row is selected, its color will revert to highlighted. | Color | .tableBackground | Appearance |
| Table Header Color | New in 8.1.14 Changes the background color of the table headers. | Color | .tableHeaderBackground | Appearance |
| Table Header Text Color | New in 8.1.14 Changes the text color of the table headers. | Color | .tableHeaderForeground | Appearance |
| Table Text Color | New in 8.1.14 Changes the text color of the table rows. When a row is selected, its text will revert to black. | Color | .tableForeground | Appearance |
| User Source | The user source to manage users in. If blank, uses the project's default user source. | String | .addFromUserSource | Behavior |
| Visible | If disabled, the component will be hidden. | boolean | .visible | Common |
| Window Color | New in 8.1.14 Changes the background color of the window. | Color | .windowBackground | Appearance |
| Window Header Color | New in 8.1.14 Changes the background color of the window header. | Color | .windowHeaderBackground | Appearance |
| Window Header Save Button Background | New in 8.1.14 Changes the background color of the window header save button. | Color | .windowHeaderSaveButtonBackground | Appearance |
| Window Header Save Button Text Color | New in 8.1.14 Changes the text color of the window header save button. | Color | .windowHeaderSaveButtonForeground | Appearance |
| Window Header Text Color | New in 8.1.14 Changes the window header text color. | Color | .windowHeaderForeground | Appearance |
| Window Text Color | New in 8.1.14 Changes the window header text color. | Color | .windowForeground | Appearance |
Scripting​
See the Vision - Roster Management Scripting Functions page for the full list of scripting functions available for this component.
Event Handlers​
Event handlers allow you to run a script based off specific triggers. See the full list of available event handlers on the Component Events page.