ricaun.Revit.Sdk 1.0.0

ricaun.Revit.Sdk

Sdk for Revit API development to support multiple Revit versions in a single project.

Features

• Automatic TargetFrameworks using TFM-Aliases for Revit versions.
• Automatic Defines using or-greater-defines for Revit versions.

Installation

To install the SDK, you need to specify in the Sdk attribute of the Project element in your project file.

<Project Sdk="ricaun.Revit.Sdk/1.0.0">
</Project>

TargetFrameworks

The Sdk support the following TargetFrameworks for Revit versions:

<Project Sdk="ricaun.Revit.Sdk/1.0.0">
  <PropertyGroup>
    <TargetFrameworks>2027;2026;2025;2024;2023;2022;2021</TargetFrameworks>
  </PropertyGroup>
</Project>

The RevitVersion is set based in the TargetFrameworks number.

Configurations

The Sdk support Configurations for Revit versions and the TargetFramework is automatically set by the Sdk depending on the Configuration:

<Project Sdk="ricaun.Revit.Sdk/1.0.0">
  <PropertyGroup>
    <Configuration>2027;Debug 2027;2026;Debug 2026;2025;Debug 2025;2024;Debug 2024</Configuration>
  </PropertyGroup>
</Project>

The RevitVersion is set based in the Configuration number.

The OutputPath is automatically set between bin\Debug\<RevitVersion> and bin\Release\<RevitVersion> depending on the Configuration name, and the DefineConstants is set between DEBUG or RELEASE.

AppendRevitVersionToOutputPath

The property AppendRevitVersionToOutputPath is automatically set to true when using the Configuration property. You can override this behavior by setting it to false in your project file.

RevitVersion

The property group RevitVersion is set to the Revit version depending on the TargetFrameworks or Configurations.

<ItemGroup>
  <PackageReference Include="Revit_All_Main_Versions_API_x64" Version="$(RevitVersion).*-*" IncludeAssets="build; compile" PrivateAssets="All" />
</ItemGroup>

IsRevitVersion

These properties IsRevitVersionNetCore and IsRevitVersionNetFramework are set depending on whether the Revit version is targeting .NET Core or .NET Framework.

<PropertyGroup Condition="$(IsRevitVersionNetFramework)">
  <Reference Include="System.IO.Compression" />
</PropertyGroup>

Defines Constants

The defines REVIT and REVIT<version> are set depending on the Revit version.

The REVIT<version>_OR_GREATER defines are set for the Revit version and all greater versions.

By default the lowest version is set to 2019, the RevitVersionMinimal property can be set to a different version to change the lowest version for the REVIT<version>_OR_GREATER defines:

<PropertyGroup>
  <RevitVersionMinimal>2019</RevitVersionMinimal>
</PropertyGroup>

AppLoader

The property AppLoader is used change how the AssemblyName is generated.

• The Version keywork is used to generate the AssemblyName with the assembly version.
• The Debug keyword is used to generate the AssemblyName with a timestamp number. (Only available with Debug configuration.)

<PropertyGroup>
  <AppLoader>Debug;Version</AppLoader>
</PropertyGroup>

This property is used work with the plugin ricaun.AppLoader.

Sdk Properties

The Sdk sets the following properties automatically:

TargetFrameworks defaults values

The TargetFrameworks defaults to the following values depending on the RevitVersion property: