Hide Table of Contents
FinishRecordingUndoObject Method (IModelDocExtension)

Obsolete. Superseded by IModelDocExtension::FinishRecordingUndoObject2.

.NET Syntax

Visual Basic (Declaration) 
Function FinishRecordingUndoObject( _
   ByVal UndoObjectName As System.String _
) As System.Boolean
Visual Basic (Usage) 
Dim instance As IModelDocExtension
Dim UndoObjectName As System.String
Dim value As System.Boolean
 
value = instance.FinishRecordingUndoObject(UndoObjectName)
C# 
System.bool FinishRecordingUndoObject( 
   System.string UndoObjectName
)
C++/CLI 
System.bool FinishRecordingUndoObject( 
&   System.String^ UndoObjectName
) 

Parameters

UndoObjectName
String to appear in SOLIDWORKS Undo list

Return Value

True if recording of the SOLIDWORKS Undo object ends, false if not

Remarks

Place IModelDocExtension::StartRecordingUndoObject at the beginning and this method at the end of any SOLIDWORKS API calls in your application that you want your user to undo as a group.

 

For example, if your application creates a complex gear that requires many SOLIDWORKS API calls, place IModelDocExtension::StartRecordingUndoObject and this method around the SOLIDWORKS API calls that create that gear. Then your user need only select the string specified for UndoObjectName in the SOLIDWORKS Undo list to undo all of the SOLIDWORKS API calls that created the gear.

 

NOTE: Only SOLIDWORKS operations that support Undo will be undone. Both SOLIDWORKS API and non-API operations are undone.

 

See Also

Availability

SOLIDWORKS 2007 FCS, Revision Number 15.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:   FinishRecordingUndoObject 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) 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.