 | App |
Inherits generally valid settings from BasicAppSettings or settings derived from it.
classes and adds application-specific properties.
Retrieves application settings from various sources:
Command line, Vishnu.exe.config (app.config), Vishnu.exe.config.user, Environment, Registry.
Inheritance hierarchyNamespace: Vishnu.Interchange
Assembly: Vishnu.Interchange (in Vishnu.Interchange.dll) Version: 1.0.0+df0404e911d6c38eaed3bb1bb1acfc482d417643
SyntaxThe AppSettings Type exposes the following members.
Properties| Name | Description of the | |
|---|---|---|
 | AbortingAllowed | 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. |
 | ActScreenBounds | Is used internally in the program as a memory field for the current screen limits. Is set by MainWindow.xaml.cs. |
| AppConfigUser |
Path of an XML file in the format of app.config with user-specific settings.
(Inherited from BasicAppSettings) |
| AppConfigUserInfo |
Info text with extended status information on the AppConfigUser loading attempt.
(Inherited from BasicAppSettings) |
| AppConfigUserLoaded |
True if an XML file in the format of the app.config with user-specific settings
could be loaded.
(Inherited from BasicAppSettings) |
| AppEnvAccessor |
Implements IGetStringValue for encapsulating access via concrete
Readers such as CommandLineAccess, SettingsAccess, EnvAccess.
(Inherited from BasicAppSettings) |
| ApplicationName |
Application.ProductName
(Inherited from BasicAppSettings) |
| ApplicationRootPath |
The directory in which the application was started as an absolute path.
(Inherited from BasicAppSettings) |
| AssemblyDirectories | List of directories in which to search for assemblies to be loaded is to be sought. |
| Autostart | If true, the tree is started automatically. Default: false. |
| BreakAlwaysAllowed |
If true, can always be cancelled - for debugging purposes. Default: false (Inherited from BasicAppSettings) |
| CheckVersion |
Can be used for a later version check if necessary. Default: true (Inherited from BasicAppSettings) |
| ClickOnceDataDirectory |
directory in which the installation data is stored during a
ClickOnce installation (EnvAccess:ISNETWORKDEPLOYED = true).
(Inherited from BasicAppSettings) |
| ConnectionString |
Connection string for a database connection.
(Inherited from BasicAppSettings) |
| ControlledNodeUserRunDialog | 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. |
| CreateWorkingDirectoryIfNotExists |
If True, the currently set WorkingDirectory is created if it does not yet exist. Default: true (Inherited from BasicAppSettings) |
| DataSource |
The customised database server instance name. Default: = (local) (Inherited from BasicAppSettings) |
| DebugArchiveMaxCount |
Maximum number of archived logs (debug files, etc.).
If there is a surplus, the oldest ones are deleted.
Default: 20.
(Inherited from BasicAppSettings) |
| DebugArchivingInterval |
Time interval at which the current log (DebugFile, etc.)
is archived and emptied.
Default: 24 hours.
(Inherited from BasicAppSettings) |
| DebugFile |
Path and name of the log file Default: WorkingDirectory + \ + ApplicationName + .log (Inherited from BasicAppSettings) |
| DebugFileRegexFilter |
Filter that limits the lines to be logged.
Default: "" - everything is logged.
(Inherited from BasicAppSettings) |
| DebugInfo |
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) |
| DebugMode |
If True, applications can generate debug output.
Default: False.
(Inherited from BasicAppSettings) |
| DefaultDatabase |
The default database. Default: zero (Inherited from BasicAppSettings) |
| DefaultSqlDataDirectory |
The default directory for SQL Server data files
(Inherited from BasicAppSettings) |
| DefaultSqlLogDirectory |
The default directory for the SQL server log files
(Inherited from BasicAppSettings) |
| Demo mode | At true, Vishnu is in demo mode. This is the case immediately after initial installation. Default: false. |
| Description |
Returns a descriptive name of this StringValueGetter,
e.g. name plus source path if applicable.
(Inherited from BasicAppSettings) |
| DumpAppSettings |
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) |
| DumpLoadedAssemblies |
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) |
| FatalInitializationException | If not equal to zero, the application should report the exception and exit. |
| FlatNodeListFilter | Combinable list of types of nodes of the tree for filtering of the nodes in a flat list of nodes (FlatNodeViewModelList). |
| FrameworkVersionMajor |
The version of the highest installed .Net framework
(Inherited from BasicAppSettings) |
| HelpPreference | 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. |
| IsClickOnce |
True, if the application was installed via ClickOnce
(see also ClickOnceDataDirectory).
(Inherited from BasicAppSettings) |
| IsFrameworkAssembly |
True if the application is based on .Net framework.
(Inherited from BasicAppSettings) |
| IsFullFramework |
True if the application is based on a complete .Net framework.
(Inherited from BasicAppSettings) |
| IsInSleepTime | Returns true if a rest period defined by the user is currently in progress. for Vishnu actors (checkers) is running. |
| IsNetCore |
True if the application is a .Net Core application.
(Inherited from BasicAppSettings) |
| IsNetNative |
True if the application is a UWP application.
(Inherited from BasicAppSettings) |
| KillChildProcessesOnApplicationExit |
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) |
| KillWorkingDirectoryAtShutdown |
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) |
| LocalConfigurationDirectory | The file path to the local configuration directory. Default: Path to the AppConfigUser directory. |
| LogSql |
If true, every sql command should be written to the log file.
For free use. Default: false (Inherited from BasicAppSettings) |
| MachineName |
The computer name
(Inherited from BasicAppSettings) |
| MinProgramVersion |
Required minimum version for later checking against the program version. Default: "1.0.0.0" (Inherited from BasicAppSettings) |
| NoWorkers | If True, defined workers are not called. Default: false. |
| OS version |
The complete operating system version
(Inherited from BasicAppSettings) |
| OSVersionMajor |
Numerical main operating system version > 5 => at least Vista (Inherited from BasicAppSettings) |
| ProcessId |
The process ID of the current process.
(Inherited from BasicAppSettings) |
| Processor |
The processor type
(Inherited from BasicAppSettings) |
| ProcessorCount |
The number of processors
(Inherited from BasicAppSettings) |
| Program version |
The current program version = Application.ProductVersion
(Inherited from BasicAppSettings) |
| RegistryBasePath |
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) |
| RootJobXmlName | XML name of the top-level job. Default: JobDescription.xml. |
| SearchDirectory |
An optional search directory for various purposes. Default: WorkingDirectory (Inherited from BasicAppSettings) |
| SingleInstance |
If true, the application can only be started once. Default: false (Inherited from BasicAppSettings) |
| SleepTimeFrom | Start of a user-defined rest period for Vishnu actors (checkers). |
| SleepTimeTo | End of a user-defined rest period for Vishnu actors (checkers). |
| SnapshotDirectory | 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. |
| SnapshotSustain | Survival time of a snapshot. |
| StartTreeOrientation | 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. |
| StartTriggeredNodesOnUserRun | 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. |
| StartWithJobs | If true, the job view is started, otherwise the tree view is started (default: false). |
| StatisticsFile |
Path and name of the statistics log file Default: WorkingDirectory + \ + ApplicationName + .stat (Inherited from BasicAppSettings) |
| StatisticsFileRegexFilter |
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) |
| TempDirectory |
Environment: "TEMP"
(Inherited from BasicAppSettings) |
| UncachedCheckers | 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. |
| UserAssemblyDirectory | Directory in which the user's cross-job assemblies are stored. |
| UserDomainName |
The Windows domain name
(Inherited from BasicAppSettings) |
| UserName |
The Windows user name
(Inherited from BasicAppSettings) |
| UserParameterReaderPath | 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. |
| VishnuProvider | The publisher of the ClickOnce installation. |
| VishnuRoot | 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. |
| VishnuSourceRoot | 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. |
| VishnuWindowAspects | Data class with essential display features of the Vishnu MainWindow. |
| WorkingDirectory |
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) |
| WorkingDirectoryCreated |
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) |
Methods| Name | Description of the | |
|---|---|---|
 | Dispose |
