Click or drag to resize

AppSettings Properties

The AppSettings Type exposes the following members.

Properties
 NameDescription of the
Public PropertyAbortingAllowed With True, nodes that do not (or cannot) respond to cooperative cancellation are is cancelled hard by "Abort()". Always: false; no longer applicable in future.
Public PropertyStatic MemberActScreenBounds Is used internally in the program as a memory field for the current screen limits. Is set by MainWindow.xaml.cs.
Public PropertyAppConfigUser Path of an XML file in the format of app.config with user-specific settings.
(Inherited from BasicAppSettings)
Public PropertyAppConfigUserInfo Info text with extended status information on the AppConfigUser loading attempt.
(Inherited from BasicAppSettings)
Public PropertyAppConfigUserLoaded True if an XML file in the format of the app.config with user-specific settings could be loaded.
(Inherited from BasicAppSettings)
Public PropertyAppEnvAccessor Implements IGetStringValue for encapsulating access via concrete Readers such as CommandLineAccess, SettingsAccess, EnvAccess.
(Inherited from BasicAppSettings)
Public PropertyApplicationName Application.ProductName
(Inherited from BasicAppSettings)
Public PropertyApplicationRootPath The directory in which the application was started as an absolute path.
(Inherited from BasicAppSettings)
Public PropertyAssemblyDirectories List of directories in which to search for assemblies to be loaded is to be sought.
Public PropertyAutostart If true, the tree is started automatically. Default: false.
Public PropertyBreakAlwaysAllowed If true, can always be cancelled - for debugging purposes.
Default: false

(Inherited from BasicAppSettings)
Public PropertyCheckVersion Can be used for a later version check if necessary.
Default: true

(Inherited from BasicAppSettings)
Public PropertyClickOnceDataDirectory directory in which the installation data is stored during a ClickOnce installation (EnvAccess:ISNETWORKDEPLOYED = true).
(Inherited from BasicAppSettings)
Public PropertyConnectionString Connection string for a database connection.
(Inherited from BasicAppSettings)
Public PropertyControlledNodeUserRunDialog Controls the behaviour of the UserRun of a node in a controlled tree, which is triggered via a TreeEvent and whose start requirements are are not yet fulfilled: None: no start possible, Info: no start possible - a message will be sent, Question: a Yes/No query with a default value of "No" is displayed. Defult: Question.
Public PropertyCreateWorkingDirectoryIfNotExists If True, the currently set WorkingDirectory is created if it does not yet exist.
Default: true

(Inherited from BasicAppSettings)
Public PropertyDataSource The customised database server instance name.
Default: = (local)

(Inherited from BasicAppSettings)
Public PropertyDebugArchiveMaxCount Maximum number of archived logs (debug files, etc.). If there is a surplus, the oldest ones are deleted. Default: 20.
(Inherited from BasicAppSettings)
Public PropertyDebugArchivingInterval Time interval at which the current log (DebugFile, etc.) is archived and emptied. Default: 24 hours.
(Inherited from BasicAppSettings)
Public PropertyDebugFile Path and name of the log file
Default: WorkingDirectory + \ + ApplicationName + .log

(Inherited from BasicAppSettings)
Public PropertyDebugFileRegexFilter Filter that limits the lines to be logged. Default: "" - everything is logged.
(Inherited from BasicAppSettings)
Public PropertyDebugInfo The types of information to be logged
public enum InfoType
{ DEBUG, INFO, WARN, MILESTONE, ERROR, EXCEPTION, USERTYPE1, USERTYPE2 };
as a string, such as: "DEBUG|INFO|WARN|MILESTONE|ERROR".
Default: is set in the start program, usually InfoType.ALL (InfoType.ALL contains everything except the USERTYPEs).

(Inherited from BasicAppSettings)
Public PropertyDebugMode If True, applications can generate debug output. Default: False.
(Inherited from BasicAppSettings)
Public PropertyDefaultDatabase The default database.
Default: zero

