Hide Table of Contents
AddComment Method (IModelDocExtension)

Adds a comment to this document's Comment Folder.

.NET Syntax

Visual Basic (Declaration) 
Function AddComment( _
   ByVal Text As System.String _
) As Comment
Visual Basic (Usage) 
Dim instance As IModelDocExtension
Dim Text As System.String
Dim value As Comment
 
value = instance.AddComment(Text)
C# 
Comment AddComment( 
   System.string Text
)
C++/CLI 
Comment^ AddComment( 
&   System.String^ Text
) 

Parameters

Text

Comment to add to the document's Comment folder

Return Value

Comment folder

Example

Remarks

A comment is added to the document's Comment folder, and the comment is associated with the preselected item when this method is run.  

 

For example:

 

If...

Then the comment is...

A feature is preselected

Associated with the feature (equivalent to running the IFeature::AddComment on the selected feature)

The Comment folder is preselected

Not associated with any feature, but is added to the Comment folder (equivalent to running the ICommentFolder::AddComment method)

 

Although it might appear that ModelDocExtension::AddComment duplicates IFeature::AddComment and ICommentFolder::AddComment, IModelDocExtension::AddComment is used when recording macros, so it is different. IModelDocExtension::AddComment shares code with the user interface, so it should behave identical to the user interface.

 

IModelDocExtension::AddComment rebuilds the FeatureManager design tree automatically, which can be a time-consuming operation if the FeatureManager design tree gets large. Take this into consideration before using it.

 

See Also

Availability

SOLIDWORKS 2006 FCS, Revision Number 14.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:   AddComment 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) 2015 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.