Hide Table of Contents

Switch Layouts Example (VBA)

This example shows how to switch layouts.


' 1. Create a VBA macro in a software product in which VBA is
'    embedded.
' 2. Copy and paste this example into the Visual Basic IDE.
' 3. Add a reference to the DraftSight type library,
'    install_dir\bin\dsAutomation.dll.
' 4. Start DraftSight and open a document.
' 5. Run the macro.
'Postconditions: Message boxes pop up when a model or sheet
'is activated. Read the text in each message box before clicking
'OK to close it.
Option Explicit
Sub main()
    Dim dsApp As DraftSight.Application
    Dim dsDoc As DraftSight.Document    
    'Connect to DraftSight
    Set dsApp = GetObject(, "DraftSight.Application")
    'Abort any command currently running in DraftSight 
    'to avoid nested commands
    'Get active document
    Set dsDoc = dsApp.GetActiveDocument()
    If Not dsDoc Is Nothing Then        
        'Activate each layout, one by one
        SwitchLayouts dsDoc        
        MsgBox "There are no open documents in DraftSight."
    End If
End Sub
Sub SwitchLayouts(dsDoc As DraftSight.Document)
    Dim dsSheet As DraftSight.Sheet
    Dim dsModel As DraftSight.Model
    Dim dsVarSheets As Variant
    Dim index As Integer
    Dim sheetName As String    
    'Get all sheets
    dsVarSheets = dsDoc.GetSheets    
    If IsArray(dsVarSheets) Then        
        For index = LBound(dsVarSheets) To UBound(dsVarSheets)        
            Set dsSheet = dsVarSheets(index)            
            'Get sheet name
            sheetName = dsSheet.Name            
            'Change sheet name, if it is not a model
            If sheetName <> "Model" Then            
                'Activate sheet
                'Verify if the sheet was activated
                If dsSheet.IsActive Then
                    MsgBox "The sheet " & sheetName & " was activated."
                End If            
                'Activate model sheet
                Set dsModel = dsDoc.GetModel                
                If Not dsModel Is Nothing Then                    
                    'Activate model sheet
                    'Verify if the sheet was activated
                    If dsModel.IsActive Then
                        MsgBox "The model sheet was activated."
                    End If                    
                End If            
            End If        
    End If    
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:   Switch Layouts 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) 2024 SP02

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.