Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/madhukarmoogala/acadplugin
How to run Javascript routines in AutoCAD .NET Plugin using ClearScript library
https://github.com/madhukarmoogala/acadplugin
Last synced: 25 days ago
JSON representation
How to run Javascript routines in AutoCAD .NET Plugin using ClearScript library
- Host: GitHub
- URL: https://github.com/madhukarmoogala/acadplugin
- Owner: MadhukarMoogala
- License: mit
- Created: 2024-04-26T07:43:53.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-04-26T08:22:40.000Z (7 months ago)
- Last Synced: 2024-04-27T08:42:40.212Z (6 months ago)
- Language: C#
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# How to Run Javascript Routines in AutoCAD .NET Plugin Using ClearScript Library
The project demonstrates a well-structured approach to running JavaScript routines in an AutoCAD .NET plugin using the [ClearScript | Add scripting to your .NET applications quickly and easily.](https://microsoft.github.io/ClearScript/)
- **Exposing AutoCAD .NET Classes:** Enables access to AutoCAD functionality from JavaScript scripts.
- **Executing JavaScript Functions:** Allows you to run JavaScript functions within your AutoCAD application.
- **Calling C# Functions from JavaScript:** Facilitates interaction between your JavaScript code and C# functions.
```csharp
public class PrintMessage
{
private static Editor? _ed
{
get
{
Document doc = Autodesk.AutoCAD.ApplicationServices.Core.Application.DocumentManager.MdiActiveDocument;
if (doc != null)
{
return doc.Editor;
}
return null;
}
}
public static void Print(string message)
{
_ed?.WriteMessage($"{message}\n");
}
}
public class Commands
{
private const string _script = @"
function square(x) {
return x*x;
}";
//Execute JS functions in DotNet runtime
[CommandMethod("JSRoutine")]
public static void JSRoutine()
{
Document doc = Autodesk.AutoCAD.ApplicationServices.Core.Application.DocumentManager.MdiActiveDocument;
if (doc is null) return;
Editor ed = doc.Editor;
// Create aV8ScriptEngine instance,
using (var engine = new V8ScriptEngine())
{
engine.AccessContext = typeof(Commands);
//Now expose the PrintMessage class from .NET to the script engine,
// and then execute a JavaScript statement that writes a message to the AutoCAD Editor.
engine.AddHostType("PrintMessage", typeof(PrintMessage));
engine.Execute("PrintMessage.Print('Hello from JavaScript!');");
//Call the JS function square and retrieve the result.
engine.Execute(_script);
dynamic? result = engine.Script.square(5);
ed.WriteMessage($"{Convert.ToString(result)}\n");
//Execute the JS code and print the result to the AutoCAD Editor
engine.Execute("function print(x) {PrintMessage.Print(x); }");
engine.Script.print(DateTime.Now.DayOfWeek.ToString());
//Calling C# Functions from JavaScript:
engine.AddHostObject("Greet", new Func((name) => $"Hello, {name}!"));
engine.Execute("var message = Greet('World'); PrintMessage.Print(message);");
// examine a script object
engine.Execute("var person = { name: 'Fred', age: 5 }");
ed.WriteMessage($"From Script: \n{Convert.ToString(engine.Script.person.name)}");
}
}
}
```
###
### Requirements
- .NET 8.0
- AutoCAD 2025 & NuGet package: [AutoCAD.NET](https://www.nuget.org/packages/AutoCAD.NET)
- Visual Studio 2022 17.8
- ClearScript library NuGet package: [Microsoft.ClearScript](https://www.nuget.org/packages/Microsoft.ClearScript)
### Build
```bash
git clone https://github.com/MadhukarMoogala/AcadPlugin.git
cd AcadPlugin
dotnet build AcadPlugin.csproj -a x64 -c Debug
```
### Usage
- NETLOAD the AcadPlugin.dll
- Execute `JSROUTINE` command in AutoCAD Command Line.
### **License**
[MIT License](https://github.com/MadhukarMoogala/AcadPlugin/tree/main?tab=MIT-1-ov-file)
### Authors
Madhukar Moogala (@galakar)