Hide Table of Contents

Add Custom File Reference Example (VB.NET)

This example shows how to add a custom file reference to a file in the vault.

NOTE: If using the .NET Framework 4.0 primary interop assembly provided with SOLIDWORKS Enterprise PDM, see Using .NET Framework 4.0 in Stand-alone Applications.

' Preconditions:
' 1. Start Microsoft Visual Studio 2010.
'    a. Click File > New > Project > Visual Basic > Windows Forms Application.
'    b. Type CustRef in Name.
'    c. Click Browse and navigate to the folder where to create 
'       the project.
'    d. Click OK
'    e. Click Show All Files in the Solution Explorer toolbar and expand 
'       Form1.vb in the Solution Explorer.
'    f. Create a form similar to the form shown above and change:
'       1. Top label to VaultsLabel.
'       2. Combo box to VaultsComboBox.
'       3. List box to CustRefListBox.
'       4. Browse button to BrowseButton.
'       5. Add custom file reference button to AddCustomFileReference.
'    g. Replace the code in Form1.vb with this code.
'    h. Replace the code in Form1.Designer.vb with this code.
' 2. Add EPDM.Interop.epdm.dll as a reference (right-click the project
'    name in the Solution Explorer, click Add Reference, click 
'    Assemblies > Framework in the left-side panel, browse to the top folder of 
'    your SOLIDWORKS Enterprise PDM installation, locate and click 
'    EPDM.Interop.epdm.dll, click Open, click Add, and click Close).
' 3. Right-click EPDM.Interop.epdm in References, click Properties, and set 
'    Embed Interop Types to False to handle methods that pass arrays of 
'    structures.
' 4. Click Debug > Start Debugging or press F5.
' Postconditions: 
' 1. The Add custom references dialog displays.
' 2. Select a vault.
' 3. Click Browse for file to which to add custom reference
'    locate and click a file in the vault, and click Open.
'    The file is checked out.
' 4. In a view of the selected vault, right-click a file and click Copy.

