Displays Client Settings (Reference) configure the startup behavior, visual indicators, and window properties for runtime display clients across different platforms.
Client Settings provide:
- Initial layout and theme selection
- Tag quality indicators
- Security visualizations
- Multi-monitor support
- Window control options
- Platform-specific settings
Configure at Displays → Client Settings to control runtime appearance and behavior.
On this page:
Table of Contents maxLevel 2 minLevel 2 indent 10px exclude Steps style none
Initial Execution Conditions
Setting | Description | Options |
---|---|---|
Layout |
Startup layout | From Displays/Layouts |
Theme |
Initial theme | From Displays/Themes |
ViewOnly |
Limits the view to specific clients. The options available are:
On WebClients: restricts the view to web-based clients, preventing access from desktop applications.
On Windows: restricts the view to Windows-based clients, preventing access from web applications.
Platform restrictions | WebClients, Windows |
Platform Restrictions
- On WebClients - Restrict to web browsers only
- On Windows - Restrict to desktop clients only
Tag Quality and Security
It refers to the definitions group, which configures visual indicators related to tag quality and security restrictions. Its purpose is to provide clear cues for identifying quality and security issues. Main functionalities include setting symbols for security restrictions and enabling indicators for undefined and bad-quality tags. This is useful in environments where visual feedback is needed to monitor system integrity. Configure it by selecting appropriate symbols. Use this group to set visual indicators.
Indications For Tag Quality And Security | |
On Security Restrictions shows | Sets indicators for tag quality and security with options such as V, ?, $, *, #, and Strikethrough. |
On Undefined Quality shows | Enables an indicator to show for undefined quality tags, unlocking additional settings for handling undefined quality. |
On Tag Bad Quality shows | Enables an indicator to show for bad quality tags, unlocking additional settings for handling bad quality. |
Enable Multiple Monitors (RichClients Only)
It refers to a configuration group that allows multiple monitors with RichClients to be used. Its purpose is to enhance display capabilities. It enables the specification of the number of monitors and the selection of the target display for the startup layout. This applies to scenarios requiring extensive display areas, such as control rooms. Before usage, ensure that the system supports multiple monitors. Use this group to configure and optimize multi-monitor setups.
Enable Multiple Monitors (RichClients Only) | |
Enable Multiple Monitors | Allows the use of multiple monitors for RichClients. |
Number of Monitors | Defines the number of monitors to be used for RichClients. |
Monitor | Sets the target display for the selected layout. |
Layout | Selects the initial layout from predefined configurations in Displays/Layouts. |
Indicators
Visual feedback for data integrity and access control.
Security Restrictions
Display symbols when access denied:
- V - View only
- ? - Unknown security
- $ - Premium feature
- * - Restricted
- # - Protected
- Strikethrough - Disabled
Quality Indicators
Setting | Shows When | Visual |
---|---|---|
Undefined Quality | Quality unknown | ? symbol |
Bad Quality | Communication error | X or strikethrough |
Multi-Monitor Configuration (RichClients)
Enable Multiple Displays
? Enable Multiple Monitors
Number of Monitors: 4
Monitor Assignment
Monitor | Layout | Use Case |
---|---|---|
1 | Overview | Main display |
2 | Alarms | Alert monitoring |
3 | Trends | Data analysis |
4 | Details | Equipment focus |
Windows Client Settings
Window Controls
Control | Description | Default |
---|---|---|
MinimizeBox | Allow minimize | Yes |
MaximizeBox | Allow maximize | Yes |
CloseBox | Allow close | Yes |
Resize | Allow resizing | Yes |
Start Maximized | Full screen startup | No |
Menu Visibility
Menu | Contains | Show |
---|---|---|
File | Open, Save, Exit | Optional |
Tools | Settings, Options | Optional |
Security | Login, Logout | Optional |
Always visible in Development profile.
Special Features
Mouse Cursor
Control cursor visibility and type:
- Visible - Normal operation
- Hidden - Kiosk mode
- Active Area - Edge detection
Active Area Mouse Types
- None - Default system cursor
- Arrow - Standard pointer
- Hand - Interactive indicator
On-Screen Keyboard
Enable for touchscreen operation:
csharp
// Show keyboard with password masking
ShowOnScreenKeyboard(
objectName: "PasswordField",
isPassword: true,
callback: (ok, tag, oldVal, newVal) => {
if (ok) ProcessLogin(newVal);
}
);
Title Bar Configuration
Custom Title
csharp
// Set runtime window title
@Client.Title = $"Plant Monitor - {DateTime.Now:yyyy-MM-dd}";
Title Options
- Enable/disable title bar
- Custom text
- Dynamic updates
- Include user/station info
Multi-Window Support
Allow multiple windows per user:
? Multiple windows on the same computer
Benefits:
- Single login for all windows
- Shared session state
- Independent displays
- Synchronized data
Runtime Properties
License Information
csharp
// Check allowed clients
int maxClients = @Info.License.AllowedRichClients;
// Monitor active sessions
int activeClients = @Server.TotalClients;
// Available slots
int available = maxClients - activeClients;
Best Practices
- Set Appropriate Defaults - Match typical use case
- Configure Quality Indicators - Clear visual feedback
- Plan Multi-Monitor - Logical layout distribution
- Test Platform Restrictions - Verify access control
- Document Settings - Explain configuration choices
- Consider Touch Operation - Enable keyboard if needed
- Secure Kiosk Mode - Disable window controls
Platform-Specific Settings
Web Clients
- No multi-monitor support
- Limited window control
- Browser-based restrictions
Windows Clients
- Full multi-monitor
- Complete window control
- Native keyboard support
Mobile Clients
- Single display only
- Touch optimized
- Auto-rotation support
Troubleshooting
Layout not loading:
- Verify layout exists
- Check platform compatibility
- Review ViewOnly settings
- Test default layout
Quality indicators missing:
- Enable indicators in settings
- Check tag quality values
- Verify communication status
- Review symbol configuration
Multi-monitor issues:
- Confirm monitor count
- Check graphics drivers
- Verify layout assignments
- Test individual monitors
Keyboard not showing:
- Enable OnScreen Keyboard
- Check touch support
- Verify focus handling
- Test input methods
In this section...
Page Tree | ||||
---|---|---|---|---|
|
Settings available only for RichClients and SmartClients (Windows)
This group provides configuration settings reserved for RichClients and SmartClients on Windows. Its purpose is to customize the user interface. Main functionalities include overriding layouts, setting window properties, and managing menu and cursor visibility. Applications include customizing the interface for different operational requirements. Before usage, ensure that predefined layouts and properties are available. Use this group to tailor the UI for specific needs.
Settings Available Only For RichClients And SmartClients (Windows) | |
Layout Override | Overrides default layout settings with options from Displays/Layouts for RichClients and SmartClients. |
Title | Enables and sets the title of the startup window. |
MinimizeBox | Enables the minimize window control button, allowing the window to be minimized by the user. |
MaximizeBox | Enables the maximize window control button, allowing the window to be maximized by the user. |
CloseBox | Enables the close window control button, allowing the window to be closed by the user. |
Resize | Allows the window to be resized by the user. |
Start Maximized | Starts the window in a maximized state, except in the development profile. |
Show Menu | Displays the menu bar in the startup window. |
File | Shows the File menu in the startup window. |
Tools | Shows the Tools menu in the startup window. |
Security | Shows the Security menu in the startup window. |
Always shows Menus in Development Profile | Ensures menus are always visible in the development profile. |
Mouse Cursor Visible | Controls the visibility of the mouse cursor on the screen. |
OnScreen Keyboard | Enables the on-screen keyboard feature, making it available for user input. Below, there's code showcasing how you can mask passwords when using this setting. |
Active Area Edges | Defines the active area edges for mouse interaction within the window. |
Active Area Mouse | Sets the mouse cursor type within the active area. None: When this option is selected, no specific mouse cursor type is assigned to the active area. The default cursor will be used, which typically appears as an arrow or the standard operating system cursor. This setting is useful when no special cursor indication is needed for the active area. Arrow: When this option is selected, the mouse cursor is displayed as an arrow within the active area. This is the standard pointer appearance and is used to indicate a normal selection or navigation action. It helps users identify areas where they can interact with standard interface elements like buttons and menus. Hand: When this option is selected, the mouse cursor is displayed as a hand within the active area. This cursor type is often used to indicate interactive elements such as hyperlinks, buttons, or other elements that respond to clicks. It helps users recognize that the area is interactive and clickable, providing a clear visual cue for interactive elements. |
Multiple windows on the same computer | Allows multiple windows to share the same user logon on the same computer, facilitating user access across different sessions. |
Masking Password when OnScreen Keyboard is available
To mask password input, set the parameter isPassword
, from the OnScreen Keyboard method, to true
when calling this method, as shown below.
Code Block |
---|
/// <summary>
/// Displays screen keyboard
/// </summary>
/// <param name="objectName">Object name</param>
/// <param name="isPassword">Flag indicating whether is a password</param>
/// <param name="_actionShowOnScreenKeyboardOptional">Method called when dialog is closed. Prototyp: void Action(bool ok, string tagName, string oldValue, string newValue) </param>
public static void ShowOnScreenKeyboard(string objectName, bool isPassword, Action<bool, string, string, string> _actionShowOnScreenKeyboardOptional = null) |
Operating clients available at runtime
This information comes directly from the license, and can be checked at runtime in the @Info.License.AllowedRichClients property, indicating how many clients can be opened in total, including RichClient, SmartClient and HTML5Client.
The @Info.License.AllowedWebClients property is deprecated and exists only for compatibility reasons, its value will always be 0.
In this section:
Page Tree | ||||
---|---|---|---|---|
|