Table of Contents

Interface IGlobalObjects

Namespace
FS.Hosting.Shared.GlobalObj
Assembly
FS.Hosting.Shared.dll

Das GlobalObject ist von überall auf mit this.Global zu erreichen. Am GlobalObject werden alle Session-Daten verwaltet und Session-Funktionen angeboten.

[ComVisible(false)]
public interface IGlobalObjects
Extension Methods

Properties

AUHelper

Gibt ein Objekt vom Typ AUHelper zurück. Dieses Objekt bietet Methoden für den Bereich Benutzer- und Rechte-Verwaltung an.

AllLanguages

Gibt die Iso-Codes von allen gepflegten Sprachen zurück.

ClientInfos

In diesem Dictionary sind Informationen abgelegt, die der Client beim Start der Anwendung an den Broker übertragen hat.

LanguageHierarchy

Gibt einen Enumeratur zurück, der die Sprach-Hierarchie beinhaltet, oder legt diesen fest.

Das sind die Sprachen in der Reihenfolge der Auswahl im Client Start.

MLColumnLanguage

Gibt den Iso-Code der Sprache zurück, die aktuell für die MLColumn-Properties verwendet wird. Normalerweise handelt es sich dabei um die SelectedLanguage. Mit der Methode UseMLColumnLanguage(string, Action) kann die Sprache vorrübergebend geändert werden.

ProgressOwner

Sammelt die Informationen zu laufenden FrameworkProgress.

ReportingSoftware

Welche Software beim Druck bevorzugt wird.

RequestCancellationToken

Dieser CancellationToken wird abgebrochen wenn der aktuelle Request beendet bzw. das GlobalObject disposed wird. Wird der aktuelle Token mit dem Ende des Requests abgebrochen wird anschließend ein neuer Token für den nachfolgenden Request zurückgegeben.

SafeInitializing

Gibt zurück, ob der Safe-Initialize-Modus aktiv ist. Dieser Modus wird mithilfe einer Einstellung im Start-Workflow aktiviert.

SelectedLanguage

Gibt den 2-Zeichen IsoCode der ersten Sprache in der LanguageHierarchy zurück oder legt diesen fest.

SessionCancellationToken

Dieser CancellationToken wird abgebrochen wenn die Session beendet bzw. das GlobalObject disposed wird.

SessionData

Speichert verschlüsselte Schlüssel-Werte-Paare für den aktuellen Client.

Token

Eindeutige ID der Session.

UseHistory

Gibt an, ob historische Daten berücksichtigt werden sollen. D.h., bei Tabellen, zu denen es eine Historientabelle gibt, werden die Daten nicht aus der Originaltabelle geladen sondern aus dem View, der die Originaltabelle mit der Historientabelle vereint.

ocGlobal

Methods

CancelRequestCancellationToken()

Bricht den aktuellen RequestCancellationToken ab und startet sofort einen neuen für den folgenden Request.

ClearDynamicDragSources()
CloseApplication()

Schließt die Anwendung. Der Benutzer wird gefragt, ob er die Anwendung beenden möchte. An den geöffneten Forms wird die Methode IsApplicationQuitAllowed aufgerufen und eine entsprechende Message-Box ausgegeben bzw. das Schließen der Anwendung verhindert.

CloseApplication(FrameworkCloseMode)

Wird als closeMode das Flag Restart angegeben, so wird ein Neustart des Clients veranlasst. Allerdings darf ein Neustart nur unter der Bedingung ausgeführt werden, dass jedes aktuell laufende Ereignis eines der folgenden ist:

  • MenuItem.OnClick
  • Button.OnClick
  • ImageButton.OnClick
  • MessageBox-Event(Als Folge eine der oben genannten Events)

Mit aktuell laufenden Ereignissen sind auch solche Ereignisse gemeint, die als Folge einen modalen Dialog geöffnet haben.Solange der Dialog offen ist, zählt das Ereignis zu den laufenden.

Zusätzlich gibt es das Flag KeepUserLogin. Wird Restart mit diesem Flag kombiniert (bitweise Oder-Verknüpfung), so wird beim Neustart der User Token in die neue Sitzung übernommen und es ist kein erneuter Login erforderlich.

CloseApplication(string)

Schließt die Anwendung unmittelbar. Es wird keine weitere Prüfung durchgeführt und der Benutzer hat keine Möglichkeit die Aktion abzubrechen. Am Client wird dabei die übergebene Message ausgegeben.

CreateComponent(string)

Erzeugt eine neue Component mit dem übergebenen Namen.

EndSafeInitialize()

Deaktiviert den SafeInitializing Modus.

GetCodeDirectory()

Liefert den Pfad des Verzeichnisses, in dem die Anwendung läuft.

RemoveDynamicDragSource(MLContainer)
SetDynamicDragSource(MLContainer, Func<IDevFrameworkBaseObject, object>)
UseMLColumnLanguage(string, Action)

Verwendet für MLColumn-Properties während der übergenenen Action die angegebene Sprache.