Instant Autodesk Revit 2013 Customization with .NET How-to [Instant] — Save 50%
A supercharged guide to creating your own plugins, add-ons, and customizations for Revit with .NET book and ebook
There may come a time when you need to prevent the user from being able to click one of your command buttons. The Revit API supports enabling and disabling commands by implementing the IExternalCommandAvailability interface and applying it to a button class. Your reasons for disabling a command can be just about anything you want. Some examples might include scenarios such as the state of the current model not meeting your application's requirements, the model name may not meet a specific requirement that you specify, or maybe the wrong flavor of Revit was used to open the model.
In this article by Don Rudder, author of Instant Autodesk Revit 2013 Customization with .NET How-to [Instant], we are going to cover recipes for enabling and disabling control for commands.
(For more resources related to this topic, see here.)
We will implement an IExternalCommandAvailability interface where we allow the command to be enabled only when a door element is selected in the current model.
How to do it...
Add a new class named AvailabilityDoorSelected.vb.
Enter the IExternalCommandAvailability code as shown, which returns true only when a door element is selected in the model:
''' Enables a Command Only if a
''' Door is Selected in the User Interface
Public Class AvailabilityDoorSelected
''' Command Availability Implementation
Public Function IsCommandAvailable(appData As _
selectedCats As CategorySet) _
As Boolean Implements _
' Iterate Categories
For i = 0 To selectedCats.Size
' Get the Category
Dim m_c As Category = _
' Is it a Door?
If m_c.Name = "Doors" Then Return True
Open the ApplicationRibbon class and enter the following code right before the ' Success line in the AddPushButton function that will assign this availability implementation to our sample button:
' Availability - Door Selection
m_pb.AvailabilityClassName = _
Run the add-in in the debugger and open one of the sample project models that ship with Revit.
Select the door element in the model to enable the sample button. Deselect the door and the button will become disabled again.
How it works...
Our AvailabilityDoorSelected class will execute anytime that a user control that this class is assigned to is either made visible in the Revit user interface or an element in the model is selected. Element selection will only execute this class when an assigned control is visible in the Revit UI. There is no limit to the number of user controls that you can assign to any class that implements IExternalCommandAvailability nor is there a limit to the amount of IExternalCommandAvailability implementations that you can use in your projects. The following illustration shows on the left-hand side how the main button looks without a door selected and on the right-hand side how it becomes enabled when a door is selected.
We could have generated a more complex scenario for our availability implementation, but in an effort to keep it simple we only included door selection as a requirement to enable our command. The possibilities for this functionality are endless and I'm sure you will find plenty of uses for it in your own projects in the future.
This article explained how to dynamically enable a control.
Resources for Article :
- Papervision3D External Models: Part 1 [Article]
- Importing 3D Formats into Away3D [Article]
- Designing an Avatar in Flash Multiplayer Virtual Worlds [Article]
About the Author :
Don Rudder is the Director of Software Development at CASE and focuses on the creation and management of specialized software and add-ins for various applications developed for client support. With over 16 years of experience in the AEC industry, Don has served well over 10 of those years as an HVAC and electrical designer for various MEP firms. He later began to focus more heavily on software development and related support where he eventually ended up in San Francisco serving as BIM Manager for HOK. He is self-taught in some 14 programming languages and well versed in .NET, web-based AEC tools, and pretty much any kind of automation. Don has also presented at Autodesk University and the Revit Technology Conference of North America.
Don has been the contributing author of the API chapters for Mastering Autodesk Revit Architecture 2011, Mastering Autodesk Revit Architecture 2012, and Mastering Autodesk Revit Architecture 2013.