Hide Table of Contents
RenameDocument Method (IModelDocExtension)

Temporarily renames the selected component using the specified name.

.NET Syntax

Visual Basic (Declaration) 
Function RenameDocument( _
   ByVal NewName As System.String _
) As System.Integer
Visual Basic (Usage) 
Dim instance As IModelDocExtension
Dim NewName As System.String
Dim value As System.Integer
 
value = instance.RenameDocument(NewName)
C# 
System.int RenameDocument( 
   System.string NewName
)
C++/CLI 
System.int RenameDocument( 
&   System.String^ NewName
) 

Parameters

NewName
New name for the component 

Return Value

Status of temporarily renaming the component as defined in swRenameDocumentError_e (see Remarks)

Example

Remarks

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:

See the SOLIDWORKS Help for details about renaming components.

 

See Also

Availability

SOLIDWORKS 2016 FCS, Revision Number 24.0


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:   RenameDocument Method (IModelDocExtension)
*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.