Public method for cleaning up.
(Inherited from BasicAppSettings) |
| GetLoadedAssemblies |
Returns a dictionary that is used for all assemblies loaded in the application.
contains the FullName and the assembly.
Can be helpful for troubleshooting in certain cases. Note: If the switch "DumpLoadedAssemblies" = true, the keys of this dictionary (FullName) are logged in "Dispose". (Inherited from BasicAppSettings) |
| GetParametersSources |
Returns a dictionary containing the name of the source for each parameter.
Can be helpful for troubleshooting in certain cases. Note: If the switch "DumpAppSettings" = true, this dictionary is logged in "Dispose". (Inherited from BasicAppSettings) |
| GetResolvedPath | Resolves the transferred path taking into account the search sequence into a secured path, if possible. |
| GetStringValue |
Returns exactly one value for a key. If there is no value for the
key, defaultValue is returned.
(Inherited from BasicAppSettings) |
| GetStringValues |
Returns a string array for a key. If there is no value for the
key, defaultValue is returned.
(Inherited from BasicAppSettings) |
| GetValueT |
Returns exactly one value for a key. If there is no value for the
key, defaultValue is returned.
Wildcards of the form %Name% are replaced recursively if possible;
An attempt is made to cast the determined string value to the return type T.
(Inherited from BasicAppSettings) |
| GetValuesT |
NOT IMPLEMENTED!
Returns an array of values for a key. If there is no value for the
key, defaultValue is returned.
Wildcards of the form %Name% are replaced recursively if possible;
An attempt is made to cast the determined string value to the return type T.
(Inherited from BasicAppSettings) |
| InitUserParameterReader | routine, which sets the ParameterReader according to the parameters previously defined in UserParameterReaderPath is initialized. Depending on the UserParameterReader, this process may take longer and is therefore not executed automatically here, but must be externally and preferably directly after instantiation. |
| LoadSettings |
Loads the system settings during Initialization or loads them again on request.
(Overwrites BasicAppSettingsLoadSettings) |
| RegisterUserStringValueGetter | Registers the transferred IGetStringValue instance (UserParameterReader) for the contained AppEnvReader. The new getter is used in the evaluation chain directly behind CommandLineAccess, which gives it (after the command line) the highest priority. |
| ReplaceWildcards |
Replaces wildcards defined here with their runtime values:
'%HOME%': '...bin\Debug'.
(Overwrites BasicAppSettingsReplaceWildcards(String)) |
| SetRegistryBasePath |
Sets the registry access key for all subsequent accesses to
the passed base path, if the passed registryBasePath
can be converted error-free into a corresponding equivalent from registry keys.
(Inherited from BasicAppSettings) |
Events| Name | Description of the | |
|---|---|---|
 | UserParametersReloaded | Event that is triggered when user parameters are reloaded. |
Remarks
File: AppSettings.cs
Author: Erik Nagel, NetEti
11 Oct 2013 Erik Nagel: created.
28.01.2024 Erik Nagel: Property VishnuRoot added.
See also