Class Qww.TextObject.Mgr
JavaScript class to manage communication with an underlying QlikView text object.
Defined in: <JavaScript\QWW\QwwJs_TextObjectMgr.js>.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
Qww.TextObject.Mgr(cfg)
Constructs a new Qww.TextObject.Mgr button instance.
|
| Field Attributes | Field Name and Description |
|---|---|
|
Caption for text object.
|
|
|
Reference to the configuration object which was used to create construct the object.
|
|
|
Whether the text object is enabled (visible) within the QlikView application.
|
|
|
Text content of the object.
|
Class Detail
Qww.TextObject.Mgr(cfg)
Constructs a new Qww.TextObject.Mgr button instance.
var txtObj = new Qww.TextObject.Mgr(
{
"ObjectID" : 'TXT_MYTXTBOX',
"OnUpdate": function(oTxt) {
alert("Qww.TextObject.Mgr.OnUpdate fired - .Text = " +
oTxt.Text + ", .Enabled = " + oTxt.Enabled);
}
});
- Parameters:
- {Object} cfg
- JSON object to configure ButtonMgr.
- {String} cfg.ObjectID
- Id of the text object in the QlikView application.
- {String} cfg.ApplicationID Optional, Default: null
- Id/Name of the QlikView application. Note this is only necessary when multiple QlikView documents are being used on the same web page and should otherwise be set to null.
- {Bool} cfg.DoNotInitialise Optional, Default: false
- Set this to false if you do not want this particular object to initialise the underlying object with QlikView Server. Use this option for example if you are already using another object or control which will have already initialised this. In this mode this object will simply parse the existing data for this object as it comese from QlikView Server.
- {Function} cfg.OnUpdate Optional
- Function to call whenever an update is received for the button (for example if the button text changes). The function should accept a single parameter which is reference to the TextObjectMgr itself.
Field Detail
{Qww.ObjectCaption}
Caption
Caption for text object.
{Object}
Cfg
Reference to the configuration object which was used to create construct the object. This
allows certain properties to be updated after initial instantiation.
{Bool}
Enabled
Whether the text object is enabled (visible) within the QlikView application. This can be dependent,
for example, upon show and hide conditions set for the object in QlikView.
{String}
Text
Text content of the object.
