Hide Table of Contents

Get DimXpert Feature Example (VBA)

This example builds a part to demonstrate usage of the DimXpert API for the following DimXpert features:


    *  Cylinder

    *  Fillet

    *  Plane

    *  Slot

    *  Pattern


' Preconditions:

' 1. Open <SolidWorks_install_dir>\samples\tutorial\api\cover_plate.sldprt.

' 2. Open the DimXpert toolbar from View > Toolbars.

' 3. Click the Auto Dimension Scheme icon in the DimXpert toolbar.

' 4. Ensure that all feature filters are selected.

' 5. Click the green check mark to accept the settings.

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

'    Cylinder, Fillet, Plane, Slot, Slot Pattern.

' 7. Open an Immediate window in the IDE.

' 8. Ensure that the latest SolidWorks DimXpert type library is loaded

'    in Tools > References.

' 9. Step through this macro (F8) and compare the output in the

'    Immediate Window with the features displayed in DimXpertManager.


' 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.


Option Explicit


Dim swApp As SldWorks.SldWorks

Dim swModel As SldWorks.ModelDoc2

Dim swModelDocExt As SldWorks.ModelDocExtension

Dim swSelMgr As SldWorks.SelectionMgr

Dim swConfig As SldWorks.Configuration

Dim swFeature As SldWorks.feature

Dim swAnn As SldWorks.feature

Dim swSchema As SldWorks.DimXpertManager

Dim swDXPart As DimXpertPart

Dim featureType As swDimXpertFeatureType_e

Dim features As Variant

Dim appliedFeatures As Variant

Dim appliedAnnotations As Variant

Dim appliedAnnotation As DimXpertAnnotation

Dim feature As DimXpertFeature

Dim appliedFeature As DimXpertFeature

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()

    Set swApp = Application.SldWorks

    Set swModel = swApp.ActiveDoc


    Set swModelDocExt = swModel.Extension

    Set swSelMgr = swModel.SelectionManager


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

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


    ' Get IDimXpertPart from the IDimXpertManager

    Set swDXPart = swSchema.DimXpertPart


    Dim featCount As Long

    featCount = swDXPart.GetFeatureCount

    msgStr = "Total of "

    msgStr2 = featCount

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

    Debug.Print ""

    Debug.Print msgStr


    ' Get IDimXpert features through IDimXpertPart

    features = swDXPart.GetFeatures


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

    Debug.Print ""

    Debug.Print msgStr

    For n = 0 To UBound(features)

        'Use IDimXpertFeature to get feature data

        Set 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 = "     " + "Swift model: "


        'Use IFeature to get the Swift model corresponding to this geometric dimensioning and tolerancing data

        Set 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 (IsEmpty(appliedFeatures)) Then

            For o = 0 To UBound(appliedFeatures)

                Set 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 (IsEmpty(appliedAnnotations)) Then

            For p = 0 To UBound(appliedAnnotations)

                Set 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


    Dim cylinderFeature As IDimXpertCylinderFeature

    Set cylinderFeature = swDXPart.GetFeature("Cylinder1")

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

        Debug.Print ""

        Debug.Print msgStr


    ' Get the nominal top plane coordinates for Cylinder1


    Dim x As Double

    Dim y As Double

    Dim z As Double

    Dim i As Double

    Dim j As Double

    Dim k As Double

    boolstatus = cylinderFeature.GetNominalTopPlane(x, y, z, i, j, k)

    msgStr = "X-coordinate of nominal top plane of " + cylinderFeature.Name + " is "

    msgStr2 = x

    Debug.Print msgStr + msgStr2


    ' Get the thread for the cylinder, if it exists


    Dim isThreaded As Boolean

    Dim threadDesignation As String

    Dim threadDepth As Double

    boolstatus = cylinderFeature.GetThread(isThreaded, threadDesignation, threadDepth)

    msgStr = "The cylinder is threaded? "

    msgStr2 = isThreaded

    Debug.Print msgStr + msgStr2

    Debug.Print ""


    ' Get the radius of Fillet1


    Dim filletFeature As IDimXpertFilletFeature

    Set filletFeature = swDXPart.GetFeature("Fillet1")

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

        Debug.Print ""

        Debug.Print msgStr

    Dim radius As Double

    radius = filletFeature.radius

    msgStr = "The fillet radius is "

    msgStr2 = radius

    Debug.Print msgStr + msgStr2


    Dim planeFeature As IDimXpertPlaneFeature

    Set planeFeature = swDXPart.GetFeature("Plane1")

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

        Debug.Print ""

        Debug.Print msgStr


    ' Get the nominal top plane coordinates for Plane1


    boolstatus = planeFeature.GetNominalPlane(x, y, z, i, j, k)

    msgStr = "X-coordinate of nominal top plane of " + planeFeature.Name + " is "

    msgStr2 = x

    Debug.Print msgStr + msgStr2


    ' Get the nominal closed slot width for Slot1


    Dim slotFeature As IDimXpertCompoundClosedSlot3DFeature

    Set slotFeature = swDXPart.GetFeature("Slot1")

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

        Debug.Print ""

        Debug.Print msgStr

    Dim width As Double

    Dim length As Double

    Dim longitudeI As Double

    Dim longitudeJ As Double

    Dim longitudeK As Double

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

    msgStr = "Width of nominal closed slot is "

    msgStr2 = width

    Debug.Print msgStr + msgStr2


    ' Get the sub-features of Slot Pattern1


    Dim patternFeature As IDimXpertPatternFeature

    Set patternFeature = swDXPart.GetFeature("Slot Pattern1")

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

        Debug.Print ""

        Debug.Print msgStr


    featureType = patternFeature.PatternType

    Call GetPatternType(featureType, msgStr2)


    Dim featureCount As Integer

    featureCount = patternFeature.GetSubFeatureCount()

    msgStr = "     Number of "

    msgStr3 = featureCount

    Debug.Print msgStr + msgStr2 + " is " + msgStr3


    Dim subfeatures As Variant

    subfeatures = patternFeature.GetSubFeatures()

    Debug.Print "     Sub-features of Slot Pattern1:"

    For n = 0 To UBound(subfeatures)

        ' Use IDimXpertCompoundClosedSlot3DFeature to get the two planes of the slot

        ' The names of the planes are inherited from the Name property of the parent interface, IDimXpertFeature

        Set slotFeature = subfeatures(n)

        Debug.Print "        " + slotFeature.Name

        Dim plane1 As IDimXpertPlaneFeature

        Dim plane2 As IDimXpertPlaneFeature

        boolstatus = slotFeature.GetPlaneFeatures(plane1, plane2)

        Debug.Print "          " + plane1.Name

        Debug.Print "          " + plane2.Name


