Hide Table of Contents

Get Display State Names and Visibilities of Components Example (C#)

This example shows how to get the names of the display states in an assembly and the visibilities of the assembly components in each display state.

// Preconditions:
// 1. Open an assembly that contains multiple components
//    and display states.
// 2. Open the Immediate window.
// Postconditions: Examine the Immediate window.
using SolidWorks.Interop.sldworks;
using SolidWorks.Interop.swconst;
using System.Runtime.InteropServices;
using System;
using System.Diagnostics;
namespace DisplayStateComponentsCSharp.csproj
    public partial class SolidWorksMacro
        public void Main()
            ModelDoc2 swModel = default(ModelDoc2);
            ModelDocExtension swModelDocExt = default(ModelDocExtension);
            ConfigurationManager swConfigMgr = default(ConfigurationManager);
            Configuration swConfig = default(Configuration);
            object oComponents = null;
            object[] components = null;
            Component2 comp = null;
            int docType = 0;
            int i = 0;
            int j = 0;
            string[] displayStateNames = null;
            string displayStateName = null;
            int[] displayStateVisibilities = null;
            int displayStateVisibility = 0;
            string visibility = "";
            swModel = (ModelDoc2)swApp.ActiveDoc;
            swModelDocExt = (ModelDocExtension)swModel.Extension;
            docType = swModel.GetType();
            if (docType == (int)swDocumentTypes_e.swDocASSEMBLY)
                swConfigMgr = (ConfigurationManager)swModel.ConfigurationManager;
                swConfig = (Configuration)swConfigMgr.ActiveConfiguration;
                displayStateNames = (string[])swConfig.GetDisplayStates();
                for (i = 0; i < displayStateNames.Length; i++)
                    displayStateName = (string)displayStateNames[i];
                    Debug.Print("Display state name: " + displayStateName);
                    displayStateVisibilities = (int[])swConfig.GetDisplayStateComponentVisibility(displayStateName, falsefalseout oComponents);
                    components = (object[])oComponents;
                    Debug.Print("  Display state visibility: ");
                    for (j = 0; j < displayStateVisibilities.Length; j++)
                        displayStateVisibility = (int)displayStateVisibilities[j];
                        switch (displayStateVisibility)
                            case 0:
                                visibility = "Hidden";
                            case 1:
                                visibility = "Shown";
                        comp = (Component2)components[j];
                        Debug.Print("    " + comp.Name2 + ": " + visibility);
                Debug.Print("Open an assembly document with multiple display states.");
        /// <summary>
        ///  The SldWorks swApp variable is pre-assigned for you.
        /// </summary>
        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 Display State Names and Visibilities of Components 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) 2017 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.