HyperPics: Beyond the UI

What APIs and Developer Documentation are Available for AutoCAD?

There are a wide range of APIs (Application Programming Interfaces) that are available for creating custom applications in AutoCAD.  Which API is right for you depends greatly on your experience and the time you can commit to learning, but for many the first API that they are ever exposed to is AutoLISP because of its ease of use and the sheer number of programs that are available for download from the Internet.

AutoLISP allows you to channel your knowledge of AutoCAD commands, and begin to combine them in ways that you might have never thought possible or maybe you have and that is what kick started your interest in programming.  Where you go from there is often different for many.  Many simply learn AutoLISP and that is enough for them to improve the tasks that they perform on a daily basis. For others, AutoLISP is simply a stepping stone towards Managed .NET or even ObjectARX.

The available AutoCAD APIs are:

• AutoLISP
• ActiveX/COM
  • AutoCAD
  • Transmittal (eTransmit/Archive)
  • Sheet Set Object (Sheet Set Manager)
  • CAD Standards Plug-in (CAD Standards and Batch Standards Checker)
  • Connectivity Automation Object (dbConnect)
• JavaScript
• ObjectARX
• Managed .NET

The JavaScript API is the newest of all the AutoCAD APIs; it was introduced with AutoCAD 2014.

The documentation for all of the available AutoCAD APIs can be located under the AutoCAD Developer Center. Based on which API you want to work with, you might find that some of the documentation is available through the product's help, installed locally with the product, or available with the ObjectARX SDK.

Sincerely,
  Lee

AutoCAD 2014 API and Developer Documentation Changes

By now, there has been lots of information circulating about what is new in AutoCAD 2014 from an end user perspective but what about the API side of things. AutoCAD 2014 offers a number of API changes, updates to the documentation, and a new API.

First and foremost, AutoCAD 2014 is binary compatible with AutoCAD 2013; programs developed for AutoCAD 2013 should run in AutoCAD 2014 without needing to be recompiled.

JavaScript API

This new API is used to provide the core functionality of the DesignFeed and Live Maps features. What can be done with this new API at the moment is limited, but does open up many new possibilities though. For additional information see:

• JavaScript Reference Guide
• Zooming to an AutoCAD entity using JavaScript - Through the Interface (Kean Walmsley)
• Getting Started with JavaScript API on AutoCAD 2014 - AutoCAD DevBlog (Philippe Leefsma)
• Enabling AutoCAD 2014 JavaScript Debugging - AutoCAD DevBlog (Fenton Webb)

Trusted File Paths

Not just an API change but a security change to which files are automatically loaded and from where they can be loaded from. This change impacts all program file types. There are a few API level changes that you should be aware of, but if your programs are not trusted they do not matter much. So the first things you need to be aware of are the SECURELOAD system variable and the Trusted Locations node on the Files tab of the Options dialog box. For additional information see:

• AutoCAD 2014 and Security - AutoCAD DevBlog (Gopinath Taget)
• AutoCAD 2014 for developers - Through the Interface (Kean Walmsley)

VBA 7.1

Microsoft has recently given new life to the once deprecated VBA technology. VBA 6.3 was the last supported release, which was still being used in AutoCAD 2013 as long as you downloaded the separate installer. VBA 6.3 was 32-bit only and is why there was performance issues when using it with AutoCAD 64-bit. VBA 7.1 resolves this issue by supporting both 32-bit and 64-bit platforms. If you have VBA programs from AutoCAD 2013 or earlier, and you are using Windows 64-bit you might encounter issues if you are using third-party libraries or form controls that do not support 64-bit.  Check with the third-party vendor and see if they offer a 64-bit version for you to use, if not you will need to rework your code and/or forms.

The ActiveX/VBA document has also been updated as well and can be found installed on your local drive at:

• %ProgramFiles%\Common Files\Autodesk Shared\acad_aag.chm - Developer's Guide
• %ProgramFiles%\Common Files\Autodesk Shared\acadauto.chm - Reference Guide

AutoLISP

There were no real notable changes to the API this release or the Visual LISP IDE, with the exception of two new functions.

