3.7.5.102 Wks.DC

Data Connector added to a worksheet are handled as objects in Origin. The column attributes can be accessed and changed using the properties in the table below.

Note:

For workbook level controls of Data Connector, please refer to Wbk object.

Properties and Methods

Property Access Description
wks.DC.Allow() Read/write
numeric
Check if the worksheet is used as the destination of a Data Connector:

0 = false,
1 = true,
2 = clean up existing File Import information. If an analysis template imported data with import X-Function in the first place and uses Data Connector to import data later (this may be the case if the template was made in some old version like Origin2019 and reused in newer version like Origin2020b), set Allow to 2 to clear old import info saved in the worksheet:
wks.DC.allow(2)=;
It will return 1 if worksheet is the proper type and File Import Info if present has been removed.

wks.DC.Flags Read/write
numeric
Append data rows in imported file to active worksheet. As of Origin 2021, for Data Connector = Text/CSV only:

0 = (default)) Do not append
256 = append data rows to current sheet on import

wks.DC.Ignore Read/Write
numeric
Ignore Data Connector icon. 0 = Data Connector icon is usable, 1 = Data Connector icon is neither selectable nor usable.
wks.DC.Import() Read/write
numeric
Import data into current sheet, without opening the Import Options dialog.
wks.dc.optn$ Read/write
string
Get or set connector settings as a string. Supported only for CSV, Excel etc connector types using its own GetN dialog.
wks.DC.Path$ Read/Write
string
Absolute path of Connector Data Source, both for local files and for web data as long as the local cache has not expired or been cleared (see @CFDT and delete -web).
wks.DC.Reset() Read/write
numeric
Clear imported data. The connection will remain.
wks.DC.Sel$ Read/Write
string
Specify the selection of sheets/table inside the data source. Use for file formats such as NetCDF or TDMS. Does not apply to formats such as CSV that import into a single sheet. See Examples below.
wks.DC.Source$ Read/write
string
Relative path of data source.
wks.DC.Sstatus Read Only Source Status:

0 = not dirty
1 = not imported yet
2 = imported but data is cleared, either by Clear Worskheet, or when open from OPJU
3 = dirty, outside file is newer
4 = web content, maybe dirty

wks.DC.SType Read/write
numeric
Data source type. It can be

0 = absolute file path, this is the only value that is read-write
1 = project relative file path
2 = common data relative file path
3 = web

wks.DC.Valid Read/write
numeric
Check the status of Data Connector added to the worksheet:

0 = has no Data Connector,
2 = worksheet has not been used as destination by any Data Connector,
3 = worksheet is the destination of a Data Connector. You can then use "wks.DC.Source$" to check its data source.
4 = Data Connector has an invalid data source.
5 = source changed.

Examples

//This example shows how to import a CSV file by Data Connector
newbook;
wbook.dc.add("CSV");
wks.dc.source$=System.path.program$+"Samples\Batch Processing\T275K.csv";
wks.dc.import();
//This example uses the NetCDF Connector to do partial import of web-stored multi-dimensional data in a .nc file
newbook mat:=1;
wbk.dc.add("NetCDF");
wks.dc.source$="https://psl.noaa.gov/thredds/fileServer/Datasets/cpc_us_precip/precip.V1.0.mon.mean.nc";
// import z=1 to end, read 1 skip 11; lon shift, lat flip, formula v*0.0393701
wks.dc.sel$=NetCDF/precip[1:0|1-11][y#][x/2]v*0.0393701;
wks.dc.import();
//Import data to all DC-containing books in the Project Explorer (PE) folder
doc -ef LBC { wks.dc.import(); };
//Import data to all DC-containing books in the entire project (all PE folders)
doc -e LBC { wks.dc.import(); };