![]() | Basic |
The BasicAppSettings Type exposes the following members.
Name | Description of the | |
---|---|---|
![]() | BasicAppSettings | constructor, may be used via reflection from the external static GenericSingletonProvider is called via GetInstance(). Get all the information and make it available as properties. |
Name | Description of the | |
---|---|---|
![]() | AppConfigUser | Path of an XML file in the format of app.config with user-specific settings. |
![]() | AppConfigUserInfo | Info text with extended status information on the AppConfigUser loading attempt. |
![]() | AppConfigUserLoaded | True if an XML file in the format of the app.config with user-specific settings could be loaded. |
![]() | AppEnvAccessor | Implements IGetStringValue for encapsulating access via concrete Readers such as CommandLineAccess, SettingsAccess, EnvAccess. |
![]() | ApplicationName | Application.ProductName |
![]() | ApplicationRootPath | The directory in which the application was started as an absolute path. |
![]() | BreakAlwaysAllowed |
If true, can always be cancelled - for debugging purposes. Default: false |
![]() | CheckVersion |
Can be used for a later version check if necessary. Default: true |
![]() | ClickOnceDataDirectory | directory in which the installation data is stored during a ClickOnce installation (EnvAccess:ISNETWORKDEPLOYED = true). |
![]() | CommandLineAccessor | Implements IGetStringValue for accessing the command line. |
![]() | ConnectionString | Connection string for a database connection. |
![]() | CreatedDirectoryRoot | Contains the path of the lowest directory that was created in the last "Directory.Create" was newly created. This |
![]() | CreateWorkingDirectoryIfNotExists |
If True, the currently set WorkingDirectory is created if it does not yet exist. Default: true |
![]() | DataSource |
The customised database server instance name. Default: = (local) |
![]() | DebugArchiveMaxCount | Maximum number of archived logs (debug files, etc.). If there is a surplus, the oldest ones are deleted. Default: 20. |
![]() | DebugArchivingInterval | Time interval at which the current log (DebugFile, etc.) is archived and emptied. Default: 24 hours. |
![]() | DebugFile |
Path and name of the log file Default: WorkingDirectory + \ + ApplicationName + .log |
![]() | DebugFileRegexFilter | Filter that limits the lines to be logged. Default: "" - everything is logged. |
![]() | 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). |
![]() | DebugMode | If True, applications can generate debug output. Default: False. |
![]() | DefaultDatabase |
The default database. Default: zero |
![]() | DefaultSqlDataDirectory | The default directory for SQL Server data files |
![]() | DefaultSqlLogDirectory | The default directory for the SQL server log files |
![]() | Description | Returns a descriptive name of this StringValueGetter, e.g. name plus source path if applicable. |
![]() | 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. |
![]() | 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. |
![]() | EnvAccessor | Implements IGetStringValue for accessing the environment. |
![]() | FrameworkVersionMajor | The version of the highest installed .Net framework |
![]() | IniAccessor | Implements IGetStringValue for accessing INI files. |
![]() | IsClickOnce | True, if the application was installed via ClickOnce (see also ClickOnceDataDirectory). |
![]() | IsFrameworkAssembly | True if the application is based on .Net framework. |
![]() | IsFullFramework | True if the application is based on a complete .Net framework. |
![]() | IsNetCore | True if the application is a .Net Core application. |
![]() | IsNetNative | True if the application is a UWP application. |
![]() | 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. |
![]() | 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. |
![]() | LogSql |
If true, every sql command should be written to the log file.
For free use. Default: false |
![]() | MachineName | The computer name |
![]() | MinProgramVersion |
Required minimum version for later checking against the program version. Default: "1.0.0.0" |
![]() | OS version | The complete operating system version |
![]() | OSVersionMajor |
Numerical main operating system version > 5 => at least Vista |
![]() | ProcessId | The process ID of the current process. |
![]() | Processor | The processor type |
![]() | ProcessorCount | The number of processors |
![]() | Program version | The current program version = Application.ProductVersion |
![]() | PropertyAccessor | Implements IGetStringValue for accessing public properties of the AppSettings. |
![]() | RegAccessor | Implements IGetStringValue for accessing the registry. |
![]() | 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: "" |
![]() | SearchDirectory |
An optional search directory for various purposes. Default: WorkingDirectory |
![]() | SettingsAccessor | Implements IGetStringValue for accessing the app.config. |
![]() | SingleInstance |
If true, the application can only be started once. Default: false |
![]() | StatisticsFile |
Path and name of the statistics log file Default: WorkingDirectory + \ + ApplicationName + .stat |
![]() | 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_" |
![]() | TempDirectory | Environment: "TEMP" |
![]() | UserDomainName | The Windows domain name |
![]() | UserName | The Windows user name |
![]() | UserSettingsAccessor | Implements IGetStringValue for accessing the app.config.user. |
![]() | 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> |
![]() | 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. |
Name | Description of the | |
---|---|---|
![]() | DirectoryCreate | Creates a complete directory path if this path or a part of it is of which does not exist. Returns the part of the directory path, which goes up to and including the first of the newly created directories or zero. The result of this routine can be used to precisely determine the part of a directory path that has been newly created. |
![]() | Dispose | Public method for cleaning up. |
![]() | Dispose(Boolean) | Finalise work, reset timer if necessary. |
![]() | Finalise |
Destructor
(Overwrites ObjectFinalise) |
![]() | 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". |
![]() | 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". |
![]() | GetStringValue | Returns exactly one value for a key. If there is no value for the key, defaultValue is returned. |
![]() | GetStringValues | Returns a string array for a key. If there is no value for the key, defaultValue is returned. |
![]() | 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. |
![]() | 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. |
![]() | LoadSettings | Loads the system settings during Initialization or loads them again on request. |
![]() | ReplaceWildcards | Replaces wildcards in the format %Name% with their runtime values. |
![]() | SetDefaultSQLDirectories | Sets the default directories for the Microsoft SQL Server. |
![]() | 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. |