Autodesk Developer Network

Inside one of the above root folders you need to create a uniquely named folder whose name ends in “.bundle”. Directly inside this folder should be a configuration file named “PackageContents.xml”. There should also be a “Contents” subfolder where you put your deliverables.

So, the minimum ‘development’ installation would have 2 files, and be along the lines of:

• %APPDATA%\Autodesk\ApplicationPlugins\ADSK.MyApp.bundle\ PackageContents.xml
• % APPDATA %\Autodesk\ApplicationPlugins\ ADSK.MyApp.bundle \ Contents\ v14\ ADSK. MyPlugin.dll

Notes:

• This assumes we target at a bundle with binary of Navisworks 2021 only, where ‘v18’ is just a name of the sub folder to deploy the binary that is compiled with .NET API of 2017. If a binary of 2022, it can be ‘v19’.
• Real installations will probably require more than 2 files, as they will contain documentation, icons, etc.
• Real installations will require “ADSK” to be replaced by your unique ADN Developer ID. Recommend to name this ID by reversed version of your domain name, e.g. com.autodesk or uk.co.autodesk
• Your folder name must be unique across all Autodesk bundles. Prefixing with your own unique Developer ID is a good starting point.
• The name of each DLL you install must be unique within a running session of Navisworks. It must not clash with DLLs that Navisworks installs, or with those provided by any other Apps. Prefixing with your unique Developer ID is a good starting point.

The minimum ‘development’ configuration file will be along the lines of:

<?xml version="1.0" encoding="utf-8"?>

<?xml version="1.0" encoding="utf-8"?>

<ApplicationPackage > 

  <Components Description="2022 parts">

    <RuntimeRequirements OS="Win64" Platform="NAVMAN|NAVSIM" SeriesMin="Nw19" SeriesMax="Nw19" />

    <ComponentEntry AppType="ManagedPlugin"ModuleName="./Contents/v18/ADSK.MyPlugin.v19.dll">    

    </ComponentEntry>

  </Components>

  <Components Description="2021 parts">

    <RuntimeRequirements OS="Win64" Platform="NAVMAN|NAVSIM" SeriesMin="Nw18" SeriesMax="Nw18" />

     <ComponentEntry AppType="ManagedPlugin"ModuleName="./Contents/v17/ADSK.MyPlugin.v18.dll">    

  </Components>

</ApplicationPackage>

This example specifies a single ‘Component’:

• OS="Win64": This component works for 64-bit product only.
• Platform="NAVMAN|NAVSIM": This component works in both Navisworks Manage and Navisworks Simulate.
• SeriesMin="Nw18" SeriesMax="Nw18": Nw18 means this component works for Navisworks 2021 version. As said above, our .NET API of on release is only compatible within one major version. Similarly, Nw17 means this is a component that works with Navisworks 2020.
• AppType="ManagedPlugin": This component is a managed .NET assembly that contains plugins targeted at the Navisworks .NET API.
• ModuleName="./Contents/v16/ADSK.MyPlugin.dll": Specifies the relative path to the components .NET Assembly. We’ve put it in a ‘v16’ folder signifying it’s targeted at “Navisworks 2019” only. You can put specific release of binary in specific folders, or name them uniquely in one folder.

Notes:

• Real configuration files will require more content than this.
• The <ApplicationPackage> element can contain multiple <Components> elements. Each component can target a different Platform and Series.

In this example the DLL pointed to by ModuleName is a managed .NET assembly. This could be written as a C# ‘Class Library’ and could contain a basic “Hello World” AddInPlugin as defined in the following code.

using Autodes.Navisworks.Api.Plugins;

...

 [PluginAttribute("MyPlugin", "ADSK", DisplayName = "Myplugin : Hello World")]
 [AddInPluginAttribute(AddInLocation.AddIn)]
 public class Myplugin : AddInPlugin
 {
 public override int Execute(params string[] parameters)
 {
  MessageBox.Show("hello World");
  return 0;
 }
 }

...  

Notes:

• You will have to add a reference to %PROGRAMFILES%\Autodesk\Navisworks Manage <release number>\Autodesk.Navisworks.Api.dll. (‘CopyLocal’ should be set to False).
• Real code should use your own unique Developer ID.