RoyalApplicationSetting

RoyalApplicationSetting

Scripting > Reference > Object Properties >

Description

The RoyalApplicationSetting object stores preferences and settings in Royal TS/X.

 

Properties

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

 

Favorite

Whether or not the object is a favorite.

bool

false

 

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

Custom Properties

CustomProperties

Custom properties allow you to collect additional information for an object.

string

Empty String

Behavior

AllowBackgroundConnect

Background connect when holding the Shift key

bool

true

 

AutoFocus

Automatically focus active connections

bool

true

 

CloseTabActivationMode

0 = Select Dashboard (when available)
1 = Select tab to the left
2 = Select tab to the right

int

0

 

ConnectAllInFolderBehavior

0 = Always ask what to do
1 = Include connections from subfolders
2 = Only connections from root level

int

0

 

DisableExternalWindowDrag

A tab cannot be dragged out of the tab bar to create an external window.

bool

false

 

DontCloseTabOnRemoteDisconnect

Keep remotely disconnected tabs open

bool

false

 

ExternalWindowSelectDashboard

External Window: Select Dashboard

bool

false

 

MouseDoubleClickModeActive

0 = Do nothing
1 = Edit Properties
2 = Disconnect
3 = Reconnect

int

2

 

MouseDoubleClickModeConnectionTabs

0 = Do nothing
1 = Edit Properties
2 = Disconnect
3 = Reconnect
4 = External

int

4

 

MouseDoubleClickModeCredentials

0 = Do nothing
1 = Edit Properties
2 = Copy Username
3 = Copy Password

int

3

 

MouseDoubleClickModeInactive

0 = Do nothing
1 = Edit Properties
2 = Connect

int

2

 

MouseDoubleClickModeTasks

0 = Do nothing
1 = Edit Properties
2 = Execute Task

int

2

 

OverrideApplyMode

0 = Apply override when Alt key is pressed
1 = Always apply override, except when Alt key is pressed
2 = Apply override when Ctrl key is pressed
3 = Always apply override, except when Ctrl key is pressed

int

0

 

TrackNavigationSelectionInTabBar

Track Navigation tree selection in tab bar

bool

true

 

TrackTabSelectionInNavigation

Track tab selection in Navigation tree

bool

true

 

Browser Extension

PMAuthenticationTimeout

The Browser Extensions Authentication Timeout in Seconds

int

300

 

PMInstanceIDTrust

A list of Instance ID trust settings for Browser Extension Verification

string[]

new string[] { }

 

PMListenerPort

Browser Extensions Port

int

54890

 

PMStartListenerOnLaunch

Enable Browser Extensions

bool

true

 

PMVerifyBrowserSignature

Enable Browser Extensions Browser Signature Verification

bool

true

 

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

 

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

 

CustomFieldName1

Caption of Custom Field 1

string

Empty String

 

CustomFieldName10

Caption of Custom Field 10

string

Empty String

 

CustomFieldName11

Caption of Custom Field 11

string

Empty String

 

CustomFieldName12

Caption of Custom Field 12

string

Empty String

 

CustomFieldName13

Caption of Custom Field 13

string

Empty String

 

CustomFieldName14

Caption of Custom Field 14

string

Empty String

 

CustomFieldName15

Caption of Custom Field 15

string

Empty String

 

CustomFieldName16

Caption of Custom Field 16

string

Empty String

 

CustomFieldName17

Caption of Custom Field 17

string

Empty String

 

CustomFieldName18

Caption of Custom Field 18

string

Empty String

 

CustomFieldName19

Caption of Custom Field 19

string

Empty String

 

CustomFieldName2

Caption of Custom Field 2

string

Empty String

 

CustomFieldName20

Caption of Custom Field 20

string

Empty String

 

CustomFieldName3

Caption of Custom Field 3

string

Empty String

 

CustomFieldName4

Caption of Custom Field 4

string

Empty String

 

CustomFieldName5

Caption of Custom Field 5

string

Empty String

 

CustomFieldName6

Caption of Custom Field 6

string

Empty String

 

CustomFieldName7

Caption of Custom Field 7

string

Empty String

 

CustomFieldName8

Caption of Custom Field 8

string

Empty String

 

CustomFieldName9

Caption of Custom Field 9

string

Empty String

 

Custom Properties

