Container

Pgina 1 de 9

Container
The QlikView container object

Method Detail
Activate
Activate()

Makes the sheet object the active sheet object.

Earliest version:
10.00

ActivateAlso
ActivateAlso()

Adds the sheet object to the active sheet objects.

Earliest version:
10.00

ApplyTheme
ApplyTheme(String FileName)

Apply theme to sheet object.

Parameters:
FileName (String)

: Theme file name with path

Returns:
No return value
Earliest version:
10.00

CanPrint
Boolean CanPrint()

Returns true if sheet object is printable.

Earliest version:
10.00

Close
Close()

Removes the sheet object.

Earliest version:
10.00

CopyBitmapToClipboard
Boolean CopyBitmapToClipboard()

Copies a bitmap image of the sheet object to the clipboard.

Earliest version:
10.00

CopyTableToClipboard
Boolean CopyTableToClipboard(Boolean IncludeLabels)

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 2 de 9

Copies the cells of a table to clipboard (table objects only).

Parameters:
IncludeLabels (Boolean)

: True if labels are to be included

Returns:
True if operation was successful
Earliest version:
10.00

CopyTextToClipboard
Boolean CopyTextToClipboard()

Copies container text to clipboard.

Earliest version:
10.00

CopyValuesToClipboard
Boolean CopyValuesToClipboard()

Copies the values of a chart object to clipboard (not available for pivot tables).
Earliest version:
10.00

DbGetTableData

