Hide Table of Contents

Get Whether Component Is Envelope And Excluded From BOM (VB.NET)

This example shows how to find out if a component is an envelope and whether the component is included in the bill of materials (BOM).


' Preconditions:  

' 1. Open SOLIDWORKS and copy the code below to a VB.NET macro.

' 2. Ensure that the specified file exists.

' 3. Specify your_license_key.

' 4. Open an Immediate window.


' Postconditions: Inspect the Immediate window.


' NOTE: ISwDMComponent5::ExcludeFromBom and ISwDMComponent5::IsEnvelope print 

' to the Immediate Window for each component.


Imports SolidWorks.Interop.sldworks

Imports SolidWorks.Interop.swconst

Imports System

Imports SwDocumentMgr

Imports System.Diagnostics

Partial Class SolidWorksMacro

    Public Sub main()

        Dim swClassFact As SwDocumentMgr.SwDMClassFactory

        Dim swDocMgr As SwDocumentMgr.SwDMApplication

        Dim swDoc As SwDocumentMgr.SwDMDocument7

        Dim swCfgMgr As SwDocumentMgr.SwDMConfigurationMgr

        Dim swConfiguration7 As SwDMConfiguration7

        Dim swComponents As Object

        Dim sDocFileName As String

        Dim nDocType As SwDocumentMgr.SwDmDocumentType

        Dim nRetVal As SwDocumentMgr.SwDmDocumentOpenError

        Dim sLicenseKey As String

        sLicenseKey = "your_license_key"

        sDocFileName = "C:\Users\Public\Documents\SOLIDWORKS\SOLIDWORKS 2018\samples\tutorial\advdrawings\98food processor.sldasm"

        nDocType = SwDocumentMgr.SwDmDocumentType.swDmDocumentAssembly

        swClassFact = CreateObject("SwDocumentMgr.SwDMClassFactory")

        swDocMgr = swClassFact.GetApplication(sLicenseKey)

        swDoc = swDocMgr.GetDocument(sDocFileName, nDocType, True, nRetVal)

        swCfgMgr = swDoc.ConfigurationManager

        Dim SWConfigNames() As String

        SWConfigNames = swCfgMgr.GetConfigurationNames

        For j As Integer = 0 To UBound(SWConfigNames)

            swConfiguration7 = swCfgMgr.GetConfigurationByName(SWConfigNames(j))

            swComponents = swConfiguration7.GetComponents

            Debug.Print("Configuration Name = " & SWConfigNames(j))

            For I As Integer = 0 To UBound(swComponents)

                Dim comp As SwDMComponent5

                comp = swComponents(I)

                Debug.Print("Component Name = " & comp.Name)

                Debug.Print("       IsEnvelope = " & comp.IsEnvelope)

                Debug.Print("       ExcludeFromBOM = " & comp.ExcludeFromBOM)





    End Sub

    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:   Get Whether Component Is Envelope And Excluded From BOM (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) 2020 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.