Hide Table of Contents

Move Annotations to Notes Area Annotation View Example (VB.NET)

This example shows how to move all annotations to the Notes Area annotation view.

' Preconditions:
' 1. Open public_documents\tutorial\api\button.sldprt.
' 2. Add a note to the *Top annotation view by double-clicking
'    *Top in the Annotations folder in the FeatureManager design
'    tree and clicking Insert > Annotations > Note. If prompted
'    to turn on feature dimensions display, click No.
' 3. Repeat step 2 to add a note to the *Front annotation view.
' 4. Double-click the Unassigned Items annotation view in the
'    Annotations folder in the FeatureManager design tree.
' 5. Open the Immediate window.
' Postconditions:
' 1. Examine the Immediate window.
' 2. Double-click each annotation view in the FeatureManager
'    design tree to verify that all annotations were moved
'    from *Front and *Top to Notes Area only. If prompted
'    to turn on feature dimensions display, click No.
' NOTE: Because the part is used elsewhere, do not
' save changes when closing it.
Imports SolidWorks.Interop.sldworks
Imports SolidWorks.Interop.swconst
Imports System.Runtime.InteropServices
Imports System
Imports System.Diagnostics
Partial Class SolidWorksMacro
    Public Sub Main()
        Dim swModel As ModelDoc2
        Dim swModelExt As ModelDocExtension
        Dim swAnnViews As Object
        Dim annotations As Object
        Dim annToMove(1) As Annotation
        Dim swAnnView As AnnotationView
        Dim swAnn As Annotation
        Dim swFeat As Feature
        Dim swMathTransform As MathTransform
        Dim i As Integer
        Dim j As Integer
        Dim k As Integer
        Dim l As Integer
        Dim planeArray() As Double
        Dim nbrPlaneArray As Integer
        Dim status As Boolean
        Dim transformArray() As Double
        swModel = swApp.ActiveDoc
        swModelExt = swModel.Extension
        'Get the annotation views, number of annotation views,
        'their names, and whether the annotation views 
        'is hidden (i.e., not activated)
        swAnnViews = swModelExt.AnnotationViews
        Debug.Print("Number of annotation views: " & swModelExt.AnnotationViewCount)
        For i = 0 To swModelExt.AnnotationViewCount - 1
            swAnnView = swAnnViews(i)
            swFeat = swAnnView
            Debug.Print("   " & swFeat.Name)
            status = swAnnView.Hide
            'status dependent on whether the annotation view is activated
            'Only Unassigned Items is activated
            Debug.Print("        Hide: " & status)
            Debug.Print("        Flat-pattern view: " & swAnnView.FlatPatternView)
        'Iterate through each annotation view and its annotations
        'Print each annotation name, its rotation matrix, whether it 
        'is shown in the annotation view, and whether it is assigned 
        'to a 3D view
        'Add all annotations to an array to move them
        k = 0
        l = 0
        Debug.Print("  Name and number of annotations in annotation view: ")
        For i = 0 To swModelExt.AnnotationViewCount - 1
            swAnnView = swAnnViews(i)
            annotations = swAnnView.GetAnnotations2(FalseFalse)
            swFeat = swAnnView
            Debug.Print("        " & swFeat.Name & " = " & swAnnView.AnnotationCount)
            If Not annotations Is Nothing Then
                For j = 0 To swAnnView.AnnotationCount - 1
                    swAnn = annotations(j)
                    If k >= 0 Then
                        annToMove(k) = swAnn
                        k = k + 1
                    End If
                    planeArray = swAnn.GetPlane
                    Debug.Print("          Rotation matrix of the annotation relative to the X-Y plane of the model: ")
                    nbrPlaneArray = UBound(planeArray)
                    Do While l < nbrPlaneArray
                        Debug.Print("           " & planeArray(l) & " " & planeArray(l + 1) & " " & planeArray(l + 2))
                        l = l + 3
                    swMathTransform = swAnn.GetFlipPlaneTransform
                    transformArray = swMathTransform.ArrayData()
                    If Not transformArray Is Nothing Then
                        Debug.Print("          Rotation matrix if annotation plane flipped:")
                        Debug.Print("           " & transformArray(0) & " " & transformArray(1) & " " & transformArray(2))
                        Debug.Print("           " & transformArray(3) & " " & transformArray(4) & " " & transformArray(5))
                        Debug.Print("           " & transformArray(6) & " " & transformArray(7) & " " & transformArray(8))
                        Debug.Print("          Translation component if annotation plane flipped:")
                        Debug.Print("           " & transformArray(9) & " " & transformArray(10) & " " & transformArray(11))
                    End If
                    l = 0
                    Debug.Print("          Annotation names:")
                    Debug.Print("            " & swAnn.GetName)
                    status = swAnnView.IsShown
                    Debug.Print("               Shown in this annotation view: " & status)
                    status = swAnnView.UnassignedView
                    Debug.Print("                  Assigned to a 3D View: " & status)
            End If
        'Move all annotations to the Notes Area annotation view
        Debug.Print("Move all annotations to Notes Area annotation view:")
        For i = 0 To swModelExt.AnnotationViewCount - 1
            swAnnView = swAnnViews(i)
            swFeat = swAnnView
            If swFeat.Name = "Notes Area" Then
                status = swAnnView.MoveAnnotations(annToMove)
                Debug.Print("  Annotations moved: " & status)
                status = swAnnView.Show()
                'status should be false because annotation was activated
                Debug.Print("    Show: " & status)
            End If
    End Sub
    ''' <summary>
    ''' The SldWorks swApp variable is pre-assigned for you.
    ''' </summary>
    Public swApp As SldWorks
End Class

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:   Move Annotations to Notes Area Annotation View Example (VB.NET)
*   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.