(Inherited from BasicAppSettings)
Public PropertyDefaultSqlDataDirectory The default directory for SQL Server data files
(Inherited from BasicAppSettings)
Public PropertyDefaultSqlLogDirectory The default directory for the SQL server log files
(Inherited from BasicAppSettings)
Public PropertyDemo mode At true, Vishnu is in demo mode. This is the case immediately after initial installation. Default: false.
Public PropertyDescription Returns a descriptive name of this StringValueGetter, e.g. name plus source path if applicable.
(Inherited from BasicAppSettings)
Public PropertyDumpAppSettings If true, BasicAppSettings returns the following via the InfoController at the end of the Processing all AppSetting properties with value and source. Default: false.
(Inherited from BasicAppSettings)
Public PropertyDumpLoadedAssemblies If true, BasicAppSettings returns the following via the InfoController at the end of the Processing the full names of all assemblies loaded in the AppDomain. Default: false.
(Inherited from BasicAppSettings)
Public PropertyFatalInitializationException If not equal to zero, the application should report the exception and exit.
Public PropertyFlatNodeListFilter Combinable list of types of nodes of the tree for filtering of the nodes in a flat list of nodes (FlatNodeViewModelList).
Public PropertyFrameworkVersionMajor The version of the highest installed .Net framework
(Inherited from BasicAppSettings)
Public PropertyHelpPreference The preferred Vishnu help (loaded via F1 or Context Menu): "online": Vishnu help is loaded from the Internet (default); "local": the Vishnu help is loaded locally as .chm.
Public PropertyIsClickOnce True, if the application was installed via ClickOnce (see also ClickOnceDataDirectory).
(Inherited from BasicAppSettings)
Public PropertyIsFrameworkAssembly True if the application is based on .Net framework.
(Inherited from BasicAppSettings)
Public PropertyIsFullFramework True if the application is based on a complete .Net framework.
(Inherited from BasicAppSettings)
Public PropertyIsInSleepTime Returns true if a rest period defined by the user is currently in progress. for Vishnu actors (checkers) is running.
Public PropertyIsNetCore True if the application is a .Net Core application.
(Inherited from BasicAppSettings)
Public PropertyIsNetNative True if the application is a UWP application.
(Inherited from BasicAppSettings)
Public PropertyKillChildProcessesOnApplicationExit With True, all child processes of the application at the end of the program should be can be scheduled recursively after a certain waiting time. Attention: BasicAppSettings only provides the property. The respective application must take care of terminating the processes. by integrating NetEti.ProcessTools and calling up ProcessWorker.FinishChildProcesses() yourself. Default: false.
(Inherited from BasicAppSettings)
Public PropertyKillWorkingDirectoryAtShutdown If True, the WorkingDirectory is removed at the end of the program. For safety reasons, this should only be done if the program start was also generated. The WorkingDirectory is not created or deleted by BasicAppSettings, but can also be used by the application or logging. Default: true.
(Inherited from BasicAppSettings)
Public PropertyLocalConfigurationDirectory The file path to the local configuration directory. Default: Path to the AppConfigUser directory.
Public PropertyLogSql If true, every sql command should be written to the log file. For free use.
Default: false

(Inherited from BasicAppSettings)
Public PropertyMachineName The computer name
(Inherited from BasicAppSettings)
Public PropertyMinprogramVersion Required minimum version for later checking against the program version.
Default: "1.0.0.0"
(Inherited from BasicAppSettings)
Public PropertyNoWorkers If True, defined workers are not called. Default: false.
Public PropertyOS version The complete operating system version
(Inherited from BasicAppSettings)
Public PropertyOSVersionMajor Numerical main operating system version
> 5 => at least Vista
(Inherited from BasicAppSettings)
Public PropertyProcessId The process ID of the current process.
(Inherited from BasicAppSettings)
Public PropertyProcessor The processor type
(Inherited from BasicAppSettings)
Public PropertyProcessorCount The number of processors
(Inherited from BasicAppSettings)
Public Propertyprogram version The current program version = Application.ProductVersion
(Inherited from BasicAppSettings)
Public PropertyRegistryBasePath Base path in which a setting is searched for in the registry. If the path contains one of the RegistryRoots, e.g. "HKEY_CURRENT_USER", then the internally set RegistryRoot has also been changed. The default for the internally set RegistryRoot is "HKEY_LOCAL_MACHINE". Default: ""
(Inherited from BasicAppSettings)
Public PropertyRootJobXmlName XML name of the top-level job. Default: JobDescription.xml.
Public PropertySearchDirectory An optional search directory for various purposes.
Default: WorkingDirectory

(Inherited from BasicAppSettings)
Public PropertySingleInstance If true, the application can only be started once.
Default: false

