BoundaryConditions Class

An object that represents a force applied across an area.

Inheritance Hierarchy

SystemObject
Autodesk.Revit.DBElement
Autodesk.Revit.DB.StructureBoundaryConditions

Namespace: Autodesk.Revit.DB.Structure
Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

C++

Copy

public class BoundaryConditions : Element

Public Class BoundaryConditions
	Inherits Element

public ref class BoundaryConditions : public Element

type BoundaryConditions = 
    class
        inherit Element
    end

The BoundaryConditions type exposes the following members.

Properties

	Name	Description
	AssemblyInstanceId	The id of the assembly instance to which the element belongs. (Inherited from Element)
	AssociatedLoadId	The Id of the internal load element associated with a boundary conditions.
	BoundingBox	Retrieves a box that circumscribes all geometry of the element. (Inherited from Element)
	Category	Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element)
	CreatedPhaseId	Id of a Phase at which the Element was created. (Inherited from Element)
	DemolishedPhaseId	Id of a Phase at which the Element was demolished. (Inherited from Element)
	DesignOption	Returns the design option to which the element belongs. (Inherited from Element)
	Document	Returns the Document in which the Element resides. (Inherited from Element)
	Geometry	Retrieves the geometric representation of the element. (Inherited from Element)
	GroupId	The id of the group to which an element belongs. (Inherited from Element)
	HostElementId	The host element Id for the boundary conditions.
	Id	A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element)
	IsModifiable	Identifies if the element is modifiable. (Inherited from Element)
	IsTransient	Indicates whether an element is transient or permanent. (Inherited from Element)
	IsValidObject	Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element)
	LevelId	The id of the level associated with the element. (Inherited from Element)
	Location	This property is used to find the physical location of an element within a project. (Inherited from Element)
	Name	A human readable name for the Element. (Inherited from Element)
	OwnerViewId	The id of the view that owns the element. (Inherited from Element)
	ParameterBuiltInParameter	Retrieves a parameter from the element given a parameter id. (Inherited from Element)
	ParameterDefinition	Retrieves a parameter from the element based on its definition. (Inherited from Element)
	ParameterGuid	Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element)
	Parameters	Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element)
	ParametersMap	Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element)
	Pinned	Identifies if the element has been pinned to prevent changes. (Inherited from Element)
	Point	Returns the position of point boundary conditions.
	UniqueId	A stable unique identifier for an element within the document. (Inherited from Element)
	VersionGuid	Get the element version Guid. (Inherited from Element)
	ViewSpecific	Identifies if the element is owned by a view. (Inherited from Element)
	WorksetId	Get Id of the Workset which owns the element. (Inherited from Element)

Top

Methods

	Name	Description
	ArePhasesModifiable	Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element)
	CanBeHidden	Indicates if the element can be hidden in the view. (Inherited from Element)
	CanBeLocked	Identifies if the element can be locked. (Inherited from Element)
	CanDeleteSubelement	Checks if given subelement can be removed from the element. (Inherited from Element)
	CanHaveTypeAssigned	Identifies if the element can have a type assigned. (Inherited from Element)
	ChangeTypeId(ElementId)	Changes the type of the element. (Inherited from Element)
	DeleteEntity	Deletes the existing entity created by %schema% in the element (Inherited from Element)
	DeleteSubelement	Removes a subelement from the element. (Inherited from Element)
	DeleteSubelements	Removes the subelements from the element. (Inherited from Element)
	Dispose	(Inherited from Element)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	EvaluateAllParameterValues	Evaluates all the parameters' values of the element. (Inherited from Element)
	EvaluateParameterValues	Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element)
	GetBoundaryConditionsType	Returns the boundary conditions type.
	GetCurve	Returns curve that define geometry of the line boundary conditions.
	GetDegreesOfFreedomCoordinateSystem	Gets the origin and rotation of coordinate system that is used by translation and rotation parameters, like X Translation or Z Rotation.
	GetDependentElements	Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element)
	GetEntity	Returns the existing entity corresponding to the Schema if it has been saved in the Element, or an invalid entity otherwise. (Inherited from Element)
	GetEntitySchemaGuids	Returns the Schema guids of any Entities stored in this element. (Inherited from Element)
	GetExternalFileReference	Gets information pertaining to the external file referenced by the element. (Inherited from Element)
	GetExternalResourceReference	Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element)
	GetExternalResourceReferenceExpanded	Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element)
	GetExternalResourceReferences	Gets the map of the external resource references referenced by the element. (Inherited from Element)
	GetExternalResourceReferencesExpanded	Gets the expanded map of the external resource references referenced by the element. (Inherited from Element)
	GetGeneratingElementIds	Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element)
	GetGeometryObjectFromReference	Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetLoops	Returns curve loops that define geometry of the area boundary conditions.
	GetMaterialArea	Gets the area of the material with the given id. (Inherited from Element)
	GetMaterialIds	Gets the element ids of all materials present in the element. (Inherited from Element)
	GetMaterialVolume	Gets the volume of the material with the given id. (Inherited from Element)
	GetMonitoredLinkElementIds	Provides the link instance IDs when the element is monitoring. (Inherited from Element)
	GetMonitoredLocalElementIds	Provides the local element IDs when the element is monitoring. (Inherited from Element)
	GetOrderedParameters	Gets the parameters associated to the element in order. (Inherited from Element)
	GetOrientTo	Returns the boundary conditions orientation option.
	GetParameter	Retrieves a parameter from the element given identifier. (Inherited from Element)
	GetParameterFormatOptions	Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element)
	GetParameters	Retrieves the parameters from the element via the given name. (Inherited from Element)
	GetPhaseStatus	Gets the status of a given element in the input phase (Inherited from Element)
	GetSubelements	Returns the collection of element subelements. (Inherited from Element)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetTypeId	Returns the identifier of this element's type. (Inherited from Element)
	GetValidTypes	Obtains a set of types that are valid for this element. (Inherited from Element)
	HasPhases	Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element)
	IsCreatedPhaseOrderValid	Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element)
	IsDemolishedPhaseOrderValid	Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element)
	IsExternalFileReference	Determines whether this Element represents an external file. (Inherited from Element)
	IsHidden	Identifies if the element has been permanently hidden in the view. (Inherited from Element)
	IsMonitoringLinkElement	Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element)
	IsMonitoringLocalElement	Indicate whether an element is monitoring other local elements. (Inherited from Element)
	IsPhaseCreatedValid	Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element)
	IsPhaseDemolishedValid	Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element)
	IsValidType(ElementId)	Checks if given type is valid for this element. (Inherited from Element)
	LookupParameter	Attempts to find a parameter on the element which has the given name. (Inherited from Element)
	RefersToExternalResourceReference	Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element)
	RefersToExternalResourceReferences	Determines whether this Element uses external resources. (Inherited from Element)
	SetEntity	Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element)
	SetOrientTo	Sets the boundary condition orientation option.
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Example

