Hide Table of Contents

Get Entity By Name Example (VBA)

This example shows how to get a face by specifying its name and changing the name. This process is commonly used with standardized parts where names can be given to objects and the objects can be accessed later.

' Preconditions:
' 1. Open a part document.
' 2. Select a face.
' Postconditions:
' 1. Displays a message box containing the
'    name of the selected face.
' 2. Click OK.
' 3. Displays a message box containing
'    the new name of the selected face.
' 4. Click OK.
Option Explicit 
Sub main()    
    Dim swApp As SldWorks.SldWorks
    Dim Part As SldWorks.PartDoc
    Dim Face As SldWorks.Face2
    Dim Model As SldWorks.ModelDoc2
    Dim ModelDocExt As SldWorks.ModelDocExtension
    Dim SelMgr As SldWorks.SelectionMgr
    Dim Entity As SldWorks.Entity
    Dim faceName As String
    Dim ret As Boolean    
    Set swApp = CreateObject("SldWorks.Application")    
    ' Get active document
    Set Part = swApp.ActiveDoc
    Set Model = Part    
    ' Get face name
    Set SelMgr = Model.SelectionManager
    Set Face = SelMgr.GetSelectedObject6(1, -1)
    Set Entity = Face
    faceName = Model.GetEntityName(Entity)    
    swApp.SendMsgToUser "Selected face name: " & faceName    
    ' Get face by its name
    Set Face = Part.GetEntityByName(faceName, 2)    
    ' Delete current face name
    ret = Part.DeleteEntityName(Entity)    
    ' Change name of the face
    ret = Part.SetEntityName(Entity, "NewFaceName")     
    ' If name change is successful
    If ret Then
        swApp.SendMsgToUser "Selected face name changed to: " & Model.GetEntityName(Entity)
    ' If name change failed
        swApp.SendMsgToUser "Error changing face name."
    End If
End Sub

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 Entity By Name Example (VBA)
*   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.