Hide Table of Contents

Get Comments in Comments Folder Example (VBA)

This example shows how to add and get the comments in a Comments folder.

' Preconditions:
' 1. Verify that the specified model document to 
'    open exits.
' 2. Open Immediate window.
' Postconditions:
' 1. Examine the FeatureManager design tree
'    to verify that the Comments folder is not
'    shown, then press F5.
' 2. Adds a comment to the Comments folder
'    and updates the FeatureManager design
'    tree.
' 3. Examine the FeatureManager design tree
'    to verify that the Comments folder is
'    shown, then press F5.
' 4. Prints the number of comments, name of the
'    the comments, and text of the comments
'    in the Comments folder to the Immediate
'    window. Examine the Immediate window.
' NOTE: Because this model document is used
' elsewhere, do not save changes.
Option Explicit 
Dim swApp As SldWorks.SldWorks
Dim swModelDoc As SldWorks.ModelDoc2
Dim swFeat As SldWorks.Feature
Dim swFeatMgr As SldWorks.FeatureManager
Dim swCommentFolder As SldWorks.CommentFolder
Dim swComment As SldWorks.Comment
Dim nbrComments As Long
Dim sFeatType As String
Dim vComments As Variant
Dim fileName As String
Dim errors As Long
Dim warnings As Long
Dim i As Long
Sub main()
Set swApp = Application.SldWorks
' Open part document
fileName = "C:\Users\Public\Documents\SOLIDWORKS\SOLIDWORKS 2017\tutorial\api\2012-sm.sldprt"
Set swModelDoc = swApp.OpenDoc6(fileName, swDocPART, swOpenDocOptions_Silent, "", errors, warnings)
' Traverse the FeatureManager design tree for Comments folder
    ' Get first feature in FeatureManager design tree
    Set swFeat = swModelDoc.FirstFeature
    Set swFeatMgr = swModelDoc.FeatureManager
    ' Examine FeatureManager design tree to verify that
    ' the the Comments folder is not shown; press F5
    Do While Not swFeat Is Nothing
      sFeatType = swFeat.GetTypeName
            ' If Comments folder, add a comment
            If sFeatType = "CommentsFolder" Then
                Set swCommentFolder = swFeat.GetSpecificFeature2
                ' Add comment and update FeatureManager design tree
                ' so that Comments folder is shown
                Set swComment = swCommentFolder.AddComment("First comment in comment folder.")
                ' Locate Comments folder in FeatureManager design; press F5                
                ' Get number of comments in Comment folder
                nbrComments = swCommentFolder.GetCommentCount
                Debug.Print "Number of comments in Comments folder         = " & nbrComments
                vComments = swCommentFolder.GetComments
                For i = 0 To (nbrComments - 1)
                    Set swComment = vComments(i)
                    Debug.Print "Name of comment in FeatureManager design tree = " & swComment.Name
                    Debug.Print "Text of comment                               = " & swComment.Text
                    Debug.Print ""
                Next i
            End If
       ' Get next feature in FeatureManager design tree
       Set swFeat = swFeat.GetNextFeature
End Sub

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

Subject:   Feedback on Help Topics
Page:   Get Comments in Comments Folder Example (VBA)
*   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:


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

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.