Get reference of active panel with API

I need help with the COM API

The following gets the resource ID of the active panel:

$Lg = ObjCreate("LogosBibleSoftware.Launcher")
$lg.LaunchApplication()
$lga = $lg.Application
$lgap = $lga.GetActivePanel()
$ResID = $lgap.Details().ResourceID ;displays resourceID of active panel
MsgBox(4096,"",$ResID)

How can I now get the reference for that panel (ie. lets say its a bible that is opened to John 3:16 - I need it to return this passage in a variable)

Can anyone help?

Find more posts tagged with

Comments

steve clark

Hi again Tim,

How can I now get the reference for that panel (ie. lets say its a bible that is opened to John 3:16 - I need it to return this passage in a variable)

Can anyone help?

See this method in Logos 4 COM API -> Logos Panel

Methods

GetCurrentReferencesAndHeadwords() : LogosReferenceOrHeadwordCollection: The current references and headwords, if any.

BTW: i answered your other post with an API question as well, you might want to check it.

Tim Engwer

https://community.logos.com/discussion/comment/255548#Comment_255548

Thanks Steve,

I did see this but cannot figure out how to use it. I have tried several different ways of accessing it and nothing works. Could you give me an example of its use?

steve clark

https://community.logos.com/discussion/comment/255561#Comment_255561

Could you give me an example of its use?

Example code below:

        Dim L4Panel As LogosPanel, s1 As String = ""

        'Get the active panel obj
        L4Panel = L4App.GetActivePanel

        'if the panel obj is valid...
        If TypeName(L4Panel.Kind) <> Nothing Then

            'if the obj is a RESOURCE...
            If UCase(L4Panel.Kind) = UCase("Resource") Then
                Dim HdRefCol As LogosReferenceOrHeadwordCollection

                'Get Reference/Head Word info for this panel
                HdRefCol = L4Panel.GetCurrentReferencesAndHeadwords

                'does the Obj have data in it?
                If HdRefCol.Count >= 1 Then

                    ' if the Reference obj is valid...
                    If TypeName(HdRefCol.Item(0).Reference) <> "Nothing" Then

                        'if we have valid DETAILS...
                        If TypeName(HdRefCol.Item(0).Reference.Details) <> "Nothing" Then
                            s1 = HdRefCol.Item(0).Reference.Details.Book & " "
                            s1 = s1 & HdRefCol.Item(0).Reference.Details.Chapter & ":"
                            s1 = s1 & HdRefCol.Item(0).Reference.Details.Verse
                        End If
                    End If
                End If
            End If
        End If

The code set s1 variable to this: "1Co 1:1" from the current active Bible.

Tim Engwer

https://community.logos.com/discussion/comment/255566#Comment_255566

Thank you for your time!!!

BTW your Quicklinks program is very useful. I will be trying the mfavs soon.

steve clark

https://community.logos.com/discussion/comment/255569#Comment_255569

Thank you for your time!!!

It would be interesting to see what your scripts do...

BTW your Quicklinks program is very useful. I will be trying the mfavs soon.

Glad that you like it! Hope that you find mFav useful too.

Tim Engwer

https://community.logos.com/discussion/comment/255569#Comment_255569

I have another question now (I thought I had evrything I needed).

I can navigate the to any passage of a bible with the following:

$Lg = ObjCreate("LogosBibleSoftware.Launcher")
$lg.LaunchApplication()
$lga = $lg.Application
$nr = $lga.CreateNavigationRequest()
$ref = $lga.DataTypes.LoadReference("Bible.1Ki8.62-66")
$nr.reference = $ref
$lga.Navigate($nr)

But how do I navigate to a given passage in the currently active commentary? I thought the above would work for commentaries as well but it doesn't. An example would be much appreciated. Thanks!

Tim Engwer

https://community.logos.com/discussion/comment/255574#Comment_255574

It would be interesting to see what your scripts do...

