Tutorial on Automating Logos4+ with ComApi in VBA

I Paste some Code here for those that can't use or open VBA. The ClassModule have Functions that could be reused in some situations.

PASTE THIS IN A CLASSMODULE IN VBA

'Win32API - Just used for a Timer in Windows

Private Declare Sub Sleep Lib "kernel32" (ByVal dwMilliseconds As Long)

Dim Launcher As LogosLauncher
Dim WithEvents Logos As LogosApplication

Const ApiVersion = 3
Const ClassName As String = "CLogos"

Public Event CopyBibleVerse(Reference As String, BibleText As String)
Public Event LibraryQuery(ResourceInfo As LogosResourceInfo)
Public Event AOpenPanel(Panel As LogosPanel)

Public Enum RenderStyles
    rsSHORT = 0
    rsMEDIUM = 1
    rsLONG = 2
    rsDEFAULT = 3
End Enum
Public Enum QueryDetails
    qdIMAGE = 0
    qdTITLE = 1
    qdTYPE = 2
    qdSERIES = 3
    qdSUBJECTS = 4
    qdAUTHER = 5
    qdMYTAGS = 6
    qdRATING = 7
    qdABTEVIATEDTITLE = 8
    qdELECTRONICPUBLICATIONDATE = 9
    qdLANGUAGES = 10
    qdPUBLICATIONDATE = 11
    qdPUBLISHER = 12
    qdLASTUPDATED = 13
    qdDEVICES = 14
    qdEDITION = 15
    qdLASTACCESSED = 16
    qdMOSTUSED = 17
    qdCOMMUNITYTAGS = 18
End Enum
Sub Create(Optional CommandLineArguments As String)
    On Error GoTo ErrHandler
    Set Launcher = New LogosLauncher
    Set Logos = Nothing
    
    Stop
    Launcher.LaunchApplication CommandLineArguments
    While Logos Is Nothing
        Set Logos = Launcher.Application
    Wend
    
    If Logos.ApiVersion < ApiVersion Then _
        MsgBox "ApiVersion " & ApiVersion & _
            " Required." & vbCrLf & _
            "You have " & Logos.ApiVersion & vbCrLf & _
            "The Logos Class may not Function correctly", vbCritical, ClassName
   Exit Sub
ErrHandler:
   MsgBox Err.Number & " - " & Err.Description
   Err.Clear
End Sub
Public Function GetResourceInfo(ResourceId As String) As LogosResourceInfo
    Stop
    Set GetResourceInfo = Logos.Library.GetResourceInfo(ResourceId)
End Function
Property Get Application() As LogosApplication
    If Logos Is Nothing Then
        MsgBox "Use Create first", vbInformation, Title
        Else
        Set Application = Logos
    End If
End Property

Sub CopyBibleVerses(BibleReferences As String, Optional RenderStyle As RenderStyles = rsDEFAULT)
    Dim LDTPRC As LogosDataTypeParsedReferenceCollection
    Dim LDTPR As LogosDataTypeParsedReference
    Dim LCBVR As LogosCopyBibleVersesRequest
    
    If Logos Is Nothing Then GoTo NoLogos
    'Scan first to check if there is more than one
        Stop
        Set LDTPRC = Logos.DataTypes.GetDataType("Bible").ScanForReferences(BibleReferences)
        If LDTPRC.Count > 0 Then
            For Each LDTPR In LDTPRC
                Set LCBVR = Logos.CopyBibleVerses.CreateRequest
                LCBVR.Reference = LDTPR.Reference
                RaiseEvent CopyBibleVerse(LDTPR.Reference.Render(GetRenderStyle(RenderStyle)), Logos.CopyBibleVerses.GetText(LCBVR))
            Next
        Else
                'This will not run because all refrences are handled above
                'This is only to show how to do a CopyBibleVerseRequest
                'with one Reference another way
                Set LCBVR = Logos.CopyBibleVerses.CreateRequest
                LCBVR.Reference = Logos.DataTypes.GetDataType("Bible").ParseReference(BibleReferences)
                RaiseEvent CopyBibleVerse(LCBVR.Reference.Render(GetRenderStyle(RenderStyle)), _
                    Logos.CopyBibleVerses.GetText(LCBVR))
        End If
    Exit Sub
