Function SetEntityName( _
   ByVal Entity As System.Object, _
   ByVal StringValue As System.String _
) As System.Boolean

Dim instance As IPartDoc
Dim Entity As System.Object
Dim StringValue As System.String
Dim value As System.Boolean
 
value = instance.SetEntityName(Entity, StringValue)

System.bool SetEntityName( 
   System.object Entity,
   System.string StringValue
)

System.bool SetEntityName( 
&   System.Object^ Entity,
&   System.String^ StringValue
) 

Parameters

Entity

Entity

StringValue

Name of the entity

Return Value

True if name is set successfully, false if not

If the entity already has a name, then this method does not change the name and returns false.

This behavior is intended to prevent a program from accidentally renaming an entity that is referenced in some other location. For example, if an assembly contains a mate to a face on a part, then a name is automatically assigned to that face. If you were to change that name, then there is no guarantee that the mate is still valid. Therefore, when using entity names, you should first check to see if the entity is already named, and, if so, use the existing name. If no name exists for the entity, then you can name the entity.

You can explicitly delete an entity name using the IPartDoc::DeleteEntityName or IPartDoc::IDeleteEntityName method. You then have the option of renaming the item or using that name elsewhere. The method was provided because the action is already available in the core SolidWorks product. However, you should recognize the possibility of reference failures as described.