Same code to create parameters in Revit 2015 + 2016

Question

So the ExternalDefinitionCreationOptions had a spelling error in the Revit 2015 API that was corrected in the 2016 API.

I try to make my app as compatible as possible with the current version + previous, but this time I'm not even able to compile it since I can only reference one of the two API DLL's, and the ExternalDefinitionCreationOptions plays a big role in the process.

The code is the following:

private static Definition GetSimpleParameterDefinition(UIApplication uiApp, Document doc, DefinitionGroup defGroup, string name)
{
    var definition = defGroup.Definitions.FirstOrDefault(d => d.Name == name);
    if (definition != null) return definition;

    var parameterType = ParameterType.Text;

    var defOptions = new ExternalDefinitionCreationOptions(name, parameterType);
    BuiltInCategory target = BuiltInCategory.OST_Furniture;
    var cat = doc.Settings.Categories.get_Item(target);

    var catSet = uiApp.Application.Create.NewCategorySet();
    catSet.Insert(cat);

    definition = defGroup.Definitions.Create(defOptions);

    return definition;
}

I'm reading about DI and IoC, but all the samples have all the code under control, not referencing a third-party API and dealing with it. I've run out of ideas.

Any thoughts on how to accomplish this?

score 2 · Answer 1 · answered Oct 28 '15 at 14:51

2

The dynamic in C# allow you to use late-binding. Then I would suggest some reflection to instante the object, like the "logic" below (not tested, needs to be completed)

Type t = System.Reflection.Assembly.GetExecutingAssembly().GetType("ExternalDefinitionCreationOptions");
dynamic defOptions = t.GetConstructor().Invoke();

Note that dynamic is different from var. Your code is using var just as a way to let the compiler decide the type... now dynamic will only define the type on runtime.

answered Oct 28 '15 at 14:51

Augusto Goncalves

8,493
2
17
44

Hi @AugustoGoncalves, this seems like a great way to accomplish this, but the `GetExecutingAssembly()` (also the `GetCallingAssembly()`) are not returning the RevitAPI assembly, both are returning my assembly. I even tried to run through the stack to get Revit, but no success. My app runs in the Revit Initialization, so I don't know if this is the reason it's not working the way you suggested. – Izzy Rodriguez Oct 28 '15 at 16:24

score 2 · Answer 2 · answered Oct 28 '15 at 20:44

Using the base code from Augusto (upvoted) and a lot more research on Reflection I was able to write this solution:

var assemblies = System.Reflection.Assembly.GetExecutingAssembly().GetReferencedAssemblies();
var assemblyName = assemblies.First(a => a.Name == "RevitAPI");
Assembly revitAssembly = Assembly.Load(assemblyName);

Type t = revitAssembly.GetType("Autodesk.Revit.DB.ExternalDefinitionCreationOptions"); // For Revit2016
if (t == null) t = revitAssembly.GetType("Autodesk.Revit.DB.ExternalDefinitonCreationOptions"); // For Revit2015

var types = new Type[1] { t };
var constructor = t.GetConstructors()[0];
dynamic defOptions = constructor.Invoke(new object[] { item.Name, parameterType });

score 1 · Answer 3 · answered Oct 29 '15 at 09:00

1

Why not use conditional compilation?

#if REVIT2015
   var defOptions = new ExternalDefinitonCreationOptions(name, parameterType);
#else
   var defOptions = new ExternalDefinitionCreationOptions(name, parameterType);
#endif

You have to define a REVIT2015 conditional compilation symbol in your Revit 2015 project (Project options, Build tab).

Of course, this only work if you have two separate VS projects, with a source project and a project where files are linked to the files in the source project.

answered Oct 29 '15 at 09:00

Maxence

12,868
5
57
69

Hi @Maxence, I use this approach in various other situations with new features that go to one version and not another. But this case was a core function of the product, I needed it to work without the conditional compilation. – Izzy Rodriguez Oct 29 '15 at 13:31
yes! this gets my vote! this is exactly the answer i had i mind just from reading the summary in the email i received, "So the ExternalDefinitionCreationOptions had a spelling error in the Revit 2015 API that was corrected in the 2016 API. I try to make my app as compatible as possible with the current version...". cool! – Jeremy Tammik Oct 30 '15 at 10:10

