DataRecordset Object Members
Visio Automation Reference |
Stores, formats, refreshes, and exposes data queried from a database in Microsoft Office Visio.
Methods
Name | Description | |
---|---|---|
Delete | Deletes the DataRecordset object from the DataRecordsetscollection of the document. | |
GetAllRefreshConflicts | Returns an array that contains shapes linked to data rows that have non-resolved conflicts after a data recordset is refreshed. | |
GetDataRowIDs | Gets an array of the IDs of all the rows in the data recordset | |
GetMatchingRowsForRefreshConflict | Returns an array of the row IDs of data-recordset rows linked to a shape that are in conflict after the data recordset is refreshed. | |
GetPrimaryKey | Gets the primary key setting and the name of the primary key column or columns for the data recordset. | |
GetRowData | Gets the data in all columns in the specified row. | |
Refresh | Executes the query string associated with the connected (non-XML-based) DataRecordset and updates linked shapes with new data from the data source returned by the query. | |
RefreshUsingXML | Updates linked shapes with data contained in the string that conforms to the ADO classic XML schema passed to the method as a parameter. | |
RemoveRefreshConflict | Clears information about a conflict for a data-linked shape from the current document. | |
SetPrimaryKey | Sets the primary key setting value and the name of the primary key column or columns for the data recordset. |
Properties
Name | Description | |
---|---|---|
Application | Returns the instance of Microsoft Office Visio associated with a DataRecordset object. Read-only. | |
CommandString | Gets or sets the command string used to query the data source to create a data recordset or refresh an existing one. Read/write. | |
DataAsXML | Returns an XML string that fully describes a data recordset and conforms to the Microsoft ActiveX® Data Objects (ADO) classic XML schema. Read-only. | |
DataColumns | Returns the DataColumns collection associated with the DataRecordset object. Read-only. | |
DataConnection | Returns the DataConnection object associated with the DataRecordset object. Read-only. | |
Document | Gets the Document object that contains the DataRecordset object. Read-only. | |
EventList | Returns the EventList collection of the DataRecordset object. Read-only. | |
ID | Gets the unique identifier of the DataRecordset object assigned by Visio. Read-only. | |
LinkReplaceBehavior | Gets or sets how existing links between shapes and data rows are handled when methods that link shapes to data are called. Read/write. | |
Name | Gets or sets the display name of the data recordset. Read/write. | |
ObjectType | Returns visObjTypeDataRecordset, the type of a DataRecordset object. Read-only. | |
RefreshInterval | Gets or sets how often Microsoft Office Visio automatically refreshes the data recordset. Read/write. | |
RefreshSettings | Gets and sets options that determine how the data recordset is refreshed. Read/write. | |
Stat | Returns status information for an object. Read-only. | |
TimeRefreshed | Returns the date and time the data recordset was last refreshed. Read-only. |
Events
Name | Description | |
---|---|---|
BeforeDataRecordsetDelete | Occurs before a DataRecordset object is deleted from the DataRecordsets collection. . | |
DataRecordsetChanged | Occurs when a data recordset changes as a result of being refreshed. |