 | App |
Erbt allgemeingültige Einstellungen von BasicAppSettings oder davon abgeleiteten
Klassen und fügt anwendungsspezifische Properties hinzu.
Holt Applikationseinstellungen aus verschiedenen Quellen:
Kommandozeile, Vishnu.exe.config (app.config), Vishnu.exe.config.user, Environment, Registry.
VererbungshierarchieNamensraum: Vishnu.Interchange
Assembly: Vishnu.Interchange (in Vishnu.Interchange.dll) Version: 1.0.0+d75bac576d44afb64cfff79fd3665c8ca1172cbc
SyntaxDer AppSettings Typ exponiert die folgenden Member.
Eigenschaften| Name | Beschreibung | |
|---|---|---|
 | AbortingAllowed | Bei True werden Knoten, die nicht auf kooperativen Cancel reagieren (können) durch "Abort()" hart abgebrochen. Immer: false; künftig wegfallend. |
 | ActScreenBounds | Wird programmintern als Merkfeld für die aktuellen Bildschirmgrenzen genutzt. Wird von MainWindow.xaml.cs gesetzt. |
| AppConfigUser |
Pfad einer XML-Datei im Format der app.config mit User-spezifischen Einstellungen.
(Vererbt von BasicAppSettings) |
| AppConfigUserInfo |
Info-Text mit erweiterten Status-Informationen zum Ladeversuch der AppConfigUser.
(Vererbt von BasicAppSettings) |
| AppConfigUserLoaded |
True wenn eine XML-Datei im Format der app.config mit User-spezifischen Einstellungen
geladen werden konnte.
(Vererbt von BasicAppSettings) |
| AppEnvAccessor |
Implementiert IGetStringValue zur Kapselung von Zugriffen über konkrete
Reader wie zum Beispiel CommandLineAccess, SettingsAccess, EnvAccess.
(Vererbt von BasicAppSettings) |
| ApplicationName |
Application.ProductName
(Vererbt von BasicAppSettings) |
| ApplicationRootPath |
Das Verzeichnis, in dem die Applikation gestartet wurde als absoluter Pfad.
(Vererbt von BasicAppSettings) |
| AssemblyDirectories | Liste von Verzeichnissen, in denen nach zu ladenden Assemblies gesucht werden soll. |
| Autostart | Bei true wird der Tree automatisch gestartet. Default: false. |
| BreakAlwaysAllowed |
Wenn true, kann immer abgebrochen werden - zu Debug-Zwecken. Default: false (Vererbt von BasicAppSettings) |
| CheckVersion |
Kann ggf. bei einer spätere Versionsprüfung genutzt werden. Default: true (Vererbt von BasicAppSettings) |
| ClickOnceDataDirectory |
Verzeichnis, in dem die Installationsdaten bei einer
ClickOnce-Installation (EnvAccess:ISNETWORKDEPLOYED = true) liegen.
(Vererbt von BasicAppSettings) |
| ConnectionString |
Connection-String für eine Datenbank-Verbindung.
(Vererbt von BasicAppSettings) |
| ControlledNodeUserRunDialog | Steuert das Verhalten beim UserRun eines Knoten in einem Controlled-Tree, der über ein TreeEvent getriggert wird und dessen Startvoraussetzungen noch nicht erfüllt sind: None: kein Start möglich, Info: kein Start möglich - es erfolgt eine Meldung, Question: es erfolgt eine mit "Nein" vorbelegte JaNein-Abfrage. Defult: Question. |
| CreateWorkingDirectoryIfNotExists |
Bei True wird das aktuell gesetzte WorkingDirectory angelegt, wenn es noch nicht existiert. Default: true (Vererbt von BasicAppSettings) |
| DataSource |
Der angepasste Datenbank-Server Instanz-Name. Default: = (local) (Vererbt von BasicAppSettings) |
| DebugArchiveMaxCount |
Maximale Anzahl von archivierten Logs (DebugFiles, o.ä.).
Bei Überzahl werden jeweils die ältesten gelöscht.
Default: 20.
(Vererbt von BasicAppSettings) |
| DebugArchivingInterval |
Zeitabstand, in dem das aktuelle Log (DebugFile, o.ä.)
archiviert und geleert wird.
Default: 24 Stunden.
(Vererbt von BasicAppSettings) |
| DebugFile |
Pfad und Name des Logfiles Default: WorkingDirectory + \ + ApplicationName + .log (Vererbt von BasicAppSettings) |
| DebugFileRegexFilter |
Filter, der die zu loggenden Zeilen begrenzt.
Default: "" - alles wird geloggt.
(Vererbt von BasicAppSettings) |
| DebugInfo |
Die zu loggenden Informationsarten public enum InfoType { DEBUG, INFO, WARN, MILESTONE, ERROR, EXCEPTION, USERTYPE1, USERTYPE2 }; als String, wie z.B.: "DEBUG|INFO|WARN|MILESTONE|ERROR". Default: wird im Startprogramm gesetzt, üblicherweise InfoType.ALL (InfoType.ALL enthält alles außer den USERTYPEn). (Vererbt von BasicAppSettings) |
| DebugMode |
Bei True können Anwendungen Debug-Ausgaben erzeugen.
Default: False.
(Vererbt von BasicAppSettings) |
| DefaultDatabase |
Die voreingestellte Datenbank. Default: null (Vererbt von BasicAppSettings) |
| DefaultSqlDataDirectory |
Das Default-Verzeichnis für SQL-Server Datendateien
(Vererbt von BasicAppSettings) |
| DefaultSqlLogDirectory |
Das Default-Verzeichnis für die SQL-Server Logdateien
(Vererbt von BasicAppSettings) |
| DemoModus | Bei true befindet sich Vishnu im Demo-Modus. Dies ist direkt nach Erstinstallation der Fall. Default: false. |
| Description |
Liefert einen beschreibenden Namen dieses StringValueGetters,
z.B. Name plus ggf. Quellpfad.
(Vererbt von BasicAppSettings) |
| DumpAppSettings |
Bei true gibt BasicAppSettings über den InfoController am Ende der
Verarbeitung alle AppSetting-Properties mit Wert und Quelle aus.
Default: false.
(Vererbt von BasicAppSettings) |
| DumpLoadedAssemblies |
Bei true gibt BasicAppSettings über den InfoController am Ende der
Verarbeitung die Vollnamen aller in der AppDomain geladenen Assemblies aus.
Default: false.
(Vererbt von BasicAppSettings) |
| FatalInitializationException | Wenn ungleich null, dann sollte die Anwendung die Exception melden und sich beenden. |
| FlatNodeListFilter | Kombinierbare Liste von Typen von Knoten des Trees zur Filterung der Knoten in einer flachen Liste von Knoten (FlatNodeViewModelList). |
| FrameworkVersionMajor |
Die Version des höchsten installierten .Net-Frameworks
(Vererbt von BasicAppSettings) |
| HelpPreference | Die bevorzugte Vishnu-Hilfe (wird über F1 oder das Kontext-Menü geladen): "online": die Vishnu-Hilfe wird aus dem Internet geladen (default); "local": die Vishnu-Hilfe wird als .chm lokal geladen. |
| IsClickOnce |
True, wenn die Anwendung per ClickOnce installiert wurde
(siehe auch ClickOnceDataDirectory).
(Vererbt von BasicAppSettings) |
| IsFrameworkAssembly |
True, wenn die Anwendung auf .Net-Framework basiert.
(Vererbt von BasicAppSettings) |
| IsFullFramework |
True, wenn die Anwendung auf einem vollständigen .Net-Framework basiert.
(Vererbt von BasicAppSettings) |
| IsInSleepTime | Returns true, wenn gerade eine vom User definierte Ruhezeit für Vishnu-Akteure (Checker) läuft. |
| IsNetCore |
True, wenn die Anwendung eine .Net Core-Anwendung ist.
(Vererbt von BasicAppSettings) |
| IsNetNative |
True, wenn die Anwendung eine UWP-Anwendung ist.
(Vererbt von BasicAppSettings) |
| KillChildProcessesOnApplicationExit |
Bei True sollen alle Child-Prozesse der Anwendung am Programmende
nach einer gewissen Wartezeit rekursiv terminiert werden.
Achtung:
BasicAppSettings stellt nur die Property zur Verfügung.
Um das Beenden der Prozesse muss sich die jeweilige Anwendung
über Einbindung von NetEti.ProcessTools und Aufruf von
ProcessWorker.FinishChildProcesses() selbst kümmern.
Default: false.
(Vererbt von BasicAppSettings) |
| KillWorkingDirectoryAtShutdown |
Bei True wird das WorkingDirectory am Programmende entfernt.
Sollte aus Sicherheitsgründen nur erfolgen, wenn es beim
Programmstart auch erzeugt wurde.
Das Anlegen oder Löschen des WorkingDirectory erfolgt nicht
durch BasicAppSettings sondern kann ggf. durch die Anwendung
oder das Logging erfolgen.
Default: true.
(Vererbt von BasicAppSettings) |
| Language |
Die UI-Sprache (Systemsprache).
(Vererbt von BasicAppSettings) |
| LocalConfigurationDirectory | Der Dateipfad zum Verzeichnis der lokalen Konfiguration. Default: Pfad zum AppConfigUser-Verzeichnis. |
| LogSql |
Wenn true, soll jeder Sql-Befehl in's Logfile geschrieben werden.
Zur freien Verwendung. Default: false (Vererbt von BasicAppSettings) |
| MachineName |
Der Rechnername
(Vererbt von BasicAppSettings) |
| MinProgrammVersion |
Geforderte Mindestversion für spätere Prüfung gegen die ProgrammVersion. Default: "1.0.0.0" (Vererbt von BasicAppSettings) |
| NoWorkers | Bei True werden definierte Worker nicht aufgerufen. Default: false. |
| OSVersion |
Die komplette Betriebssystem-Version
(Vererbt von BasicAppSettings) |
| OSVersionMajor |
Numerische Haupt-Betriebssystem-Version > 5 => mindestens Vista (Vererbt von BasicAppSettings) |
| ProcessId |
Die Prozess-Id des aktuellen Prozesses.
(Vererbt von BasicAppSettings) |
| Processor |
Der Prozessortyp
(Vererbt von BasicAppSettings) |
| ProcessorCount |
Die Anzahl Prozessoren
(Vererbt von BasicAppSettings) |
| ProgrammVersion |
Die aktuelle ProgrammVersion = Application.ProductVersion
(Vererbt von BasicAppSettings) |
| RegistryBasePath |
Basis-Pfad, in dem in der Registry nach einer Einstellung gesucht wird.
Enthält der Pfad eine der RegistryRoots, z.B. "HKEY_CURRENT_USER", wird
die intern eingestellte RegistryRoot ebenfalls umgestellt.
Default für die intern eingestellte RegistryRoot ist "HKEY_LOCAL_MACHINE".
Default: ""
(Vererbt von BasicAppSettings) |
| RootJobXmlName | XML-Name des obersten Jobs. Default: JobDescription.xml. |
| SearchDirectory |
Ein optionales Suchverzeichnis für verschiedene Zwecke. Default: WorkingDirectory (Vererbt von BasicAppSettings) |
| SingleInstance |
Bei true kann die Applikation nur einmal gestartet werden. Default: false (Vererbt von BasicAppSettings) |
| SleepTimeFrom | Beginn einer vom User definierten Ruhezeit für Vishnu-Akteure (Checker). |
| SleepTimeTo | Ende einer vom User definierten Ruhezeit für Vishnu-Akteure (Checker). |
| SnapshotDirectory | Vom User definiertes Verzeichnis, in dem Snapshots von Knoten abgespeichert werden. Ist der SnapshotDirectory-Pfad relativ oder leer (i.d.R. nicht sinnvoll), dann ist der SnapshotDirectory-Pfad immer relativ zum Verzeichnis, in dem die JobDescription.xml des MainJob liegt. |
| SnapshotSustain | Überlebensdauer eines Snapshots. |
| StartTreeOrientation | Ausrichtung des Trees beim Start der Anwendung. AlternatingHorizontal: Alternierender Aufbau, waagerecht beginnend (Default). Vertical: Senkrechter Aufbau. Horizontal: Waagerechter Aufbau. AlternatingVertical: Alternierender Aufbau, senkrecht beginnend. |
| StartTriggeredNodesOnUserRun | Parameter zur Steuerung des Startverhaltens von getriggerten Knoten beim Start durch den Anwender (UserRun): None = kein direkter Start, All = alle getriggerten Knoten innerhalb eines durch UserRun gestarteten (Teil-)Trees starten direkt (wie nicht getriggerte Knoten), Direct = alle getriggerten Knoten starten direkt, wenn sie selbst durch UserRun gestartet wurden. AllNoTreeEvents = wie All aber nicht durch TreeEvents getriggerte Knoten, DirectNoTreeEvents = wie Direct aber nicht durch TreeEvents getriggerte Knoten. Default: Direct. |
| StartWithJobs | Bei True wird mit der Job-Ansicht gestartet, ansonsten mit der Tree-Ansicht (default: false). |
| StatisticsFile |
Pfad und Name des Statistics-Logfiles Default: WorkingDirectory + \ + ApplicationName + .stat (Vererbt von BasicAppSettings) |
| StatisticsFileRegexFilter |
Filter, der die zu loggenden Zeilen begrenzt.
Default: "" - alles wird geloggt.
z.B.: @"(?:_NOPPES_)" - Nichts wird geloggt, bzw. nur Zeilen, die "_NOPPES_" enthalten
(Vererbt von BasicAppSettings) |
| TempDirectory |
Environment: "TEMP"
(Vererbt von BasicAppSettings) |
| UncachedCheckers | Liste von INodeChecker-Dll-Namen, die für jeden Run neu geladen werden sollen. Dient zum Debuggen von Memory Leaks, die mutmaßlich durch User-Checker verursacht werden. |
| UserAssemblyDirectory | Verzeichnis, in dem Job-übergreifende Assemblies des Users abgelegt sind. |
| UserDomainName |
Der Windows-Domain-Name
(Vererbt von BasicAppSettings) |
| UserName |
Der Windows-Username
(Vererbt von BasicAppSettings) |
| UserParameterReaderPath | Dateipfad einer optionalen Dll, die IParameterReader implementiert. Wenn vorhanden, wird die Dll dynamisch geladen und erweitert Vishnus Fähigkeiten zur Parameter-Ersetzung in ReplaceWildcards. |
| VishnuProvider | Der Herausgeber der ClickOnce Installation. |
| VishnuRoot | Das Vishnu-Rootverzeichnis zur Laufzeit. Im Gegensatz zum optionalen Environment-Setting "Vishnu_Root" wird diese Property, wenn sie nicht von außen als Parameter gesetzt wird, durch die Vishnu-Programmlogik gefüllt, so dass sie immer so gut, wie möglich gesetzt ist und somit auch von außen über "%VishnuRoot%" genutzt werden kann. Während "Vishnu_Root", sofern es gesetzt wurde, immer das Root-Verzeichnis der Vishnu-Entwicklung bezeichnet, zeigt "VishnuRoot" bevorzugt auf das Verzeichnis, in dem sich die gestartete Vishnu.exe befindet ("ApplicationRootPath"). Nur, wenn sich auf gleicher Hierarchiestufe, wie "ApplicationRootPath" kein Verzeichnis "UserAssemblies" befindet, wird "VishnuRoot", wenn nicht von außen mitgegeben, so gut es geht, durch die Vishnu-Programmlogik auf das das Root-Verzeichnis der Vishnu-Entwicklung gesetzt. |
| VishnuSourceRoot | VishnuSourceRoot bezeichnet immer das Root-Verzeichnis der Vishnu-Entwicklung. Wenn im Programm-Environment kein Verzeichnis "Vishnu_Root" gesetzt wurde, wird VishnuSourceRoot so gut es geht, durch die Vishnu-Programmlogik auf das das Root-Verzeichnis der Vishnu-Entwicklung gesetzt. |
| VishnuWindowAspects | Datenklasse mit wesentlichen Darstellungsmerkmalen des Vishnu-MainWindow. |
| WorkingDirectory |
Das Arbeitsverzeichnis Default: Bei "SingleInstance=true: C:\Users\<user>\AppData\Local\Temp\<ApplicationName> Bei "SingleInstance=false: C:\Users\<user>\AppData\Local\Temp\<ApplicationName>\<ProcessId> (Vererbt von BasicAppSettings) |
| WorkingDirectoryCreated |
True, wenn das WorkingDirectory beim Programmstart erzeugt wurde.
Das Anlegen oder Löschen des WorkingDirectory erfolgt nicht
durch BasicAppSettings sondern kann ggf. durch die Anwendung
oder das Logging erfolgen.
Default: false.
(Vererbt von BasicAppSettings) |
Methoden| Name | Beschreibung | |
|---|---|---|
 | Dispose |
