RoyalRDSConnection |
![]() |
The RoyalRDSConnection object represents an Remote Desktop connection object in Royal TS/X.
Category |
Name |
Description |
Type |
Default Value |
Is Secure |
---|---|---|---|---|---|
General |
Name |
The display name of the object. |
string |
Empty String |
|
Description |
The description text of the object. |
string |
Empty String |
|
|
URI |
The target URI for the connection object (computer name, URL, ...). |
string |
Empty String |
|
|
Custom Fields |
CustomField1 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
CustomField2 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField3 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField4 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField5 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField6 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField7 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField8 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField9 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField10 |
Custom fields allow you to collect additional information to the object. |
string |
Empty String |
|
|
CustomField11 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField12 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField13 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField14 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField15 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField16 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField17 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField18 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField19 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
CustomField20 |
Custom fields allow you to collect additional information to the object. The content of this custom field will be stored encrypted in your document. |
string |
Empty String |
✓ |
|
Advanced |
AllowBackgroundInput |
If set to true, background input mode is enabled. When background input is enabled the client can accept input when the client does not have focus. |
bool |
false |
|
AuthenticationLevel |
0 = Connect And Do Not Warn Me |
int |
0 |
|
|
BitmapPersistence |
If set to true, bitmap caching is used. This can improve performance but requires additional disk space. |
bool |
true |
|
|
Compression |
If set to true, compression is used. |
bool |
true |
|
|
ConnectToAdministerOrConsole |
If set to true, the session is used for administrative purposes on a Windows Server 2008-based server, or to the console session on a Windows Server 2003-based server. |
bool |
false |
|
|
EnableAutoReconnect |
If set to true, the client control automatically reconnects to a session in the event of a network disconnection. |
bool |
false |
|
|
GlyphCache |
If set to true, glyph caching is enabled. |
bool |
true |
|
|
GrabFocusOnConnect |
If set to true, the client control will grab the focus upon connect. |
bool |
false |
|
|
KeepAliveInterval |
The interval to send keep alive packets (0 = off). |
int |
0 |
|
|
LoadBalanceInfo |
The load balancing cookie that will be placed in the X.224 Connection. |
string |
Empty String |
|
|
MaxReconnectAttempts |
The number of times to try to reconnect during automatic reconnection. A value between 0 to 200 is allowed. |
int |
3 |
|
|
NetworkLevelAuthentication |
If set to true, network level authentication (credsspsupport) is enabled and required. Applies to Windows Vista or later / Windows Server 2008 or later. |
bool |
true |
|
|
PublicMode |
If set to true, the client control does not cache any data to the local system. Use public mode, for example, when connecting to a business server from a system in a conference center. |
bool |
false |
|
|
RestrictedAdminMode |
When Restricted Admin Mode is enabled, the user authenticated on the remote device may not be able to connect to other remote devices, as delegation is restricted and connections to other remote devices are made using the local computer account. |
bool |
false |
|
|
TLSEncryption |
If set to true transport layer security (TLS) is enabled. |
bool |
false |
|
|
Changes |
Created |
The date and time the object was created. |
DateTime |
DateTime.Now |
|
CreatedBy |
The user who initially created the object. |
string |
Empty String |
|
|
Modified |
The last date and time the object was modified. |
DateTime |
DateTime.Now |
|
|
ModifiedBy |
The user who last modified the object. |
string |
Empty String |
|
|
Connect Task |
PreConnectTaskConditionAbort |
If set to true, the connection will be closed when the task fails (exit code <> 0). |
bool |
false |
|
PreConnectTaskConditionFirst |
If set to true, the task will only be executed if it is the first connection in a folder to be connected. |
bool |
false |
|
|
PreConnectTaskFromParent |
Use the Connect Task values from the parent folder. |
bool |
false |
|
|
PreConnectTaskId |
Assign a task object to this object as connect task by specifying the task object's GUID. |
Guid |
Guid.Empty |
|
|
PreConnectTaskMode |
0 = Use connect task from parent folder |
int |
1 |
|
|
PreConnectTaskName |
Assign a task object to this object as connect task by specifying the task object's name. |
string |
Empty String |
|
|
PreConnectTaskWait |
If set to true, the connection will be started after the task finished. |
bool |
false |
|
|
Credentials |
CredentialAutologon |
Whether or not to automatically logon to the connection. Connections which do not support automatic logon will ignore this setting. |
bool |
true |
|
CredentialFromParent |
Use the Credential values from the parent folder. |
bool |
false |
|
|
CredentialId |
Assign a credential object to this object by specifying the credential object's GUID. |
Guid |
Guid.Empty |
|
|
CredentialKeyFile |
Assign a key file to the object by specifying the key file's full path. |
string |
Empty String |
|
|
CredentialMode |
0 = Do not use any credentials |
int |
0 |
|
|
CredentialName |
Assign a credential object to this object by specifying the credential object's name. |
string |
Empty String |
|
|
CredentialPassphrase |
Assign a key file passphrase to the object. |
string |
Empty String |
✓ |
|
CredentialPassword |
Assign a password to the object. |
string |
Empty String |
✓ |
|
CredentialUsername |
Assign a username to the object. |
string |
Empty String |
|
|
Custom Fields |
CustomField10FromParent |
Use the CustomField10 value from the parent folder. |
bool |
false |
|
CustomField11FromParent |
Use the CustomField11 value from the parent folder. |
bool |
false |
|
|
CustomField12FromParent |
Use the CustomField12 value from the parent folder. |
bool |
false |
|
|
CustomField13FromParent |
Use the CustomField13 value from the parent folder. |
bool |
false |
|
|
CustomField14FromParent |
Use the CustomField14 value from the parent folder. |
bool |
false |
|
|
CustomField15FromParent |
Use the CustomField15 value from the parent folder. |
bool |
false |
|
|
CustomField16FromParent |
Use the CustomField16 value from the parent folder. |
bool |
false |
|
|
CustomField17FromParent |
Use the CustomField17 value from the parent folder. |
bool |
false |
|
|
CustomField18FromParent |
Use the CustomField18 value from the parent folder. |
bool |
false |
|
|
CustomField19FromParent |
Use the CustomField19 value from the parent folder. |
bool |
false |
|
|
CustomField1FromParent |
Use the CustomField1 value from the parent folder. |
bool |
false |
|
|
CustomField20FromParent |
Use the CustomField20 value from the parent folder. |
bool |
false |
|
|
CustomField2FromParent |
Use the CustomField2 value from the parent folder. |
bool |
false |
|
|
CustomField3FromParent |
Use the CustomField3 value from the parent folder. |
bool |
false |
|
|
CustomField4FromParent |
Use the CustomField4 value from the parent folder. |
bool |
false |
|
|
CustomField5FromParent |
Use the CustomField5 value from the parent folder. |
bool |
false |
|
|
CustomField6FromParent |
Use the CustomField6 value from the parent folder. |
bool |
false |
|
|
CustomField7FromParent |
Use the CustomField7 value from the parent folder. |
bool |
false |
|
|
CustomField8FromParent |
Use the CustomField8 value from the parent folder. |
bool |
false |
|
|
CustomField9FromParent |
Use the CustomField9 value from the parent folder. |
bool |
false |
|
|
Dashboard |
DashboardAutoHyperVInfo |
If set to true, the dashboard will automatically show hyper-v instances. |
bool |
true |
|
DashboardAutoSessionInfo |
If set to true, the dashboard will automatically show the remote sessions. |
bool |
true |
|
|
DashboardUseAppSettings |
If set to true, the plugin default settings for the dashboard are used. |
bool |
true |
|
|
DashboardUseCredential |
If set to true, the dashboard will use the configured credentials to retrieve the dashboard data. |
bool |
false |
|
|
Disconnect Task |
PostDisconnectTaskConditionLast |
If set to true, the task will only be executed if it is the last active connection in a folder. |
bool |
false |
|
PostDisconnectTaskFromParent |
Use the Disconnect Task values from the parent folder. |
bool |
false |
|
|
PostDisconnectTaskId |
Assign a task object to this object as disconnect task by specifying the task object's GUID. |
Guid |
Guid.Empty |
|
|
PostDisconnectTaskMode |
0 = Use disconnect task from parent folder |
int |
1 |
|
|
PostDisconnectTaskName |
Assign a task object to this object as disconnect task by specifying the task object's name. |
string |
Empty String |
|
|
PostDisconnectTaskWait |
If set to true, the connection will be closed after the task finished. |
bool |
false |
|
|
Display Options |
ColorDepth |
8 = 8bpp (256 colors) |
int |
24 |
|
DesktopHeight |
Specifies the remote desktop height in pixels. |
int |
0 |
|
|
DesktopWidth |
Specifies the remote desktop width in pixels. |
int |
0 |
|
|
DoNotShowConnectionBar |
If set to true, the connection bar will not be displayed in Full Screen mode. |
bool |
false |
|
|
ScaleFactor |
Specifies the remote desktop scaling factor in percent. |
int |
100 |
|
|
SmartReconnect |
If set to true, the client control reconnects when the window was resized. Only works when SmartSizing is false and no desktop width or height is set. |
bool |
false |
|
|
SmartSizing |
If set to true, the display will be scaled down to fit the client area of the control. Note that scroll bars do not appear when the SmartSizing property is enabled. Unlike most other properties, this property can be set when the control is connected. |
bool |
false |
|
|
UseRetinaResolution |
If set to true, the full retina resolution is used, otherwise the display will be scale up. Applies only to Royal TSX on OS X. |
bool |
false |
|
|
Gateway |
GatewayCredentialID |
Assign a credential object as gateway server credential by specifying the credential object's GUID. |
Guid |
Guid.Empty |
|
GatewayCredentialMode |
0 = Ask for credentials on connect |
int |
0 |
|
|
GatewayCredentialName |
Assign a credential object as gateway server credential by specifying the credential object's name. |
string |
Empty String |
|
|
GatewayHostName |
The terminal service gateway server computer name. |
string |
Empty String |
|
|
GatewayPassword |
The password for the gateway server. Only works with XP SP3, Vista SP1, Windows 2008 or later. |
string |
Empty String |
✓ |
|
GatewayTransportType |
0 = Auto |
int |
0 |
|
|
GatewayUsageMethod |
0 = Never |
int |
0 |
|
|
GatewayUserName |
The username for the gateway server. Only works with XP SP3, Vista SP1, Windows 2008 or later. |
string |
Empty String |
|
|
General |
Color |
Assign a custom color as hex string to the object (#FF0000 for red). Empty string is the default color value (no custom color assigned). |
string |
Empty String |
|
ColorFromParent |
Use the Color value from the parent folder. |
bool |
false |
|
|
ID |
The unique object identifier (GUID) of the object. |
Guid |
Guid.Empty |
|
|
IsConnectionTemplate |
If set to true, the connection object is a template. |
bool |
false |
|
|
Hyper-V |
HyperVEnhancedSessionMode |
If set to true, the Hyper-V enhanced session mode is used. |
bool |
false |
|
HyperVInstance |
The GUID of the Hyper-V Instance. |
string |
Empty String |
|
|
HyperVMode |
0 = Standard RDP connection |
int |
0 |
|
|
HyperVPort |
The TCP port of the Hyper-V RDP connection proxy. Default = 2179. |
int |
2179 |
|
|
Key Sequence |
KeySequence |
The key sequence to be executed after the connection was successfully established. |
string |
Empty String |
|
KeySequenceEnabled |
If set to true, the configured key sequence will be executed after the connection was successfully established. |
bool |
false |
|
|
KeySequenceFromParent |
Use the Key Sequence values from the parent folder. |
bool |
false |
|
|
KeySequenceId |
Assign a key sequence task object to this connection by specifying the task object's GUID. |
Guid |
Guid.Empty |
|
|
KeySequenceMode |
0 = Specify a key sequence |
int |
0 |
|
|
KeySequenceName |
Assign a key sequence task object to this object by specifying the key sequence task object's name. |
string |
Empty String |
|
|
Keyboard |
AcceleratorPassthrough |
If set to true, keyboard accelerators are passed to the server. |
bool |
true |
|
EnableConvenienceKeyForwards |
If set to true, certain OS X native keyboard shortcuts are passed to the remote session as their Windows equivalents. |
bool |
true |
|
|
EnableWindowsKey |
If set to true, Windows key combinations are passed to the server. |
bool |
false |
|
|
KeyboardLayoutStr |
The name of the active input locale identifier (formerly called the keyboard layout) to use for the connection. If this property is not set, the control uses the default layout. |
string |
Empty String |
|
|
SendUnicodeKeyboardEvents |
If set to true, the Windows key can be used in the remote session. |
bool |
false |
|
|
Notes |
NotesFromParent |
Use the Notes value from the parent folder. |
bool |
false |
|
Performance |
AllowDesktopComposition |
If set to true, 'Aero' user interface is allowed to be rendered. May only work when using Windows Vista or later. |
bool |
false |
|
AllowFontSmoothing |
If set to true, 'ClearType' to render text is allowed. May only work when connecting to Windows Vista or later. |
bool |
true |
|
|
AllowFullWindowDrag |
If set to true, the window content is displayed when a window is moved, otherwise only the window outline is displayed. |
bool |
true |
|
|
AllowMenuAnimations |
If set to true, menu animations are shown. |
bool |
true |
|
|
AllowMouseCursorShadow |
If set to true, a shadow is displayed for the cursor. |
bool |
true |
|
|
AllowTextCursorBlinking |
If set to true, blinking for the text cursor is allowed. |
bool |
true |
|
|
AllowThemes |
If set to true, Windows themes are displayed. |
bool |
true |
|
|
AllowWallpaper |
If set to true, the wallpaper is displayed in the remote session. |
bool |
true |
|
|
BandwidthDetection |
If set to true, bandwidth changes are automatically detected. |
bool |
true |
|
|
CacheSize |
0 = Full Cache Mode |
int |
0 |
|
|
EnableGraphicsPipeline |
If set to true, the RDP8 Graphics Pipeline is enabled. |
bool |
false |
|
|
NetworkConnectionType |
0 = Not specified |
int |
0 |
|
|
RedirectDirectX |
If set to true, DirectX is redirected. |
bool |
false |
|
|
Plugin for OS X |
PlugInOSX |
The plug in ID used for this connection for OS X. |
string |
Empty String |
|
UseGlobalPlugInOSX |
If set to true, the connection will use the application default plug in for the connection type on OS X. |
bool |
true |
|
|
Plugin for Windows |
PlugInWin |
The plug in ID used for this connection for Windows. |
string |
Empty String |
|
UseGlobalPlugInWin |
If set to true, the connection will use the application default plug in for the connection type on Windows. |
bool |
true |
|
|
Program |
MaximizeShell |
If set to true, the programs launched with the StartProgram property should be maximized. |
bool |
false |
|
StartProgram |
Specifies the working directory of the start program. |
string |
Empty String |
|
|
WorkDir |
The program to be started on the remote server upon connection. Remarks: If the value of this property is not set, the session user's shell command will be run. The shell command will be read from the following registry value on the server: HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows NT\CurrentVersion\WinLogon\Shell |
string |
Empty String |
|
|
Redirection |
AudioCaptureRedirectionMode |
If set to true, audio capture (the microphone) is redirected. |
bool |
false |
|
AudioRedirectionMode |
0 = Bring to this computer |
int |
0 |
|
|
Drives |
A string representing the driveletters which should be redirected (e.g. 'CEH' for the drives C:, E: and H:). If empty, all drives are redirected if drive redirection is enabled |
string |
Empty String |
|
|
RedirectClipboard |
If set to true, the clipboard is shared and redirected. |
bool |
true |
|
|
RedirectDevices |
If set to true, devices are redirected. |
bool |
false |
|
|
RedirectDrives |
If set to true, local disk drives are redirected. |
bool |
false |
|
|
RedirectPorts |
If set to true, local ports (such as COM and LPT ports) are redirected. |
bool |
false |
|
|
RedirectPOSDevices |
If set to true, POS (Point of Service) devices are redirected. |
bool |
false |
|
|
RedirectPrinters |
If set to true, printers are redirected. |
bool |
false |
|
|
RedirectSmartCards |
If set to true, smart cards are redirected. |
bool |
false |
|
|
Royal Server |
ManagementEndpointFromParent |
Use the Royal Server values from the parent folder. |
bool |
false |
|
ManagementEndpointID |
Assign a Royal Server object to this object by specifying the Royal Server object's GUID. |
Guid |
Guid.Empty |
|
|
ManagementEndpointName |
Assign a Royal Server object to this object by specifying the Royal Server object's name. |
string |
Empty String |
|
|
Secure Gateway |
SecureGatewayFromParent |
Use the Secure Gateway values from the parent folder. |
bool |
false |
|
SecureGatewayID |
Assign a Secure Gateway or Royal Server object to this object by specifying the Secure Gateway or Royal Server object's GUID. |
Guid |
Guid.Empty |
|
|
SecureGatewayName |
Assign a Secure Gateway or Royal Server object to this object by specifying the secure gateway or Royal Server object's name. |
string |
Empty String |
|
|
SecureGatewayUsageMode |
0 = Never |
int |
0 |
|
|
Window Mode |
DisplayMode |
0 = Embedded (Tabbed) |
int |
0 |
|
ExternalHeight |
Specifies the last known height of the external window. |
int |
0 |
|
|
ExternalLeft |
Specifies the last known position (left) of the external window. |
int |
0 |
|
|
ExternalPositionMode |
0 = Remember position |
int |
0 |
|
|
ExternalScreen |
Specifies on which Screen the External Window will be shown (Windows). |
int |
0 |
|
|
ExternalScreenMode |
0 = Remember Screen |
int |
0 |
|
|
ExternalScreenOSX |
Specifies on which Screen the External Window will be shown (OS X). |
int |
0 |
|
|
ExternalSizeMode |
0 = Remember Size |
int |
0 |
|
|
ExternalTop |
Specifies the last known position (top) of the external window. |
int |
0 |
|
|
ExternalWidth |
Specifies the last known width of the external window. |
int |
0 |
|
|
FixedSize |
Specifies whether or not the control or form should be expanded automatically to fill the container or maximized form |
bool |
false |
|
|
MinimizeMainWindow |
If set to true, the main window will be minimized after the connection was established. |
bool |
false |
|
|
UseMultiMon |
If set to true, multiple monitors are used in full screen mode. |
bool |
false |
|