DataShark.Open  1.2.14.0
DataShark.Grid.Elements.Base.BaseGridElement Klassenreferenzabstract

Abstrakte Basisklasse des Grid-Elements. Mehr ...

Klassendiagramm für DataShark.Grid.Elements.Base.BaseGridElement:
DataShark.Grid.Elements.Base.BaseResultElement DataShark.Grid.Elements.Base.BaseTableElement DataShark.Grid.Elements.DownloaderElement DataShark.Grid.Elements.InjectorElement DataShark.Grid.Elements.NodeElement DataShark.Grid.Elements.NoteElement DataShark.Grid.Elements.TableWriterElement DataShark.Grid.Elements.CombinerElement DataShark.Grid.Elements.ContentSelectorElement DataShark.Grid.Elements.CounterElement DataShark.Grid.Elements.DistributorElement DataShark.Grid.Elements.ExtractorElement DataShark.Grid.Elements.MergeElement DataShark.Grid.Elements.TableSelectorElement DataShark.Grid.Elements.DatabaseTableElement DataShark.Grid.Elements.TableElement

Öffentliche Methoden

Image GetIcon ()
 Gibt das 16x16 Image zu diesem GridElement zurück. Mehr ...
 
abstract String GetCategory ()
 Hier wird die Kategorie des Grid-Elements registriert. Dieser Kategorie wird das Grid-Element in der Kontrollelement-Ansicht zugeordnet. Es kann auch eine Kategorie angegeben werden, die noch nicht existiert. Mehr ...
 
 BaseGridElement ()
 Initialisiert ein neues Grid-Element. Mehr ...
 
virtual void GetProperties (ref Dictionary< String, String > properties)
 Liefert abfragerelevante Eigenschaften von dieser BaseGridElement Instanz. BaseGridElement.GetProperties(ref Dictionary<string, string>) liefert die Eigenschaften Name und Index. Mehr ...
 
abstract String GetInputCardinality ()
 Hat das Element keine Eingabe: 0 Hat das Element exakt eine Eingabe: 1 Hat das Element mehrere Eingaben: N Mehr ...
 
abstract String GetOutputCardinality ()
 Hat das Element keine Ausgabe: 0 Hat das Element exakt eine Ausgabe: 1 Hat das Element mehrere Ausgaben: N Mehr ...
 
virtual void PreDelete (ref Dictionary< String, Object > memory)
 Diese Funktion sollte im abgeleiteten GridElement-Typ überschrieben werden, falls abhängige Objekte modifiziert oder entfernt werden müssen, falls es zu einer Löschung des GridElements kommt. Mehr ...
 
virtual void Restore (ref Dictionary< String, Object > memory)
 Wenn eine Löschung rückgängig gemacht wird, können hier die Referenzen oder Objekte wiederhergestellt werden. Mehr ...
 
abstract XmlNode SaveXml (XmlDocument xmlDocument)
 Diese Methode erstellt aus einem BaseGridElement ein XmlNode. Diese Methode wird vom DataSharkProject aufgerufen, wenn der Speichervorgang veranlasst wird. Mehr ...
 
void FromXml (XmlNode gridElementNode)
 Setzt die Basisattribute an der aktuellen BaseGridElement Instanz aus dem übergebenen XmlNode. Mehr ...
 
List< T > SortByIndex< T > (List< T > elementList)
 Sortiert die übergebene Liste von Grid-Elementen nach Ihrem Ausführungsindex. Mehr ...
 
abstract void InitializeProperties ()
 Hier werden sämtliche eigenen GridElementProperties registriert, die direkt auf einem Blick im Grid-Element auf dem DataShark.Grid verfügbar sein sollen. Die Eigenschaften sind immer ReadOnly, sie können nur verändert werden, wenn die DataShark.Runtime gestoppt ist. Mehr ...
 
string GetElementPrefix ()
 Liefert den erforderlichen Prefix für diesen Typ zurück. Mehr ...
 
void Check ()
 Diese Methode prüft die Basisattribute auf Ihre Gültgkeit und löst im Fehlerfall Ausnahmen aus. Mehr ...
 
void FindExtractor (IInputElement inputElement, Int32 layer, ref ExtractorElement foundExtractor)
 Ermittelt vom verknüpften Eingabeelement den ersten gefundenen Extraktor. Mehr ...
 
void Warn (DataSharkRuntime runtime, String warning)
 Wollen Sie den Benutzer über eine Warnung informieren, geben Sie hier eine Nachricht an. Diese Warnung wird direkt im Grid-Element auf dem DataShark.Grid angezeigt. Mehr ...
 