• showHTMLModalWindow - Displays a modal window with a HTML document; use in conjunction with the new JavaScript API.
• findtrustedfile - Searches the AutoCAD trusted file paths for the specified file.

ObjectARX

Changes to the ObjectARX API are limited to new classes and functions.

• AcDb
  • AcDbExtents2d - New class
  • AcDbGeoDataReactor - New class
  • AcDbModelDocViewStyle - New methods added; existing class
  • AcDbXrecord - New method added; existing class
  • AcDbXrecordIterator - New methods added; existing class
• AcAp
  • AcApDocument - New method added; existing class
• Global functions
  • acedAddHTMLPalette - New
  • acedFindTrustedFile - New
  • acedLoadJSScript - New
  • acedShowHTMLModalWindow - New
  • acedShowHTMLModelessWindow - New
• Miscellaneous class
  • IPointCloudFilter2 - New

Managed .NET

Changes to the Managed .NET API are limited to new classes and functions.

• Autodesk.AutoCAD.ApplicationServices
  • Application.ShowModalWindow Method
  • Application.ShowModelessWindow Method
  • Document.IsNamedDrawing Property
• Autodesk.AutoCAD.DatabaseServices
  • MLeader.Scale Property
  • Region.AreaProperties Method
  • RegionAreaProperties Structure 
  • RegionAreaProperties.Area Property
  • RegionAreaProperties.Centroid Property
  • RegionAreaProperties.Extents Property
  • RegionAreaProperties.MomentsOfInertia Property
  • RegionAreaProperties.Perimeter Property
  • RegionAreaProperties.PrincipalMoments Property
  • RegionAreaProperties.ProductOfInertia Property
  • RegionAreaProperties.RadiiOfGyration Property
  • Xrecord.Append Method
  • XrecordEnumerator.Current Property
  • XrecordEnumerator.InsertAtCurrent Method
  • XrecordEnumerator.RemoveCurrent Method
• Autodesk.AutoCAD.EditorInput
  • Editor.ApplyCurDwgLayerTableChanges Method
  • Editor.PostCommandPrompt Method
• Autodesk.AutoCAD.GraphicsInterface
  • TextStyle.FromTextStyleTableRecord Method
  • TextStyle.ToTextStyleTableRecord Method
• Autodesk.AutoCAD.Windows
  • Window.Focus Method
• Autodesk.AutoCAD.ApplicationServices.Core
  • Application.LoadJSScript Method

The Developer's Guide was updated in the following areas were changed:

• Viewports and layouts
• Plotting and publishing
• Document events
• Disposal of objects
• Plot styles
• Visual styles and render presets
• Raster images and xrefs
• Clipping blocks, xrefs, and raster images
• Defining and inserting blocks, and working with attributes

The .NET Developer's Guide is part of the product help.

Hope this helps give you an understanding of the changes that you might or might not need to make with your custom programs.

Sincerely,
  Lee

AutoCAD Developer Documentation Survey

Do you create AutoLISP, VBA, .NET, or ObjectARX applications to automate tasks for your company or to solve problems for a client?  If so, chances are you might have used the AutoCAD developer documentation. The Learning Experience team would like some input on the developer documentation via the AutoCAD Developer Documentation Survey. The survey will take 5-10 minutes of your time.

Here is the link to the survey -
https://www.surveymonkey.com/s/H72RWJC

Sincerely,
  Lee

Updated AutoCAD 2013 ActiveX Developer Documentation

A new update to the AutoCAD 2013 ActiveX Developer Documentation has recently been made available through the AutoCAD Developer Center. The updated documentation set can be found at the bottom of the page under the Documentation section.

The updates that were made to the documentation are:

• Corrections to the existing VBA samples
• VBA samples ported to show the use of AutoLISP/Visual LISP
• Reference documentation updated to include all the latest and previously missing classes/properties/methods
• Full list of changes to the API from AutoCAD 2000 through AutoCAD 2013
• Corrections to and the inclusion of the ActiveX Developer's Guide

To utilize the documentation with the VBA IDE or Visual LISP IDE, download and extract the contents of the ZIP file to the following location:

