Hide Table of Contents

Get ID of Active Configuration or Current Drawing Sheet Example (C#)

This example shows how to get the name and ID of the active configuration or the current drawing sheet.

A unique ID is assigned to each configuration and drawing. This ID does not change when the name of the configuration or drawing sheet is changed.


// Preconditions: Part, assembly, or drawing document is open.


// Postconditions: Either the active configuration's name or

//       the current sheet's name is changed to "Test"; however,

//       its ID remains unchanged.


using SolidWorks.Interop.sldworks;

using SolidWorks.Interop.swconst;

using System;

using System.Diagnostics;

namespace GetIDConfigurationSheet_CSharp.csproj


    partial class SolidWorksMacro


        public void Main()


            ModelDoc2 swModel = default(ModelDoc2);

            Configuration swConfig = default(Configuration);

            DrawingDoc swDrawingDoc = default(DrawingDoc);

            Sheet swSheet = default(Sheet);

            int nDocType = 0;

            swModel = (ModelDoc2)swApp.ActiveDoc;

            // Get type of model document

            if (swModel.GetType() == 1)


                nDocType = (int)swDocumentTypes_e.swDocPART;


            else if (swModel.GetType() == 2)


                nDocType = (int)swDocumentTypes_e.swDocASSEMBLY;


            else if (swModel.GetType() == 3)


                nDocType = (int)swDocumentTypes_e.swDocDRAWING;




                // Not a SolidWorks model document,

                // so exit macro



            // If a part or assembly document,

            // then get the name of it and its ID

            if (nDocType != (int)swDocumentTypes_e.swDocDRAWING)


                swConfig = (Configuration)swModel.GetActiveConfiguration();

                if ((swConfig != null))


                    Debug.Print("Active configuration's name = " + swConfig.Name + ", ID = " + swConfig.GetID());

                    // Change the active configuration's name

                    swConfig.Name = "Test";

                    // Test to see if the ID remains the same

                    // after changing the name of the configuration

                    Debug.Print("Active configuration's new name = " + swConfig.Name + ", ID = " + swConfig.GetID());




            // A drawing sheet must be active,

            // so get its name and ID

            swDrawingDoc = (DrawingDoc)swModel;

            swSheet = (Sheet)swDrawingDoc.GetCurrentSheet();

            if ((swSheet != null))


                Debug.Print("Current sheet's name = " + swSheet.GetName() + ", ID = " + swSheet.GetID());

                // Change current sheet's name


                // Test to see if the ID remains the same

                // after changing the name of the sheet

                Debug.Print("Current sheet's new name = " + swSheet.GetName() + ", ID = " + swSheet.GetID());



        public SldWorks swApp;



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 ID of Active Configuration or Current Drawing Sheet 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) 2010 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.