The WBK object has properties and methods related to the active Origin Workbook or Matrixbook. The object properties and methods can be accessed using the following syntax:
wbkObject.property
wbkObject.method (argument)
|
Note:
In addition to the WBK object, most attributes can be accessed and changed using the Page object. Also, many operations on child windows can be done by Window command. For more operations and examples, please refer to Basic Workbook Operation and Basic Matrix Operation. |
| Property | Access | Description |
|---|---|---|
| wbk.canAddDC | Read bool |
Return whether the workbook can be used to add Data Connector, 1 = ture, 0 = false. |
| wbk.DC | Read/write | Data Connector settings. See also: The Wbk.DC object properties. |
| wbk.image | Read bool |
Toggle Data Mode (=0) or Image Mode (=1). |
| wbk.Is4D | Read/write bool |
For Matrix book, indicate matrix sheets are depths/levels of 4D object. 0= not 4D, 1= 4D
E.g. After importing 4D NetCDF data with multiple levels/depth, the Matrix book will be set to 4D so that future ROI and intensity profile, etc. will work across matrix sheets. |
| wbk.organizer | Read/write bool |
Show or hide the workbook or matrixbook Organizer. 0 = hide, 1 = show. |
| wbk.saveData | Read/write bool |
Whether to save the imported data in the workbook when saving a project (as .opju) or workbook window (as .ogwu): 0 = exclude the imported data while other data (from typing, calculation or other performances) will remain, 1 = save the imported data |
| wbk.selector | Read/write bool |
Displays the thumbnail/selector region between the matrixbook grid and the window title bar. 0 = hide, 1 = show. |
| wbk.showXY | Read/write bool |
Toggle display of Column/Row (=0) or X/Y (=1). |
| wbk.slider | Read/write bool |
Toggles between display of slider or image thumbnails in the region between the matrixbook grid and the window title bar. 0 = show thumbnails, 1 = show slider. |
| Method | Description |
|---|---|
| wbk.open(sheetName) |
Open the embedded sheetName in a window. sheetName can be Notes, Graph or Matrix. For example, if you add a graph window as a worksheet to the current workbook by right clicking on a current worksheet tab and select menu item Add Graph as Sheet, and rename the worksheet as MyGraph, you can run
wbk.OPEN(MyGraph); to open the graph in a separated window. |