void UndoWarn ()
 Ist der Schritt erfolgreich durchgelaufen, müssen Sie die Warnung wieder rückgängig machen. Mit dieser Methode führen Sie diese Aktion durch. Mehr ...
 
void Wait (DataShark.Runtime.DataSharkRuntime runtime)
 Diese Methode muss zwingend beim Einsteigen in die Boolean Execute(DataSharkRuntime) Methode aufgerufen werden. Hier wird geprüft, ob das Element einen Haltepunkt hat oder die Laufzeit angehalten wurde. Mehr ...
 
void SetParentElement (object parentElement)
 Diese Methode muss zwingend beim Einsteigen in die Boolean Execute(DataSharkRuntime) Methode aufgerufen werden. Hier wird das übergeordnete, also aufrufende Element registriert. Mehr ...
 
abstract Boolean Execute (DataShark.Runtime.DataSharkRuntime runtime, Object data)
 In dieser Methode findet die eigentliche Ausführung des Grid-Elements statt. Mehr ...
 
abstract List< BaseGridElementGetNextElementList ()
 Diese Methode liefert eine Auflistung an BaseGridElement Instanzen, die dieses Element referenzieren. Abschließend muss die Liste mit SortByIndex übergeben werden, um die Ausführungsreihenfolge zu gewährleisten. Mehr ...
 
virtual void RuntimeInit ()
 Wenn die Laufzeit initialisiert wird, wird diese Methode aufgerufen. Hier können Initialisierungsschritte für den abgeleiteten Elementtyp implementiert werden. Mehr ...
 

Öffentliche, statische Methoden

static String GetValidIdentifier (String identifier)
 Liefert aus einem ElementName einen gültigen Feldbezeichner zurück. Mehr ...
 

Geschützte Methoden

void SetTitle (String title)
 Setzt den Titel des aktuellen Grid-Elements. Der Titel ist sowohl in der Grid-Element Ansicht zu sehen, als auch in der Kontrollelement-Ansicht. Mehr ...
 
void SetIcon (System.Drawing.Bitmap icon)
 Setzt das Icon (16x16px) des aktuellen Grid-Elements. Das Icon ist in der Titelleiste des Grid-Elements zu sehen. Mehr ...
 
XmlNode SaveXml (XmlDocument xmlDocument, XmlNode objectXmlNode)
 Speichert die Basisattribute im erstellten XmlNode. Mehr ...
 
void InitializeProperties (List< GridElementProperty > properties)
 Initialisiert die Standardattribute in der Grid-Element Ansicht. Mehr ...
 
override void OnPaint (PaintEventArgs e)
 
override void Dispose (bool disposing)
 Verwendete Ressourcen bereinigen. Mehr ...
 

Geschützte Attribute

String inputType = "None"
 Der interne Eingabetyp. Mehr ...
 
System.Windows.Forms.TableLayoutPanel tableLayoutPanel
 
System.Windows.Forms.Label labelHeaderValue
 
System.Windows.Forms.Label labelHeaderAttr
 
System.Windows.Forms.ToolTip toolTipAttributes
 
System.Windows.Forms.Label labelHeader
 
System.Windows.Forms.PictureBox pbHeaderLeft1
 
System.Windows.Forms.PictureBox pbHeaderRight2
 
System.Windows.Forms.PictureBox pbHeaderRight1
 
System.Windows.Forms.PictureBox pbHeaderLeft2
 
System.Windows.Forms.PictureBox pbHeaderLeft3
 

Propertys

Dictionary< FieldElement, Boolean > RegisteredNameChangeEventMap [get, set]
 Internes Verzeichnis zum Vorhalten der Feld-Elemente, die bereits für das FieldElement.NameChange Event registriert wurden. Mehr ...
 
String ElementName [get, set]
 Der Elementbezeichner des Grid-Elements. Mehr ...
 
String Status [get, set]
 Der interne Status des Objekts: Created oder Updated Mehr ...
 
String SaveStatus = String.Empty [get, set]
 Der Speicherstatus des Objekts: InProgress oder Finished Mehr ...
 
BaseGridElement ParentElement = String.Empty [get, protected set]
 Während der Laufzeit kann hier das übergeordnete Element abgerufen werden. Mehr ...
 

Ausführliche Beschreibung

Abstrakte Basisklasse des Grid-Elements.

Beschreibung der Konstruktoren und Destruktoren

◆ BaseGridElement()

DataShark.Grid.Elements.Base.BaseGridElement.BaseGridElement ( )

Initialisiert ein neues Grid-Element.

Dokumentation der Elementfunktionen

◆ Check()

void DataShark.Grid.Elements.Base.BaseGridElement.Check ( )

