Solidworks VBA Macro - Insert Broken-out View

5 minute read

Objective

In this article, we understand “how to” Insert Broken-out View in Drawing document from VBA macro.

This is most updated method of Insert Broken-out View in an drawing document.

Results We Can Get

Below image shows the result we get.

We Insert Broken-out View in simple manners.

There are no extra steps required.

To get the correct result, please follow the steps correctly.

Macro Video

Below 🎬 video shows how to Insert Broken-out View from SOLIDWORKS VBA Macros.

Above video is just for visualization and there is no explanation.

I have explained every line in this article.

It is advisable to watch video, since it helps you to better understand the process.

VBA Macro

Below is the VBA macro for Insert Broken-out View.

                        Option Explicit

' Creating variable for Solidworks application
Dim swApp As SldWorks.SldWorks

' Creating variable for Solidworks document
Dim swDoc As SldWorks.ModelDoc2

' Creating variable for Solidworks Drawing
Dim swDrawing As SldWorks.DrawingDoc

' Program to Insert Broken-out View
Sub main()

  ' Setting Solidworks variable to Solidworks application
  Set swApp = Application.SldWorks
  
  ' Set Solidworks document variable to currently opened document
  Set swDoc = swApp.ActiveDoc
  
  ' Check if Solidworks document is opened or not
  If swDoc Is Nothing Then
    MsgBox "Solidworks document is not opened."
    Exit Sub
  End If
  
  ' Set Solidworks Drawing document variable
  Set swDrawing = swDoc
  
  ' Boolean variable
  Dim boolStatus As Boolean
  
  ' Insert Broken-out View
  boolStatus = swDrawing.CreateBreakOutSection(0.1)
  
  ' Check if we successfully insert Broken-out View
  If boolStatus = False Then
    MsgBox "Failed to Insert Broken-out View."
    Exit Sub
  End If
  
  ' Rebuild drawing
  swDoc.ForceRebuild3 False

End Sub

                      

Prerequisite

There are some prerequisites for this article.

Knowledge of VBA programming language is ❗required.
We create Broken-out view from an existing (Base) view.
We already select a Circle in this existing (Base) view.

We will apply checks in this article, so the code we write, should be error free mostly.

Steps To Follow

This VBA macro can be divided into following sections:

Create Global Variables
Initialize Variables
Insert Broken-out Views

Every section with each line is explained below.

I also give some links (see icon 🚀) so that you can go through them if there are anything I explained in previous articles.

Create Global Variables

In this section, we create global variables.

Option Explicit

Purpose: Above line forces us to define every variable we are going to use.
Reference: 🚀 SOLIDWORKS Macros - Open new Part document article.

                        ' Variable for Solidworks application
Dim swApp As SldWorks.SldWorks

Purpose: In above line, we create a variable for Solidworks application.
Variable Name: swApp
Type: SldWorks.SldWorks
Reference: Please visit 🚀 online SOLIDWORKS API Help.

                        ' Variable for Solidworks document
Dim swDoc As SldWorks.ModelDoc2

Purpose: In above line, we create a variable for Solidworks document.
Variable Name: swDoc
Type: SldWorks.ModelDoc2
Reference: Please visit 🚀 online SOLIDWORKS API Help.

                        ' Creating variable for Solidworks Drawing
Dim swDrawing As SldWorks.DrawingDoc

Purpose: In above line, we create a variable for Solidworks Drawing.
Variable Name: swDrawing
Type: SldWorks.DrawingDoc
Reference: Please visit 🚀 online SOLIDWORKS API Help.

These all are our global variables.

They are SOLIDWORKS API Objects.

                        ' Program to Insert Broken-out View
Sub main()

End Sub

In above line, we create Program to Insert Broken-out View.
This is a Sub procedure which has name of main.
This procedure hold all the statements (instructions) we give to computer.
Reference: Detailed information 🚀 VBA Sub and Function Procedures article of this website.

Initialize Variables

In this section, we initialize Variables.

                        ' Set Solidworks Application variable to current application
Set swApp = Application.SldWorks

In above line, we set value of swApp variable.
This value is currently opened Solidworks application.

                        ' Set Solidworks document variable to currently opened document
Set swDoc = swApp.ActiveDoc

In above line, we set value of swDoc variable.
This value is currently opened part document.

                        ' Check if Solidworks document is opened or not
If swDoc Is Nothing Then
  MsgBox ("Solidworks document is not opened.")
  Exit Sub
End If

                      

In above code block, we check if we successfully set the value of swDoc variable.
We use 🚀 IF statement for checking.
Condition: swDoc Is Nothing
When this condition is True,
- We show and 🚀 message window to user.
- Message: SOLIDWORKS document is not opened.
- Then we stop our macro here.

                        ' Set Solidworks Drawing document
Set swDrawing = swDoc

In above line, we set value of swDrawing variable.
This value is swDoc variable.

Insert Broken-out Views

In this section, we Insert Broken-out Views.

                        ' Boolean variable
Dim boolStatus As Boolean

Purpose: In above line, we create a Boolean variable.
Variable Name: boolStatus
Type: Boolean

                        ' Insert Broken-out View
boolStatus = swDrawing.CreateBreakOutSection(0.1)

In above code, we Insert Broken-out View into Drawing.
For this, we use CreateBreakOutSection method.
This CreateBreakOutSection method is part of swDrawing variable.
This method takes following parameters.
- Depth: X position for the Detail view.
Return Value : This CreateBreakOutSection method return True if the broken-out section was created, False if not.

In our code, I have used following values:

Parameter Name	Value Used
Depth	`0.1`

Reference: For more details please visit 🚀 online SOLIDWORKS API Help.

                        ' Check if we successfully insert Broken-out View
If boolStatus = False Then
  MsgBox "Failed to Insert Broken-out View."
  Exit Sub
End If

                      

In above code block, we check if we successfully insert views or not.
We use 🚀 IF statement for checking.
Condition: boolStatus = False
When this condition is True,
- We show and 🚀 message window to user.
- Message: *Failed to Insert Broken-out View.
- Then we stop our macro here.

                        ' Rebuild drawing
swDoc.ForceRebuild3 True

In above line, we Rebuild drawing.
For this we use ForceRebuild3 method which is part of SOLIDWORKS Document variable i.e swDoc variable.

Now we run the macro and after running macro we show selected component as shown in below image.

This is it !!!

I hope my efforts will helpful to someone! 😊

If you found anything to add or update, please let me know on my e-mail 📧.

Hope this post helps you to Insert Broken-out View with SOLIDWORKS VBA Macros.

For more such tutorials on SOLIDWORKS VBA Macro, do come to this website after sometime.

If you like the post then please share it with your friends also. 🙏🏻

Do let me know by you like this post or not!

Till then, Happy learning!!!