DataRecordsets.Add-Methode (Visio)DataRecordsets.Add Method (Visio)

Fügt ein DataRecordset -Objekt der DataRecordsets -Auflistung durch Verbinden mit und Abrufen von Daten aus einer OLEDB- oder ODBC-Datenquelle.Adds a DataRecordset object to the DataRecordsets collection by connecting to and retrieving data from an OLEDB or ODBC data source.

Hinweis Dieses Visio-Objekt oder dieser Member ist nur für lizenzierte Benutzer von Visio Professional 2013 verfügbar.Note This Visio object or member is available only to licensed users of Visio Professional 2013.

SyntaxSyntax

Ausdruck.expression. Add( _ConnectionIDOrString_ , _CommandString_ , _AddOptions_ , _Name_ )

Ausdruck Eine Variable, die ein DataRecordsets -Objekt darstellt.expression A variable that represents a DataRecordsets object.

ParameterParameters

NameName Erforderlich/OptionalRequired/Optional DatentypData type BeschreibungDescription
ConnectionIDOrStringConnectionIDOrString ErforderlichRequired VariantVariant Die ID des vorhandenen DataConnection -Objekts oder der Verbindungszeichenfolge eine neue Datenquelle Verbindung an.The ID of an existing DataConnection object or the connection string to specify a new data-source connection.
CommandStringCommandString ErforderlichRequired StringString Abfragezeichenfolge, die die Datenbanktabelle oder das Excel-Arbeitsblatt und die Felder (Spalten) in der Tabelle bzw. in dem Arbeitsblatt angibt, die die abzufragenden Daten enthalten.Query string that specifies the database table or Excel worksheet and the fields (columns) within the table or worksheet that contain the data you want to query.
AddOptionsAddOptions ErforderlichRequired LongLong Optionen, die Eigenschaften des hinzuzufügenden Datenrecordsets bestimmen.Options that determine properties of the data recordset to add. Eine Kombination von mindestens einen Aufzählungswert aus VisDataRecordsetAddOptions.A combination of one or more enumerated value from VisDataRecordsetAddOptions. Weitere Informationen finden Sie unter "Hinweise".For more information, see Remarks.
NameName OptionalOptional StringString Weist einen Anzeigenamen für das DataRecordset -Objekt hinzugefügt wird.Assigns a display name to the DataRecordset object being added.

RückgabewertReturn value

DataRecordsetDataRecordset

BemerkungenRemarks

Sie können eine gültige Verbindungszeichenfolge für den Parameter ConnectionIDOrString durch übergeben zuerst mit der Datenauswahl-Assistent in der Visio-Benutzeroberfläche (UI) für den gleichen Verbindungsaufbau bestimmen Aufzeichnen eines Makros beim Ausführen des Assistenten, und klicken Sie dann die Verbindungszeichenfolge kopieren aus dem Makrocode.You can determine an appropriate connection string to pass to the ConnectionIDOrString parameter by first using the Data Selector Wizard in the Visio user interface (UI) to make the same connection, recording a macro while running the wizard, and then copying the connection string from the macro code.

Eine einfache Möglichkeit zum Wiederverwenden einer vorhandenen Verbindungs Daten ist den Wert der DataConnection -Eigenschaft eines vorhandenen DataRecordset -Objekts für den ConnectionIDOrString-Parameter übergeben.An easy way to reuse an existing data connection is to pass the DataConnection property value of an existing DataRecordset object for the ConnectionIDOrString parameter. Verwenden Sie die nachstehend aufgeführte Syntax.Use the following syntax:

NewDataRecordset  = DataRecordsets.Add(ExistingDataRecordset .DataConnection.ID, CommandString, AddOptions, Name)

Wenn Sie die ID eines vorhandenen DataConnection -Objekts übergeben, die derzeit von einer oder mehreren anderen Datenrecordsets verwendet wird, werden alle Datenrecordsets für den Parameter ConnectionIDOrString durchgeführte Gruppe Recordset-Objekt .For the ConnectionIDOrString parameter, if you pass the ID of an existing DataConnection object that is currently being used by one or more other data recordsets, all the data recordsets become a transacted group recordset . Alle Datenrecordsets in der Gruppe werden aktualisiert, wenn eine Aktualisierung der Daten ausgeführt wird.All data recordsets in the group are refreshed whenever a data-refresh operation occurs.