Diese Methode prüft die Basisattribute auf Ihre Gültgkeit und löst im Fehlerfall Ausnahmen aus.

◆ Dispose()

override void DataShark.Grid.Elements.Base.BaseGridElement.Dispose ( bool  disposing)
protected

Verwendete Ressourcen bereinigen.

Parameter
disposingTrue, wenn verwaltete Ressourcen gelöscht werden sollen; andernfalls False.

◆ Execute()

abstract Boolean DataShark.Grid.Elements.Base.BaseGridElement.Execute ( DataShark.Runtime.DataSharkRuntime  runtime,
Object  data 
)
pure virtual

In dieser Methode findet die eigentliche Ausführung des Grid-Elements statt.

Parameter
runtime
dataDie Instanz des übergeordneten, also aufrufenden Grid-Elements. Muss explizit auf BaseGridElement überprüft und gecastet werden.
Rückgabe

Implementiert in DataShark.Grid.Elements.ExtractorElement, DataShark.Grid.Elements.TableElement, DataShark.Grid.Elements.ContentSelectorElement, DataShark.Grid.Elements.DatabaseTableElement, DataShark.Grid.Elements.DownloaderElement, DataShark.Grid.Elements.TableWriterElement und DataShark.Grid.Elements.MergeElement.

◆ FindExtractor()

void DataShark.Grid.Elements.Base.BaseGridElement.FindExtractor ( IInputElement  inputElement,
Int32  layer,
ref ExtractorElement  foundExtractor 
)

Ermittelt vom verknüpften Eingabeelement den ersten gefundenen Extraktor.

Parameter
inputElementGeben Sie hier das Eingabeelement an.
layerGeben Sie hier 0 an.
foundExtractorDer gefundene Extraktor oder null

◆ FromXml()

void DataShark.Grid.Elements.Base.BaseGridElement.FromXml ( XmlNode  gridElementNode)

Setzt die Basisattribute an der aktuellen BaseGridElement Instanz aus dem übergebenen XmlNode.

Parameter
gridElementNode

◆ GetCategory()

◆ GetElementPrefix()

string DataShark.Grid.Elements.Base.BaseGridElement.GetElementPrefix ( )

Liefert den erforderlichen Prefix für diesen Typ zurück.

Rückgabe

◆ GetIcon()

Image DataShark.Grid.Elements.Base.BaseGridElement.GetIcon ( )

Gibt das 16x16 Image zu diesem GridElement zurück.

Rückgabe

◆ GetInputCardinality()

◆ GetNextElementList()

◆ GetOutputCardinality()

◆ GetProperties()

virtual void DataShark.Grid.Elements.Base.BaseGridElement.GetProperties ( ref Dictionary< String, String >  properties)
virtual

Liefert abfragerelevante Eigenschaften von dieser BaseGridElement Instanz. BaseGridElement.GetProperties(ref Dictionary<string, string>) liefert die Eigenschaften Name und Index.

Rückgabe

◆ GetValidIdentifier()

static String DataShark.Grid.Elements.Base.BaseGridElement.GetValidIdentifier ( String  identifier)
static

Liefert aus einem ElementName einen gültigen Feldbezeichner zurück.

Parameter
identifier
Rückgabe

◆ InitializeProperties() [1/2]

◆ InitializeProperties() [2/2]

void DataShark.Grid.Elements.Base.BaseGridElement.InitializeProperties ( List< GridElementProperty properties)
protected

Initialisiert die Standardattribute in der Grid-Element Ansicht.

Parameter
properties

◆ PreDelete()

virtual void DataShark.Grid.Elements.Base.BaseGridElement.PreDelete ( ref Dictionary< String, Object >  memory)
virtual

Diese Funktion sollte im abgeleiteten GridElement-Typ überschrieben werden, falls abhängige Objekte modifiziert oder entfernt werden müssen, falls es zu einer Löschung des GridElements kommt.

Erneute Implementation in DataShark.Grid.Elements.ContentSelectorElement, DataShark.Grid.Elements.Base.BaseResultElement und DataShark.Grid.Elements.Base.BaseTableElement.

◆ Restore()

virtual void DataShark.Grid.Elements.Base.BaseGridElement.Restore ( ref Dictionary< String, Object >  memory)
virtual

Wenn eine Löschung rückgängig gemacht wird, können hier die Referenzen oder Objekte wiederhergestellt werden.

Erneute Implementation in DataShark.Grid.Elements.ContentSelectorElement, DataShark.Grid.Elements.Base.BaseResultElement und DataShark.Grid.Elements.Base.BaseTableElement.

◆ RuntimeInit()