C:\Program Files\Common Files\Autodesk Shared

Sincerely,
  Lee

ActiveX API Changes in AutoCAD 2013

While the ActiveX API typically does not see significant changes between releases like the Managed .NET and ObjectARX APIs do, it is still useful to know what changes were made.  There were really no major changes made to the AutoCAD 2013 ActiveX API, outside of the following three areas:

• Drawing file format (AcSaveAsType Enum)
• PointCloud property and enum additions
• Checking the interference of a 3DSolid (CheckInterference method)

Note: The AutoCAD ActiveX API can be used with AutoLISP, VBA, .NET, and C++ but only on Windows and not on Mac OS.

A full list of the changes made to the AutoCAD 2013 ActiveX API are:

Changed Enums:
AcSaveAsType
        ac2013_dwg = 60 (New)
        ac2013_dxf = 61 (New)
        ac2013_Template = 62 (New)
        acNative = 60 (Changed)

New Enums:
AcPointCloudIntensityStyle
        acIntensityGrayscale = 0
        acIntensityRainbow = 1
        acIntensityRed = 2
        acIntensityGreen = 3
        acIntensityBlue = 4
        acIntensityEditableFlag = 5
AcPointCloudColorType
        acTrueColor = 0
        acByColor = 1

Changed Classes:
IAcad3DSolid
        CheckInterference - Method (Added solid interfere parameter)
IAcadDynamicBlockReferenceProperty (Changed)
        show - Property (Renamed, previously Show)
IAcadEntity
        EntityTransparency - Property (New)
IAcadHatch
        BackgroundColor - Property (New)
IAcadLoftedSurface
        EndSmoothContinuity - Property (New)
        EndSmoothMagnitude - Property (New)
        Periodic - Property
        StartSmoothContinuity - Property (New)
        StartSmoothMagnitude - Property (New)
IAcadPointCloud
        Height - Property (New)
        IntensityColorScheme - Property (New)
        Length - Property (New)
        Name - Property (New)
        Path - Property (New)
        ShowClipped - Property (New)
        ShowIntensity - Property (New)
        Width - Property (New)
IAcadPreferencesFiles
        ActiveInvProject - Property (New)
IAcadRasterImage
        transparency - Property (Renamed, previously Transparency)
IAcadSpline
        Closed2 - Property (New)
        Degree2 - Property (New)
        KnotParameterization - Property (New)
        SplineFrame - Property (New)
        SplineMethod - Property (New)
IAcadSurface
        EdgeExtensionDistances - Property (New)
        MaintainAssociativity - Property (New)
        ShowAssociativity - Property (New)
        SurfTrimAssociativity - Property (New)
        WireframeType - Property (New)

Removed Classes:
Classes were merged with the class in which they were derived in most cases (ie. IAcadEntity2 -> IAcadEntity)
IAcad3DFace2
IAcad3DPolyline2
IAcad3DSolid2
IAcadArc2
IAcadAttribute2
IAcadBlockReference2
IAcadCircle2
IAcadDim3PointAngular2
IAcadDimAligned2
IAcadDimAngular2
IAcadDimArcLength2
IAcadDimDiametric2
IAcadDimOrdinate2
IAcadDimRadial2
IAcadDimRadialLarge2
IAcadDimRotated2
IAcadEllipse2
IAcadEntity2
IAcadExternalReference2
IAcadExtrudedSurface2
IAcadExtrudedSurface3
IAcadHatch2
IAcadHelix2
IAcadLine2
IAcadLeader2
IAcadLoftedSurface2
IAcadLoftedSurface3
IAcadLWPolyline2
IAcadMLeader2
IAcadMText2
IAcadNurbSurface2
IAcadOle2
IAcadPlaneSurface2
IAcadPlaneSurface3
IAcadPoint2
IAcadPolyfaceMesh2
IAcadPolygonMesh2
IAcadPolyline2
IAcadPViewport2
IAcadRay2
IAcadRasterImage2
IAcadRegion2
IAcadRevolvedSurface2
IAcadRevolvedSurface3
IAcadShape2
IAcadSolid2
IAcadSpline2
IAcadSurface2
IAcadSurface3
IAcadSweptSurface2
IAcadSweptSurface3
IAcadSubDMesh2
IAcadTable2
IAcadText2
IAcadTolerance2
IAcadTrace2
IAcadXline2
IAcadWipeout2