AddOptions-Parameters kann eine Kombination aus einem oder mehreren der folgenden Werte aus der VisDataRecordsetAddOptions -Aufzählung, die in der Visio-Typbibliothek deklariert ist.The AddOptions parameter can be a combination of one or more of the following values from the VisDataRecordsetAddOptions enumeration, which is declared in the Visio type library. Der Standardwert ist NULL (0), der angibt, dass keine der Optionen festgelegt werden.The default is zero (0), which specifies that none of the options be set.

KonstanteConstant WertValue BeschreibungDescription
visDataRecordsetNoExternalDataUIvisDataRecordsetNoExternalDataUI 11 Verhindert, dass Daten im neuen Datenrecordset im Fenster Externe Daten angezeigt werden.Prevents data in the new data recordset from being displayed in the External Data window.
visDataRecordsetNoRefreshUIvisDataRecordsetNoRefreshUI 22 Verhindert, dass das Datenrecordset im Dialogfeld Daten aktualisieren angezeigt wird.Prevents the data recordset from being displayed in the Refresh Data dialog box.
visDataRecordsetNoAdvConfigvisDataRecordsetNoAdvConfig 44 Verhindert, dass das Datenrecordset im Dialogfeld Aktualisierung konfigurieren angezeigt wird.Prevents the data recordset from being displayed in the Configure Refresh dialog box.
visDataRecordsetDelayQueryvisDataRecordsetDelayQuery 88 Fügt ein Datenrecordset hinzu, doch die CommandString-Abfrage erst beim nächsten Öffnen Sie die Refresh -Methode aufrufen, wird nicht ausgeführt.Adds a data recordset but does not execute the CommandString query until the next time you call the Refresh method.
visDataRecordsetDontCopyLinksvisDataRecordsetDontCopyLinks 1616 Fügt ein Datenrecordset, Shape-Daten Hyperlinks jedoch nicht in die Zwischenablage kopiert werden, wenn Shapes kopiert oder ausgeschnitten werden.Adds a data recordset, but shape-data links are not copied to the Clipboard when shapes are copied or cut.

Wenn Sie diese Werte zugewiesen haben, können sie während der Lebensdauer des DataRecordset-Objekts nicht mehr geändert werden.Once you assign these values, you cannot change them for the life of the DataRecordset object.

Der Parameter Name ist eine optionale Zeichenfolge, die Sie dem Datenrecordset einen Anzeigenamen zuweisen kann.The Name parameter is an optional string that lets you assign the data recordset a display name. Wenn Sie angeben, dass das Fenster Externe Daten in der Visio-UI angezeigt werden, wird auf der Registerkarte Fenster Externe Daten , das die das hinzugefügte Datenrecordset entspricht, der Namen, den Sie für dieses Argument übergeben angezeigt.If you specify that the External Data window be displayed in the Visio UI, the name you pass for this argument appears on the tab of the External Data window that corresponds to the data recordset added.

Wenn die Add -Methode erfolgreich ist, werden die folgenden Aktionen ausgeführt:If the Add method succeeds, it performs the following actions:

  • Erstellt ein DataRecordset -Objekt und weist sie den im Parameter Name angegebenen Namen.Creates a DataRecordset object and assigns it the name specified in the Name parameter. Wenn Sie keinen Namen angeben, wird von Visio dem Datenrecordset den Namen der Datenbanktabelle, die die Quelle der Daten ist.If you do not specify a name, Visio assigns the data recordset the name of the database table that is the source of the data.

  • Ordnet ein neues oder vorhandenes DataConnection -Objekt mit dem DataRecordset -Objekt.Associates a new or existing DataConnection object with the DataRecordset object.

  • Öffnet das Fenster Externe Daten in der Visio-UI, sofern visDataRecordsetNoExternalDataUI nicht festgelegt ist.Opens the External Data window in the Visio UI, unless visDataRecordsetNoExternalDataUI is set.