CustomPropertiesFromParent

Use the Custom Properties from the parent folder.

bool

false

 

Dynamic Folder

DynamicFolderEvaluateShellPersonalizationFile

When executing dynamic folder scripts, by default the shell personalization file will be evaluated. Disable this setting to disable evaluating the shell personalization file.

bool

true

 

General

AdHocIdentifierEnabled

Use Ad Hoc Identifier

bool

true

 

AdHocIdentifierString

Ad Hoc connection identifier

string

(Ad Hoc)

 

AutoBackupFile

Creates a .backup file in the same directory where the document is stored.

bool

true

 

AutoBackupGen

Backup History (0 = disable)

int

10

 

AutoBackupPath

Backup Path

string

%temp%

 

AutoRemoveAdHocWhenDisconnected

Remove Ad Hoc connection after closing the tab

bool

true

 

AutoStartDocumentList

A list of files Royal TS will open when it starts

string[]

new string[] { }

 

AutoStartDocumentMode

0 = Empty
1 = Open last files
2 = Open selected files (from AutoStartDocumentList)
3 = Getting Started Page

int

3

 

CheckForBetaUpdates

Check for Updates: Include Beta Releases

bool

false

 

CheckForPlugInUpdates

Check for Plugin Updates

bool

true

 

CheckForServerBetaUpdates

Checks for server beta updates

bool

false

 

CheckForServerUpdates

Checks for server update

bool

true

 

CheckForUpdatesOnStartup

Check for Updates

bool

true

 

CollectUsageStatistics

Collect anonymous usage statistics

bool

false

 

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

 

ConfirmClose

Application Close; Show a warning for active connections

bool

true

 

DeepKeyboardHook

Deep Keyboard Hooks are used to recognize some keyboard shortcuts.

bool

false

 

DeepKeyboardHookForExternalApps

Deep Keyboard Hooks are also used when Royal TS hosts external applications.

bool

false

 

DoNotCreateDashboardOnStartup

Don't create the Dashboard tab

bool

false

 

DoNotShowGettingStartedPageOnStartup

Don't show the getting started page on launch (macOS only)

bool

false

 

ExternalID

The external unique object identifier (GUID) of the object.

string

Empty String

 

ID

The unique object identifier (GUID) of the object.

Guid

Guid.Empty

 

KeePassPath

Path to the keepass exe

string

Empty String

 

MinimizeToSysTray

Minimize to Notification Area (Systray)

bool

false

 

OverviewHidden

Hide Overview tab

bool

false

 

OverviewZoomLevel

OverviewZoomLevel for overview page

double

.66

 

OverviewZoomLevelWin

Zoom level for Overview page (on Windows)

int

250

 

PanelSlideInDelay

The delay in ms until the panel slides in

int

-1

 

PositionLeft

Window Left Position

int

25

 

PositionTop

Window Top Position

int

25

 

ScreenId

The screen id (display) where Royal TS was open last time. For multimonitor setups

int

1

 

ShowRibbon

Shows the ribbon if true. Ribbon is collapsed if false

bool

true

 

ShowToolbar

Show Toolbar (macOS)

bool

false

 

ShowWindowListAlphabetically

Show Window List Alphabetically

bool

true

 

SuperStartPageBehavior

0 = Show never
1 = Show always
2 = Show when new content is available

int

2

 

UseExtendedFullScreen

Whether to maximize screen real estate when entering full screen or not (macOS only)

bool

false

 

WindowHeight

Window Height

int

743

 

WindowMaximized

Window Maximized

bool

true

 

WindowWidth

Window Width

int

999

 

Logging

LoggingConsoleLoggingUseColors

Use Console Color Output

bool

true

 

LoggingCreateNewFileMode

0 = never (overwrite)
1 = on exit
2 = on exit or after some time/log entries which is defined in LoggingCreateNewFileThreshold and LoggingCreateNewFileUnit

int

0

 

LoggingCreateNewFileThreshold

If LoggingCreateNewFileMode is set to 2 the threshold controls when a new file will be created

int

0

 

LoggingCreateNewFileUnit

0 = minutes
1 = log entries

int

0

 

LoggingEventLogTemplate

Event Log Template

string

