Page Comparison

ARES Commander supports three .NET API sets that you can use independently. Now here we’ll going to discuss about

This document describes CFx. NET(.NET ARES) and listed it’s lists the differences with .NET Classic API's coding.

1. .NET Classic API

2. ARES COM API

3. CFx .NET (SWIG generated .NET API version of ARES C++ SDK)
   
   Here We differentiate Differences between .NET Classic and .NET ARES.

...

1. Create a new .NET ARES project using the Visual Studio project creation Wizard(  **minimum requirement .NET Framework v4.5)
   

   

2. From Solution Explore, add references of of the following .dll:
   ArgonMGD.dll
   TD_SwigCoreMgd.dll

   TD_SwigDbMgd.dll

   TG_SwigDbMgd.dll

   TD_Mgd_x.xx_xx.dll from the ARES Commander installation folder.
   

   

   
   

   

   You can see all available NameSpaces, Classes, Methods, and Properties in each assembly in the Object Browser.

   

              

3. Rename Class1.cs to PluginCommands.cs. This changes the class Class1 to class PluginCommands, as in the following example.
   

   

4. Defining a command uses Teigha.Runtime namespace to access CommandMethod method attribute and adds a method, such as AnyFunctionName an AnyFunctionName method 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.
   

   

5. There is another way to You can also define a command , Directly inherit directly inheriting from CFxCommand and add . Use the Setup method to add an instance of this class to command stack by using Setup method it adds the command into the stack.
   

   Code Block

   namespace SamplePlugin { public class PluginCommands : CFxCommand { public bool m_bExecuted; public PluginCommands() { m_bExecuted = false; } public override string globalName() { return "SampleCMD"; } public override int Execute(CFxCommandContext pFxCmdCtx) { m_bExecuted = true; returnCFxDocument pFxDoc = PCADGlobals.RTNORM.FXAPI().GetFxDocument(); } if (pFxDoc == null) class CFxCommandTest : TestCase { return PCADGlobals.RTCAN; PluginCommands m_test; CFxCommandContext ctx = pFxDoc.GetFxCommandContext(); public CFxCommandTest() if (ctx == null) { return PCADGlobals.RTCAN; } public override string Name() { PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n SampleCMD Command Executed")); return "CFxCommand"PCADGlobals.RTNORM; } } class CFxCommandTest : IExtensionApplication { public override bool SetupTest() DocumentReactor docReactor; { PluginCommands m_test; m_test = newpublic PluginCommandsCFxCommandTest(); { Teigha.Core.Globals.odedRegCmds().addCommand(m_test); docReactor = returnnew trueDocumentReactor(); } public overridevoid bool ExecuteInitialize() { CFxDocumentm_test pFxDoc= = PCADGlobals.FXAPI().GetFxDocumentnew PluginCommands(); if (pFxDoc == null) return falseGlobals.odedRegCmds().addCommand(m_test); CFxCommandContext ctx = pFxDoc.GetFxCommandContext(PCADGlobals.GetFxSystemServices().GetFxDocumentManager().AddReactor(docReactor); } if (ctx == null) public void Terminate() return{ false; Teigha.Core.Globals.odedRegCmds().executeCommandremoveCmd(m_test.globalNamegroupName(), ctxm_test.globalName()); return truePCADGlobals.GetFxSystemServices().GetFxDocumentManager().RemoveReactor(docReactor); } } } }

6. Build the sample project to generate PluginCommands.dll or <YourProjectName.dll>.

7. Start ARES Commander and type NETLOAD at the command prompt. Next, browse and load the plugin dll (PluginCommands.dll).
   The command window displays a confirmation message.

...

Notifications(via Reactor Classes)

In .NET ARES there are Reactors

1. CFxDocumentManagerReactor

2. CFxDatabaseReactor

3. CFxEditorReactor

4. OdEdCommandStackReactor
   you can use Reactors like this:

class ReactorTest DocumentReactor : CFxDocumentManagerReactor
    {
        public override void DocumentActivated(CFxDocument pActivatedDoc)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentActivated Fired"));
        }
        public override void DocumentActivationModified(bool bActivation)
        {
            static DatabaseReactor _dbReactor;PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentActivationModified Fired"));
        }
        public staticoverride void OnDatabaseAttachedDocumentBecameCurrent(CFxDatabaseCFxDocument dbpDoc)
        {
            db.addReactor(_dbReactorPCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentBecameCurrent Fired"));
        }
        public staticoverride void OnDatabaseDetachedDocumentCreateCanceled(CFxDatabaseCFxDocument dbpDocCreateCancelled)
        {
            db.removeReactor(_dbReactorPCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentCreateCanceled Fired"));
        }
        public override void DocumentCreated(CFxDocument pDocCreating)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentCreated Fired"));
        }
     class DatabaseReactor : CFxDatabaseReactor    public override void DocumentCreateStarted(CFxDocument pDocCreating)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentCreateStarted Fired"));
        }
        public override void objectAppendedDocumentDestroyed(OdDbDatabaseCFxDocument pDbpDocToDestroyed, OdDbObjectCFxString pObjectstrFileName)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentDestroyed Fired"));
        }
        public override void objectModified(OdDbDatabase pDb, OdDbObject pObjectDocumentPreOpen(CFxDocument pDoc, CFxString strFileName, int codePage, int openFlags)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentPreOpen Fired"));
        }
        public override void objectErased(OdDbDatabase pDb, OdDbObject pObject DocumentToBeActivated(CFxDocument pActivatingDoc)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentToBeActivated Fired"));
        }
        public override void DocumentToBeDeactivated(CFxDocument pDeActivatedDoc)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentToBeDeactivated Fired"));
        }
        public override void goodbyeDocumentToBeDestroyed(OdDbDatabaseCFxDocument pDbpDocToDestroy)
        {
            PCADGlobals.GetFxSystemServices().WriteLine(new CFxString("\n Event DocumentToBeDestroyed Fired"));
        }
    }