Hide Table of Contents

Add and Mate Component Example (VB.NET)

This example shows how to add a component to an assembly and mate it.

' Preconditions:
' 1. Open install_dir\samples\tutorial\toolbox\lens_mount.sldasm.
' 2. Open an Immediate window.
' Postconditions:
' 1. Adds the specified component, camtest.sldprt, to the assembly.
' 2. Fires the AddItemNotify event.
' 3. Makes the specified component virtual by saving it to the
'    assembly with a new name.
' 4. Fires the RenameItemNotify event.
' 5. Adds a mate between the selected planes to the assembly.
' 6. Inspect the Immediate window.
' NOTE: Because the models are used elsewhere, do not save changes to them.

Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System.Runtime.InteropServices
Imports System
Imports System.Diagnostics
Imports System.Collections
Partial Class SolidWorksMacro
    Public WithEvents swAssemblyDoc As AssemblyDoc
    Dim swModel As ModelDoc2
    Dim swDocExt As ModelDocExtension
    Dim openAssem As Hashtable
    Dim tmpPath As String
    Dim tmpObj As ModelDoc2
    Dim boolstat As Boolean, stat As Boolean
    Dim strings As Object
    Dim swComponent As Component2
    Dim matefeature As Feature
    Dim MateName As String
    Dim FirstSelection As String
    Dim SecondSelection As String
    Dim strCompName As String
    Dim AssemblyTitle As String
    Dim AssemblyName As String
    Dim errors As Integer
    Dim warnings As Integer
    Dim mateError As Integer
    Sub Main()
        swModel = swApp.ActiveDoc
        ' Set up event
        swAssemblyDoc = swModel
        openAssem = New Hashtable
        ' Get title of assembly document
        AssemblyTitle = swModel.GetTitle()
        ' Split the title into two strings using the period as the delimiter
        strings = Split(AssemblyTitle, ".")
        ' Use AssemblyName when mating the component with the assembly
        AssemblyName = strings(0)
        Debug.Print("Name of assembly: " & AssemblyName)
        boolstat = True
        Dim strCompModelname As String
        strCompModelname = "camtest.sldprt"
        ' Because the component resides in the same folder as the assembly, get
        ' the assembly's path and use it when opening the component
        tmpPath = Left(swModel.GetPathName, InStrRev(swModel.GetPathName"\"))
        ' Open the component
        tmpObj = swApp.OpenDoc6(tmpPath + strCompModelname, swDocumentTypes_e.swDocPART, swOpenDocOptions_e.swOpenDocOptions_Silent, "", errors, warnings)
        ' Check to see if the file is read-only or cannot be found; display error
        ' messages if either
        If warnings = swFileLoadWarning_e.swFileLoadWarning_ReadOnly Then
            MsgBox("This file is read only.")
            boolstat = False
        End If
        If tmpObj Is Nothing Then
            MsgBox("Cannot locate the file.")
            boolstat = False
        End If
        ' Activate the assembly so that you can add the component to it
        swModel = swApp.ActivateDoc3(AssemblyTitle, True, swRebuildOnActivation_e.swUserDecision, errors)
        ' Add the camtest part to the assembly document
        swComponent = swAssemblyDoc.AddComponent5(strCompModelname, swAddComponentConfigOptions_e.swAddComponentConfigOptions_CurrentSelectedConfig, ""False"", -1, -1, -1)
        ' Make the component virtual
        stat = swComponent.MakeVirtual
        ' Get the name of the component for the mate
        strCompName = swComponent.Name2()
        ' Create the name of the mate and the names of the planes to use for the mate
        MateName = "top_coinc_" + strCompName
        FirstSelection = "Top@" + strCompName & "@" + AssemblyName
        SecondSelection = "Front@" + AssemblyName
        swDocExt = swModel.Extension
        ' Select the planes for the mate
        boolstat = swDocExt.SelectByID2(FirstSelection, "PLANE", 0, 0, 0, True, 1, Nothing, swSelectOption_e.swSelectOptionDefault)
        boolstat = swDocExt.SelectByID2(SecondSelection, "PLANE", 0, 0, 0, True, 1, Nothing, swSelectOption_e.swSelectOptionDefault)
        ' Add the mate
        matefeature = swAssemblyDoc.AddMate5(swMateType_e.swMateCOINCIDENT, swMateAlign_e.swMateAlignALIGNED, False, 0, 0, 0, 0, 0, 0, 0, 0, FalseFalse, 0, mateError)
        matefeature.Name = MateName
        Debug.Print("Mate added: " & matefeature.Name)
    End Sub
    Sub AttachEventHandlers()
    End Sub
    Sub AttachSWEvents()
        AddHandler swAssemblyDoc.AddItemNotifyAddressOf Me.swAssemblyDoc_AddItemNotify
        AddHandler swAssemblyDoc.RenameItemNotifyAddressOf Me.swAssemblyDoc_RenameItemNotify
    End Sub
    Private Function swAssemblyDoc_AddItemNotify(ByVal EntityType As IntegerByVal itemName As StringAs Integer
        Debug.Print("Component added: " & itemName)
    End Function
    Private Function swAssemblyDoc_RenameItemNotify(ByVal EntityType As IntegerByVal oldName As StringByVal NewName As StringAs Integer
        Debug.Print("Virtual component name: " & NewName)
    End Function
    ''' <summary>
    ''' The SldWorks swApp variable is pre-assigned for you
    ''' </summary>
    Public swApp As SldWorks
End Class

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 and Mate Component 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.