Room

Description:
Provides access to the room topology in Autodesk Revit.

Remarks:
The room object can be queried for its boundary for use in space planning tools.

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Element
    Autodesk.Revit.DB.SpatialElement
      Autodesk.Revit.DB.Architecture.Room

public class Room : SpatialElement

Public Class Room _
	Inherits SpatialElement

public ref class Room : public SpatialElement

private void Getinfo_Room(Room room)
{
    string message = "Room: ";

    //get the name of the room
    message += "\nRoom Name: " + room.Name;

    //get the room position
    LocationPoint location = room.Location as LocationPoint;
    XYZ point = location.Point;
    message += "\nRoom position: " + XYZToString(point);

    //get the room number
    message += "\nRoom number: " + room.Number;

    IList<IList<Autodesk.Revit.DB.BoundarySegment>> segments = room.GetBoundarySegments(new SpatialElementBoundaryOptions());
    if (null != segments)  //the room may not be bound
    {
        foreach (IList<Autodesk.Revit.DB.BoundarySegment> segmentList in segments)
        {
            message += "\nBoundarySegment of the room: ";
            foreach (Autodesk.Revit.DB.BoundarySegment boundarySegment in segmentList)
            {
                // Get curve start point
                XYZ start = boundarySegment.GetCurve().GetEndPoint(0);
                message += "\nCurve start point: " + XYZToString(start);
                // Get curve end point
                XYZ end = boundarySegment.GetCurve().GetEndPoint(1);
                message += " Curve end point: " + XYZToString(end);

                // Show the boundary elements
                message += "\nBoundary element id: " + boundarySegment.ElementId.ToString();
            }
        }
    }

    TaskDialog.Show("Revit",message);
}

// output the point's three coordinates
string XYZToString(XYZ point)
{
    return "(" + point.X + ", " + point.Y + ", " + point.Z + ")";
}

Private Sub Getinfo_Room(room As Room)
    Dim message As String = "Room: "

    'get the name of the room
    message += vbLf & "Room Name: " & Convert.ToString(room.Name)

    'get the room position
    Dim location As LocationPoint = TryCast(room.Location, LocationPoint)
    Dim point As XYZ = location.Point
    message += vbLf & "Room position: " & XYZToString(point)

    'get the room number
    message += vbLf & "Room number: " & Convert.ToString(room.Number)

    Dim segments As IList(Of IList(Of Autodesk.Revit.DB.BoundarySegment)) = room.GetBoundarySegments(New SpatialElementBoundaryOptions())
    If segments IsNot Nothing Then
        'the room may not be bound
        For Each segmentList As IList(Of Autodesk.Revit.DB.BoundarySegment) In segments
            message += vbLf & "BoundarySegment of the room: "
            For Each boundarySegment As Autodesk.Revit.DB.BoundarySegment In segmentList
                ' Get curve start point
          Dim start As XYZ = boundarySegment.GetCurve().GetEndPoint(0)
                message += vbLf & "Curve start point: " & XYZToString(start)
                ' Get curve end point
          Dim [end] As XYZ = boundarySegment.GetCurve().GetEndPoint(1)
                message += " Curve end point: " & XYZToString([end])

                ' Show the boundary elements
          message += vbLf & "Boundary element id: " + boundarySegment.ElementId.ToString()
            Next
        Next
    End If

    TaskDialog.Show("Revit", message)
End Sub

' output the point's three coordinates
Private Function XYZToString(point As XYZ) As String
    Return "(" & Convert.ToString(point.X) & ", " & Convert.ToString(point.Y) & ", " & Convert.ToString(point.Z) & ")"
End Function

