com.aspose.diagram

Class DataRecordSet

  • java.lang.Object
    • com.aspose.diagram.DataRecordSet
public class DataRecordSet 
extends java.lang.Object

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

Constructor Summary
DataRecordSet()
Constructor.
 
Property Getters/Setters Summary
java.lang.StringgetADOData()
void
setADOData(java.lang.Stringvalue)
           Contains XML that conforms to the ADO classic XML schema for an ADO recordset and that describes the data in the data recordset.
AutoLinkComparisongetAutoLinkComparison()
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.
longgetChecksum()
void
setChecksum(longvalue)
           A checksum value, generated by Visio, and based on data-recordset properties. Set this attirbute to 0; Visio recalculates this value at runtime.
java.lang.StringgetCommand()
void
setCommand(java.lang.Stringvalue)
           The command string used to query data from the data source.
longgetConnectionID()
void
setConnectionID(longvalue)
           The connection ID for the associated DataConnection object. Does not exist for XML data sources.
DataColumnCollectiongetDataColumns()
Contains all the DataColumn elements in a data recordset.
longgetID()
void
setID(longvalue)
           The data recordset ID, unique within the document.
java.lang.StringgetName()
void
setName(java.lang.Stringvalue)
           The display (or "friendly") name of the data recordset.
longgetNextRowID()
void
setNextRowID(longvalue)
           The next available Visio row ID.
intgetOptions()
void
setOptions(intvalue)
           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.
System.Collections.Specialized.StringCollectiongetPrimaryKeys()
Identifies one or more primary-key columns in the data recordset.
RowCollectiongetRefreshConflicts()
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.
longgetRefreshInterval()
void
           How often (in minutes) Visio refreshes the data recordset automatically. This value must be 1 or larger.
intgetRefreshNoReconciliationUI()
void
           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.
intgetRefreshOverwriteAll()
void
           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.
intgetReplaceLinks()
void
setReplaceLinks(intvalue)
           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.
RowCollectiongetRowMaps()
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.
intgetRowOrder()
void
setRowOrder(intvalue)
           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.
com.aspose.cells.DateTimegetTimeRefreshed()
The date and time the data recordset was last refreshed.
 

    • Constructor Detail

      • DataRecordSet

        public DataRecordSet()
        Constructor.
    • Property Getters/Setters Detail

      • getID/setID

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

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

        public java.lang.String getCommand() / public void setCommand(java.lang.String value)
        
        The command string used to query data from the data source.
      • getOptions/setOptions

        public int getOptions() / public void setOptions(int 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

        public com.aspose.cells.DateTime getTimeRefreshed()
        
        The date and time the data recordset was last refreshed.
      • getNextRowID/setNextRowID

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

        public java.lang.String getName() / public void setName(java.lang.String value)
        
        The display (or "friendly") name of the data recordset.
      • getRowOrder/setRowOrder

        public int getRowOrder() / public void setRowOrder(int 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

        public int getRefreshOverwriteAll() / public void setRefreshOverwriteAll(int 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

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

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

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

        public long getChecksum() / public void setChecksum(long 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

        public java.lang.String getADOData() / public void setADOData(java.lang.String 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

        public System.Collections.Specialized.StringCollection getPrimaryKeys()
        
        Identifies one or more primary-key columns in the data recordset.
      • getRefreshConflicts

        public 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

        public 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

        public 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.
      • getDataColumns

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