Méthode DataRecordset.SetPrimaryKey (Visio)

Article
04/07/2023

Définit la valeur de paramètre de clé primaire et le nom de la ou des colonnes de clé primaire du jeu d'enregistrements de données.

Remarque

Cet objet ou ce membre Visio est disponible uniquement pour les titulaires d’une licence d’utilisation de Visio Professionnel 2013.

Syntaxe

expression. SetPrimaryKey (PrimaryKeySettings, PrimaryKey())

Expression Expression qui renvoie un objet DataRecordset .

Parameters

Nom	Requis/Facultatif	Type de données	Description
PrimaryKeySettings	Requis	VisPrimaryKeySettings	Paramètre de clé primaire pour le jeu d'enregistrements de données. Voir la section Remarques pour les valeurs possibles.
PrimaryKey()	Requis	[SAFE-ARRAY]	Tableau de variables String.

Valeur renvoyée

Aucune

Remarques

Utilisez la méthode SetPrimaryKey pour spécifier le paramètre de clé primaire et le nom de la ou des colonnes de clé primaire pour le jeu d’enregistrements de données. Vous spécifiez le paramètre de clé primaire du jeu d'enregistrements de données en transmettant une valeur issue de l'énumération VisPrimaryKeySettings pour le paramètre ParamètresCléPrimaire. La valeur par défaut (lorsque vous ne spécifiez pas de clé primaire) est visKeyRowOrder, ce qui signifie que Visio identifie les lignes de jeu d'enregistrements de données par ordre des lignes.

Vous pouvez spécifier que le jeu d’enregistrements de données a une seule colonne ou une clé primaire composite. Une clé primaire avec une seule colonne base l'identification de lignes sur les valeurs d'une seule colonne. Une clé primaire composite utilise deux ou plusieurs colonnes pour identifier une ligne de manière unique. Les valeurs possibles pour ParamètresCléPrimaire sont indiquées dans ce tableau.

Constante	Valeur	Description
visKeyRowOrder	1	Utiliser l'ordre de lignes comme clé primaire.
visKeySingle	2	Utiliser une seule colonne comme colonne de clé primaire.
visKeyComposite	3	Utiliser plusieurs colonnes comme colonnes de clé primaire.

Pour le paramètre PrimaryKey(), transmettez un tableau d’une ou de plusieurs chaînes qui représentent le nom de la ou des colonnes que vous souhaitez définir comme colonne(s) de clé primaire. La valeur transmise au paramètre ParamètresCléPrimaire doit correspondre au nombre d'éléments du tableau. Lorsque vous définissez des clés primaires, veillez à ce que la ou les colonnes que vous choisissez en tant que colonnes de clé primaire contiennent des valeurs uniques (ou ensembles de valeurs) pour chaque ligne.

Utilisez la méthode GetPrimaryKey pour déterminer le paramètre de clé primaire actuel pour le jeu d’enregistrements de données, ainsi que le nom de la ou des colonnes, le cas échéant, qui sont actuellement définies comme colonne ou colonnes de clé primaire.

Exemple

La macro Microsoft Visual Basic pour Applications (VBA) ci-dessous illustre comment utiliser la méthode SetPrimaryKey pour spécifier le paramètre de clé primaire d'un jeu d'enregistrements de données ainsi que le nom de la colonne de clé primaire. La macro trouve le jeu d'enregistrements de données dernièrement créé qui est associé au document, spécifie le paramètre de clé primaire (visKeySingle, pour indiquer une clé primaire de colonne unique), puis définit le nom de la colonne de clé primaire.

Avant d'exécuter cette macro, créez au moins un jeu d'enregistrements de données dans le document actif, puis remplacez la variable NomColonne dans le code par le nom de la colonne du jeu d'enregistrements de données à spécifier en tant que colonne de clé primaire.

Public Sub SetPrimaryKey_Example() 
 
    Dim vsoDataRecordset As Visio.DataRecordset 
    Dim intCount As Integer 
    Dim aPrimaryKeyColumns() As String 
     
    intCount = ThisDocument.DataRecordsets.Count 
    aPrimaryKeyColumns(0) = "columnName " 
    Set vsoDataRecordset = ThisDocument.DataRecordsets(intCount) 
    vsoDataRecordset.SetPrimaryKey visKeySingle, aPrimaryKeyColumns 
    
End Sub

Assistance et commentaires

Avez-vous des questions ou des commentaires sur Office VBA ou sur cette documentation ? Consultez la rubrique concernant l’assistance pour Office VBA et l’envoi de commentaires afin d’obtenir des instructions pour recevoir une assistance et envoyer vos commentaires.

Partager via