Sofern Sie VisDataRecordsetDelayQuery als Teil des AddOptions-Parameters übergeben, führt die Add -Methode auch Folgendes aus:Unless you pass visDataRecordsetDelayQuery as part of the AddOptions parameter, the Add method also does the following:

  • Die im CommandString-Parameter angegebene Abfragezeichenfolge wird ausgeführt, und die daraus resultierenden Daten werden abgerufen.Executes the query string specified in the CommandString parameter and retreive the resulting data.

  • Die Datentypen der Spalten in der Datenquelle werden den entsprechenden Datentypen in Visio zugewiesen. Gleichzeitig werden durch das Filtern der Ergebnisse Datenquellenspalten entfernt, die nicht mit Visio-Shapes verknüpft werden können, da sie keinen entsprechenden Visio-Datentyp aufweisen.Maps the data types of the columns of the data source to equivalent Visio data types, while filtering the results to remove data-source columns that cannot be linked to Visio shapes because they have no equivalent Visio data type. Binärdaten oder Programmen Datentypen wie UserDefined , Kapitel und IDispatchkönnen insbesondere kann nicht importiert werden.In particular, you cannot import binary data or esoteric data types such as UserDefined , Chapter , and IDispatch.

  • Jeder Zeile im Datenrecordset eine Zeilen-ID zugewiesen.Assigns a row ID to each row in the data recordset. Weitere Informationen zu Zeilen-IDs finden Sie unter DataRecordset.GetDataRowIDs Thema.For more information about row IDs, see DataRecordset.GetDataRowIDs topic.

Hinweis Die Add -Methode schlägt fehl und gibt eine Ausnahme zurück, falls Fehler, Netzwerk Timeouts oder Datenbankberechtigungen auftreten.Note The Add method fails and returns an exception if it encounters network connection errors, network time outs, or database permission errors. Wenn die Option VisDataRecordsetDelayQuery festgelegt ist, unter den gleichen Umständen kann Hinzufügen ein neuen Datenrecordsets erfolgreich hinzugefügt, aber die Aktualisierung kann fehlschlagen.If the visDataRecordsetDelayQuery option is set, under the same circumstances Add may successfully add a new data recordset, but refresh may fail.

BeispielExample

Der folgende Microsoft Visual Basic für Applikationen (VBA)-Makro zeigt die Verwendung der Add -Methode für die Verbindung eine Visio-Zeichnung mit Daten in BEISPIELMAKRO. XLS, Microsoft Office Excel-Arbeitsmappe, die bei der Installation von Visio an den Standardpfad für die Datei unter C:\Program Files\Microsoft Office\OFFICE12\SAMPLES\1033\ installiert ist.The following Microsoft Visual Basic for Applications (VBA) macro shows how you might use the Add method to connect a Visio drawing to data in ORGDATA.XLS, a Microsoft Office Excel workbook that is installed at C:\Program Files\Microsoft Office\OFFICE12\SAMPLES\1033\ when you install Visio at the default file path.

In diesem Beispiel wird es besteht keine vorhandenen Datenverbindung, damit der erste Parameter der Add -Methode, wir StrConnection , die Verbindungszeichenfolge übergeben.In this example, there is no existing data connection, so for the first parameter of the Add method, we pass strConnection , the connection string. Für den zweiten Parameter übergeben wir StrCommand , die Befehlszeichenfolge an, die Visio anweist alle Spalten des Arbeitsblatts auszuwählen, die wir angeben.For the second parameter, we pass strCommand , the command string, which directs Visio to select all columns from the worksheet we specify. Für den dritten Parameter der Add -Methode wir Nullwert übergeben, um das Standardverhalten des Datenrecordsets anzugeben, und den letzten-Parameter übergeben "Org Data" , den Anzeigenamen, den wir das Datenrecordset zuweisen möchten.For the third parameter of the Add method, we pass zero to specify default behavior of the data recordset, and for the last parameter, we pass "Org Data" , the display name we want to assign to the data recordset.

Public Sub AddDataRecordset_Example() 
 
    Dim strConnection As String 
    Dim strCommand As String 
    Dim strOfficePath As String 
    Dim vsoDataRecordset As Visio.DataRecordset 
 
    strOfficePath = Visio.Application.Path     
    strConnection = "Provider=Microsoft.ACE.OLEDB.12.0;" _ 
                       & "User ID=Admin;" _ 
                       & "Data Source=" + strOfficePath + "SAMPLES\1033\ORGDATA.XLS;" _ 
                       & "Mode=Read;" _ 
                       & "Extended Properties=""HDR=YES;IMEX=1;MaxScanRows=0;Excel 12.0;"";" _ 
                       & "Jet OLEDB:Engine Type=34;" 
 
    strCommand = "SELECT * FROM [Sheet1$]" 
 
    Set vsoDataRecordset = ActiveDocument.DataRecordsets.Add(strConnection, strCommand, 0, "Org Data") 
 
End Sub