NoLogos:
    MsgBox "Use Create First", vbInformation, Title
ErrHandler:
    MsgBox Err.Number & " - " & Err.Description
    Err.Clear
End Sub
Private Function GetRenderStyle(rs As RenderStyles) As String
    Stop
    Select Case rs
        Case rsSHORT
            GetRenderStyle = "short"
        Case rsMEDIUM
            GetRenderStyle = "medium"
        Case rsLONG
            GetRenderStyle = "long"
        Case rsDEFAULT
            GetRenderStyle = "default"
    End Select
End Function

Sub QueryLibraryByDetails(QueryByDetail As QueryDetails, SearchString As String)
    Dim strDetail As String: getQueryDetail (querybydetails)
    Dim RIC As LogosResourceInfoCollection
    Dim RI As LogosResourceInfo
    Stop
    Set RIC = Logos.Library.GetResourcesMatchingQuery(getQueryDetail(QueryByDetail) & SearchString)
    For Each RI In RIC
        RaiseEvent LibraryQuery(RI)
    Next
End Sub
 Sub QueryLibraryByResourceType(ResourceType As String)
    Dim RIC As LogosResourceInfoCollection
    Dim RI As LogosResourceInfo
    Stop
    Set RIC = Logos.Library.GetResourcesByResourceType(ResourceType)
    For Each RI In RIC
        RaiseEvent LibraryQuery(RI)
    Next
 End Sub
Private Function getQueryDetail(qd As QueryDetails) As String
    Select Case qd
        Case qdIMAGE
            getQueryDetail = "Image:"
        Case qdTITLE
            getQueryDetail = "Title:"
        Case qdTYPE
            getQueryDetail = "Type:"
        Case qdSERIES
            getQueryDetail = "Series:"
        Case qdSUBJECTS
            getQueryDetail = "Subjects:"
        Case qdAUTHER
            getQueryDetail = "Auther:"
        Case qdMYTAGS
            getQueryDetail = "MyTags:"
        Case qdRATING
            getQueryDetail = "Rating:"
        Case qdABTEVIATEDTITLE
            getQueryDetail = "AbbreviatedTitle:"
        Case qdELECTRONICPUBLICATIONDATE
            getQueryDetail = "ElectronicPublicationDate:"
        Case qdLANGUAGES
            getQueryDetail = "Languages:"
        Case qdPUBLICATIONDATE
            getQueryDetail = "PublicationDate:"
        Case qdPUBLISHER
            getQueryDetail = "Publisher:"
        Case qdLASTUPDATED
            getQueryDetail = "LastUpdated:"
        Case qdDEVICES
            getQueryDetail = "Devices:"
        Case qdEDITION
            getQueryDetail = "Edition:"
        Case qdLASTACCESSED
            getQueryDetail = "LastAccessed:"
        Case qdMOSTUSED
            getQueryDetail = "MostUsed:"
        Case qdCOMMUNITYTAGS
            getQueryDetail = "CommunityTags:"
    End Select
End Function

Sub GetOpenPanels()
    Dim OP As LogosPanel
    For Each OP In Logos.GetOpenPanels
        RaiseEvent AOpenPanel(OP)
    Next
End Sub
Private Sub Logos_Exiting()
    Stop
End Sub

Private Sub Logos_PanelActivated(ByVal Panel As Object)
    Stop
End Sub

Private Sub Logos_PanelChanged(ByVal Panel As Object, ByVal Hint As Object)
    Stop
End Sub

Private Sub Logos_PanelClosed(ByVal Panel As Object)
    Stop
End Sub

Private Sub Logos_PanelOpened(ByVal Panel As Object)
    Stop
End Sub

