aspose.diagram
Class DataRecordSet

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

Constructor Summary
DataRecordSet()
           Constructor.
 
Property Getters/Setters Summary
functiongetADOData()
functionsetADOData(value)
           Contains XML that conforms to the ADO classic XML schema for an ADO recordset and that describes the data in the data recordset.
functiongetAutoLinkComparison()
           Defines a rule that compares a column in the parent DataRecordset element with a shape data item from the last successful automatic linking action performed in the user interface.
functiongetChecksum()
functionsetChecksum(value)
           A checksum value, generated by Visio, and based on data-recordset properties. Set this attirbute to 0; Visio recalculates this value at runtime.
functiongetCommand()
functionsetCommand(value)
           The command string used to query data from the data source.
functiongetConnectionID()
functionsetConnectionID(value)
           The connection ID for the associated DataConnection object. Does not exist for XML data sources.
functiongetDataColumns()
           Contains all the DataColumn elements in a data recordset.
functiongetID()
functionsetID(value)
           The data recordset ID, unique within the document.
functiongetName()
functionsetName(value)
           The display (or "friendly") name of the data recordset.
functiongetNextRowID()
functionsetNextRowID(value)
           The next available Visio row ID.
functiongetOptions()
functionsetOptions(value)
           Options to apply to the data recordset. Possible values can be any combination of one or more of those shown in the following table. The value of the property is OptionsValue integer constant.
functiongetPrimaryKeys()
           Identifies one or more primary-key columns in the data recordset.
functiongetRefreshConflicts()
           Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. RowID - Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. ShapeID - Shape ID of the shape involved in the conflict. PageID - Page ID of the shape involved in the conflict.
functiongetRefreshInterval()
functionsetRefreshInterval(value)
           How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.
functiongetRefreshNoReconciliationUI()
functionsetRefreshNoReconciliationUI(value)
           Whether the data-reconciliation user interface should be disabled. True (1) to disable the user interface (UI). False (0) to enable the UI. The value of the property is BOOL integer constant.
functiongetRefreshOverwriteAll()
functionsetRefreshOverwriteAll(value)
           Whether to overwrite user changes to shape data items in shapes linked to data when the data recordset is refreshed. The value of the property is BOOL integer constant.
functiongetReplaceLinks()
functionsetReplaceLinks(value)
           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.
functiongetRowMaps()
           Maps a data-recordset row to a shape. RowID - Row ID of the row, unique within the data recordset. ShapeID - Shape ID of the shape linked to data in the data-recordset row identified by RowID. PageID - Page ID of the shape linked to data in the data-recordset row identified by RowID.
functiongetRowOrder()
functionsetRowOrder(value)
           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. The value of the property is BOOL integer constant.
functiongetTimeRefreshed()
           The date and time the data recordset was last refreshed.
 
Method Summary
functionrefresh(connectionType)
           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.
 

Constructor Detail

DataRecordSet

function DataRecordSet()
Constructor.

Property Getters/Setters Detail

getID/setID : long 

function getID() / function setID(value)
The data recordset ID, unique within the document.

getConnectionID/setConnectionID : long 

function getConnectionID() / function setConnectionID(value)
The connection ID for the associated DataConnection object. Does not exist for XML data sources.

getCommand/setCommand : String 

function getCommand() / function setCommand(value)
The command string used to query data from the data source.

getOptions/setOptions : Number 

function getOptions() / function setOptions(value)
Options to apply to the data recordset. Possible values can be any combination of one or more of those shown in the following table. The value of the property is OptionsValue integer constant.

getTimeRefreshed : DateTime 

function getTimeRefreshed()
The date and time the data recordset was last refreshed.

getNextRowID/setNextRowID : long 

function getNextRowID() / function setNextRowID(value)
The next available Visio row ID.

getName/setName : String 

function getName() / function setName(value)
The display (or "friendly") name of the data recordset.

getRowOrder/setRowOrder : Number 

function getRowOrder() / function setRowOrder(value)
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. The value of the property is BOOL integer constant.

getRefreshOverwriteAll/setRefreshOverwriteAll : Number 

function getRefreshOverwriteAll() / function setRefreshOverwriteAll(value)
Whether to overwrite user changes to shape data items in shapes linked to data when the data recordset is refreshed. The value of the property is BOOL integer constant.

getRefreshNoReconciliationUI/setRefreshNoReconciliationUI : Number 

function getRefreshNoReconciliationUI() / function setRefreshNoReconciliationUI(value)
Whether the data-reconciliation user interface should be disabled. True (1) to disable the user interface (UI). False (0) to enable the UI. The value of the property is BOOL integer constant.

getRefreshInterval/setRefreshInterval : long 

function getRefreshInterval() / function setRefreshInterval(value)
How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.

getReplaceLinks/setReplaceLinks : Number 

function getReplaceLinks() / function setReplaceLinks(value)
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.

getChecksum/setChecksum : long 

function getChecksum() / function setChecksum(value)
A checksum value, generated by Visio, and based on data-recordset properties. Set this attirbute to 0; Visio recalculates this value at runtime.

getADOData/setADOData : String 

function getADOData() / function setADOData(value)
Contains XML that conforms to the ADO classic XML schema for an ADO recordset and that describes the data in the data recordset.

getPrimaryKeys : StringCollection 

function getPrimaryKeys()
Identifies one or more primary-key columns in the data recordset.

getRefreshConflicts : RowCollection 

function getRefreshConflicts()
Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. RowID - Indicates a row in the data recordset linked to a shape that is in conflict after the data recordset is refreshed. ShapeID - Shape ID of the shape involved in the conflict. PageID - Page ID of the shape involved in the conflict.

getRowMaps : RowCollection 

function getRowMaps()
Maps a data-recordset row to a shape. RowID - Row ID of the row, unique within the data recordset. ShapeID - Shape ID of the shape linked to data in the data-recordset row identified by RowID. PageID - Page ID of the shape linked to data in the data-recordset row identified by RowID.

getAutoLinkComparison : AutoLinkComparison 

function getAutoLinkComparison()
Defines a rule that compares a column in the parent DataRecordset element with a shape data item from the last successful automatic linking action performed in the user interface.

getDataColumns : DataColumnCollection 

function getDataColumns()
Contains all the DataColumn elements in a data recordset.

Method Detail

refresh

function refresh(connectionType)
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.
Parameters:
connectionType: Number - A DataConnectionType value. The type of provider which will be used for connectionDataConnectionType.

See Also:
          Aspose.Cells Documentation - the home page for the Aspose.Cellss Product Documentation.
          Aspose.Cells Support Forum - our preferred method of support.