RevitAPI Samples Readme

Introduction

This document provides an overview of the sample applications that come with RevitAPI for .NET developers. Whether you are new to RevitAPI or relatively experienced with it, the sample applications can be a source of ideas and an opportunity to learn new concepts. In addition to describing what each sample application does, this document gives tips on building samples and explains the sample categories, lists the skill level required to understand each application, and provides a suggested order in which to go through the sample applications.

Build Samples

The samples projects use references to dlls in Revit's default installation folders.

C:\Program Files\Autodesk\<Revit_Version>\Program\RevitAPI.dll
C:\Program Files\Autodesk\<Revit_Version>\Program\RevitAPIUI.dll
C:\Program Files\Autodesk\<Revit_Version>\Program\RevitAddInUtility.dll
C:\Program Files\Autodesk\<Revit_Version>\Addins\CivilAlignments\Autodesk.CivilAlignments.DBApplication.dll
C:\Program Files\Autodesk\<Revit_Version>\Addins\SteelConnections\ASCADLinkMgd.dll
C:\Program Files\Autodesk\<Revit_Version>\Addins\SteelConnections\ASGeometryMgd.dll
C:\Program Files\Autodesk\<Revit_Version>\Addins\SteelConnections\ASObjectsMgd.dll
C:\Program Files\Autodesk\<Revit_Version>\Addins\SteelConnections\Autodesk.SteelConnectionsDB.dll
C:\Program Files\Autodesk\<Revit_Version>\Addins\SteelConnections\DotNetRoots.dll

To build all the samples, all these files must exist. If you install Revit in a non-standard place, you can use any of the following solutions:

Copy the required dlls to the default installation locations described above.
Open the *.targets files and fix each <HintPath> for the dlls. The *.targets files found in "C:\<Revit_SDK_Version>\Samples\VSProps\".

Sample Categories

The RevitAPI sample applications are grouped into subdirectories according to the major focus of the sample code. The subdirectories and descriptions of the corresponding categories are listed below.

Basics

The category Contains samples related to the ExternalCommand framework, transactions, and event registration.

Geometry

Contains samples related to read and analysis of element geometry including curves and reference planes.

Parameters

Contains samples related to creation, modification and read of element and shared parameters.

Elements

Contains samples related to Revit basic elements such as walls, roofs, floors, levels, grids.

Families

Contains samples related to family creation and family instances.

Materials

Contains samples related to materials and units.

Annotation

Contains samples related to annotations such as notes, detail curves, dimensions and tags.

Views

Contains samples related to view creation and view properties.

Rooms/Spaces

Contains samples related to rooms, spaces and areas.

Data Exchange

Contains samples related to import, export, or print of Revit documents.

MEP

Contains MEP-specific samples.

Structure

Contains structure-specific samples.

Sample Skill Levels

To help you identify where to start and what skill level you need to understand a particular sample application, this document lists a skill level rating for each sample. The four levels, beginning, medium, high, and advanced, are characterized by the specific RevitAPI development skills described below.

Subject:	Create spaces and zones.
Skill Level:	Medium
Category:	Rooms/Spaces
Type:	ExternalCommand,
Revit Platform:	MEP
First Released For:	2009.0
Classes:	Autodesk.Revit.Creation.Document Autodesk.Revit.DB.Mechanical.Space Autodesk.Revit.DB.Mechanical.Zone Autodesk.Revit.DB.Phase Autodesk.Revit.UI.IExternalCommand
Summary:	This sample demonstrates three main features:1. How to get all Space elements in a specified level.2. How to get all Zone elements in a specified level.3. How to create Space elements for each closed wall loop or closed space separation.4. How to create a new Zone element in a specified level and phase.5. How to add/remove spaces in a Zone element.

Subject:	Generate a new sheet that includes all the selected views and edit properties of a selected viewport in a sheet.
Skill Level:	Medium
Category:	Views
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	9.0
Classes:	Autodesk.Revit.Creation.Document.NewViewSheet Autodesk.Revit.DB.View Autodesk.Revit.DB.ViewSet
Summary:	This sample demonstrates how to generate a new sheet that includes all the selected views. It also demonstrates how to access the properties of a viewport such as LabelLineOffset, LabelLength and Orientation.

Subject:	Display analysis results in a Revit model using Dynamic Model Update
Skill Level:	Advanced
Category:	Geometry
Type:	ExternalApplication,
Revit Platform:	All
First Released For:	2011.0
Classes:	Autodesk.Revit.DB.Analysis.FieldDomainPointsByUV Autodesk.Revit.DB.Analysis.FieldValues Autodesk.Revit.DB.Analysis.SpatialFieldManager Autodesk.Revit.DB.BoundingBoxUV Autodesk.Revit.DB.Events.DocumentOpenedEventArgs Autodesk.Revit.DB.FaceArray Autodesk.Revit.DB.FilteredElementCollector Autodesk.Revit.DB.LocationPoint Autodesk.Revit.DB.UpdaterRegistry
Summary:	On startup, the external application creates a trigger that will execute when walls, masses, and family instances in the project change. When this occurs, Revit calculates the distance from a family instance (sphere.rfa) to several points on each face. These distances are used as values for the analysis visualization display.