Sincerely,
  Lee

Danger VBA Developers, VBA Will Be Offline

Okay not quite as catchy or timeless as "Danger Will Robinson!" or "Robot is online." (both from Lost in Space), but I hope you get where this is all heading.  However, it is the ugly truth that is coming towards all of us at sub-light speeds.  AutoCAD 2011 will be the last release of AutoCAD that will support the ability to install a VBA enabler and run DVB project files.  That means, if you do not migrate your VBA programs (DVB files) to AutoLISP, .NET, or ObjectARX you will not be able to use them in the next release of AutoCAD.

Here is the text from the AutoCAD Readme about VBA and its future in AutoCAD:

Visual Basic for Applications (VBA)

Microsoft Visual Basic^® for Applications (VBA) is available for free download at http://www.autodesk.com/vba-download. Autodesk is transitioning from VBA technology to .NET Framework. The VBA module is available for AutoCAD 2011-based products as an unsupported feature. It will not be available in future releases of AutoCAD. Autodesk will provide documentation and other assistance to help customers and developers migrate from VBA to .NET Framework.

To migrate your VBA projects, you will need to download the VBA enabler for AutoCAD 2011 (or AutoCAD 2010) from the following URL:

  http://www.autodesk.com/vba-download

With a bit of effort and a basic understanding of .NET you can migrate your code from VBA to VB.NET.  To help make the transition, we created several procedures on creating a .NET project and placed them in the AutoCAD .NET Developer's Guide which was posted last summer.  The AutoCAD .NET Developer's Guide also contains a large number of code samples that can be copy and pasted into a VB.NET or C# project and used with minimal effort.  The AutoCAD .NET Developer's Guide can be viewed from the following location:

http://www.autodesk.com/autocad-net-developers-guide

As the year goes along, I will post articles that focus on migrating from VBA to VB.NET and some of the basics of VB.NET as they might apply to you the VBA developer.  Until later, take some time to review the AutoCAD .NET Developer's Guide and let me know if you have any questions.

Sincerely,
  Lee

VBA Downloads for AutoCAD

I have uploaded a couple of additional sample VBA projects to my website that can be downloaded.  Below is an overview of the 4 samples that are currently available.

CustomDblClickEdit - This example is used to demonstrate how you can replace the standard functionality of the Double Click Editing inside of AutoCAD of your own handler. This allows for changing the default editors and the way objects are handled. Some what out dated with AutoCAD 2007, but if you are using a previous release and what to customize the actions that are performed when double clicking objects, you will want to check this one out.  Last updated for 2004, but will still work with 2005 and 2006 though.

SheetCount - This example is used to demonstrate how to create a custom sheet set property that holds the total number of sheets for all the sheets in the sheet set file. Project was originally developed with AutoCAD 2005 and later tested under AutoCAD 2006. A new version is now available for download that will work with AutoCAD 2007.

SummaryInfo - This example shows how to list, create and modify both standard and custom drawing properties for the current drawing. This is a great example to build on if you want to automate the population of custom properties that you want to use with fields in text objects.

The VBA sample code download page is available by clicking here. Check back once in a while as I will be uploading new samples as I have time to clean some of them up.  You never know what might show up on the site.  Stuck on trying to figure something out in VBA, just let me know and I will see what I can do about putting together a sample project file for you.  Looking for some AutoLISP sample code, well click the jump to access our AutoLISP downloads page.

Sincerely,
  Lee

AutoCAD & AutoCAD LT All-in-One Desk Reference For Dummies Book is Released