End Sub

Public Sub GetPatternType(ByRef featureType, ByRef msgStr2)

    If (featureType = swDimXpertFeature_Plane) Then

            msgStr2 = "Plane"

    ElseIf (featureType = swDimXpertFeature_Cylinder) Then

            msgStr2 = "Cylinder"

    ElseIf (featureType = swDimXpertFeature_Cone) Then

            msgStr2 = "Cone"

    ElseIf (featureType = swDimXpertFeature_Extrude) Then

            msgStr2 = "Extrude"

    ElseIf (featureType = swDimXpertFeature_Fillet) Then

            msgStr2 = "Fillet"

    ElseIf (featureType = swDimXpertFeature_Chamfer) Then

            msgStr2 = "Chamfer"

    ElseIf (featureType = swDimXpertFeature_CompoundHole) Then

            msgStr2 = "CompoundHole"

    ElseIf (featureType = swDimXpertFeature_CompoundWidth) Then

            msgStr2 = "CompoundWidth"

    ElseIf (featureType = swDimXpertFeature_CompoundNotch) Then

            msgStr2 = "CompoundNotch"

    ElseIf (featureType = swDimXpertFeature_CompoundClosedSlot3D) Then

            msgStr2 = "CompoundClosedSlot3D"

    ElseIf (featureType = swDimXpertFeature_IntersectPoint) Then

            msgStr2 = "IntersectPoint"

    ElseIf (featureType = swDimXpertFeature_IntersectLine) Then

            msgStr2 = "IntersectLine"

    ElseIf (featureType = swDimXpertFeature_IntersectCircle) Then

            msgStr2 = "IntersectCircle"

    ElseIf (featureType = swDimXpertFeature_IntersectPlane) Then

            msgStr2 = "IntersectPlane"

    ElseIf (featureType = swDimXpertFeature_Pattern) Then

            msgStr2 = "Pattern"

ElseIf (featureType = swDimXpertFeature_Sphere) Then

            msgStr2 = "Sphere"

ElseIf (featureType = swDimXpertFeature_BestfitPlane) Then

            msgStr2 = "Bestfit plane"

ElseIf (featureType = swDimXpertFeature_Surface) Then

            msgStr2 = "Surface"

    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:   Get DimXpert Feature 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) 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.