Subject:	Analysis Visualization Framework
Skill Level:	Advanced
Category:	Geometry
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	2012.0
Classes:	Autodesk.Revit.DB.Analysis.FieldDomainPointsByUV Autodesk.Revit.DB.Analysis.FieldValues Autodesk.Revit.DB.Analysis.SpatialFieldManager Autodesk.Revit.DB.UpdaterRegistry System.Threading.Thread
Summary:	A combination of Analysis Visualization Framework, multi-threading, Revit’s Idling event, and Dynamic Model Update to simulate how analysis results can be periodically updated during computation and re-started when the Revit model changes.

Subject:	Display elements' analytical support informations.
Skill Level:	Medium
Category:	Structure
Type:	ExternalCommand,
Revit Platform:	Structure
First Released For:	9.0
Classes:	Autodesk.Revit.DB.Structure.AnalyticalModel Autodesk.Revit.DB.Structure.AnalyticalModelSupport Autodesk.Revit.DB.Structure.AnalyticalSupportType Autodesk.Revit.UI.IExternalCommand
Summary:	This sample displays the supported information of the element (includes the element id, element type and supported type of the element).

Subject:	Launch an external application.
Skill Level:	Beginning
Category:	Basics
Type:	ExternalApplication,
Revit Platform:	All
First Released For:	2008.0
Classes:	Autodesk.Revit.UI.IExternalApplication
Summary:	This sample demonstrates how to launch an external application when Revit starts and closes.

Subject:	Edit appearance asset properties via a small control dialog
Skill Level:	Medium
Category:	Materials
Type:	ExternalApplication, ExternalCommand,
Revit Platform:	All
First Released For:	2018.1
Classes:	Autodesk.Revit.DB.AppearanceAssetElement Autodesk.Revit.DB.Material Autodesk.Revit.DB.Visual.AppearanceAssetEditScope Autodesk.Revit.DB.Visual.AssetPropertyBoolean Autodesk.Revit.DB.Visual.AssetPropertyDoubleArray4d
Summary:	This sample demonstrates basic usage of the AppearanceAssetEditScope and AssetProperty classes to change the value of an asset property in a given material.

Subject:	Export data to Excel.
Skill Level:	Medium
Category:	Data Exchange
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	8.0
Classes:	Autodesk.Revit.Collections.Map Autodesk.Revit.Collections.MapIterator Autodesk.Revit.Collections.Set Autodesk.Revit.DB.Element Autodesk.Revit.DB.ElementSet Autodesk.Revit.DB.Parameter Autodesk.Revit.DB.ParameterSet Autodesk.Revit.UI.IExternalCommand
Summary:	This sample exports the contents of an entire project to Microsoft Excel 2003.

Subject:	Parameters of AreaReinCurve.
Skill Level:	Beginning
Category:	Structure
Type:	ExternalCommand,
Revit Platform:	Structure
First Released For:	9.0
Classes:	Autodesk.Revit.DB.BuiltInParameter Autodesk.Revit.DB.ElementSet Autodesk.Revit.DB.Structure.AreaReinforcementCurve Autodesk.Revit.UI.IExternalCommand
Summary:	This sample shows user how to get AreaReinforcementCurve and change its parameters.

Subject:	Parameters of AreaReinforcement and Rebar.
Skill Level:	Medium
Category:	Structure
Type:	ExternalCommand,
Revit Platform:	Structure
First Released For:	9.0
Classes:	Autodesk.Revit.DB.BuiltInParameter Autodesk.Revit.DB.ElementIterator Autodesk.Revit.DB.ElementSet Autodesk.Revit.DB.Structure.AreaReinforcementCurve Autodesk.Revit.DB.Structure.RebarBarType Autodesk.Revit.UI.IExternalCommand
Summary:	This sample shows how to use API displays and modifies parameters of AreaReinforcement. And teach user how to get all parameters of Rebar.

Subject:	Attached Detail Group
Skill Level:	Medium
Category:	Elements
Type:	ExternalApplication,
Revit Platform:	All
First Released For:	2019.1
Classes:	Autodesk.Revit.DB.Group Autodesk.Revit.UI.IExternalApplication Autodesk.Revit.UI.IExternalCommand
Summary:	This sample shows how to show and hide the attached detail groups of a model group.

Subject:	Route ducts and fittings.
Skill Level:	Beginning
Category:	MEP
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	2010.0
Classes:	Autodesk.Revit.DB.Connector Autodesk.Revit.DB.Document Autodesk.Revit.DB.FamilyInstance Autodesk.Revit.DB.Mechanical.Duct Autodesk.Revit.DB.Mechanical.MechanicalSystem
Summary:	This sample demonstrates how to route a set of ducts and fittings between a base air supply equipment and 2 terminals.