Name	Return Type	Description	Inherited From
M IsPointInRoom(XYZ)	bool	Determines if a point lies within the volume of the room.
M Unplace()	None	Remove the room from its location, but the project still contains the room. The room can be placed in another location after unplaced.
M ArePhasesModifiable()	bool	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element.	Element
M CanBeHidden(View)	bool	Indicates if the element can be hidden in the view.	Element
M CanBeLocked()	bool	Identifies if the element can be locked.	Element
M CanDeleteSubelement(Subelement)	bool	Checks if given subelement can be removed from the element.	Element
M CanHaveTypeAssigned()	bool	Identifies if the element can have a type assigned.	Element
M CanHaveTypeAssigned(Document, ICollection<ElementId>)	bool	Checks if all elements in the set can have a type assigned.	Element
M ChangeTypeId(Document, ICollection<ElementId>, ElementId)	IDictionary	Changes the type of all elements in the given set.	Element
M ChangeTypeId(ElementId)	ElementId	Changes the type of the element.	Element
M DeleteEntity(Schema)	bool	Deletes the existing entity created by %schema% in the element	Element
M DeleteSubelement(Subelement)	bool	Removes a subelement from the element.	Element
M DeleteSubelements(IList<Subelement>)	bool	Removes the subelements from the element.	Element
M Dispose()	None	Releases all resources used by the	Element
M EvaluateAllParameterValues()	EvaluatedParameter	Evaluates all the parameters' values of the element.	Element
M EvaluateParameterValues(ISet<ElementId>)	EvaluatedParameter	Evaluate the parameters' values of the element on the given parameter ID set.	Element
M GetChangeTypeAny()	ChangeType	Returns ChangeType associated with any change in an element.	Element
M GetChangeTypeElementAddition()	ChangeType	Returns ChangeType associated with element addition	Element
M GetChangeTypeElementDeletion()	ChangeType	Returns ChangeType associated with element deletion.	Element
M GetChangeTypeGeometry()	ChangeType	Returns ChangeType associated with a change in the geometry of an element	Element
M GetChangeTypeParameter(ElementId)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetChangeTypeParameter(Parameter)	ChangeType	Returns ChangeType associated with a change in a parameter's value	Element
M GetDependentElements(ElementFilter)	IList<ElementId>	Get all elements that, from a logical point of view, are the children of this Element.	Element
M GetEntity(Schema)	The returned Entity.	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise.	Element
M GetEntitySchemaGuids()	IList<Guid>	Returns the Schema guids of any Entities stored in this element.	Element
M GetExternalFileReference()	ExternalFileReference	Gets information pertaining to the external file referenced by the element.	Element
M GetExternalResourceReferenceExpanded(ExternalResourceType)	IList<ExternalResourceReference>	Gets the collection of ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReference(ExternalResourceType)	ExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type.	Element
M GetExternalResourceReferencesExpanded()	IDictionary	Gets the expanded map of the external resource references referenced by the element.	Element
M GetExternalResourceReferences()	IDictionary	Gets the map of the external resource references referenced by the element.	Element
M GetGeneratingElementIds(GeometryObject)	ICollection<ElementId>	Returns the ids of the element(s) that generated the input geometry object.	Element
M GetGeometryObjectFromReference(Reference)	GeometryObject	Retrieve one geometric primitive contained in the element given a reference.	Element
M GetMaterialArea(ElementId, Boolean)	double	Gets the area of the material with the given id.	Element
M GetMaterialIds(Boolean)	ICollection<ElementId>	Gets the element ids of all materials present in the element.	Element
M GetMaterialVolume(ElementId)	double	Gets the volume of the material with the given id.	Element
M GetMonitoredLinkElementIds()	IList<ElementId>	Provides the link instance IDs when the element is monitoring.	Element
M GetMonitoredLocalElementIds()	IList<ElementId>	Provides the local element IDs when the element is monitoring.	Element
M GetOrderedParameters()	IList<Parameter>	Gets the parameters associated to the element in order.	Element
M GetParameterFormatOptions(ElementId)	FormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists.	Element
M GetParameter(ForgeTypeId)	Parameter	Retrieves a parameter from the element given identifier.	Element
M GetParameters(String)	IList<Parameter>	Retrieves the parameters from the element via the given name.	Element
M GetPhaseStatus(ElementId)	ElementOnPhaseStatus	Gets the status of a given element in the input phase	Element
M GetSubelements()	IList<Subelement>	Returns the collection of element subelements.	Element
M GetTypeId()	ElementId	Returns the identifier of this element's type.	Element
M GetValidTypes()	ICollection<ElementId>	Obtains a set of types that are valid for this element.	Element
M GetValidTypes(Document, ICollection<ElementId>)	ICollection<ElementId>	Obtains a set of types that are valid for all given elements.	Element
M HasPhases()	bool	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId.	Element
M IsCreatedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsDemolishedPhaseOrderValid(ElementId)	bool	Returns true if createdPhaseId and demolishedPhaseId are in order.	Element
M IsExternalFileReference()	bool	Determines whether this Element represents an external file.	Element
M IsHidden(View)	bool	Identifies if the element has been permanently hidden in the view.	Element
M IsMonitoringLinkElement()	bool	Indicate whether an element is monitoring any elements in any linked models.	Element
M IsMonitoringLocalElement()	bool	Indicate whether an element is monitoring other local elements.	Element
M IsPhaseCreatedValid(ElementId)	bool	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element.	Element
M IsPhaseDemolishedValid(ElementId)	bool	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element.	Element
M IsValidType(Document, ICollection<ElementId>, ElementId)	bool	Checks if given type is valid for the set of elements.	Element
M IsValidType(ElementId)	bool	Checks if given type is valid for this element.	Element
M LookupParameter(String)	nullNothingnullptr	Attempts to find a parameter on the element which has the given name.	Element
M RefersToExternalResourceReference(ExternalResourceType)	bool	Determines whether this Element uses external resources associated with a specified external resource type.	Element
M RefersToExternalResourceReferences()	bool	Determines whether this Element uses external resources.	Element
M SetEntity(Entity)	None	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten.	Element
M GetBoundarySegments(SpatialElementBoundaryOptions)	IList<IList<BoundarySegment>>	Returns the boundary segments.	SpatialElement
M GetSpatialElementDomainData()	SpatialElementDomainData	Gets the domain data for the spatial element. The domain data contains information of different spatial elements, such as electrical load area. Currently room/space/area don't have domain data.	SpatialElement

