asposediagram.api

Class DataRecordSet

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

Constructor Summary
DataRecordSet()
Constructor.
 
Property Getters/Setters Summary
methodgetADOData()
method
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.
methodgetAutoLinkComparison()
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.
methodgetChecksum()
method
           A checksum value, generated by Visio, and based on data-recordset properties. Set this attribute to 0; Visio recalculates this value at runtime.
methodgetCommand()
method
setCommand(value)
           The command string used to query data from the data source.
methodgetConnectionID()
method
           The connection ID for the associated DataConnection object. Does not exist for XML data sources.
methodgetDataColumns()
Contains all the DataColumn elements in a data recordset.
methodgetID()
method
setID(value)
           The data recordset ID, unique within the document.
methodgetName()
method
setName(value)
           The display (or "friendly") name of the data recordset.
methodgetNextRowID()
method
           The next available Visio row ID.
methodgetOptions()
method
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.
methodgetPrimaryKeys()
Identifies one or more primary-key columns in the data recordset.
methodgetRefreshConflicts()
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.
methodgetRefreshInterval()
method
           How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.
methodgetRefreshNoReconciliationUI()
method
           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.
methodgetRefreshOverwriteAll()
method
           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.
methodgetReplaceLinks()
method
           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.
methodgetRowMaps()
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.
methodgetRowOrder()
method
           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.
methodgetTimeRefreshed()
method
           The date and time the data recordset was last refreshed.
 

    • Constructor Detail

      • DataRecordSet

        DataRecordSet()
        Constructor.
    • Property Getters/Setters Detail

      • getID/setID : long 

        long getID() / setID(value)
        
        The data recordset ID, unique within the document.
      • getConnectionID/setConnectionID : long 

        long getConnectionID() / setConnectionID(value)
        
        The connection ID for the associated DataConnection object. Does not exist for XML data sources.
      • getCommand/setCommand : String 

        String getCommand() / setCommand(value)
        
        The command string used to query data from the data source.
      • getOptions/setOptions : int 

        int getOptions() / 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/setTimeRefreshed : DateTime 

        DateTime getTimeRefreshed() / setTimeRefreshed(value)
        
        The date and time the data recordset was last refreshed.
      • getNextRowID/setNextRowID : long 

        long getNextRowID() / setNextRowID(value)
        
        The next available Visio row ID.
      • getName/setName : String 

        String getName() / setName(value)
        
        The display (or "friendly") name of the data recordset.
      • getRowOrder/setRowOrder : int 

        int getRowOrder() / 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 : int 

        int getRefreshOverwriteAll() / 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 : int 

        int getRefreshNoReconciliationUI() / 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 

        long getRefreshInterval() / setRefreshInterval(value)
        
        How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.
      • getReplaceLinks/setReplaceLinks : int 

        int getReplaceLinks() / 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 

        long getChecksum() / setChecksum(value)
        
        A checksum value, generated by Visio, and based on data-recordset properties. Set this attribute to 0; Visio recalculates this value at runtime.
      • getADOData/setADOData : String 

        String getADOData() / 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 

        StringCollection getPrimaryKeys()
        
        Identifies one or more primary-key columns in the data recordset.
      • getRefreshConflicts : RowCollection 

        RowCollection 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 

        RowCollection 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 

        AutoLinkComparison 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.