Page Comparison

ARES Commander provides .NET API which lets you author third party Plugin Software for ARES Commander.

...

ARES Commander supports three API sets which that you can use independently.

...

Creating a .NET Classic Plugin:

1. Create a new C#  or VB.NET project using the Visual Studio project Wizard(  **minimum requirement .NET Framework v4.5)
   
   Image Modified
2. Browse ARES Commander installation folder

...

1. and add references of TD_Mgd_x.xx_xx*.dll and FxCoreMgd_x.xx_xx.dll from Solution Explore.
   
   Image Modified
   

...

1. 
   You can

...

1. see all available NameSpaces, Classes, Methods, and Properties in each assembly

...

1. in the Object Browser.
   
   Image Modified
               
2. Rename Class1.cs to PluginCommands.cs. This changes the class Class1 to class PluginCommands, as in the following example.
   
   Image Modified
3. Defining a command uses Teigha.Runtime namespace to access CommandMethod method attribute and adds a method, such as AnyFunctionName

...

1. that has this attribute. The following example defines the MySampleCommand command which you can run later in ARES Commander, from the command prompt.
   You can define all types of in-process plugin using a similar procedure.
   Image Modified

...

1. Build the sample project

...

1. to generate PluginCommans.dll or <YourProjectName.dll>.
2. Start ARES Commander and type NETLOAD at the command prompt. Next, browse and load the plugin dll (PluginCommands.dll).
   The coommand window displays a confirmation message.
3. Run MySampleCommand, which executes the AnyFunctionName method. 

Accessing Application Object

...

Prompting for User Input 

?For user IO Editor class is responsible, one can get it from Document and all related class for UserIO are available in The Editor class controls the user Input and prints the output into command window. All related classes for prompting on the command window are available in Teigha.EditorInput namespace.

            Document activeDocument = docManager.MdiActiveDocument;
            Editor ed = activeDocument.Editor;

            PromptIntegerOptions op = new PromptIntegerOptions("Input a positive integer");
            op.AllowNegative = false;
            PromptIntegerResult res =(PromptIntegerResult) ed.DoPrompt(op);
            if( res.Status == PromptStatus.OK)
            {
                int retVal = res.Value;
            }

...

.NETExtension Application lets you run your code while loading the plugin.  

.i.e when plugin is loaded it want to add some entries in Ribbon or want to show some UI palatte in ARES Commander then creating the extension application is the right choice. But it is optional and totally depend upon the requirement.

???.NETExtension Application allow user to run their code while loading the plugin.i.e when plugin is loaded it want to add some entries in Ribbon or want to show some UI palatte in ARES Commander then creating the extension application is the right choice. But it is optional and totally depend upon the requirement.

To make the Plugin as For example, you must create the Plugin as an Extension Application to display tabs on the Ribbon or palettes while the plugin is loading in the software.

To create the Plugin as an Extension Application, add a class that implements IExtensionApplication interface. Each plugin can have only one class of such class.???public this type.

When you load the plugin using the NETLOAD command, public void Initialize() get called when this plugin loaded via NETLOAD command and Terminate one this plugin unloaded by the Systemis automatically called. When the System unloads the plugin, it calls Terminate.

Defining .NET LispFunction

Third party can define .NET methods , which can be used that you can use later in LISP. The following example defines the lisptest function using the LispFunction Method attribute. You can call this function using the following LISP script:

...

        //Method attribute to define lisp callable function 'LispTest' 
        //i.e (setq x (lisptest "Text created by .NET lisp function" 1.0 '(10 10 0)))
        [LispFunction("lisptest")]
        public ResultBuffer DoIt(ResultBuffer args)
        {
            // Get the database of the active document.
            Database db = HostApplicationServices.WorkingDatabase;
            TypedValue[] argsVal = new TypedValue[3];
            if (args != null)
            {
                argsVal = args.AsArray();
            }
            else
            {
                argsVal[0] = new TypedValue((int)LispDataType.Text, "Default Text");
                argsVal[1] = new TypedValue((int)LispDataType.Double, .2);
                argsVal[1] = new TypedValue((int)LispDataType.Point3d, new Point3d(0, 0, 0));
            }
            // Set up transaction manager.
            Teigha.DatabaseServices.TransactionManager tm = db.TransactionManager;
            using (Transaction tr = tm.StartTransaction())
            {
                try
                {
                    Point3d pPosition = new Point3d(0, 0, 0);

                    // Create a new MText object and set properties.
                    DBText pText = new DBText();
                    pText.TextString = (String)argsVal[0].Value;
                    pText.Height = Convert.ToDouble(argsVal[1].Value);
                    pText.Position = (Point3d)argsVal[2].Value;

                    // Get model space to add the MText object.
                    BlockTable pBlockTable = (BlockTable)tr.GetObject(db.BlockTableId, OpenMode.ForWrite);
                    BlockTableRecord pModelSpace = (BlockTableRecord)tr.GetObject(pBlockTable[BlockTableRecord.ModelSpace], OpenMode.ForWrite);

                    // Add the object to the model space.
                    ObjectId id = pModelSpace.AppendEntity(pText);
                    tr.AddNewlyCreatedDBObject(pText, true);

                    // Commit changes to database.
                    tr.Commit();
                    //return created text entity to lisp
                    return new ResultBuffer(new TypedValue((int)LispDataType.ObjectId, id));
                }
                finally
                {
                    // delete tr , managed by c# with garbage collection
                }

            }
        }

Migrating AutoCAD® .NET Classic Application to ARES Commander

...

Step 2: Using project Properties select all configurations one by one and define Symbol “AutoCAD” or “ARES” for the corresponding configurations.

i.e For AutoCAD_Release configuration

and For ARES_Release

 Step 3: Add Conditional reference assemblies to the project using Symbols, Modify csproj file manually in the text editor to add condition as below for all references as in the following example.

<ItemGroup>

    <Reference Include="accoremgd" Condition="$(DefineConstants.Contains('AutoCAD'))">

      <HintPath>C:\Program Files\Autodesk\AutoCAD 2018\accoremgd.dll</HintPath>

    </Reference>

    <Reference Include="acdbmgd" Condition="$(DefineConstants.Contains('AutoCAD'))">

      <HintPath>C:\Program Files\Autodesk\AutoCAD 2018\acdbmgd.dll</HintPath>

    </Reference>

    <Reference Include="acmgd" Condition="$(DefineConstants.Contains('AutoCAD'))">

      <HintPath>C:\Program Files\Autodesk\AutoCAD 2018\acmgd.dll</HintPath>

    </Reference>

    <Reference Include="FxCoreMgd_4.03_14" Condition="$(DefineConstants.Contains('ARES'))">

      <HintPath>C:\Program Files\Graebert GmbH\ARES Commander 2018\BIN\FxCoreMgd_4.03_14.dll</HintPath>

    </Reference>

    <Reference Include="TD_Mgd_4.03_14" Condition="$(DefineConstants.Contains('ARES'))">

      <HintPath>C:\Program Files\Graebert GmbH\ARES Commander 2018\BIN\TD_Mgd_4.03_14.dll</HintPath>

    </Reference>

  </ItemGroup>

Step 4: Changes in the source code add using directives for both the application conditionallyconditionally and Replace Autodesk.AutoCAD to CADApp in *.cs source files which is defined conditional declaration below.

#if  AutoCAD

using Autodesk.AutoCAD.DatabaseServices;

using Autodesk.AutoCAD.Runtime;

using Autodesk.AutoCAD.Geometry;

using Autodesk.AutoCAD.ApplicationServices;

using Autodesk.AutoCAD.EditorInput;

using CADApp = Autodesk.AutoCAD;

#endif



#if  ARES

using Teigha.DatabaseServices;

using Teigha.Runtime;

using Teigha.Geometry;

using Teigha.ApplicationServices;

using Teigha.EditorInput;

using CADApp = Teigha;

#endif

and Replace Autodesk.AutoCAD to CADApp in *.cs source files which is defined conditional declaration above.

Step 5:

Specify separate Output directories folders for both the configurations.

Build both configurations one by one these . The builds will work with their respective corresponding applications.