Namespace:
Autodesk.Revit.UI.Selection
Selection
Class
Description:
Contains the current user selection of elements within the project.
Contains the current user selection of elements within the project.
Remarks:
The Selection object is used to retrieve the current user selected elements when an external API command is executed.
The Selection object is used to retrieve the current user selected elements when an external API command is executed.
Examples
[Autodesk.Revit.Attributes.Transaction(Autodesk.Revit.Attributes.TransactionMode.ReadOnly)]
public class Document_Selection : IExternalCommand
{
public Autodesk.Revit.UI.Result Execute(ExternalCommandData commandData,
ref string message, ElementSet elements)
{
try
{
// Select some elements in Revit before invoking this command
// Get the handle of current document.
UIDocument uidoc = commandData.Application.ActiveUIDocument;
// Get the element selection of current document.
Selection selection = uidoc.Selection;
ICollection<ElementId> selectedIds = uidoc.Selection.GetElementIds();
if (0 == selectedIds.Count)
{
// If no elements selected.
TaskDialog.Show("Revit","You haven't selected any elements.");
}
else
{
String info = "Ids of selected elements in the document are: ";
foreach (ElementId id in selectedIds)
{
info += "\n\t" + id.ToString();
}
TaskDialog.Show("Revit",info);
}
}
catch (Exception e)
{
message = e.Message;
return Autodesk.Revit.UI.Result.Failed;
}
return Autodesk.Revit.UI.Result.Succeeded;
}
/// </ExampleMethod>
}
Selection Class Members:
Name | Description | Inherited From |
---|---|---|
IsValidObject | Specifies whether the .NET object represents a valid Revit entity. |
Name | Description | Inherited From |
---|---|---|
Dispose | Releases all resources used by the Selection | |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
GetElementIds | Returns the ids of the elements that are currently selected within the project. The selection may not be complete. See GetReferences for more options. | |
GetHashCode | Serves as the default hash function. (Inherited from Object ) | Object |
GetReferences | Returns the references that are currently selected. | |
GetType | Gets the Type of the current instance. (Inherited from Object ) | Object |
PickBox(PickBoxStyle) | Invokes a general purpose two-click editor that lets the user to specify a rectangular area on the screen. | |
PickBox(PickBoxStyle, String) | Invokes a general purpose two-click editor that lets the user to specify a rectangular area on the screen. | |
PickElementsByRectangle() | Prompts the user to select multiple elements by drawing a rectangle. | |
PickElementsByRectangle(ISelectionFilter) | Prompts the user to select multiple elements by drawing a rectangle which pass a customer filter. | |
PickElementsByRectangle(String) | Prompts the user to select multiple elements by drawing a rectangle while showing a custom status prompt string. | |
PickElementsByRectangle(ISelectionFilter, String) | Prompts the user to select multiple elements by drawing a rectangle which pass a customer filter while showing a custom status prompt string. | |
PickObject(ObjectType) | Prompts the user to select one object. | |
PickObject(ObjectType, ISelectionFilter) | Prompts the user to select one object which passes a custom filter. | |
PickObject(ObjectType, String) | Prompts the user to select one object while showing a custom status prompt string. | |
PickObject(ObjectType, ISelectionFilter, String) | Prompts the user to select one object which passes a custom filter while showing a custom status prompt string. | |
PickObjects(ObjectType) | Prompts the user to select multiple objects. | |
PickObjects(ObjectType, ISelectionFilter) | Prompts the user to select multiple objects which pass a customer filter. | |
PickObjects(ObjectType, String) | Prompts the user to select multiple objects while showing a custom status prompt string. | |
PickObjects(ObjectType, ISelectionFilter, String) | Prompts the user to select multiple objects which pass a custom filter while showing a custom status prompt string. | |
PickObjects(ObjectType, ISelectionFilter, String, IList<Reference>) | Prompts the user to select multiple objects which pass a custom filter while showing a custom status prompt string. A preselected set of objects may be supplied and will be selected at the start of the selection. | |
PickPoint() | Prompts the user to pick a point on the active work plane. | |
PickPoint(ObjectSnapTypes) | Prompts the user to pick a point on the active work plane using specified snap settings. | |
PickPoint(String) | Prompts the user to pick a point on the active work plane while showing a custom status prompt string. | |
PickPoint(ObjectSnapTypes, String) | Prompts the user to pick a point on the active work plane using specified snap settings while showing a custom status prompt string. | |
SetElementIds | Selects the elements. | |
SetReferences | Selects the references. The references can be an element or a subelement in the host or a linked document. | |
ToString | Returns a string that represents the current object. (Inherited from Object ) | Object |