Benutzer-Werkzeuge

Webseiten-Werkzeuge


de:mexx:api:excel

Excel-AddIn Schnittstelle

Das MeXX-Excel-AddIn stellt einige rudimentäre Funktionen für andere AddIns oder Makros zur Verfügung.

Aufruf

Alle Funktionen sind auf dem Connect-Objekt des AddIns definiert. Dieses Objekt kann wie folgt abgerufen werden.

Private AddIn As COMAddIn
Private Const ProgId = "Reitec.MeXX.AddIn.Excel.Connect"
 
Public Function InitializeAddin(Optional ShowMessage As Boolean = True) As Boolean
  If AddIn Is Nothing Then
    On Error Resume Next
    If Application.COMAddIns(ProgId).Connect Then Set AddIn = Application.COMAddIns(ProgId)
  Else
    ' detect deactivation within session
    If Not AddIn.Connect Then Set AddIn = Nothing
  End If
  InitializeAddin = Not (AddIn Is Nothing)
  If AddIn Is Nothing And ShowMessage Then MsgBox "MeXX-AddIn not found.", vbInformation, cAppAddinName
End Function
 
Function LocalFilename(NodeID As String)
  Dim s As String
  If InitializeAddin Then s = AddIn.Object.GetLocalFileNameForNodeID(NodeID)
  LocalFilename = s
End Function

Funktionen

Auf dem AddIn stehen folgende öffentliche Funktionen zur Verfügung.

GetNodeIDByValue

Die Funktion ermittelt die NodeID eines Elements an Hand des übergebenen Suchschlüssels.

Parameter Beschreibung
CategoryAttribute Attribut der Kategorien in denen gesucht werden soll.
SearchColumnAttribute Attribut der Spalte in der gesucht werden soll.
SearchValue Schlüsselwert nach dem gesucht werden soll.

Rückgabe: NodeID als Text oder leer.

Function GetNodeIDByValue(CategoryAttribute As String, SearchColumnAttribute As String, SearchValue As String) As String

GetMetaDataIDByValue

Die Funktion ermittelt die MetaDataID eines Elements an Hand des übergebenen Suchschlüssels.

Parameter Beschreibung
CategoryAttribute Attribut der Kategorien in denen gesucht werden soll.
SearchColumnAttribute Attribut der Spalte in der gesucht werden soll.
SearchValue Schlüsselwert nach dem gesucht werden soll.

Rückgabe: MetaDataID als Text oder leer.

Function GetMetaDataIDByValue(CategoryAttribute As String, SearchColumnAttribute As String, SearchValue As String) As String

GetNodeIDsByParentAndCategory

Die Funktion ermittelt rekursiv die NodeIDs der einem Eltern-Element zugeordneten Elemente einer bestimmten Kategorie.

Parameter Beschreibung
ParentNodeID NodeID des Eltern-Elements.
CategoryAttribute Attribut der Kategorie die gesucht werden sollen.

Rückgabe: Liste der NodeIDs als Text-Array oder leer.

Function GetNodeIDsByParentAndCategory(ParentNodeID As String, CategoryAttribute As String) As String()

GetValueByNodeAndColumn

Die Funktion ermittelt einen bestimmten Wert eines Elements.

Parameter Beschreibung
NodeID NodeID des Elements.
ColumnAttribute Attribut der Wertspalte.

Rückgabe: Wert als Text oder leer.

Function GetValueByNodeAndColumn(NodeID As String, ColumnAttribute As String) As String

GetFileDescriptionForNodeID

Die Funktion ermittelt die Dateibezeichnung für das übergebene Datei-Element.

Parameter Beschreibung
NodeID GUID des Datei-Elementes als Text.

Rückgabe: Dateibezeichnung als Text oder leer.

Function GetFileDescriptionForNodeID(ByVal NodeID As String) As String

GetLocalFileNameForNodeID

Die Funktion ermittelt den lokalen, vollständingen Dateinamen für das übergebene Datei-Element.

Parameter Beschreibung
NodeID GUID des Datei-Elementes als Text.

Rückgabe: Vollständiger, lokaler Dateiname als Text oder leer.

Function GetLocalFileNameForNodeID(ByVal NodeID As String) As String
de/mexx/api/excel.txt · Zuletzt geändert: 2019/05/20 13:02 (Externe Bearbeitung)