virtual void DataShark.Grid.Elements.Base.BaseGridElement.RuntimeInit ( )
virtual

Wenn die Laufzeit initialisiert wird, wird diese Methode aufgerufen. Hier können Initialisierungsschritte für den abgeleiteten Elementtyp implementiert werden.

Erneute Implementation in DataShark.Grid.Elements.ExtractorElement, DataShark.Grid.Elements.CounterElement, DataShark.Grid.Elements.CombinerElement und DataShark.Grid.Elements.TableWriterElement.

◆ SaveXml() [1/2]

◆ SaveXml() [2/2]

XmlNode DataShark.Grid.Elements.Base.BaseGridElement.SaveXml ( XmlDocument  xmlDocument,
XmlNode  objectXmlNode 
)
protected

Speichert die Basisattribute im erstellten XmlNode.

Parameter
xmlDocument
objectXmlNode
Rückgabe

◆ SetIcon()

void DataShark.Grid.Elements.Base.BaseGridElement.SetIcon ( System.Drawing.Bitmap  icon)
protected

Setzt das Icon (16x16px) des aktuellen Grid-Elements. Das Icon ist in der Titelleiste des Grid-Elements zu sehen.

Parameter
icon

◆ SetParentElement()

void DataShark.Grid.Elements.Base.BaseGridElement.SetParentElement ( object  parentElement)

Diese Methode muss zwingend beim Einsteigen in die Boolean Execute(DataSharkRuntime) Methode aufgerufen werden. Hier wird das übergeordnete, also aufrufende Element registriert.

Parameter
parentElement

◆ SetTitle()

void DataShark.Grid.Elements.Base.BaseGridElement.SetTitle ( String  title)
protected

Setzt den Titel des aktuellen Grid-Elements. Der Titel ist sowohl in der Grid-Element Ansicht zu sehen, als auch in der Kontrollelement-Ansicht.

Parameter
title

◆ SortByIndex< T >()

List<T> DataShark.Grid.Elements.Base.BaseGridElement.SortByIndex< T > ( List< T >  elementList)

Sortiert die übergebene Liste von Grid-Elementen nach Ihrem Ausführungsindex.

Template-Parameter
T
Parameter
elementList
Rückgabe
Type Constraints
T :BaseGridElement 

◆ UndoWarn()

void DataShark.Grid.Elements.Base.BaseGridElement.UndoWarn ( )

Ist der Schritt erfolgreich durchgelaufen, müssen Sie die Warnung wieder rückgängig machen. Mit dieser Methode führen Sie diese Aktion durch.

◆ Wait()

void DataShark.Grid.Elements.Base.BaseGridElement.Wait ( DataShark.Runtime.DataSharkRuntime  runtime)

Diese Methode muss zwingend beim Einsteigen in die Boolean Execute(DataSharkRuntime) Methode aufgerufen werden. Hier wird geprüft, ob das Element einen Haltepunkt hat oder die Laufzeit angehalten wurde.

Parameter
runtime

◆ Warn()

void DataShark.Grid.Elements.Base.BaseGridElement.Warn ( DataSharkRuntime  runtime,
String  warning 
)

Wollen Sie den Benutzer über eine Warnung informieren, geben Sie hier eine Nachricht an. Diese Warnung wird direkt im Grid-Element auf dem DataShark.Grid angezeigt.

Parameter
runtime
warning

Dokumentation der Datenelemente

◆ inputType

String DataShark.Grid.Elements.Base.BaseGridElement.inputType = "None"
protected

Der interne Eingabetyp.

Dokumentation der Propertys

◆ ElementName

String DataShark.Grid.Elements.Base.BaseGridElement.ElementName
getset

Der Elementbezeichner des Grid-Elements.

◆ ParentElement

BaseGridElement DataShark.Grid.Elements.Base.BaseGridElement.ParentElement = String.Empty
getprotected set

Während der Laufzeit kann hier das übergeordnete Element abgerufen werden.

◆ RegisteredNameChangeEventMap

Dictionary<FieldElement, Boolean> DataShark.Grid.Elements.Base.BaseGridElement.RegisteredNameChangeEventMap
getsetprotected

Internes Verzeichnis zum Vorhalten der Feld-Elemente, die bereits für das FieldElement.NameChange Event registriert wurden.

◆ SaveStatus

String DataShark.Grid.Elements.Base.BaseGridElement.SaveStatus = String.Empty
getset

Der Speicherstatus des Objekts: InProgress oder Finished

◆ Status

String DataShark.Grid.Elements.Base.BaseGridElement.Status
getset

Der interne Status des Objekts: Created oder Updated


Die Dokumentation für diese Klasse wurde erzeugt aufgrund der Dateien: