Hide Table of Contents

Replace Component Example (C#)

This example shows how to replace a component with a different component.

// Preconditions:
// 1. Read the SOLIDWORKS Document Manager API Getting Started
//    topic and ensure that the required DLLs are registered.
// 2. Copy and paste this code into a VB.NET console application
//    in Microsoft Visual Studio.
// 3. Add the SolidWorks.Interop.swdocumentmgr.dll reference to the project:
//    a. Right-click the solution in Solution Explorer.
//    b. Click Add Reference.
//    c. Click Browse.
//    d. Click:
//       install_dir\api\redist\CLR2\SolidWorks.Interop.swdocumentmgr.dll
//    e. Click Add.
//    f. Click Close.
// 4. Ensure that the model to open exists.

// 5. Substitute your_license_key with your SOLIDWORKS Document
//    Manager license key.
// 6. Open the Immediate window.
' Postconditions:
' 1. Inspect the Immediate window.
' 2. The first instance of the shaft washer component is
'    replaced with a lock washer in the document.
' NOTE: The specified file should be backed up before running this macro,
' as it is used elsewhere. The macro uses a replacement that does not
' properly fit in the model.

using System;
using System.Diagnostics;
using SolidWorks.Interop.swdocumentmgr;
namespace ConsoleApplication2
class Program
static void Main(string[] args)

            SwDMClassFactory swCf;
            swCf =
new SwDMClassFactory();
SwDMApplication swDocMgr;
            swDocMgr = (
SwDMDocument12 swDoc12;
SwDmDocumentOpenError res;
SwDmDocumentType dt;
            dt =
string filename;
Debug.Print("Opening an assembly...");
            filename =
"C:\\Users\\Public\\Documents\\SOLIDWORKS\SOLIDWORKS 2018\\samples\\tutorial\\advdrawings\\98food processor.sldasm";
            swDoc12 = swDocMgr.GetDocument(filename, dt,
false, out res) as SwDMDocument12;

if (swDoc12 == null | (res != SwDmDocumentOpenError.swDmDocumentOpenErrorNone))
Debug.Print("Error opening file...");

Debug.Print("Getting the active configuration...");
SwDMConfiguration8 activeConfig;
SwDMConfigurationMgr configMgr;
            configMgr = swDoc12.ConfigurationManager;
            activeConfig = configMgr.GetConfigurationByName(configMgr.GetActiveConfigurationName())
as SwDMConfiguration8;
if (activeConfig == null)
Debug.Print("Error getting the active configuration...");

Debug.Print("Getting the components of the active configuration...");
object[] vComponents;
            vComponents = (
SwDMComponent6 swDmComponent;

int i;
for (i = 0; i < vComponents.Length; i++)
                swDmComponent = (
if (swDmComponent.Name == "shaft washer")
bool bResult = swDmComponent.Replace("C:\\Program Files\\SOLIDWORKS Corp\\SOLIDWORKS\\samples\\tutorial\\smartcomponents\\lockwasher.sldprt", "Default", false);
Debug.Print("Replacing shaft washer with lock washer...");



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:   Replace Component Example (C#)
*   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) 2018 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.