' 5. In the Add custom references dialog, click Add custom file reference.
'    The file that was copied to the clipboard is added as a custom 
'    reference to the checked-out file.
' 6. In the Create File References dialog, click OK.
'    The file is checked in.
' 7. In the Edit User-Defined File References dialog, click OK.
' 8. Close the Add custom references dialog.         
Imports System.IO
Imports System.Xml.Serialization
Imports System.Collections
Imports System.Collections.Generic
Imports System.Data
Imports System.Diagnostics
Imports System.Windows.Forms
Imports System.ComponentModel
Imports EPDM.Interop.epdm
Public Class Form1
    Private vault1 As IEdmVault5 = Nothing
    Public Sub Form1_Load(ByVal sender As System.ObjectByVal e As System.EventArgsHandles MyBase.Load
            Dim vault1 As IEdmVault5 = New EdmVault5()
            Dim vault As IEdmVault8 = DirectCast(vault1, IEdmVault8)
            Dim Views As EdmViewInfo() = Nothing
            vault.GetVaultViews(Views, False)
            For Each View As EdmViewInfo In Views
            If VaultsComboBox.Items.Count > 0 Then
                VaultsComboBox.Text = DirectCast(VaultsComboBox.Items(0), String)
            End If
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message)
        Catch ex As Exception
        End Try
    End Sub
    Public Sub BrowseButton_Click(ByVal sender As System.ObjectByVal e As System.EventArgsHandles BrowseButton.Click
            'Only create a new vault object
            'if one hasn't been created yet
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
            If Not vault1.IsLoggedIn Then
                'Log into selected vault as the current user
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
            'Set the initial directory in the File Open dialog
            CustRefOpenFileDialog.InitialDirectory = vault1.RootFolderPath
            'Show the File Open dialog
            Dim DialogResult As System.Windows.Forms.DialogResult = Nothing
            DialogResult = CustRefOpenFileDialog.ShowDialog()
            'If the user didn't click Open, exit the sub
            If Not (DialogResult = System.Windows.Forms.DialogResult.OK) Then
            End If
            For Each FileName As String In CustRefOpenFileDialog.FileNames
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message)
        Catch ex As Exception
        End Try
    End Sub
    Public Sub AddCustomFileReference_Click(ByVal sender As System.ObjectByVal e As System.EventArgsHandles AddCustomFileReference.Click
            'Only create a new vault object
            'if one hasn't been created yet
            Dim vault2 As IEdmVault7 = Nothing
            If vault1 Is Nothing Then
                vault1 = New EdmVault5()
            End If
            vault2 = DirectCast(vault1, IEdmVault7)
            If Not vault1.IsLoggedIn Then
                'Log into selected vault as the current user
                vault1.LoginAuto(VaultsComboBox.Text, Me.Handle.ToInt32())
            End If
            Dim addCustRefs As IEdmAddCustomRefs = DirectCast(vault2.CreateUtility(EdmUtility.EdmUtil_AddCustomRefs), IEdmAddCustomRefs)
            Dim ppoFileIdArray As Int32() = New Int32(CustRefListBox.Items.Count - 1) {}
            Dim file As IEdmFile5 = Nothing
            Dim parentFolder As IEdmFolder5 = Nothing
            Dim i As Integer = 0
            For Each FileName As String In CustRefListBox.Items
                file = vault2.GetFileFromPath(FileName, parentFolder)
                If Not file.IsLocked Then
                    file.LockFile(parentFolder.IDMe.Handle.ToInt32(), CInt(EdmLockFlag.EdmLock_Simple))
                End If
                ppoFileIdArray(i) = file.ID
                i += 1
            Dim retCode As [Boolean] = False
            'Add the file that is copied to the clipboard as a custom reference to the selected file
            For Each ID As Integer In ppoFileIdArray
                retCode = addCustRefs.CreateReferences()
            ' Check in the file
            file.UnlockFile(Me.Handle.ToInt32(), "Custom reference added")
            'Display current custom file references
            retCode = addCustRefs.ShowEditReferencesDlg(ppoFileIdArray, Me.Handle.ToInt32())
        Catch ex As System.Runtime.InteropServices.COMException
            MessageBox.Show("HRESULT = 0x" + ex.ErrorCode.ToString("X") + " " + ex.Message)
        Catch ex As Exception
        End Try
    End Sub

End Class

Back to top


<Global.Microsoft.VisualBasic.CompilerServices.DesignerGenerated()> _
Partial Class Form1
    Inherits System.Windows.Forms.Form
    ''' <summary>
    ''' Required designer variable.
    ''' </summary>
    Private components As System.ComponentModel.IContainer = Nothing
    ''' <summary>
    ''' Clean up any resources being used.
    ''' </summary>
    ''' <param name="disposing">true if managed resources should be disposed; otherwise, false.</param>
    Protected Overrides Sub Dispose(ByVal disposing As Boolean)
        If disposing AndAlso (components IsNot NothingThen
        End If
    End Sub
#Region "Windows Form Designer generated code"
    ''' <summary>
    ''' Required method for Designer support - do not modify
    ''' the contents of this method with the code editor.
    ''' </summary>
    Private Sub InitializeComponent()
        Me.VaultsLabel = New System.Windows.Forms.Label()
        Me.VaultsComboBox = New System.Windows.Forms.ComboBox()
        Me.BrowseButton = New System.Windows.Forms.Button()
        Me.CustRefListBox = New System.Windows.Forms.ListBox()
        Me.AddCustomFileReference = New System.Windows.Forms.Button()
        Me.CustRefOpenFileDialog = New System.Windows.Forms.OpenFileDialog()
        Me.VaultsLabel.AutoSize = True
        Me.VaultsLabel.Location = New System.Drawing.Point(13, 26)
        Me.VaultsLabel.Name = "VaultsLabel"
        Me.VaultsLabel.Size = New System.Drawing.Size(244, 13)
        Me.VaultsLabel.TabIndex = 0
        Me.VaultsLabel.Text = "Copy a file to the clipboard, then select vault view:"
        Me.VaultsComboBox.FormattingEnabled = True
        Me.VaultsComboBox.Location = New System.Drawing.Point(16, 59)
        Me.VaultsComboBox.Name = "VaultsComboBox"
        Me.VaultsComboBox.Size = New System.Drawing.Size(121, 21)
        Me.VaultsComboBox.TabIndex = 1
        Me.BrowseButton.Location = New System.Drawing.Point(16, 98)
        Me.BrowseButton.Name = "BrowseButton"
        Me.BrowseButton.Size = New System.Drawing.Size(271, 23)
        Me.BrowseButton.TabIndex = 3
        Me.BrowseButton.Text = "Browse for file to which to add a custom reference..."
        Me.BrowseButton.UseVisualStyleBackColor = True
        Me.CustRefListBox.FormattingEnabled = True
        Me.CustRefListBox.Location = New System.Drawing.Point(16, 150)
        Me.CustRefListBox.Name = "CustRefListBox"
        Me.CustRefListBox.Size = New System.Drawing.Size(259, 95)
        Me.CustRefListBox.TabIndex = 4
        Me.AddCustomFileReference.Location = New System.Drawing.Point(16, 273)
        Me.AddCustomFileReference.Name = "AddCustomFileReference"
        Me.AddCustomFileReference.Size = New System.Drawing.Size(259, 23)
        Me.AddCustomFileReference.TabIndex = 5
        Me.AddCustomFileReference.Text = "Add custom file reference"
        Me.AddCustomFileReference.UseVisualStyleBackColor = True
        Me.AutoScaleDimensions = New System.Drawing.SizeF(6.0!, 13.0!)
        Me.AutoScaleMode = System.Windows.Forms.AutoScaleMode.Font
        Me.ClientSize = New System.Drawing.Size(317, 308)
        Me.Name = "Form1"
        Me.Text = "Add custom file references"
    End Sub
#End Region
    Friend WithEvents VaultsLabel As System.Windows.Forms.Label
    Friend WithEvents VaultsComboBox As System.Windows.Forms.ComboBox
    Friend WithEvents BrowseButton As System.Windows.Forms.Button
    Friend WithEvents CustRefListBox As System.Windows.Forms.ListBox
    Friend WithEvents AddCustomFileReference As System.Windows.Forms.Button
    Friend WithEvents CustRefOpenFileDialog As System.Windows.Forms.OpenFileDialog
End Class

Back to top

Provide feedback on this topic

SOLIDWORKS welcomes your feedback concerning the presentation, accuracy, and thoroughness of the documentation. Use the form below to send your comments and suggestions about this topic directly to our documentation team. The documentation team cannot answer technical support questions. Click here for information about technical support.

* Required

Subject:   Feedback on Help Topics
Page:   Add Custom File Reference Example (VB.NET)
*   I acknowledge I have read and I hereby accept the privacy policy under which my Personal Data will be used by Dassault Systèmes

Print Topic

Select the scope of content to print:


We have detected you are using a browser version older than Internet Explorer 7. For optimized display, we suggest upgrading your browser to Internet Explorer 7 or newer.

 Never show this message again

Web Help Content Version: API Help (English only) 2015 SP05

To disable Web help from within SOLIDWORKS and use local help instead, click Help > Use SOLIDWORKS Web Help.

To report problems encountered with the Web help interface and search, contact your local support representative. To provide feedback on individual help topics, use the “Feedback on this topic” link on the individual topic page.