Skip to content

Latest commit

 

History

History
121 lines (109 loc) · 4.79 KB

README.md

File metadata and controls

121 lines (109 loc) · 4.79 KB
Raw

AutoCAD-Csharp-Project-Template

C# Visual Studio Project Template for an AutoCAD Plugin.

These templates allow to start a C# 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 Csharp Project Template' is to be used with AutoCAD prior to 2025 (targets .NET Framework). 'AutoCAD R25 Csharp 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.

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.

AutoCAD R24 Csharp Project Template

AutocadR24Plugin.csproj

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

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.

		<!-- Change the path to the installation folder of the targeted AutoCAD version -->
		<StartProgram>C:\Program Files\Autodesk\AutoCAD 2022\acad.exe</StartProgram>

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 -->
		<Reference Include="AcCoreMgd">
			<HintPath>C:\ObjectARX 2022\inc\AcCoreMgd.dll</HintPath>
			<Private>False</Private>
		</Reference>
		<Reference Include="AcDbMgd">
			<HintPath>C:\ObjectARX 2022\inc\AcDbMgd.dll</HintPath>
			<Private>False</Private>
		</Reference>
		<Reference Include="AcMgd">
			<HintPath>C:\ObjectARX 2022\inc\AcMgd.dll</HintPath>
			<Private>False</Private>
		</Reference>

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 -->
		<TargetFrameworkVersion>v4.8</TargetFrameworkVersion>

MyTemplate.vstemplate

This file describes the template.

Name and Desription of the template.

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

Default name of the assembly.

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

AutoCAD R25 Csharp Project Template

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 2025\\acad.exe",
      "commandLineArgs": "/nologo /b \"start.scr\""
    }
  }
}

AutocadR25Plugin.csproj

The MSBuild project file (.csproj) 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 2025\inc\AcCoreMgd.dll</HintPath>
			<Private>False</Private>
		</Reference>
		<Reference Include="Acdbmgd">
			<HintPath>F:\ObjectARX 2025\inc\AcDbMgd.dll</HintPath>
			<Private>False</Private>
		</Reference>
		<Reference Include="acmgd">
			<HintPath>F:\ObjectARX 2025\inc\AcMgd.dll</HintPath>
			<Private>False</Private>
		</Reference>
	</ItemGroup>

To reference Windows Forms or WPF libraries, you have to add the following nodes to the first PropertyGroup node.

<UseWindowsForms>true</UseWindowsForms>
<!-- and/or -->
<UseWPF>true</UseWPF>

To disable some .NET Core specific features such as Nullable References, remove the following node or replace enable with disable.

<Nullable>enable</Nullable>

MyTemplate.vstemplate

This file describes the template.

Name and Desription of the template.

		<!-- Change the name and description as desired -->
		<Name>AutoCAD R25 Plugin</Name>
		<Description>AutoCAD R25 Plugin (.NET 8)</Description>

Default name of the assembly.

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

Installation of the template

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