The AutoCAD & AutoCAD LT All-in-One Desk Reference For Dummies book has just been released and can be picked up at your favorite local bookstore or on the Internet from a site like BarnesandNobles.com or Amazon.com.  Like other books in the Dummies series, this book gives you the information that you need in order to quickly get up speed on new features if you are an existing user, or if you are a new user to AutoCAD or AutoCAD LT you will find the step-by-step approach helpful in learning the program much quicker.  The book covers AutoCAD 2007 and AutoCAD LT 2007, and weighs in at over 800 pages.  The book is broken down into 10 sub books that cover specific topics which allow you to find the information that you are looking for in a short period of time.

Click on the following links to read excerpts from the book:
Read Excerpt 1 (PDF)
Read Excerpt 2 (PDF)
Read Excerpt 3 (PDF)

Below is a listing of the 10 sub books and the chapters that can be found in each one:

Book I: AutoCAD Basics.
  Chapter 1: Drawing on (and in) AutoCAD.
  Chapter 2: Navigating the AutoCAD Interface.
  Chapter 3: All about Files.
  Chapter 4: Basic Tools.
  Chapter 5: Setting Up Drawings.
  Chapter 6: Precision Tools.

Book II: 2D Drafting.
  Chapter 1: Drawing Objects.
  Chapter 2: Modifying Objects.
  Chapter 3: Managing Views.

Book III: Annotating Drawings.
  Chapter 1: Text: When Pictures Just Won’t Do.
  Chapter 2: Dimensioning.
  Chapter 3: Hatching Your Drawings.

Book IV: LT Differences.
  Chapter 1: The LT Difference.
  Chapter 2: Extending AutoCAD LT.
  Chapter 3: Mixed Environments.

Book V: 3D Modeling.
  Chapter 1: Introducing the Third Dimension.
  Chapter 2: Using the 3D Environment.
  Chapter 3: Viewing in 3D.
  Chapter 4: Moving from 2D to 3D.
  Chapter 5: Working with Solids.
  Chapter 6: Working with Surfaces.
  Chapter 7: Rendering: Lights, Cameras, AutoCAD!

Book VI: Advanced Drafting.
  Chapter 1: Playing with Blocks.
  Chapter 2: Dynamic Blocks.
  Chapter 3: External References.
  Chapter 4: Organizing Your Drawings.
  Chapter 5: AutoCAD Utilities.

Book VII: Publishing Drawings.
  Chapter 1: Page Setup.
  Chapter 2: Sheet Sets without Regret.
  Chapter 3: Print, Plot, Publish.

Book VIII: Collaboration.
  Chapter 1: CAD Management: The Necessary Evil.
  Chapter 2: CAD Standards.
  Chapter 3: Working with Drawing Files.
  Chapter 4: Sharing Electronic Files.

Book IX: Customizing AutoCAD.
  Chapter 1: The Basics of Customizing AutoCAD.
  Chapter 2: Customizing the Interface.
  Chapter 3: Customizing the Tools.
  Chapter 4: Delving Deeper into Customization.

Book X: Programming AutoCAD.
  Chapter 1: The AutoCAD Programming Interfaces.
  Chapter 2: Using Custom Programs.
  Chapter 3: Introducing AutoLISP.
  Chapter 4: Visual Basic for AutoCAD.

