Revit 2024 API |
Element..::..GetMaterialArea Method |
Element Class See Also |
Gets the area of the material with the given id.
Namespace: Autodesk.Revit.DB
Assembly: RevitAPI (in RevitAPI.dll) Version: 24.0.0.0 (24.0.0.0)
Since:
2014
Syntax
C# |
---|
public double GetMaterialArea( ElementId materialId, bool usePaintMaterial ) |
Visual Basic |
---|
Public Function GetMaterialArea ( _ materialId As ElementId, _ usePaintMaterial As Boolean _ ) As Double |
Visual C++ |
---|
public: double GetMaterialArea( ElementId^ materialId, bool usePaintMaterial ) |
Parameters
- materialId
- Type: Autodesk.Revit.DB..::..ElementId
The material id returned from GetMaterialIds(Boolean).
- usePaintMaterial
- Type: System..::..Boolean
If true, this material id was returned as a paint material from GetMaterialIds(Boolean) and the area returned should be calculated from paint applied to the element. If false, this material id was returned as a non-paint element material from GetMaterialIds(Boolean) and the area is calculated from the element geometry and layers.
Return Value
The area of the material for this element. Returns 0.0 if the material id is not a part of this element.Exceptions
Exception | Condition |
---|---|
Autodesk.Revit.Exceptions..::..ArgumentException | materialId is not a valid Element identifier. |
Autodesk.Revit.Exceptions..::..ArgumentNullException | A non-optional argument was null |
Autodesk.Revit.Exceptions..::..InvalidOperationException | This Element element does not support paint material assignment. |