QlikView: SingleObjectActiveIndex does not change the current active object

Client is trying to change the current active object in a container via a button and a macro written in VBscript, but the function to do this, SingleObjectActiveIndex, does not seem to work anymore since QlikView 12x. The client wants to know how to identify and change the active object via code. For example, The typical code test code you might see for this kind of attempt is:
 

sub test
    Set ContainerObj = ActiveDocument.GetSheetObject("CT01") 
    set ContProp = ContainerObj.GetProperties 
    ActiveObject = ContProp.SingleObjectActiveIndex 
    msgbox("Active Object Index = " & ActiveObject & " Active Object = " & ContProp.ContainedObjects.Item(ActiveObject).Id)
    
    ActiveObject = 1
    ContProp.SingleObjectActiveIndex = ActiveObject 
    ContainerObj.SetProperties ContProp
    msgbox("Active Object Index = " & ActiveObject & " Active Object = " & ContProp.ContainedObjects.Item(ActiveObject).Id)
end sub

In the example above, we cannot get the ID of the current active object, and if you comment that part out, you would see that the second message box will show that the current object has changed, but this is not reflected physically in the UI.


Affected Environments:
QlikView versions prior to 12.30 (November 2018) SR 1
 

API's have changed, and this is not documented since the current API information is not up-to-date. The latest APIs use Def.ObjectId instead of Id and ShowSingleObject to replace SingleObjectActiveIndex for changing an object in a container.

Upgrade QlikView to at least version 12.30 (November 2018) SR 1 or 12.40 (April 2019).
Then, use the following code from the updated APIs:
 

sub test
    Set ContainerObj = ActiveDocument.GetSheetObject("CT01")
    set ContProp = ContainerObj.GetProperties
    ActiveObject = ContProp.SingleObjectActiveIndex
    msgbox("Active Object Index = " & ActiveObject & " Active Object = " & ContProp.ContainedObjects.Item(ActiveObject).Def.ObjectId)
 
    ContainerObj.ShowSingleObject 1 'New function that uses less code to change active object.
    msgbox("Active Object Index = " & ActiveObject & " Active Object = " & ContProp.ContainedObjects.Item(ActiveObject).Def.ObjectId)
end sub

Related Content

QlikView APIs and SDKs
QlikView for developers