Function GetNavigationRequestFromActivePanel()
    Stop
    'First I'll open the esv Bible
    'I use LoadReference to get the ref to Gen 1:1 formatted for ExecuteUri
    'You can use "bible.Gen 1:1" and there is other ways to get to this ref as well
    'This is just to show how to use LoadReference
    'and to open a Resource for the Navigation Sample
    Debug.Print Logos.DataTypes.LoadReference("bible.Gen 1:1").Save
    Logos.ExecuteUri "logosres:esv;ref=" & Logos.DataTypes.LoadReference("bible.Gen 1:1").Save
    
    Stop
    'With the following code you should keep in mind
    'There are different kinds of Panels
    
    Dim AP As LogosPanel
    Dim NR As LogosNavigationRequest
    'Take note that the following will contain info for
    'Reference Or Headword
    'This means the info inside LogosReferenceOrHeadwordCollection and LogosReferenceOrHeadword
    'may be either Reference OR Headword
    Dim HC As LogosReferenceOrHeadwordCollection
    Dim H As LogosReferenceOrHeadword
    
    Set AP = Logos.GetActivePanel
 
    If AP.DetailsKind = "Resource" Then
        Debug.Print "Now we know we can use Panel.Details"
        Debug.Print "It Return LogosResourcePanelDetails containing the ResourceId: " & AP.Details.ResourceId
        Set NR = Logos.CreateNavigationRequest
        Set HC = AP.GetCurrentReferencesAndHeadwords
        If HC.Count > 0 Then
            With NR
                .Headword = HC.Item(0).Headword
                .HeadwordLanguage = HC.Item(0).HeadwordLanguage
                .Reference = HC.Item(0).Reference
                .ResourceId = AP.Details.ResourceId
            End With
        End If
        Stop
        
        'I'll Close All in Logos so we can See the Navigation take place
        Logos.Activate
        SendKeys "%D", True
        SendKeys "Close All", True
        Sleep 2000
        SendKeys "{ENTER}", True
        

        
        Stop
        Logos.Navigate NR
        
        Stop
        'We can use the Info from the Panel to create an Uri
        Debug.Print "logosres:" & NR.ResourceId & ";ref=" & NR.Reference.Save
        'We can use that Uri to ExecuteUri
        
        Stop
        'I'll Close All in Logos so we can See the ExecuteUri take place
        Logos.Activate
        SendKeys "%D", True
        SendKeys "Close All", True
        Sleep 2000
        SendKeys "{ENTER}", True

        Stop
        Logos.ExecuteUri "logosres:" & NR.ResourceId & ";ref=" & NR.Reference.Save
    End If
    
    Stop
    'The above is a Startingpoint for a more complex way
    'to generate NavigationRequests or Uri's for different Panels
    'eg: logos4:Explorer;ref=BibleESV.Ge1.1 using logos4:(Panel.Kind obtained)
    'This way you can generate Uri's for external links from Active Panels
    'Just use your imagination
    
End Function

PASTE THIS IN A FORM IN VBA

Public WithEvents Logos As CLOgos

Private Sub Logos_AOpenPanel(Panel As Logos4Lib.LogosPanel)
    Debug.Print Panel.Title
End Sub

Private Sub Logos_CopyBibleVerse(Reference As String, BibleText As String)
    Debug.Print Reference & vbCrLf & vbTab & BibleText
End Sub

Private Sub Logos_LibraryQuery(ResourceInfo As Logos4Lib.LogosResourceInfo)
    Debug.Print ResourceInfo.Title
    Stop
End Sub

