Function RenameDocument( _
   ByVal NewName As System.String _
) As System.Integer

Dim instance As IModelDocExtension
Dim NewName As System.String
Dim value As System.Integer
 
value = instance.RenameDocument(NewName)

System.int RenameDocument( 
   System.string NewName
)

System.int RenameDocument( 
&   System.String^ NewName
) 

Parameters

NewName

New name for the component 

Return Value

If this method returns swRenameDocumentError_e.swRenameDocumentError_None, then the new name of the component is shown in the FeatureManager design tree and the file name of the component changes in memory. All currently open documents that reference the renamed file are updated to reference the new file name.

To:

• get whether the document has renamed components, call IModelDocExtension::HasRenamedDocuments.
• to avoid an error when attempting to save the document without first saving its references, use IRenamedDocumentReferences to update references to the renamed component in unopened documents.
• permanently rename the component, save the document.

See the SOLIDWORKS Help for details about renaming components.