diub-Dokumentation

Inhalt

Titel


2 diub.Base

2.1 diub.Framework

2.1.1 Persistence

2.1.1.1 Initialisierung

Die Initialisierung sollte möglichst früh im Code erfolgen.

  • Am Ende des Konstruktors einer Form.
  • Zu Beginn des Load-Ereignisses.

private void Main_Load (object sender, EventArgs e) { if (Setting.Designtime) return; Persistence.Initialize (); ... }

Zugriff auf erweiterte Daten bietet aus Gründen der Kompatibilität die Funtion GetCopy.

PersistenceData pd; pd = Persistence.GetCopy ();

2.1.1.2 Initialisierung Teil II: Hilfe -> Lizenz

Für eine Verknüpfung des Menüeintrags Hilfe→Lizenz mit einer erweiterten Lizenzauswertung muss ein EventHandler zugewiesen werden:

  • im Load-Ereignis
  • im Show-Ereignis

Das beim Aufruf übergebene Objekt ist dabei von Typ PersistenceData.

diub.Dialog.Strip.PostCall += PostCallEventHandler; void PostCallEventHandler(object obj, object e){ ... }

2.1.1.3 Language

Persistence.ApplicationOptions.Save<LanguageInfoRecord> (Persistence.LanguageInfo)

2.1.1.4 FormAndControls

Zum persistenten Ablegen und Wiederherstellen von Fensterpostion und -größe.

using diub; using static diub.Framework.Persistence; static public void FormPosSave (Forms.Form Form); static public FormItem FormPosRestore (Forms.Form Form, FormResizeMode ResizeMode, bool ForceVisibleWindowState);

2.1.1.5 ApplicationOptions

Zum Sichern bzw. Laden einzelner Optionen-Klassen reichen einfache Save- und Load-Aufrufe mit Typangabe.

Bei der Nutzung von PersistentIndex ist eine Ableitung der Klasse von der Klasse RecordBase keine Vorraussetzung mehr!

Instanzen

// Instanz einer Klasse class Classy {...}; Classy instance = new Classy(); instance = ApplicationOptions.Load<Classy> ("SpecificName"); ApplicationOptions.Save<Classy> ("SpecificName", instance); // Der Name der Klasse wird benutzt instance = ApplicationOptions.Load<Classy> (); ApplicationOptions.Save<Classy> (instance);

Einzel-Werte

# Einzelne Werte wie Primitive int i; i = ApplicationOptions.LoadValue<int> ("SpecificName"); ApplicationOptions.SaveValue<int> ("SpecificName", i);

2.1.1.6 RecentLastUsed

Wichtig: die Liste kann von mehreren Instanzen parallel benutzt werden!

Abfrage des letzen Eintrags

using static diub.Framework.Persistence; // NULL oder der letzte Eintrag aller Instanzen ... = RecentUsed.GetCommonRecentUsed(); // Aus dem Setting dieser Instanz ... = Setting.CurrentUsed

Merken der zuletzt benutzten Datei

using static diub.Framework.Persistence; RecentUsedItem RUI; // in der Liste aller Instanzen RUI = new RecentUsedItem(PathFilename, diub.IO.FileTypes.Box, ""); RecentUsed.PutAsLastUsed (RUI); // für diese Instanz Setting.CurrentUsed = RUI;

2.1.2 Language

2.1.3 ProjectHandling

Die Klasse liefert die Standard-Dialoge zum Öffnen und Speichern von Dateien

  • inkl. Fehlerbehandlung

Es müssen lediglich Funktionen für

  • die eigentlichen Lese-Schreib-Operationen
  • die Aktualisierung der RecentUsed Liste
  • die Aktualisierung der Programm Titel-Leiste

angegeben werden.

Die Ereignisfunktionen der Menüs sind dann nach dem folgenden Schema zu implementieren.