Subject:	Auto Tag Rooms.
Skill Level:	Medium
Category:	Annotation
Type:	ExternalCommand,
Revit Platform:	Architecture
First Released For:	2008.0
Classes:	Autodesk.Revit.Creation.Document Autodesk.Revit.DB.Architecture.Room Autodesk.Revit.DB.Architecture.RoomTag Autodesk.Revit.DB.Architecture.RoomTagType Autodesk.Revit.UI.IExternalCommand
Summary:	This sample demonstrates three main features:1. How to get all rooms in a specified level.2. How to get all room tags in current document.3. How to create new room tags with specified room tag type to auto tag all rooms in a specified level.

Subject:	Obstruction detects and resolve.
Skill Level:	Medium
Category:	MEP
Type:	ExternalCommand,
Revit Platform:	MEP
First Released For:	2010.0
Classes:	Autodesk.Revit.Creation.Document Autodesk.Revit.DB.Document Autodesk.Revit.DB.Mechanical.Duct Autodesk.Revit.DB.Plumbing.Pipe Autodesk.Revit.UI.IExternalCommand
Summary:	This sample will demonstrate how to detect and resolve the obstructions of Pipe with Pipe, Pipe with Beam, or Pipe with Duct.

Subject:	Shared parameter.
Skill Level:	Medium
Category:	Parameters
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	9.0
Classes:	Autodesk.Revit.DB.CategorySet Autodesk.Revit.DB.Definition Autodesk.Revit.DB.DefinitionFile Autodesk.Revit.DB.DefinitionGroup Autodesk.Revit.DB.DefinitionGroups Autodesk.Revit.DB.Definitions Autodesk.Revit.DB.InstanceBinding Autodesk.Revit.DB.Parameter Autodesk.Revit.UI.IExternalCommand Autodesk.Revit.UI.Selection.SelElementSet
Summary:	This sample demonstrates how to add a shared instance parameter to beams and slabs, and uses GUID as the parameter’s value. Users also can use the value of the parameter to find the special element.

Subject:	Create or retrieve boundary conditions.
Skill Level:	High
Category:	Structure
Type:	ExternalCommand,
Revit Platform:	Structure
First Released For:	9.1
Classes:	Autodesk.Revit.DB.BoundaryConditions Autodesk.Revit.UI.IExternalCommand
Summary:	This sample shows to get BoundaryConditions’ parameters or create BoundaryConditons.

Subject:	Display shared parameters bindings.
Skill Level:	Beginning
Category:	Parameters
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	8.0
Classes:	Autodesk.Revit.ApplicationServices.Application Autodesk.Revit.DB.BindingMap Autodesk.Revit.DB.CategorySet Autodesk.Revit.DB.Definition Autodesk.Revit.DB.DefinitionBindingMapIterator Autodesk.Revit.DB.ElementBinding Autodesk.Revit.UI.IExternalCommand
Summary:	This sample browses all the shared parameters bindings used in the project.

Subject:	Capitalize All Text
Skill Level:	Beginning
Category:	Annotation, Basics
Type:	ExternalCommand,
Revit Platform:	All
First Released For:	2017.0
Classes:	Autodesk.Revit.DB.FormattedText Autodesk.Revit.DB.TextNote Autodesk.Revit.UI.IExternalCommand
Summary:	Capitalizes all the text of all the TextNotes in the project by formatting the text to use 'AllCaps'

Subject:	Infrastructure alignments
Skill Level:	Medium
Category:	Annotation, Elements
Type:	ExternalApplication, ExternalCommand,
Revit Platform:	All
First Released For:	2021.1
Classes:	Revit.SDK.Samples.CivilAlignments.CS.CivilAlignmentsApp Revit.SDK.Samples.CivilAlignments.CS.CreateAlignmentStationLabelSetCmd Revit.SDK.Samples.CivilAlignments.CS.ShowProperties
Summary:	Demonstrates the use of API for finding, property querying and annotating of infrastructure alignment elements.

Subject:	Revit Cloud API Usage Sample
Skill Level:	High
Category:	Basics
Type:	ExternalApplication,
Revit Platform:	All
First Released For:	2020.0
Classes:	Revit.SDK.Samples.CloudAPISample.CS.Application Revit.SDK.Samples.CloudAPISample.CS.Coroutine.Coroutine Revit.SDK.Samples.CloudAPISample.CS.Coroutine.CoroutineScheduler Revit.SDK.Samples.CloudAPISample.CS.Migration.DefaultMigrationModel Revit.SDK.Samples.CloudAPISample.CS.Migration.FolderLocation Revit.SDK.Samples.CloudAPISample.CS.Migration.IMigrationModel Revit.SDK.Samples.CloudAPISample.CS.Migration.MigrationRule Revit.SDK.Samples.CloudAPISample.CS.Migration.MigrationToBim360 Revit.SDK.Samples.CloudAPISample.CS.RunSample Revit.SDK.Samples.CloudAPISample.CS.SampleContext Revit.SDK.Samples.CloudAPISample.CS.SampleEngine Revit.SDK.Samples.CloudAPISample.CS.View.ViewMigrationToBim360 Revit.SDK.Samples.CloudAPISample.CS.View.ViewSamplePortal
Summary:	This is a sample helps third party developers understand how to use Revit Cloud API