(Inherited from BasicAppSettings)
Public PropertySleepTimeFrom Start of a user-defined rest period for Vishnu actors (checkers).
Public PropertySleepTimeTo End of a user-defined rest period for Vishnu actors (checkers).
Public PropertySnapshotDirectory Directory defined by the user in which snapshots of nodes are saved. If the SnapshotDirectory path is relative or empty (usually not useful), then the SnapshotDirectory path always relative to the directory in which the JobDescription.xml of the MainJob.
Public PropertySnapshotSustain Survival time of a snapshot.
Public PropertyStartTreeOrientation Alignment of the tree when starting the application. AlternatingHorizontal: Alternating structure, starting horizontally (default). Vertical: Vertical structure. Horizontal: Horizontal structure. AlternatingVertical: Alternating structure, starting vertically.
Public PropertyStartTriggeredNodesOnUserRun Parameters for controlling the start behaviour of triggered nodes when started by the user (UserRun): None = no direct start, All = all triggered nodes within of a (partial) tree started by UserRun start directly (like non-triggered nodes), Direct = all triggered nodes start directly when they themselves were started by UserRun. AllNoTreeEvents = like All but nodes not triggered by TreeEvents, DirectNoTreeEvents = like Direct but nodes not triggered by TreeEvents. Default: Direct.
Public PropertyStartWithJobs If true, the job view is started, otherwise the tree view is started (default: false).
Public PropertyStatisticsFile Path and name of the statistics log file
Default: WorkingDirectory + \ + ApplicationName + .stat

(Inherited from BasicAppSettings)
Public PropertyStatisticsFileRegexFilter Filter that limits the lines to be logged. Default: "" - everything is logged. e.g: @"(?:_NOPPES_)" - Nothing is logged, or only lines that contain "_NOPPES_"
(Inherited from BasicAppSettings)
Public PropertyTempDirectory Environment: "TEMP"
(Inherited from BasicAppSettings)
Public PropertyUncachedCheckers List of INodeChecker dll names that are to be reloaded for each run. Used to debug memory leaks that are presumably caused by user checkers.
Public PropertyUserAssemblyDirectory Directory in which the user's cross-job assemblies are stored.
Public PropertyUserDomainName The Windows domain name
(Inherited from BasicAppSettings)
Public PropertyUserName The Windows user name
(Inherited from BasicAppSettings)
Public PropertyUserParameterReaderPath File path of an optional dll that implements IParameterReader. If available, the dll is loaded dynamically and extends Vishnu's Capabilities for parameter replacement in ReplaceWildcards.
Public PropertyVishnuProvider The publisher of the ClickOnce installation.
Public PropertyVishnuRoot The Vishnu root directory at runtime. In contrast to the optional "Vishnu_Root" environment setting this property if it is not set externally as a parameter, filled by the Vishnu program logic, so that they are always as good as is set to "%VishnuRoot%" and can therefore also be accessed from outside via "%VishnuRoot%" can be used. While "Vishnu_Root", if it has been set, is always the root directory of Vishnu development, "VishnuRoot" shows a preference for the directory in which the started Vishnu.exe is located ("ApplicationRootPath"). Only if at the same hierarchy level, such as "ApplicationRootPath" directory "UserAssemblies" is not located, "VishnuRoot", if not from the outside, as well as possible, through the Vishnu program logic on the root directory of the Vishnu development.
Public PropertyVishnuSourceRoot VishnuSourceRoot always refers to the root directory of the Vishnu development. If no "Vishnu_Root" directory has been set in the program environment, VishnuSourceRoot will be implemented as well as possible by the Vishnu program logic on the root directory of the Vishnu development.
Public PropertyVishnuWindowAspects Data class with essential display features of the Vishnu MainWindow.
Public PropertyWorkingDirectory The working directory
Default:
If "SingleInstance=true: C:\Users\<user>\AppData\Local\Temp\<ApplicationName>
With "SingleInstance=false: C:\Users\<user>\AppData\Local\Temp\<ApplicationName>\<ProcessId>

(Inherited from BasicAppSettings)
Public PropertyWorkingDirectoryCreated True if the WorkingDirectory was created when the program was started. The WorkingDirectory is not created or deleted by BasicAppSettings, but can also be used by the application or logging. Default: false.
(Inherited from BasicAppSettings)
Back to the top
See also