private void MenueFileOpen_Click (object sender, EventArgs e) { project_handling.Open (this); } private void MenueFileSave_Click (object sender, EventArgs e) { PopControl (); // Daten aufbereiten project_handling.Save (this); }

Load-Ereignis

project_handling = new ProjectHandling<Structure.V3.Document> (Firm.ExtSetSave) { FileFormat = FileFormats.Documenter, NewFunction = null, OpenFunction = OpenFile, SaveFunction = FileSaveAs, SaveAsFunction = FileSaveAs, UpdateRecentUsed = UpdateRecentUsed };

Öffnen bei Programm-Start via Parameter

RecentUsedItem rui; string [] args = Environment.GetCommandLineArgs (); if (args.Length > 1) { rui = new RecentUsedItem (args [1], FileFormats. ...); project.OpenLastUsed (rui); }

Delegaten

public delegate (CommonStatus, T) CallbackDelegate (string PathFilename);

New

public CallbackDelegate NewFunction;

Open

public delegate (CommonStatus, T) CallbackDelegate (string PathFilename); public CallbackDelegate OpenFunction;

Save & SaveAs

private void MenueFileSave_Click (object sender, EventArgs e) { project_handling.SaveAsFunction = FileSaveAs; project_handling.SaveAs (this); } private (CommonStatus, Structure.V3.Document) FileSaveAs (string PathFilename) { ... }

CloseFunction

Func<CommonStatus> CloseFunction;

2.2 diub.Dialog

2.2.1 ToolTips / Captions für Steuerelemente

Die Klasse ToolTipData vereinfacht die Erzeugung und Zuweisung eines ToolTip / Caption an ein Steuerelement.

private Forms.ToolTip tooltip; private Forms.Control ctrl; private xKeys shortcut; ctrl = this.IconButtonWeb; shortcut = xKeys.Control | xKeys.I; if (tool_tip == null) tool_tip = new ToolTip (); // Das Tooltip mit dem Steuerelement "verheiraten" new ToolTipData ("TranslationPrefix", "Title", "Text", shortcut).Compound (ctrl);

2.2.2 OpenFileDialog

using diub.Dialog; // Initialisierung void SetInitialDirectory (Persistence.RecentUsedItem RUI); ExtensionSets Extensions = ... string InitialFilename = ... string InitialDirectory = ... // Ergebnis ... = UsedDirectory; ... = UsedFilename;

2.2.3 PrinterSelectionDialog

Die eingestellten Werte werden persistent verwaltet.

PrinterSelectionDialog dlg; PrinterSelectionSetting setting; dlg = new PrinterSelectionDialog (); if (DialogResult.OK != dlg.ShowDialog (this)) return; setting = dlg.Value;

2.2.4 SaveFileDialog

using diub.Dialog; // Initialisierung void SetInitialDirectory (Persistence.RecentUsedItem RUI); ExtensionSets Extensions; string InitialFilename = ... string InitialDirectory = ... bool ForceNewFile = ... bool ForceFileExists = ... // Ergenis ... = UsedDirectory; ... = UsedFilename;

2.2.5 FileFolderSelectionBox

EditBox zur Eingabe eines Pfad- oder Dateinamens.

Bietet Schaltfläche zum Aufruf des passenden Such-Dialogs.

2.3 diub.Actuator

Actuator ist ein Synonym für Control; damit bleiben die Namensräume eindeutig.

Viele der Steuerelemente von MS haben unerwünschte Eigenschaften.

  • Das ValueChanged Ereignis wird auch ausgelöst, wenn das Programm den Wert ändert.
    Das ist so blödsinnig, das es schmerzt. Durch den Programm-Ablauf ist doch bekannt das sich der Wert ändert!
  • Die TextBox ist einfach unerträglich bei Skalierungen, besonders wenn sich die Größe nach dem umgebenden Steuerelement richten soll.
    Ich habe einmal einen mehrseitigen Artikel gelesen, der argumentiert warum und wieso. Alles Blödsinn: Es ist einfach falsch, die Box 2 x zu skalieren. Das 1te Mal bei Änderung der Font-Größe (dabei wird immer die Breite geändert), dann noch ein 2tes Mal durch das umgebende Steuerelement.
    Da fehlt lediglich eine einzige IF-Abfrage im Quellcode. Aber lieber 3 Seiten darüber argumentieren …

2.3.1 AutoDockPanel

Ein Panel, das für alle hinzugefügten Benutzersteuerelemente automatisch den DockStyle auf Fill setzt.

Am besten einzusetzen mit andern Panel bzw. UserControl.

Lässt sich bequem durch TabStrap, steuern.

2.3.2 EditBox

EditBox ist eine Alternative zur TextBox. Das ValueChanged Ereignis wird nur durch Benutzeraktion ausgelöst. Zudem hat EditBox keine Probleme bei Skalierungen.

Hinweis

EditBox nutzt immer einen Fixed-Font (nicht proportional), was der Lesbarkeit sehr entgegenkommt.

2.3.3 FileFolderSelectionBox

Aktuator zur Datei- oder Pfad-Wahl.

Initialisierung

UsageMode = FileFolderUsageMode.xxx Extensions = new ExtensionSets(...) InitialDirectory (string ...) InitialDirectory (RecentUsedItem ...)

Ergebnis

... = UsedDirectory; ... = Filename;

2.3.4 FilterTextBox

Eine SelectionList lässt sich sehr einfach mit einer FilterTextBox verknüpfen!

filterTextBox.TokenListChanged += selectionList.TokenListChange;

2.3.5 RadioBox / RadioGroupBox

RadioBox ist eine Alternative zu RadioButton. Das ValueChanged Ereignis wird nur durch Benutzeraktion ausgelöst.

Das Ergebnis, zum Beispiel einer Enumeration, kann direkt über die umgebende RadioGroupBox abgefragt werden bzw. funktioniert über den Namen der RadioGroupBox mit Push/Pop.

RadioGroupBox unterstützt das Interface IValue und liefert daher direkt den richtigen Enumerations-Wert.

  • Die RadioGroupBox benötigt die Initialisierung für eine entsprechende Type-Zuweisung der Enumeration.
  • Bei RadioGroupBox<T> initialisiert der Konstruktor mit default(T).
    Die Ableitung dient einzig und allein der Erzeugung eines neuen Actuator-Typs.

Expliziete Initialisierng

public MacroListEditorActuator () { InitializeComponent (); // erledigt auch die Initialsierung des Enum-Typs radioGroupBox_MacroMode.Value = MacroListEditorModes.Text; }

// Initialisierung mit Typ(!) und Wert. radioGroupBox_OddEvenPrinterType.Value = OddEvenPrinterType.Laser;

Konstruktor-Initialsierung mit eigenem Typ

public enum ScriptModes { Disabled, BatchJob, Scripting } // class public class ScriptModesGroupBox : RadioGroupBox<ScriptModes> { // bleibt leer! }

2.3.6 SelectionList

Vor- & Nachspann

SelectionListColumnItem ci; selectionList_Logfile.Locked = false; selectionList_Logfile.ColumnItems.Clear (); ... selectionList_Logfile.Locked = true;

Text-Spalte erzeugen

ci = new SelectionListColumnItem (); ci.Name = "Name"; ci.Width = "F4233B60_TaxiLogbuch_CrashLog_2018-03-04_12.23.46.log"; ci.TextAlignment = HorizontalAlignment.Left; ci.Text = Language.Translate ["LogfileColumns.Name"]; ci.SortEnabled = false; selectionList_Logfile.ColumnItems.Add (ci);

Bild-Spalte erzeugen

ci = new SelectionListColumnItem () { Name = "Active", Text = "", Width = "16px", ColumnMode = LogList.ColumnModes.Image, Image = global::FDroidGrep.Properties.Resources.cross, TextAlignment = System.Windows.Forms.HorizontalAlignment.Center }; // benötigte Bilder hizufügen selectionList_Jobs.Images.Add ("true", diub.Properties.Resources.tick); selectionList_Jobs.Images.Add ("false", diub.Properties.Resources.cross); selectionList_Jobs.ColumnItems.Add (ci); // vom Durchsucht-werden ausschließen selectionList_Jobs.PreventColumns.Add ("Active");

2.3.7 TabStrap


Abbildung 2.1:

TabStrap ist für die Nutzung mit AutoDockPanel , und als Ersatz fü das TabControl konzipiert !

static internal MainTagsPanel _maintags_panel; static internal LyricsPanel _lyrics_panel; TabStripItem maintags_item, lyrics_item; if (DesignMode) return; // Die Panel vor der Sprache! tabStrap.Items.Clear (); // Panel #1 _maintags_panel = autoDockPanel.Add<MainTagsPanel> (); maintags_item = new TabStripItem (nameof (MainTagsPanel), "MainTagsPanel", null, true, _maintags_panel); tabStrap.Items.Add (maintags_item); // Panel #2 _lyrics_panel = autoDockPanel.Add<LyricsPanel> (); lyrics_item = new TabStripItem (nameof (LyricsPanel), "LyricsPanel", null, true, _lyrics_panel); tabStrap.Items.Add (lyrics_item);

2.3.8 TickBox

TickBox ist eine Alternative zu CheckBox. Das ValueChanged Ereignis wird nur durch Benutzeraktion ausgelöst.

2.3.9 xLabel

Ein einfacher Ersatz für Forms.Label.

  • Zuweisung an Text ist unverändert
  • Quant und Value wechseln bei Bedarf den Thread
  • Value können auch direkt Zahlenwerte zugewiesen werden

2.4 diub.Log

2.4.1 Benutzer Log — Arbeitsprotokolle

Ein Benutzer-Log ist zur Protokollierung der einzelnen Arbeitsschritte für den Benutzer bei normaler Nutzung gedacht.

Siehe auch diub.Log .

Öffnen

UserLog ul; // Nur zum Lesen! ul = new UserLog ("UserLog_Meines.log") ; ul = ul.Open (); // zum Schreiben ul = new UserLog ("ProgrammName", 30); ul = ul.Open (MsgLogLevel.Error);

Schließen

ul.Close ();

2.4.1.1 Standard Log

Die Einträge werden in eine SQLite-Datenbank in eine Tabelle geschrieben.

Schreiben

UserLogData uld; uld = new UserLogData (0, Level, Text, JobId.ToString ()); ul.Write (uld); ul.Write (MsgLogLevel.System, MsgLogResult.Info MsgLogResult, "Prog started", namof(Modul), BinaryObject)

Auslesen

List<UserLogData> list; list = ul.ListUserLog ()

2.4.1.2 Binäre Daten in der Log-Datei sichern

Die public-Anteile der Objekte werden in XML gewandelt und unter einem Namen in einer gesonderten Tabelle gespeichert.

Schreiben

Settung setting = new Setting () {...}; // Binäre Daten sichern WriteExtended ("MySetting", setting); // vereinfacht: sichert unter dem Namen "Setting" StoreSetting (Setting);

Zurücklesen

Setting setting; setting = ReadExtended<Setting> ("MySetting"); setting = ReadExtended<Setting> ("Setting");

2.5 diub.Keyboard

2.5.1 Hotkeys - Shortcuts

Die Hotkey-Bibliothek wird bei Verwendung der Klasse xForm automatisch genutzt.

2.5.1.1 Initialisierung

  • Vor dem Ändern von Hotkeys müssen erst die bestehenden Shortcuts des Fensters beim Start erfasst werden.
  • Dann erfolgt die Wiederherstellung aus einer Sicherung.

HotkeyMethodHandler.ExamineMethods (this); HotkeyMethodHandler.UpdateMethods (Vars.hotkey_assigments);

2.5.1.2 Hotkey einer Methode zuweisen

  • Die aufzurufende Methode muss dem Delegaten HotkeyEventHandlerDelegate entsprechen
  • Für die Definition des Hotkey wird einfach ein xKeys Objekt entsprechend initialisiert.
  • Dann wird der Hotkey in die Liste der aktiven Hotkeys eingetragen.
  • Zuletzt die Methode an den Hotkey-Eintrag gebunden.

// delegate void HotkeyEventHandlerDelegate (object sender, HotkeyHandlerEventArgs e); private void FocusToolUrl (object sender, HotkeyHandlerEventArgs e) { Tool_Url.Focus (); } // Hotkey definieren xKeys LINK_SHORTCUT = xKeys.Control | xKeys.L; // Hotkey in die Liste der aktiven Hotkeys eintragen HotkeysActive.Set (nameof (Firm.LINK_SHORTCUT), Firm.LINK_SHORTCUT, true); // Methode dem Hotkey-Eintrag zuweisen HotkeyMethodHandler.Add (nameof (Firm.LINK_SHORTCUT), FocusToolUrl);