Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
| Beide Seiten der vorigen Revision Vorhergehende Überarbeitung | |||
|
de:mexx:start:api:excel [2017/06/21 15:23] admin [GetMetaDataIDByValue] |
— (aktuell) | ||
|---|---|---|---|
| Zeile 1: | Zeile 1: | ||
| - | ====== 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. | ||
| - | <code vb> | ||
| - | Private AddIn As COMAddIn | ||
| - | Private Const ProgId = " | ||
| - | |||
| - | 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 " | ||
| - | 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 | ||
| - | |CategoryAttribute | ||
| - | |SearchColumnAttribute | Attribut der Spalte in der gesucht werden soll. | | ||
| - | |SearchValue | ||
| - | |||
| - | Rückgabe: NodeID als Text oder leer. | ||
| - | |||
| - | <code vb> | ||
| - | 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 | ||
| - | |CategoryAttribute | ||
| - | |SearchColumnAttribute | Attribut der Spalte in der gesucht werden soll. | | ||
| - | |SearchValue | ||
| - | |||
| - | Rückgabe: MetaDataID als Text oder leer. | ||
| - | |||
| - | <code vb> | ||
| - | 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 | ||
| - | |ParentNodeID | ||
| - | |CategoryAttribute | ||
| - | |||
| - | |||
| - | Rückgabe: Liste der NodeIDs als Text-Array oder leer. | ||
| - | |||
| - | <code vb> | ||
| - | Function GetNodeIDsByParentAndCategory(ParentNodeID As String, CategoryAttribute As String) As String() | ||
| - | </ | ||
| - | |||
| - | ==== GetValueByNodeAndColumn==== | ||
| - | Die Funktion ermittelt einen bestimmten Wert eines Elements. | ||
| - | |||
| - | ^Parameter | ||
| - | |NodeID | ||
| - | |ColumnAttribute | ||
| - | |||
| - | Rückgabe: Wert als Text oder leer. | ||
| - | |||
| - | <code vb> | ||
| - | Function GetValueByNodeAndColumn(NodeID As String, ColumnAttribute As String) As String | ||
| - | </ | ||
| - | ==== GetFileDescriptionForNodeID==== | ||
| - | Die Funktion ermittelt die Dateibezeichnung für das übergebene Datei-Element. | ||
| - | |||
| - | ^Parameter | ||
| - | |NodeID | ||
| - | |||
| - | Rückgabe: Dateibezeichnung als Text oder leer. | ||
| - | |||
| - | <code vb> | ||
| - | Function GetFileDescriptionForNodeID(ByVal NodeID As String) As String | ||
| - | </ | ||
| - | |||
| - | ==== GetLocalFileNameForNodeID==== | ||
| - | Die Funktion ermittelt den lokalen, vollständingen Dateinamen für das übergebene Datei-Element. | ||
| - | |||
| - | ^Parameter | ||
| - | |NodeID | ||
| - | |||
| - | Rückgabe: Vollständiger, | ||
| - | |||
| - | <code vb> | ||
| - | Function GetLocalFileNameForNodeID(ByVal NodeID As String) As String | ||
| - | </ | ||