C++

Copy

public void GetInfo_BoundaryConditions(BoundaryConditions boundaryConditions)
{
    string message = "BoundaryConditions : ";

    boundaryConditions.GetBoundaryConditionsType();
    switch (boundaryConditions.GetBoundaryConditionsType())
    {
        case BoundaryConditionsType.Point:
            XYZ point = boundaryConditions.Point;
            message += "\nThis BoundaryConditions is a Point Boundary Conditions.";
            message += "\nLocation point: (" + point.X + ", "
                        + point.Y + ", " + point.Z + ")";
            break;
        case BoundaryConditionsType.Line:
            message += "\nThis BoundaryConditions is a Line Boundary Conditions.";
            Curve curve = boundaryConditions.GetCurve();
            // Get curve start point
            message += "\nLocation Line: start point: (" + curve.GetEndPoint(0).X + ", "
                    + curve.GetEndPoint(0).Y + ", " + curve.GetEndPoint(0).Z + ")";
            // Get curve end point
            message += ";  end point:(" + curve.GetEndPoint(1).X + ", "
                    + curve.GetEndPoint(1).Y + ", " + curve.GetEndPoint(1).Z + ")";
            break;
        case BoundaryConditionsType.Area:
            message += "\nThis BoundaryConditions is an Area Boundary Conditions.";
            IList<CurveLoop> loops = boundaryConditions.GetLoops();
            foreach (CurveLoop curveLoop in loops)
            {
                foreach (Curve areaCurve in curveLoop)
                {
                    // Get curve start point
                    message += "\nCurve start point:(" + areaCurve.GetEndPoint(0).X + ", "
                            + areaCurve.GetEndPoint(0).Y + ", " + areaCurve.GetEndPoint(0).Z + ")";
                    // Get curve end point
                    message += "; Curve end point:(" + areaCurve.GetEndPoint(1).X + ", "
                            + areaCurve.GetEndPoint(1).Y + ", " + areaCurve.GetEndPoint(1).Z + ")";
                }
            }
            break;
        default:
            break;
    }

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

Public Sub GetInfo_BoundaryConditions(boundaryConditions As BoundaryConditions)
    Dim message As String = "BoundaryConditions : "

    boundaryConditions.GetBoundaryConditionsType()
    Select Case boundaryConditions.GetBoundaryConditionsType()
        Case BoundaryConditionsType.Point
            Dim point As XYZ = boundaryConditions.Point
            message += vbLf & "This BoundaryConditions is a Point Boundary Conditions."
            message += vbLf & "Location point: (" + point.X + ", " + point.Y + ", " + point.Z + ")"
            Exit Select
        Case BoundaryConditionsType.Line
            message += vbLf & "This BoundaryConditions is a Line Boundary Conditions."
            Dim curve As Curve = boundaryConditions.GetCurve()
            ' Get curve start point
            message += vbLf & "Location Line: start point: (" + curve.GetEndPoint(0).X + ", " + curve.GetEndPoint(0).Y + ", " + curve.GetEndPoint(0).Z + ")"
            ' Get curve end point
            message += ";  end point:(" + curve.GetEndPoint(1).X + ", " + curve.GetEndPoint(1).Y + ", " + curve.GetEndPoint(1).Z + ")"
            Exit Select
        Case BoundaryConditionsType.Area
            message += vbLf & "This BoundaryConditions is an Area Boundary Conditions."
            Dim loops As IList(Of CurveLoop) = boundaryConditions.GetLoops()
            For Each curveLoop As CurveLoop In loops
                For Each areaCurve As Curve In curveLoop
                    ' Get curve start point
                    message += vbLf & "Curve start point:(" + areaCurve.GetEndPoint(0).X + ", " + areaCurve.GetEndPoint(0).Y + ", " + areaCurve.GetEndPoint(0).Z + ")"
                    ' Get curve end point
                    message += "; Curve end point:(" + areaCurve.GetEndPoint(1).X + ", " + areaCurve.GetEndPoint(1).Y + ", " + areaCurve.GetEndPoint(1).Z + ")"
                Next
            Next
            Exit Select
        Case Else
            Exit Select
    End Select

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

Reference

Autodesk.Revit.DB.Structure Namespace