DataRecordSet Element

Article
09/15/2015

Stores, formats, refreshes, and exposes data queried from a database in Microsoft Visio.

Attributes

Required unsigned integer. The data recordset ID, unique within the document.

ConnectionID

Optional unsigned integer. The connection ID for the associated DataConnection object. Does not exist for XML data sources.

Command

Optional string. The command string used to query data from the data source.

Options

Optional unsigned integer. Options to apply to the data recordset. Possible values can be any combination of one or more of those shown in the following table.

Name	Value	Description
NoExternalDataUI	1	Prevents data in the data recordset from being displayed in the External Data window.
NoAdvConfig	4	Limits the control users have of how the data recordset is refreshed in the Configure Refresh dialog box for the data recordset. In particular, users cannot change the primary key or specify when shape data should be overwritten; however, users can set the refresh interval and can change the data source.
NoRefreshUI	2	Prevents the data recordset from being displayed in the Refresh Data dialog box.
NoLinkOnPaste	16	Does not copy shape-data links to the Clipboard when shapes are copied or cut.
DelayQuery	8	Does not execute the command-string query until the next time the data recordset is refreshed..

TimeRefreshed

Optional Date. The date and time the data recordset was last refreshed.

NextRowID

Optional unsigned integer. The next available Visio row ID.

Name

Optional string. The display (or "friendly") name of the data recordset.

RowOrder

Optional Boolean. Whether to use the order of the rows in the data recordset as the primary key. True (1) if row IDs are determined by row order. False (0) if row IDs are determined by values in the primary key column(s) of the data recordset.

RefreshOverwriteAll

Optional Boolean. Whether to overwrite user changes to shape data items in shapes linked to data when the data recordset is refreshed.

RefreshNoReconciliationUI

Optional Boolean. Whether the data-reconciliation user interface should be disabled. True (1) to disable the user interface (UI). False (0) to enable the UI.

RefreshInterval

Optional unsigned integer. How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.

ReplaceLinks

Optional integer. Defines how shape-data links are treated when shapes are copied or cut. 1 to replace existing links in the target shape. 0 to maintain existing links in the target shape. If this attribute is absent, Visio asks the user whether to replace links on copy or cut.

Checksum

Optional unsigned integer. A checksum value, generated by Visio, and based on data-recordset properties. Set this attirbute to 0; Visio recalculates this value at runtime.