Académique Documents
Professionnel Documents
Culture Documents
Pgina 1 de 9
BookmarkObject
The QlikView Bookmark layout object
Method Detail
Activate
Activate()
ActivateAlso
ActivateAlso()
ApplyTheme
ApplyTheme(String FileName)
Returns:
No return value
Earliest version:
6.0x
CanPrint
Boolean CanPrint()
Close
Close()
CopyBitmapToClipboard
Boolean CopyBitmapToClipboard()
CopyTableToClipboard
Boolean CopyTableToClipboard(Boolean IncludeLabels)
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 2 de 9
Returns:
True if operation was successful
Earliest version:
6.0x
CopyTextToClipboard
Boolean CopyTextToClipboard()
CopyValuesToClipboard
Boolean CopyValuesToClipboard()
Copies the values of a chart object to clipboard (not available for pivot tables).
Earliest version:
6.0x
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. No relevance for objects of this class
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:
6.0x
DbGetTableInfo
Ireturn object for SheetObject.DbGetTableInfo() and CustomDropDown.DbGetTableInfo() and GraphBasics.D... DbGetTableInfo()
Returns information about fields in table for QV ODBC driver. No relevance for objects of this class
Earliest version:
6.0x
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:
6.0x
Deactivate
Deactivate()
Removes the sheet object from the list of active sheet objects.
Earliest version:
6.0x
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 3 de 9
DialogPrint
Boolean DialogPrint()
DialogProperties
Boolean DialogProperties(Integer Page)
ExportBitmapToFile
Boolean ExportBitmapToFile(String Filename)
Returns:
Returns true if export succeeded
Earliest version:
6.0x
GetCaption
ICaption GetCaption()
GetDoc
Document GetDoc()
GetFrameDef
IFrame GetFrameDef()
Returns frame, border and caption settings for the sheet object with position rectangles in docunits. Replaces GetFrame from QV5
Earliest version:
6.0x
GetObjectCalcTime
Integer GetObjectCalcTime()
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 4 de 9
GetObjectId
String GetObjectId()
GetObjectMemoryUsage
Integer GetObjectMemoryUsage()
GetObjectType
short GetObjectType()
GetPrintOptions
IPrinterOptions GetPrintOptions()
GetProperties
IBookmarkObjectProperties GetProperties()
GetRect
IRect GetRect()
GetRelevantSelections
Variant (Array of String) GetRelevantSelections()
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 5 de 9
Earliest version:
6.0x
GetReplacementObject
LPDISPATCH GetReplacementObject()
Returns pointer to OCX replacement object. No relevance for objects of this class
Earliest version:
6.0x
GetSheet
Sheet GetSheet()
GetStatus
Integer GetStatus()
GetTableAsText
String GetTableAsText(Boolean IncludeLabels)
Returns:
No meaning for bookmark objects
Earliest version:
6.0x
GetZedLevel
Integer GetZedLevel()
IsActive
Boolean IsActive()
IsMaximized
Boolean IsMaximized()
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 6 de 9
Earliest version:
6.0x
IsMinimized
Boolean IsMinimized()
Maximize
Maximize()
Minimize
Minimize()
MoveToSheet
Boolean MoveToSheet(String SheetId)
Returns:
True if operation succeeded
Earliest version:
7.00
Print
Boolean Print()
Prints the sheet object if printable. No relevance for objects of this class
Earliest version:
6.0x
PrintEx
Boolean PrintEx(String PrinterName, Boolean ShowPrinterDlg)
be used
Returns:
Returns true if object is printable
Earliest version:
7.00
PrintOut
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 7 de 9
Boolean PrintOut()
Prints the sheet object if printable. No relevance for objects of this class
Earliest version:
6.0x
Restore
Restore()
SendToExcel
Integer SendToExcel()
No relevance for objects of this class. No relevance for objects of this class
Earliest version:
6.0x
SetBorder
SetBorder(IFrame Frame)
SetFont
SetFont(IBaseFont Font)
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,
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 8 de 9
9 FONT_CHANGE,
10 ADVANCEDCAPTION_CHANGE,
11 MACRO_TRIGGER_CHANGE,
The order of the elements is arbitrary.
Returns:
No return value
Earliest version:
6.0x
SetFrameDef
SetFrameDef(IFrame Frame)
SetLayer
SetLayer(Integer Level)
SetPrintOptions
SetPrintOptions(IPrinterOptions Opt)
SetProperties
SetProperties(IBookmarkObjectProperties Properties)
Returns:
No return value
Earliest version:
6.0x
Example:
set bo = ActiveDocument.GetSheetObject("BM01")
set bp = bo.GetProperties
bp.Layout.BkgAlpha = 127
bo.SetProperties bp
SetRect
SetRect(IRect WinRect)
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016
BookmarkObject
Pgina 9 de 9
Sets the position rectangle for the sheet object. Rectangle must be in pixels.
Parameters:
WinRect (IRect)
Returns:
No return value
Earliest version:
6.0x
WriteXmlPropertiesFile
WriteXmlPropertiesFile(String FileName)
Returns:
No return value
Earliest version:
7.00
file:///C:/Users/Opss/Downloads/QlikViewAPI_html/BookmarkObject.htm
17/03/2016