Name	Return Type	Description	Inherited From
P BaseOffset	double	Get or Set the Base Offset of the Room.
P ClosedShell	GeometryElement	Return the closedShell of the Room.
P LimitOffset	double	Get or Set the Limit Offset of the Room.
P UnboundedHeight	double	Get the Unbounded Height of the Room.
P UpperLimit	Level	Get or Set the Upper Limit of the Room.
P Volume	double	Get the Volume of the Room.
P AssemblyInstanceId	ElementId	The id of the assembly instance to which the element belongs.	Element
P BoundingBox	BoundingBoxXYZ	Retrieves a box that circumscribes all geometry of the element.	Element
P Category	Category	Retrieves a Category object that represents the category or sub category in which the element resides.	Element
P CreatedPhaseId	ElementId	Id of a Phase at which the Element was created.	Element
P DemolishedPhaseId	ElementId	Id of a Phase at which the Element was demolished.	Element
P DesignOption	DesignOption	Returns the design option to which the element belongs.	Element
P Document	Document	Returns the Document in which the Element resides.	Element
P Geometry	GeometryElement	Retrieves the geometric representation of the element.	Element
P GroupId	ElementId	The id of the group to which an element belongs.	Element
P Id	ElementId	A unique identifier for an Element in an Autodesk Revit project.	Element
P IsModifiable	bool	Identifies if the element is modifiable.	Element
P IsTransient	bool	Indicates whether an element is transient or permanent.	Element
P IsValidObject	bool	Specifies whether the .NET object represents a valid Revit entity.	Element
P LevelId	ElementId	The id of the level associated with the element.	Element
P Location	Location	This property is used to find the physical location of an element within a project.	Element
P Name	string	A human readable name for the Element.	Element
P OwnerViewId	ElementId	The id of the view that owns the element.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a parameter id.	Element
P Parameter	Parameter	Retrieves a parameter from the element based on its definition.	Element
P Parameter	Parameter	Retrieves a parameter from the element given a GUID for a shared parameter.	Element
P ParametersMap	ParameterMap	Retrieves a map containing all of the parameters that are contained within the element.	Element
P Parameters	ParameterSet	Retrieves a set containing all of the parameters that are contained within the element.	Element
P Pinned	bool	Identifies if the element has been pinned to prevent changes.	Element
P UniqueId	string	A stable unique identifier for an element within the document.	Element
P VersionGuid	Guid	Get the element version Guid.	Element
P ViewSpecific	bool	Identifies if the element is owned by a view.	Element
P WorksetId	WorksetId	Get Id of the Workset which owns the element.	Element
P Area	double	The area.	SpatialElement
P Level	Level	Gets the level of the room.	SpatialElement
P Location	Location	The location of the element.	SpatialElement
P Name	string	A human readable name for the Element.	SpatialElement
P Number	string	The number.	SpatialElement
P Perimeter	double	The perimeter.	SpatialElement
P SpatialElementType	SpatialElementType	The spatial element type.	SpatialElement