Öffentliche Methode zum Aufräumen.
(Vererbt von BasicAppSettings) |
| GetLoadedAssemblies |
Liefert ein Dictionary, das für alle in der Applikation geladenen Assemblies
den FullName und die Assembly enthält.
Kann in bestimmten Fällen für die Fehlersuche hilfreich sein. Hinweis: ist der Schalter "DumpLoadedAssemblies" = true, werden in "Dispose" die Keys dieses Dictionarys (FullName) geloggt. (Vererbt von BasicAppSettings) |
| GetParametersSources |
Liefert ein Dictionary, das zu jedem Parameter den Namen der Quelle enthält.
Kann in bestimmten Fällen für die Fehlersuche hilfreich sein. Hinweis: ist der Schalter "DumpAppSettings" = true, wird in "Dispose" dieses Dictionary geloggt. (Vererbt von BasicAppSettings) |
| GetResolvedPath | Löst den übergebenen Pfad unter Berücksichtigung der Suchreihenfolge in einen gesicherten Pfad auf, wenn möglich. |
| GetStringValue |
Liefert genau einen Wert zu einem Key. Wenn es keinen Wert zu dem
Key gibt, wird defaultValue zurückgegeben.
(Vererbt von BasicAppSettings) |
| GetStringValues |
Liefert ein string-Array zu einem Key. Wenn es keinen Wert zu dem
Key gibt, wird defaultValue zurückgegeben.
(Vererbt von BasicAppSettings) |
| GetValueT |
Liefert genau einen Wert zu einem Key. Wenn es keinen Wert zu dem
Key gibt, wird defaultValue zurückgegeben.
Wildcards der Form %Name% werden, wenn möglich, rekursiv ersetzt;
Es wird versucht, den ermittelten String-Wert in den Rückgabetyp T zu casten.
(Vererbt von BasicAppSettings) |
| GetValuesT |
NICHT IMPLEMENTIERT!
Liefert ein Array von Werten zu einem Key. Wenn es keinen Wert zu dem
Key gibt, wird defaultValue zurückgegeben.
Wildcards der Form %Name% werden, wenn möglich, rekursiv ersetzt;
Es wird versucht, den ermittelten String-Wert in den Rückgabetyp T zu casten.
(Vererbt von BasicAppSettings) |
| InitUserParameterReader | Routine, die den ParameterReader entsprechend der vorher in UserParameterReaderPath konfigurierten Parameter initialisiert. Je nach UserParameterReader kann dieser Vorgang länger dauern und wird deshalb hier nicht automatisch ausgeführt, sondern muss extern und möglichst direkt nach Instanziierung aufgerufen werden. |
| LoadSettings |
Lädt die Systemeinstellungen bei der Initialisierung oder lädt sie auf Anforderung erneut.
(Überschreibt BasicAppSettingsLoadSettings) |
| RegisterUserStringValueGetter | Registriert die übergebene IGetStringValue-Instanz (UserParameterReader) beim enthaltenen AppEnvReader. Der neue Getter wird in der Auswertungskette direkt hinter CommandLineAccess eingehängt, was ihm (nach der Kommandozeile) höchste Priorität gibt. |
| ReplaceWildcards |
Ersetzt hier definierte Wildcards durch ihre Laufzeit-Werte:
'%HOME%': '...bin\Debug'.
(Überschreibt BasicAppSettingsReplaceWildcards(String)) |
| SetRegistryBasePath |
Setzt den Registry-Zugriffskey für alle nachfolgende Zugriffe auf
den übergebenen Basis-Pfad, wenn sich der übergebene registryBasePath
fehlerfrei in ein entsprechendes Equivalent aus Registy-Keys umwandeln lässt.
(Vererbt von BasicAppSettings) |
Ereignisse| Name | Beschreibung | |
|---|---|---|
 | UserParametersReloaded | Event, das ausgelöst wird, wenn User-Parameter neu geladen wurden. |
Anmerkungen
File: AppSettings.cs
Autor: Erik Nagel, NetEti
11.10.2013 Erik Nagel: erstellt.
28.01.2024 Erik Nagel: Property VishnuRoot hinzugefügt.
Siehe auch