DataRecordset.SetPrimaryKey メソッド (Visio)

データ レコードセットの主キーの設定値および主キーの列の名前を設定します。

注:

この Visio オブジェクトまたはメンバーは Visio Professional 2013 のライセンス ユーザーのみが使用できます。

構文

式。SetPrimaryKey (PrimaryKeySettings, PrimaryKey())

式DataRecordset オブジェクトを返す式。

パラメーター

名前	必須 / オプション	データ型	説明
PrimaryKeySettings	必須	VisPrimaryKeySettings	データ レコードセットの主キー設定を出力します。 設定される値については、「備考」を参照してください。
PrimaryKey()	必須	[SAFE-ARRAY]	文字列型 (String) 変数の配列を指定します。

戻り値

なし

解説

SetPrimaryKey メソッドを使用して、主キーの設定と、データ レコードセットの主キー列または列の名前を指定します。 データ レコードセットの主キーを設定するには、PrimaryKeySettings パラメーターとして VisPrimaryKeySettings 列挙の値を渡します。 主キーを指定しない場合の既定値は visKeyRowOrder で、行の順序によってデータ レコードセットの行を識別します。

データ レコードセットに単一列または複合主キーを指定できます。 単一列の主キーは、単一のカラムの値に基づいて行を識別します。 後者の場合、複数の列の組み合わせで、行を一意に識別します。 PrimaryKeySettings に設定される値は、次のとおりです。

定数	値	説明
visKeyRowOrder	1	主キーとして行の順序を使用します。
visKeySingle	2	主キーの列として単一の列を使用します。
visKeyComposite	3	主キーの列として複数の列を使用します。

PrimaryKey() パラメーターの場合は、主キー列として設定する列または列の名前を表す 1 つ以上の文字列の配列を渡します。 PrimaryKeySettings パラメーターとして渡す値は、配列のアイテム数に対応する必要があります。 主キーを設定する場合は、主キーの列となる 1 つ、または、複数の列には、各行に一意の値が含まれていることを確認してください。

GetPrimaryKey メソッドを使用して、データ レコードセットの現在の主キー設定と、現在主キー列または列として設定されている列または列 (存在する場合) の名前を決定します。

例

次の Microsoft Visual Basic for Applications (VBA) マクロは、SetPrimaryKey メソッドを使用して、データ レコードセットの主キーの設定および主キーの列の名前を指定する方法を示します。 このマクロは、最後に作成された、図面に関連付けられているデータ レコードセットを検索し、主キーの設定 (単一の列による主キーを示す visKeySingle) を指定し、主キーの列の名前を設定します。

このマクロを実行する前に、現在の図面にデータ レコードセットを少なくとも 1 つ作成し、コードの columnName 変数を、主キーの列として指定するデータ レコードセット内の列の名前で置き換えてください。

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

サポートとフィードバック

Office VBA またはこの説明書に関するご質問やフィードバックがありますか？ サポートの受け方およびフィードバックをお寄せいただく方法のガイダンスについては、Office VBA のサポートおよびフィードバックを参照してください。