Hide Table of Contents

Get More DimXpert Feature Examples (VB.NET)

This example shows how to build and get attributes for the following DimXpert features:


    *  Hole

    *  Notch


' Preconditions:

' 1. Open:

' <SolidWorks_install_dir>\samples\tutorial\api\cover_with_dimensions.sldprt

' 2. Open the DimXpert toolbar from View > Toolbars

'    (select the first instance of Toolbars on the View menu).

' 3. Observe the following DimXpert features on the DimXpertManager tab:  

'    Simple Hole2, Notch1.

' 4. Open an Immediate window in the IDE.

' 5. Ensure that the latest SolidWorks.Interop.swdimxpert.dll interop assembly

'    is loaded (right-click on the project in Project Explorer,

'    click Add Reference, click .NET tab)

' 6. Step through this macro (F8).


' Postconditions: Compare the output in the Immediate Window

' with the features displayed on the DimXpertManager tab of the Management Panel.

' NOTE: Because this part is used in a SolidWorks online tutorial,

' do not save any changes when you close it.


Imports SolidWorks.Interop.sldworks

Imports SolidWorks.Interop.swdimxpert

Imports SolidWorks.Interop.swconst

Imports System

Imports System.Diagnostics

Partial Class SolidWorksMacro


    Dim swModel As IModelDoc2

    Dim swModelDocExt As IModelDocExtension

    Dim swSelMgr As ISelectionMgr

    Dim swConfig As IConfiguration

    Dim swFeature As IFeature

    Dim swAnn As IFeature

    Dim swSchema As IDimXpertManager

    Dim swDXPart As IDimXpertPart

    Dim featureType As swDimXpertFeatureType_e

    Dim holeType As swDimXpertCompoundHoleType_e

    Dim features As Object

    Dim appliedFeatures As Object

    Dim appliedAnnotations As Object

    Dim appliedAnnotation As IDimXpertAnnotation

    Dim feature As IDimXpertFeature

    Dim appliedFeature As IDimXpertFeature

    Dim msgStr As String

    Dim msgStr2 As String

    Dim msgStr3 As String

    Dim msgStr4 As String

    Dim n As Long

    Dim o As Long

    Dim p As Long

    Dim boolstatus As Boolean

    Sub main()

        swModel = swApp.ActiveDoc

        swModelDocExt = swModel.Extension

        swSelMgr = swModel.SelectionManager

        ' Get the default DimXpert schema using IModelDocExtension.DimXpertManager()

        swSchema = swModelDocExt.DimXpertManager("Default", True)

        ' Get IDimXpertPart from the IDimXpertManager

        swDXPart = swSchema.DimXpertPart

        Dim featCount As Long

        featCount = swDXPart.GetFeatureCount

        msgStr = "Total of "

        msgStr2 = featCount

        msgStr = msgStr + msgStr2 + " features in " + (swSchema.SchemaName)



        ' Get IDimXpert features through IDimXpertPart

        features = swDXPart.GetFeatures

        msgStr = (swSchema.SchemaName) + " has the following features: "



        For n = 0 To UBound(features)

            feature = features(n)

            Debug.Print("  " + "Feature name: " + (feature.Name))

            featureType = feature.Type

            Call GetPatternType(featureType, msgStr2)

            msgStr = "     Feature type "

            msgStr3 = " is suppressed on the DimXpertManager tab? "

            msgStr4 = feature.IsSuppressed()

            Debug.Print(msgStr + msgStr2 + msgStr3 + msgStr4)

            msgStr = "     " + "Model feature: "

            swFeature = feature.GetModelFeature()

            If Not (swFeature Is Nothing) Then

                msgStr2 = swFeature.GetTypeName2()

                Debug.Print(msgStr + msgStr2)

            End If

            msgStr = "     " + "Number of SolidWorks face entities in this feature: "

            msgStr2 = feature.GetFaceCount

            Debug.Print(msgStr + msgStr2)

            msgStr = "     " + "Number of applied features: "

            msgStr2 = feature.GetAppliedFeatureCount()

            Debug.Print(msgStr + msgStr2)

            appliedFeatures = feature.GetAppliedFeatures()

            If Not (IsNothing(appliedFeatures)) Then

                For o = 0 To UBound(appliedFeatures)

                    appliedFeature = appliedFeatures(o)

                    Debug.Print("        " + "Applied feature name: " + (appliedFeature.Name))


            End If

            msgStr = "     " + "Number of applied annotations: "

            msgStr2 = feature.GetAppliedAnnotationCount()

            Debug.Print(msgStr + msgStr2)

            appliedAnnotations = feature.GetAppliedAnnotations()

            If Not (IsNothing(appliedAnnotations)) Then

                For p = 0 To UBound(appliedAnnotations)

                    appliedAnnotation = appliedAnnotations(p)

                    Debug.Print("        " + "Applied annotation name: " + (appliedAnnotation.Name))


            End If

            Debug.Print("     ")


        ' If you know the name of a DimXpert feature, you can get it directly using IDimXpertPart.GetFeature("name"),

        ' which can return a general IDimXpertFeature or a more specific interface on the feature

        ' Get IDimXpertCompoundHoleFeature for the Simple Hole2 feature

        Dim holeFeature As IDimXpertCompoundHoleFeature

        holeFeature = swDXPart.GetFeature("Simple Hole2")

        msgStr = holeFeature.Name + " is a DimXpert feature"




        ' Get the bottom feature if one exists

        Dim bottomFeature As IDimXpertFeature

        bottomFeature = holeFeature.GetBottomFeature

        If Not (bottomFeature Is Nothing) Then

            msgStr = "Bottom feature is "

            msgStr2 = bottomFeature.Name

            Debug.Print(msgStr + msgStr2)

        End If

        ' Get the reference feature

        Dim refFeature As IDimXpertFeature

        refFeature = holeFeature.GetReferenceFeature

        msgStr = "Reference feature for dimensioning is "

        msgStr2 = refFeature.Name

        Debug.Print(msgStr + msgStr2)

        ' Get the sub-feature count

        Dim count As Integer

        count = holeFeature.GetSubFeatureCount

        msgStr = "Number of subfeatures is "

        msgStr2 = count

        Debug.Print(msgStr + msgStr2)

        ' Get whether the hole is blind

        msgStr = "Hole feature is blind and not through: "

        msgStr2 = holeFeature.Blind

        Debug.Print(msgStr + msgStr2)

        ' Get the type of the hole

        holeType = holeFeature.CompoundHoleType

        msgStr = "Hole feature is type: "

        Call GetHoleType(holeType, msgStr2)

        Debug.Print(msgStr + msgStr2)

        ' Get IDimXpertCompoundNotchFeature for the Notch1 feature

        Dim notchFeature As IDimXpertCompoundNotchFeature

        notchFeature = swDXPart.GetFeature("Notch1")

        msgStr = notchFeature.Name + " is a DimXpert feature"




        ' Get the nominal notch coordinates

        Dim width As Double

        Dim length As Double

        Dim x As Double

        Dim y As Double

        Dim z As Double

        Dim i As Double

        Dim j As Double

        Dim k As Double

        Dim longitudeI As Double

        Dim longitudeJ As Double

        Dim longitudeK As Double

        Debug.Print("Nominal notch of Notch1")


        boolstatus = notchFeature.GetNominalNotch(width, length, x, y, z, i, j, k, longitudeI, longitudeJ, longitudeK)

        msgStr = "Width is "

        msgStr2 = width

        Debug.Print(msgStr + msgStr2)

        msgStr = "Length is "

        msgStr2 = length

        Debug.Print(msgStr + msgStr2)

        msgStr = "X-coordinate is "

        msgStr2 = x

        Debug.Print(msgStr + msgStr2)

        msgStr = "Y-coordinate is "

        msgStr2 = y

        Debug.Print(msgStr + msgStr2)

        msgStr = "Z-coordinate is "

        msgStr2 = z

        Debug.Print(msgStr + msgStr2)

        msgStr = "I-component of unit vector is "

        msgStr2 = i

        Debug.Print(msgStr + msgStr2)

        msgStr = "J-component of unit vector is "

        msgStr2 = j

        Debug.Print(msgStr + msgStr2)

        msgStr = "K-component of unit vector is "

        msgStr2 = k

        Debug.Print(msgStr + msgStr2)

        msgStr = "Longitudinal i-component of pierce unit vector is "

        msgStr2 = longitudeI

        Debug.Print(msgStr + msgStr2)

        msgStr = "Longitudinal j-component of pierce unit vector is "

        msgStr2 = longitudeJ

        Debug.Print(msgStr + msgStr2)

        msgStr = "Longitudinal k-component of pierce unit vector is "

        msgStr2 = longitudeK

        Debug.Print(msgStr + msgStr2)


    End Sub

    Public Sub GetPatternType(ByRef featureType As swDimXpertFeatureType_e, ByRef msgStr2 As String)

        If (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Plane) Then

            msgStr2 = "Plane"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Cylinder) Then

            msgStr2 = "Cylinder"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Cone) Then

            msgStr2 = "Cone"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Extrude) Then

            msgStr2 = "Boss"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Fillet) Then

            msgStr2 = "Fillet"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Chamfer) Then

            msgStr2 = "Chamfer"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundHole) Then

            msgStr2 = "CompoundHole"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundWidth) Then

            msgStr2 = "CompoundWidth"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundNotch) Then

            msgStr2 = "CompoundNotch"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_CompoundClosedSlot3D) Then

            msgStr2 = "CompoundClosedSlot3D"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectPoint) Then

            msgStr2 = "IntersectPoint"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectLine) Then

            msgStr2 = "IntersectLine"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectCircle) Then

            msgStr2 = "IntersectCircle"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_IntersectPlane) Then

            msgStr2 = "IntersectPlane"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Pattern) Then

            msgStr2 = "Pattern"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Sphere) Then

            msgStr2 = "Sphere"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_BestfitPlane) Then

            msgStr2 = "Bestfit plane"

        ElseIf (featureType = swDimXpertFeatureType_e.swDimXpertFeature_Surface) Then

            msgStr2 = "Surface"

        End If

    End Sub

    Public Sub GetHoleType(ByRef holeType As swDimXpertCompoundHoleType_e, ByRef msgStr2 As String)

        If (holeType = swDimXpertCompoundHoleType_e.swDimXpertCompoundHoleType_Compound) Then

            msgStr2 = "Compound"

        ElseIf (holeType = swDimXpertCompoundHoleType_e.swDimXpertCompoundHoleType_Counterbore) Then

            msgStr2 = "Counterbore"

        ElseIf (holeType = swDimXpertCompoundHoleType_e.swDimXpertCompoundHoleType_Countersink) Then

            msgStr2 = "Countersink"

        ElseIf (holeType = swDimXpertCompoundHoleType_e.swDimXpertCompoundHoleType_Simple) Then

            msgStr2 = "Simple"

        End If

    End Sub


    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:   Get More DimXpert Feature Examples (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) 2010 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.