$Message${0}{0}Details:{0}$Details${0}{0}More Information:{0}Local User: $LocalUser${0}Local Host: $LocalHost${0}Remote User: $RemoteUser${0}URI: $RemoteURI${0}Action: $Action${0}Object ID:$ObjectID${0}Object Display Name: $ObjectDisplayName${0}Object Type: $ObjectType${0}{0}Plugin ID: $PluginID${0}Plugin Name: $PluginName${0}Plugin Version: $PluginVersion$

 

LoggingFileName

Logfile Name

string

RoyalTSLog.rtsl

 

LoggingFilePath

Log Directory

string

%temp%

 

LoggingLevelConsole

-1 = uninitialized
0 = Activity
1 = Information
2 = Warning
3 = Error
4 = Debug
5 =Verbose

int

-1

 

LoggingLevelFile

-1 = uninitialized
0 = Activity
1 = Information
2 = Warning
3 = Error
4 = Debug
5 =Verbose

int

-1

 

LoggingLevelTraceFile

-1 = uninitialized
0 = Activity
1 = Information
2 = Warning
3 = Error
4 = Debug
5 =Verbose

int

-1

 

LoggingLevelWindowsEventLog

-1 = uninitialized
0 = Activity
1 = Information
2 = Warning
3 = Error
4 = Debug
5 =Verbose

int

-1

 

LoggingSaveToFileMode

0 = never
1 = on exit
2 = on exit or after some time/log entries which is defined in LoggingSaveToFileThreshold and LoggingSaveToFileUnit

int

0

 

LoggingSaveToFileThreshold

If LoggingSaveToFileMode is set to 2, the threshold and unit controls when the file is saved

int

60

 

LoggingSaveToFileUnit

0 = minutes
1 = log entries

int

0

 

LoggingTraceFileName

Trace File Name

string

RoyalTSTrace.rtsl

 

LoggingTraceFileOverrideOnStart

Overwrite File on Application Start

bool

true

 

LoggingTraceFilePath

Trace File Directory

string

%temp%

 

LoggingUseConsoleLogging

-1 = uninitialized
0 = disabled
1 = enabled

int

-1

 

LoggingUseStandardLogging

Enable Internal Logging

bool

true

 

LoggingUseTraceFileLogging

-1 = uninitialized
0 = disabled
1 = enabled

int

-1

 

LoggingUseWindowsEventLog

Enable Logging to the Windows Event Log

bool

true

 

Messages

DontShowDocumentModifiedNotification

A notification is shown when a document is modified on disk

bool

false

 

DontShowExtendedFullScreenIntroduction

A popup showing a quick introduction to the extended full screen feature

bool

false

 

DontShowMaintenanceExtensionNotification

A dialog is shown when maintenance can be extended

bool

false

 

DontShowMajorUpgradeNotification

A dialog is shown when a new major version is available

bool

false

 

DontShowRestoreConnectionsDialog

A dialog is shown that allows to reconnect to previously disconnected sessions

bool

false

 

Notes

NotesFromParent

Use the Notes value from the parent folder.

bool

false

 

Password Generator

PasswordGeneratorAvoidAmbiguousCharacters

Password Generator Avoid Ambiguous Characters

bool

true

 

PasswordGeneratorIncludeDigits

Password Generator Include Digits

bool

true

 

PasswordGeneratorIncludeSymbols

Password Generator Include Symbols

bool

false

 

PasswordGeneratorIncludeUpperCaseLetters

Password Generator Include Uppercase Letters

bool

true

 

PasswordGeneratorLength

Password Generator Length

int

12

 

Proxy Server

ProxyEnabled

Use a Proxy Server

bool

false

 

ProxyPassword

Password

string

Empty String

ProxyPort

Port

int

8080

 

ProxyServer

Proxy Server

string

Empty String

 

ProxyUsername

Username

string

Empty String

 

Screenshots

ScreenshotFileName

Use Custom File Name (leave empty for default file name)

string

Empty String

 

ScreenshotFolder

Use Custom Folder (leave empty for Pictures folder)

string

Empty String

 

ScreenshotMaxSize

Limit Screenshot Size (0 for full size)

int

0

 

Search Options

ShowCredentialTreeSearch

Show Credential Panel Search

bool

false

 

ShowNavigationTreeSearch

Show Navigation Panel Search

bool

true

 

ShowTaskTreeSearch