I will be putting them out soon. I plan on having a website where I will post these things and more. I have one that allows you to use the internet and other apps from within Logos and tags the bible verses and uses custom popup windows. Another changes the background colors of panels (takes a little work to set it up but it looks nice in the end). Right now I want to create a quick shortcut key that will allow a person to do a ctrl-right click on a commentary and have it jump to the reference of the window previously used (usually a bible in my case) without having the inconvenience of links changing the bible when the commentary is scrolled. I know how to get the reference of the bible thanks to you so now I just need to know how to navigate the commentary to that passage. I know this can be done with your quicklinks but I wanted a simple and quick right click method just for this task.

steve clark

https://community.logos.com/discussion/comment/255590#Comment_255590

But how do I navigate to a given passage in the currently active commentary? I thought the above would work for commentaries as well but it doesn't. An example would be much appreciated.

It is getting late here where i live and i need to study some for tomorrow's worship.

There is an issue with navigating a multi-volume commentary (see this post).

QL navigates within a commentary just as i would navigate a Bible resource (except when the commentary is a multi-volume one). So i am guessing that you are having the same problem as mentioned above (a limitation of the API).

Perhaps after Church tomorrow i will have more time to look at your code.

steve clark

https://community.logos.com/discussion/comment/255599#Comment_255599

The more i think about it, i am pretty sure your problem is commentary series. Have you tried to navigate the Bible Knowledge Commentary? (BKC is treated as a single volume commentary in L4). So if you can navigate in the BKC but not other commentaries, then that is the problem that you are running into.

Tim Engwer

https://community.logos.com/discussion/comment/255712#Comment_255712

The more i think about it, i am pretty sure your problem is commentary series. Have you tried to navigate the Bible Knowledge Commentary? (BKC is treated as a single volume commentary in L4). So if you can navigate in the BKC but not other commentaries, then that is the problem that you are running into.

The following works for single volume commentarys:

$Lg = ObjCreate("LogosBibleSoftware.Launcher")
$lg.LaunchApplication()
$lga = $lg.Application
$nr = $lga.CreateNavigationRequest()
$lgap = $lga.GetActivePanel()
$ResID = $lgap.Details().ResourceID ;displays resourceID of active panel
MsgBox(4096,"",$ResID)
$nr.ResourceId = $ResID
$ref = $lga.DataTypes.LoadReference("Bible.1Ki8.62-66")
$nr.reference = $ref
$lga.Navigate($nr)

You need the ResourceID to get it to work with commentarys (and other non bible resources probably). This was the one line that was missing in my original code and it then only navigated the last used bible to the reference. As you suspected it does not work with multivolume commentarys ( I tried the Pulpit Commentary). I suspect this is becasue the resourceID is needed to navigate in commentarys and this ID is different for each volume. Therefore the only way to get this to work on a multivolume would be to have a way of getting the ID of the resource that the passage is in ahead of time. Not sure if this can be done with the API at present.

Thanks for your help. I have learned a lot just from the examples you gave. I realized that if there is a collection of objects you need the Item() command to let the computer know which of the many items you want. Once I saw this I was able to figure a few more things out. Good job on that Bible pgs web site! I did a little poking around. Thanks again for the help. If I have any more questions I'll send them to the forum and maybe you can help again.

steve clark

https://community.logos.com/discussion/comment/255723#Comment_255723

As you suspected it does not work with multivolume commentarys ( I tried the Pulpit Commentary). I suspect this is becasue the resourceID is needed to navigate in commentarys and this ID is different for each volume. Therefore the only way to get this to work on a multivolume would be to have a way of getting the ID of the resource that the passage is in ahead of time. Not sure if this can be done with the API at present.

Since this can be done on the L4 reference box of a commentary window, the ability is built into L4 but is not patched into the navigation API function. As for finding the ResourceID for other commentary books, this would be hit & miss since we do not have access to Series info on resources. Not all commentary series have similarity in the ResID. As for me i would prefer to have Logos add the ability that the UI has, no sense in trying to re-engineer the same functionality.

You are welcome for the help! i hope to see you post the website for your tools in the future! You have some interesting ideas and i will be even more excited once that i see them in action.