AutoCAD-Fsharp-Project-Template

F# Visual Studio Project Template for an AutoCAD Plugin.

These templates allow to start a F# project for an AutoCAD plugin in Visual Studio . They are designed to automatically start the specified AutoCAD version and load the assemby when starting the debugging. 'AutoCAD R24 Fsharp Project Template' is to be used with AutoCAD prior to 2025 (targets .NET Framework). 'AutoCAD R25 Fsharp Project Template' is to be used with AutoCAD 2025 and later (targets .NET 8).

For AutoCAD 2016 and later versions it is imperative that the LEGACYCODESEARCH system variable is set to 1 to allow automatic loading of the assembly.

The helpers.fs file contains helpers to write some common AutoCAD tasks in a more declarative functional style. The command.fs file contains an example of command.

Example using pipeline style to erase lines shorter than a supplied value

let eraseShortLines minLength =
    use tr = Active.db.TransactionManager.StartTransaction()

    Active.db
    |> getModelSpace tr OpenMode.ForRead
    |> getObjects<Line> tr OpenMode.ForRead
    |> Seq.filter (fun l -> l.Length < minLength)
    |> upgradeOpen tr
    |> Seq.iter (fun l -> l.Erase())

    tr.Commit()

Example using a prompts workflow to get the center and radius of a circle

[<CommandMethod("DrawCircle")>]
let drawCircle () =
    let inputs =
        prompt {
            let! ppr = Active.ed.GetPoint("\nCenter: ")
            let! pdr = Active.ed.GetDistance(ppr.Value, "\nRadius: ")
            return (ppr.Value, pdr.Value)
        }

    match inputs with
    | None -> ()
    | Some (center, radius) ->
        use tr = Active.db.TransactionManager.StartTransaction()

        Active.db.CurrentSpaceId
        |> getObject<BlockTableRecord> tr OpenMode.ForWrite
        |> addEntity tr (new Circle(center, Vector3d.ZAxis, radius))
        |> ignore

        tr.Commit()

Editing the template files

In order for the template to work, the paths to the acad.exe file and to the autoCAD libraries must match those on the local computer.

Properties\launchSettings.json

The path to the acad.exe file of the AutoCAD version to be launched at debugging startup must be consistent with that of the local computer.

{
  "profiles": {
    "$safeprojectname$": {
      "commandName": "Executable",
      "executablePath": "C:\\Program Files\\Autodesk\\AutoCAD 2022\\acad.exe",
      "commandLineArgs": "/nologo /b \"start.scr\""
    }
  }
}

FsharpPluginNetFramework.fsproj / FsharpPluginNet8.fsproj

The MSBuild project file (.fsproj) is an xml file that describe and control the process of generation of the applications.

The paths to the AutoCAD libraries referenced by the project must be consistent with those of the local computer.

	<!-- Change the paths to the targeted AutoCAD libraries -->
	<ItemGroup>
		<Reference Include="accoremgd">
			<HintPath>F:\ObjectARX 2022\inc\AcCoreMgd.dll</HintPath>
			<Private>false</Private>
		</Reference>
		<Reference Include="Acdbmgd">
			<HintPath>F:\ObjectARX 2022\inc\AcDbMgd.dll</HintPath>
			<Private>false</Private>
		</Reference>
		<Reference Include="acmgd">
			<HintPath>F:\ObjectARX 2022\inc\AcMgd.dll</HintPath>
			<Private>false</Private>
		</Reference>
	</ItemGroup>

It is preferable that the required version of .NET (Framework) is the one installed by the targeted AutoCAD version (see this page).

    <!-- Change the targeted .NET Framework version -->
    <TargetFramework>net48</TargetFramework> 

MyTemplate.vstemplate

This file describes the template.

Name and Desription of the template.

		<!-- Change the name and description as desired -->
		<Name>Fsharp Plugin for AutoCAD R24</Name>
		<Description>Fsharp Plugin for AutoCAD R24 (.NET Framework)</Description>

Default name of the assembly.

		<!-- Change the default project name as desired -->
		<DefaultName>AcadR24FsharpPlugin</DefaultName>

Installation of the template

The 'AutoCAD Plugin Template' folder (possibly zipped) have to be pasted in the 'Visual Studio 20XX\Templates\ProjectTemplates' directory.