score 0 · Answer 4 · answered Oct 30 '15 at 10:36

0

i fully agree with maxence' approach above.

i also suggest placing all conditional compilation into one single compatibility module and exporting its functionality as methods or properties, e.g. by defining a method like this:

ExternalDefinitionCreationOptions
  NewExternalDefinitionCreationOptions(
    string name,
    ParameterType parameterType )
{
  #if REVIT2015
    return new ExternalDefinitonCreationOptions(name, parameterType);
  #else // if not REVIT2015
    return new ExternalDefinitionCreationOptions( name, parameterType );
  #endif // REVIT2015
}

i implemented this here:

https://github.com/jeremytammik/the_building_coder_samples/blob/master/BuildingCoder/BuildingCoder/Util.cs#L1209-L1225

have fun!

cheers

jeremy

answered Oct 30 '15 at 10:36

Jeremy Tammik

7,333
2
12
17

Hi @Jeremy, thanks for the answer. But how do you make this Util class work seamlessly between Revit 2015 and 2016 in the same DLL? – Izzy Rodriguez Oct 30 '15 at 14:52
ahaa, in the same DLL. ok, that rules out the conditional compilation. there is another simple solution, though: you could check the Application.VersionNumber property and then call the appropriate method using Invoke. – Jeremy Tammik Oct 31 '15 at 15:54
YES! Augusto solution was an amazing head start to me, I just posted the final and working solution afterwards – Izzy Rodriguez Oct 31 '15 at 15:56

score 0 · Answer 5 · answered Oct 31 '15 at 16:54

Updated answer for handling both Revit 2015 and Revit 2016 API within the same add-in.

Do you really want to do that?

Well, if you insist, here goes:

#region Compatibility fix for spelling error change
/// <summary>
/// Wrapper to fix a spelling error prior to Revit 2016.
/// </summary>
public class SpellingErrorCorrector
{
  static bool _in_revit_2015_or_earlier;
  static Type _external_definition_creation_options_type;

  public SpellingErrorCorrector( Application app )
  {
    _in_revit_2015_or_earlier = 0
      <= app.VersionNumber.CompareTo( "2015" );

    string s
      = _in_revit_2015_or_earlier
        ? "ExternalDefinitonCreationOptions"
        : "ExternalDefinitionCreationOptions";

    _external_definition_creation_options_type
      = System.Reflection.Assembly
        .GetExecutingAssembly().GetType( s );
  }

  object NewExternalDefinitionCreationOptions(
    string name,
    ParameterType parameterType )
  {
    object[] args = new object[] { 
      name, parameterType };

    return _external_definition_creation_options_type
      .GetConstructor( new Type[] { 
        _external_definition_creation_options_type } )
      .Invoke( args );
  }

  public Definition NewDefinition(
    Definitions definitions,
    string name,
    ParameterType parameterType )
  {
    //return definitions.Create( 
    //  NewExternalDefinitionCreationOptions() );

    object opt
      = NewExternalDefinitionCreationOptions(
        name,
        parameterType );

    return typeof( Definitions ).InvokeMember(
      "Create", BindingFlags.InvokeMethod, null,
      definitions, new object[] { opt } )
      as Definition;
  }
}
#endregion // Compatibility fix for spelling error change

Usage:

static Util.SpellingErrorCorrector
  _spellingErrorCorrector = null;

Application app = doc.Application;

if( null == _spellingErrorCorrector )
{
  _spellingErrorCorrector
    = new Util.SpellingErrorCorrector( app );
}

DefinitionGroup group = sharedParametersFile
    .Groups.Create( "Reinforcement" );

def = _spellingErrorCorrector.NewDefinition(
    group.Definitions, "ReinforcementParameter",
    ParameterType.Text );

Untested!

Cheers,

Jeremy

Thanks Jeremy, this very much what I developed a few days ago -> http://stackoverflow.com/a/33401274/228160 — Izzy Rodriguez, Nov 01 '15 at 05:03

Same code to create parameters in Revit 2015 + 2016

5 Answers5

Linked