Getting Started | Class Index

Classes


Class Qv.Document.Object

The object being operated on.

Class Summary
Constructor Attributes Constructor Name and Description
 
Field Summary
Field Attributes Field Name and Description
 
Data for the object
 
Reference to the Qlikview document manager.
 
Reference to the html-element
 
Layout of object
 
The internal QV-name of the object
 
Reference to the Qlikview manager for this object.
 
Reference to the Qlikview object binder.
 
The object's QV-type
Method Summary
Method Attributes Method Name and Description
 
Note! Only available for Buttons.
 
Note! Only available for Extensions.
 
Note! Only available for Text objects.
 
Note! Only available for Inputboxes.
 
Note! Only available for Extensions.
 
Checks if your Extension is "valid", i.e.
 
SetOnUpdateComplete(onupdatecomplete)
Set a function to be called when the QlikView object is updated
 
SetVariable(text, row)
Note! Only available for Inputboxes.
Class Detail
Qv.Document.Object
Field Detail
Data for the object

{Object} DocumentMgr
Reference to the Qlikview document manager. This is the top level manager, from this manager you can find the sheet manager, the bookmark manager, all object managers etc.

{Object} Element
Reference to the html-element

Layout of object

{String} Name
The internal QV-name of the object

{Object} ObjectMgr
Reference to the Qlikview manager for this object.

{Object} PageBinder
Reference to the Qlikview object binder.

{String} Type
The object's QV-type
Method Detail
{void} Click()
Note! Only available for Buttons.
Trigger a click on the button.
    qvButton.Click();

{Number} GetHeight()
Note! Only available for Extensions.
Returns the maximum height assigned for the object by its container.
Returns:
{Number}

{String} GetText()
Note! Only available for Text objects.
Returns the text.
Returns:
{String}

{Object} GetVariable(row)
Note! Only available for Inputboxes.
Returns an object where the property value is the unformated variable and text is formatted. If you omit the row parameter the first variable in the input box is returned.
    var variable = qvInput.GetVariable();
    var variableText = variable.text;
Parameters:
row
Returns:
{Object}

{Number} GetWidth()
Note! Only available for Extensions.
Returns the maximum width assigned for the object by its container.
Returns:
{Number}

{Boolean} IsInvalid()
Checks if your Extension is "valid", i.e. has been rendered and is ready for use. This can also be checked for the object you get returned by GetObject, e.g:
    var myObj = this.GetObject("LB01");
    alert(myObj.IsInvalid());
Returns:
{Boolean}

{void} SetOnUpdateComplete(onupdatecomplete)
Set a function to be called when the QlikView object is updated
Example:
var doc = Qv.GetCurrentDocument();
var lb = doc.GetObject("LB36");
lb.SetOnUpdateComplete(function() {alert("on update complete called");});
Parameters:
{Function} onupdatecomplete
The function to be called

{void} SetVariable(text, row)
Note! Only available for Inputboxes.
If you omit the row parameter the first variable in the input box is updated.
    qvInput.SetVariable("new value");
Parameters:
text
row