Ireturn object for SheetObject.DbGetTableData() and CustomDropDown.DbGetTableData() and GraphBasics.D... DbGetTableData(Variant (Array of Integer) Colu

Returns data from table for QV ODBC driver.

Parameters:
Columns (Variant (Array of Integer)) : Array of column numbers
ForceText (Variant (Array of Boolean)) : Not implemented
StartRow (Integer) : First row to extract
NoOfRows (Integer) : Number of rows to extract

to extract (0 based)

Returns:
Returns data from table for QV ODBC driver
Earliest version:
10.00

DbGetTableInfo
Ireturn object for SheetObject.DbGetTableInfo() and CustomDropDown.DbGetTableInfo() and GraphBasics.D... DbGetTableInfo()

Returns information about fields in table for QV ODBC driver.

Earliest version:
10.00

DbIsTable
Boolean DbIsTable()

Returns true if the object is a table box, straight table or bitmap chart (and thus can deliver data to QV ODBC driver).
Earliest version:
10.00

Deactivate
Deactivate()

Removes the sheet object from the list of active sheet objects.
Earliest version:
10.00

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 3 de 9

DialogPrint
Boolean DialogPrint()

Earliest version:

DialogProperties
Boolean DialogProperties(Integer Page)

Opens sheet object properties dialog.

Parameters:
Page (Integer) : Property dialog page (0 based). -1 opens on last used page.
Returns:
No return value
Earliest version:
10.00

ExportBitmapToFile
Boolean ExportBitmapToFile(String Filename)

Exports a bitmap image of the sheet object to a file.

Parameters:
Filename (String)

: File name with path

Returns:
Returns true if export succeeded
Earliest version:
10.00

GetCaption
ICaption GetCaption()

Returns sheet object caption.

Earliest version:
10.00

GetDoc
Document GetDoc()

Returns the document.

Earliest version:
10.00

GetFrameDef
IFrame GetFrameDef()

Returns frame, border and caption settings for the sheet object with position rectangles in docunits.
Earliest version:
10.00

GetObjectCalcTime
Integer GetObjectCalcTime()

Returns latest object calculation time.

Earliest version:
10.00

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 4 de 9

GetObjectId
String GetObjectId()

Returns the unique ID for the sheet object.

Earliest version:
10.00

GetObjectMemoryUsage
Integer GetObjectMemoryUsage()

Returns latest object calculation memory usage.

Earliest version:
10.00

GetObjectType
short GetObjectType()

Returns code for sheet object type.

Earliest version:
10.00

GetPrintOptions
IPrinterOptions GetPrintOptions()

Returns printer settings for the sheet object.

Earliest version:
10.00

GetProperties
IContainerProperties GetProperties()

Returns container properties.

Earliest version:
10.00

GetRect
IRect GetRect()

Returns sheet object position/size rectangle (pixels).

Earliest version:
10.00

GetRelevantSelections
Variant (Array of String) GetRelevantSelections()

Returns the current selections relevant for the object.

Earliest version:
10.00

GetReplacementObject
LPDISPATCH GetReplacementObject()

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 5 de 9

Returns pointer to OCX replacement object.

Earliest version:
10.00

GetSheet
Sheet GetSheet()

Returns the sheet where the sheet object resides.

Earliest version:
10.00

GetStatus
Integer GetStatus()

Returns sheet object state.

Earliest version:
10.00

GetTableAsText
String GetTableAsText(Boolean IncludeLabels)

Not implemented for this object type.

Parameters:
IncludeLabels (Boolean)

: No meaning for container

Returns:
No meaning for container
Earliest version:
10.00

GetZedLevel
Integer GetZedLevel()

Returns z layer for sheet object.

Earliest version:
10.00

IsActive
Boolean IsActive()

Returns true if the sheet object is active.

Earliest version:
10.00

IsMaximized
Boolean IsMaximized()

Returns true if sheet object is maximized.

Earliest version:
10.00

IsMinimized
Boolean IsMinimized()

Returns true if the sheet object is minimized.

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 6 de 9

Earliest version:
10.00

Maximize
Maximize()

Maximizes the sheet object.

Earliest version:
10.00

Minimize
Minimize()

Minimizes the sheet object as an icon if minimizable.

Earliest version:
10.00

MoveToSheet
Boolean MoveToSheet(String SheetId)

Moves the sheet object to a specified sheet.

Parameters:
SheetId (String)

: Sheet ID of target sheet

Returns:
True if operation succeeded
Earliest version:
10.00

Print
Boolean Print()

Prints the sheet object if printable.

Earliest version:
10.00

PrintEx
Boolean PrintEx(String PrinterName, Boolean ShowPrinterDlg)

Prints the sheet object to a named printer.

Parameters:
PrinterName (String) : Name of printer. If omitted default printer will
ShowPrinterDlg (Boolean) : True if Print dialog should be shown

be used

Returns:
Returns true if object is printable
Earliest version:
10.00

PrintOut
Boolean PrintOut()

Prints the sheet object.

Earliest version:
10.00

Restore

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 7 de 9

Restore()

Restores the minimized sheet object if minimized.

Earliest version:
10.00

SendToExcel
Integer SendToExcel()

No relevance for objects of this class.

Earliest version:
10.00

SetBorder
SetBorder(IFrame Frame)

Sets border settings for the sheet object.

Parameters:
Frame (IFrame) : Frame (border) object
Returns:
No return value
Earliest version:
10.00

SetFont
SetFont(IBaseFont Font)

Sets font for the sheet object.

Parameters:
Font (IBaseFont) : Font object
Returns:
No return value
Earliest version:
10.00

SetFrame
SetFrame(IFrame Frame, Boolean RectsAlso, Variant (Array of short) Parts)

Sets frame, border and caption settings for the sheet object.
Parameters:
Frame (IFrame) : Sheet object frame
RectsAlso (Boolean) : True if position/size rectangles to be included
Parts (Variant (Array of short)) : Parts of frame to be set.
Should either be empty (all parts set)
or contain an array containing one element for
each part of the frame to be set. The element
should contain one of the numbers below:
0 BORDER_CHANGE,
1 CAPTION_ON_OFF,
2 LAYER_CHANGE,
3 ALLOWMINIM_CHANGE,
4 ALLOWMAXIM_CHANGE,
5 ALLOWINFO_CHANGE,
6 AUTOMIN_CHANGE,
7 ALLOWMOVESIZE_CHANGE,
8 CONDSHOW_CHANGE,
9 FONT_CHANGE,
10 ADVANCEDCAPTION_CHANGE,
11 MACRO_TRIGGER_CHANGE,
The order of the elements is arbitrary.
Returns:
No return value
Earliest version:
10.00

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 8 de 9

SetFrameDef
SetFrameDef(IFrame Frame)

Sets sheet object frame with position/size rectangle in docunits.

Parameters:
Frame (IFrame) : Sheet object frame with position/size rectangle in docunits
Returns:
No return value
Earliest version:
10.00

SetLayer
SetLayer(Integer Level)

Sets layer for the sheet object.

Parameters:
Level (Integer) : -127 to 127
Returns:
No return value
Earliest version:
10.00

SetPrintOptions
SetPrintOptions(IPrinterOptions Opt)

Sets printer settings for the sheet object.

Parameters:
Opt (IPrinterOptions) : Printer settings object
Returns:
No return value
Earliest version:
10.00

SetProperties
SetProperties(IContainerProperties Properties)

Sets container properties.

Parameters:
Properties (IContainerProperties)

: Container properties object

Returns:
No return value
Earliest version:
10.00

SetRect
SetRect(IRect WinRect)

Sets the position rectangle for the sheet object. Rectangle must be in pixels.
Parameters:
WinRect (IRect)

: Position rectangle object

Returns:
No return value
Earliest version:
10.00

WriteXmlPropertiesFile
WriteXmlPropertiesFile(String FileName)

Writes an xml file with properties describing the sheet object.

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016

Container

Pgina 9 de 9

Parameters:
FileName (String)

: File name with path

Returns:
No return value
Earliest version:
10.00

file:///C:/Users/Opss/Downloads/QlikViewAPI_html/Container.htm

17/03/2016