Show Tasks Panel Search

bool

false

 

ShowTodoItemsTreeSearch

Show Todo Items Panel Search

bool

false

 

Sort Options

SortDefaultCriteria

Default Sort Settings

RoyalStore.SortArgument

new RoyalStore.SortArgument() { SortCriteria1 = RoyalStore.SortCriteria.ObjectType, SortDirection1 = RoyalStore.SortDirection.Ascending, SortCriteria2 = RoyalStore.SortCriteria.Name, SortDirection2 = RoyalStore.SortDirection.Ascending, SortCriteria3 = RoyalStore.SortCriteria.None, SortDirection3 = RoyalStore.SortDirection.Ascending }

 

Tab Scan

TabScanInterval

Tab Scan Interval (in seconds)

int

5

 

User Interface

ActiveSuperView

0 = Overview| 1 = Dashboard

int

0

 

ActiveTabBold

Display active tab caption bold

bool

true

 

AllowAnimations

Allow Animations

bool

true

 

AllowFormGlass

0 = form glass disabled
1= form glass enabled
2 = automatic

int

1

 

AutoHideDocumentsList

Whether or not the document list is hidden automatically on macOS.

bool

false

 

ColorizeConnection

Show colorized border

bool

false

 

ColorizeTab

Use colors in Tabs

bool

false

 

ColorizeTree

Use colors in the Navigation tree

bool

false

 

ConnectionBorderPadding

Border Size

int

2

 

DisableDisplayScalingOnHighDpiSettings

If false (default), the OS will scale Royal TS on high DPI displays which may result in lower quality graphics and icons. If true, Royal TS will act as a dpi aware application which provides high quality graphics and icons but may have side effects on remote connections.

bool

false

 

DocumentsListPosition

0 = left
1 = right

int

0

 

EnableDirectX

Enables hardware accelerated DirectX rendering where possible

bool

false

 

EnablePixelScrolling

Enable Pixel-Scrolling in Navigation

bool

false

 

FontSize

Font size in navigation tree and lists.

double

9.00

 

ForceTreeLines

Always show lines in the Navigation tree

bool

false

 

IncludeDescriptionInTreeSearch

Include Description in search

bool

false

 

IncludeFoldersInTreeSearch

Include Folders in search

bool

false

 

IncludeNotesInTreeSearch

Include Notes in search

bool

false

 

IncludeOnlyFavoritesInTreeSearch

Include only Favorites in search

bool

false

 

IncludeUriInTreeSearch

Include URI (Computer Name or URL) in search

bool

true

 

MaxTabSize

The maximum size of a tab header

int

0

 

PanelActivation

0 = Hover
1 = Click

int

0

 

ResizeWindowToSessionSize

Whether or not to resize the application window to the currently visible session size

bool

false

 

ShowConnectionTypeInTabTooltip

Show Connection Type in Tab Tooltip (macOS)

bool

false

 

ShowDescriptionInWindowTitle

Show the Description in the main window title

bool

true

 

ShowDocumentNameInWindowTitle

Show the Document Name in the main window title

bool

false

 

ShowFavoriteIndicator

Shows an indicator for favorites

bool

true

 

ShowParentFolderNameInWindowTitle

Show the Folder Name in the main window title

bool

false

 

ShowStatusBar

Show the Status Bar

bool

true

 

ShowTabBar

Show Tabs

bool

true

 

ShowTabBarInExternalWindows

Whether or not to show the tab bar in external windows

bool

true

 

ShowTabTitleInWindowTitle

Show the Tab Title in the main window title

bool

true

 

ShowTaskbarThumbnails

Enable Taskbar Thumbnails

bool

false

 

ShowTooltipsInForms

Show Tooltips in Dialogs

bool

true

 

ShowTooltipsInTree

Show Tooltips in the Navigation tree

bool

true

 

TabMultiLine

Display tabs in multiple lines

bool

false

 

TabSizeMode

0 = Auto
1 = Fill
2 = Manual

int

0

 

TreeFontBold

Render tree view items bold

bool

false

 

TreeFontSizeOSX

0 = Small
1 = Medium
2 = Large

int

0

 

TwoLetterISOLanguageName

Language (like en for English or de for German)

string

Empty String

 

UIThemeMac

0 = Automatic
1 = Dark
2 = Light

int

0