This book was an absolute joy to write for my first published work through a publisher, and I hope you enjoy it as much as I did writing it.  Now what are you waiting for, go grab a cup of Starbucks (or a favorite drink of your's) and get a copy of the AutoCAD & AutoCAD LT All-in-One Desk Reference For Dummies Book.  After you pick up a copy of the book, it would be great to hear from you.

Sincerely,
  Lee

AutoCAD ActiveX History Reference

Do you find yourself maintaining multiple releases of AutoCAD and need to know what ActiveX functions existed in which release? Maybe you are on an older release and want to know what might have been added. A fellow read and visitor of my web site has shared with me his cross reference table of all the ActiveX Methods and Properties from AutoCAD 2000 through 2006.  Many thanks to Marc for sharing this.

Below is a linkt to the PDF file that he has posted.
AutoCAD ActiveX History (Methods and Properties)

Thanks,
  Lee

What's Changed in the ActiveX API? - AutoCAD 2004/2005

One of the readers of this blog asked if I had a list of changes in the ActiveX API for AutoCAD 2004 and AutoCAD 2005, just like I have provided for AutoCAD 2006.  Which my response was, "Yes I do".  It was a listing that I pulled together for my class that I taught at AU last year called "What's New in the ActiveX API?".  The class covered changes that dated back to AutoCAD 2004 and 2005.  So for those users of AutoCAD that are looking to upgrade this time around, here is a list of changes to the ActiveX API that you might be of interest to you.

Changes to the API for AutoCAD 2004
New Collections
AcadFileDependencies

New Classes
AcadAcCmColor
AcadFileDependency
AcadSummaryInfo
AcadSecurityParams

New Enumerators
AcColorMethod
AcGradientPatternType
AcHatchObjectType
AcShadePlot
AcadSecurityParamsConstants
AcadSecurityParamsType

Class Changes
AcadApplication
    Property - HWND

AcadDocument
    Property - FileDependencies
    Property - SummaryInfo

AcadExternalReference
    Property - EffectiveName

AcadHatch
    Property - GradientAngle
    Property - GradientCentered
    Property - GradientColor1
    Property - GradientColor2
    Property - GradientName
    Property - HatchObjectType

AcadLWPolyline
    Property - Length

AcadMtext
    Property - LineSpacingDistance

AcadMtext
    Property - RemoveHiddenLines (Removed)
    Property - ShadePlot (Replaces RemoveHiddelLines)

AcadPreferencesFiles
    Property - ColorBookPath
    Property - ToolPalettePath
    Property - LicenseServer (Removed)
    Property - ObjectARXPath (Removed)

AcadPreferencesOpenSave
    Property - SaveAsType (Constant values for AcSaveAsType changed)

AcadPreferencesUser
    Property - SCMTimeMode
    Property - SCMTimeValue

Changed Enumerators
AcSaveAsType
    ac2000_dwg
    ac2000_dxf
    ac2000_Template
    ac2004_dwg
    ac2004_dxf
    ac2004_Template
    acR18_dwg
    acR18_dxf
    acR18_Template
    acNative (value has changed to be the same as ac2004_dwg)

AcViewportScale
    acVp1and1_2in_1ft

Changes to the API for AutoCAD 2005
New Collections
N/A

New Classes
AcadOle
AcadSortentsTable
AcadTable
AcadTableStyle

New Enumerators
AcCellAlignment
AcCellEdgeMask
AcCellType
AcGridLineype
AcRowType
AcSelectType
AcTableDirection
AcTableStyleOverrides
AcOlePlotQuality
AcOleType
AcRotationAngle

Changed Collections
AcadLayers >> IAcadLayers2

Class Changes
AcadLayers
    Method - GenerateUsageData

Changed Classes
AcadLayer >> IAcadLayer2
AcadBlock >> IAcadBlock2
AcadModelSpace >> IAcadModelSpace2
AcadMText >> IAcadMText2
AcadPaperSpace >> IAcadPaperSpace2
AcadPreferencesFile >> IAcadPreferencesFile2
AcadPreferencesOutput >> IAcadPreferencesOutput2
AcadPViewport >> IAcadPViewport2
AcadText >> IAcadText2
AcadView >> IAcadView2

Class Changes
AcadDocument
    Event - BeginDocClose

AcadBlock
    Method - AddTable

AcadLayer
    Property - Description

AcadModelSpace
    Method - AddTable

AcadMText
    Property - BackgroundFill
    Method - FieldCode

AcadPaperSpace
    Method - AddTable

AcadPreferencesFile
    Property - PageSetupOverridesTemplateFile
    Property - PlotLogFilePath
    Property - QNewTemplatePath

AcadPreferencesOutput
    Property - AutomaticPlotLog
    Property - ContinuousPlotLog

AcadPViewport
    Property - HasSheetView
    Property - LabelBlockId
    Property - ModelView
    Property - SheetView
    Method - SyncModelView

AcadText
    Method - FieldCode

AcadView
    Property - CategoryName
    Property - HasVpAssociation
    Property - LayerState
    Property - LayoutId

Changed Enumerators
AcEntityName
    acTable

Sincerely,
  Lee