Hide Table of Contents

Insert External Reference Example (VB.NET)

This example shows how to insert an external reference to a drawing document.

' 1. Create a VB.NET Windows console project.
' 2. Copy and paste this example into the VB.NET IDE.
' 3. Add a reference to:
'    install_dir\APISDK\tlb\DraftSight.Interop.dsAutomation.dll.
' 4. Start DraftSight and open a new document.
' 5. If C:\Block.dwg exists, then skip this step.
'    - or -
'    If C:\Block.dwg does not exist, then construct
'    some geometry in the drawing, save the drawing
'    as C:\Block.dwg, and open a new drawing document.
' 6. Start debugging the project.
' Postconditions: A message box pops up when an external reference
' is inserted in the drawing document.
Imports DraftSight.Interop.dsAutomation

Module Module1

    Sub Main()

        Dim dsApp As Application
        Dim dsDoc As Document
        Dim dsModel As Model
        Dim dsSketchManager As SketchManager
        Dim dsExtReference As BlockInstance
	Dim dsReference as ExternalReference
        Dim pathName As String
        Dim insertX, insertY, insertZ, scaleValue, rotation As Double

        'Connect to DraftSight
        dsApp = GetObject(, "DraftSight.Application")
	dsApp.AbortRunningCommand() ' abort any command currently running in DraftSight to avoid nested commands

        'Get active document
        dsDoc = dsApp.GetActiveDocument()

        If Not dsDoc Is Nothing Then
            'Get model space
            dsModel = dsDoc.GetModel()
            'Get Sketch Manager
            dsSketchManager = dsModel.GetSketchManager()

            'External reference parameters (rotation value should be in radians)
            pathName = "C:\Block.dwg"
            insertX = 0.0#
            insertY = 0.0#
            insertZ = 0.0#
            scaleValue = 1.0#
            rotation = 0.0#
            'Add a Block instance
            dsExtReference = dsSketchManager.InsertExternalReference(pathName, insertX, insertY, insertZ, scaleValue, rotation)

            If dsExtReference Is Nothing Then
                MsgBox(pathName & " file was not found.")
                MsgBox("An external reference was added to the drawing.")
                Dim references As Object
                Dim reference As Object
                references = dsDoc.GetExternalReferences
                reference = references(0)
                dsReference = reference
                If Not dsReference Is Nothing Then
                    MsgBox("Name of external reference " & dsReference.Name & ".")
                End If
            End If
            MsgBox("There are no open documents in DraftSight.")
        End If
    End Sub
End Module


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:   Insert External Reference 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) 2023 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.