Private Sub UserForm_Initialize()
    MsgBox "This shows the complicated part of ComApi" & vbCrLf & _
        "The rest seems to be easy and straight forward"
        
    Set Logos = New CLOgos
    
    Stop
    'Create Logos
    Logos.Create
    
    Stop
    'Single Reference
    Logos.CopyBibleVerses "Joh 3:16", rsMEDIUM
    
    Stop
    'Or Multiple References
    Logos.CopyBibleVerses "Gen 1:1 AND maybe Rev 4:8 and Lev 4:3", rsLONG
     
    Stop
    'Library Query
    Logos.QueryLibraryByDetails qdTITLE, "Bible"
    
    Stop
    'Library Query By ResourceType
    Logos.QueryLibraryByResourceType "text.monograph"
    
    Stop
    'The following is to demonstrate how to get ResourceInfo
    'using ResourceId
    Dim RI As LogosResourceInfo
    Set RI = Logos.GetResourceInfo("LLS:1.0.710")
    Debug.Print RI.Title, RI.ResourceId
    'Not the ResourceId returned by ResourceInfo.ResourceId
    Set RI = Logos.GetResourceInfo("esv")
    If RI Is Nothing Then Debug.Print "Returned NOTHING"
    
    Stop
    'How to Use GetOpenPanels
    Logos.GetOpenPanels
    
    Stop
    'I'll demonstrate Application.CreateNavigationRequest and
    'Application.Navigate using GetActivePanel
    Logos.GetNavigationRequestFromActivePanel
    
End Sub

RUN THE FORM

It will Pause itself throughout the Code to show you how to use the API

The execution of the SendKeys could cause trouble depending on the speed of your system. Type in "Close All" in your CommandBox and take note of the time delay until the dropdown lists the Close All command. Use that time delay x 1000 in the Sleep command. That should be the delay you normally need.

        Logos.Activate
        SendKeys "%D", True
        SendKeys "Close All", True
        Sleep [TimeDelay in milliseconds]
        SendKeys "{ENTER}", True

Another reason could also be that in those 2 sec delay you probably switched focus to VBA. To make sure the command gets to Logos, insert an Actiavte command before the {ENTER}:

      Sleep [TimeDelay in milliseconds]

       Logos.Activate
       SendKeys "{ENTER}", True

Try to Run your document as administrator. Maybe there's a mixup in privilages? I don't think Verbum is the issue because if I understand it correctly it uses the same Engine as the other packages.

steve clark said:

btw, how do you see this api being used inside of an Office app? i am curious.

The best answer is always a Sample (3157.AnaliseLNData.zip provided as is, not well commented and not cleaned up [Logos 5.2a SR-2 (5.2.1.0098)  | ComApi 3 | Office 2010 32bit | Win8 64bit]).

Input: ESV Louw-Nida data

Output: Summary of Louw-Nida Domains

1. Open the Excel Workbook
2. Open the ESV
3. Turn on the Display for Louw-Nida on the ESV
4. select Desired Verses
5. Click Analise Selected ESV Button in Workbook on Sheet > Graph Domains
6. Filter the PivotTable as Desired

Analysis: Without reading the passage the summary tells me that the passage contains valuable information about Relations, Attitudes and Emotions and maybe it's worth looking into Afformation and Negation etc... I would therefore spend more time on these domains when analising the passage in Greek.

Here is a Screenshot of a Filter and ChartType change of the Results in Excel:

LogosComApi:

1. I used the API to ScanForReferences to the Louw Nida DataType and one of the Keyboard SendKeys to copy selected text to the Clipboard

Thoughts:

Maybe this is possible in Logos, I've tried it once by grouping some stuff in SearchResults.

What if I want to know how Israel traveled geographically in Genesis to Exodus. And then I want to compare the usage of all the terms they used to refer to the Creator. As a result I would be able to see if there is any relationship between the two. Did Israel prefer a certain usage in Egypt and another in other places? I did this once using the Export function in Logos. But a Macro could cut the time about 90%. I'm still investigating this idea.

I would like Word to scroll to References/Headwords etc. in the Active Document while in Logos or to Navigate Logos automatically while in Word. Using CompareTo and Intersect of the ComAPI would help doing this. Usefull for PBB.

Other ideas would be to automatically link FreeMind or FreePlane ideas as I work in those apps. Even linking Active Panels to ideas to leave a trail on my research and to have everything (Clippings|Notes|Passage Lists etc.) linked to a single map. It would be nice if I can drop a Panel in an app and it would create a link.

Most of all - This is fun and if I can improve my Sermon Prep while having fun,  it's a win win situation.