Hide Table of Contents
ComponentName Property (IEModelViewControl)

Gets the name of the component in the specified configuration.

.NET Syntax

Visual Basic (Declaration) 
ReadOnly Property ComponentName( _
   ByVal Config As System.String, _
   ByVal index As System.Integer _
) As System.String
Visual Basic (Usage) 
Dim instance As IEModelViewControl
Dim Config As System.String
Dim index As System.Integer
Dim value As System.String
 
value = instance.ComponentName(Config, index)
C# 
System.string ComponentName( 
   System.string Config,
   System.int index
) {get;}
C++/CLI 
property System.String^ ComponentName {
   System.String^ get(System.String^ Config, System.int index);
}

Parameters

Config
Name of the configuration in which the component exists or an empty string ("") or an asterisk ("*") (see Remarks)
index

Index number of the component to get

Property Value

Name of the component

Example

Visual Basic code snippet that shows how to get the names of the components and the names of their component configurations in a top-level assembly configuration named Level1_Config2:

    count = Document.EModelViewControl.ComponentCount("Level1_Config2")
    for index = 0 to count
        componentName = Document.EModelViewControl.ComponentName("Level1_Config2", index)
        configurationName = Document.EModelViewControl.ComponentConfigurationName ("Level1_Config2", index)
Debug.Print "Component name: " & componentName & " , Component configuration name: " & configurationName
   next

Remarks

This property does not get component names for inactive component configurations of a top-level assembly in a SOLIDWORKS document. To get the component names for inactive component configurations of a top-level assembly, you must use an eDrawings file that was published from SOLIDWORKS.

Passing an:

  • Empty string ("") to Config gets the name of the component at the specified index from the components in the active configuration.

  • Asterisk ("*") to Config gets the name of the component at the specified index from the components in all configurations.

You can also call IEModelViewControl::ConfigurationName to get the name of a configuration.

 

Before calling this property call IEModelViewControl::ComponentCount to get a valid value for Index.

See Also

Availability

eDrawings API 2005 SP0


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

 
*Email:  
Subject:   Feedback on Help Topics
Page:   ComponentName Property (IEModelViewControl)
*Comment:  
*   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:

x

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
x

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.