Namespace:
Autodesk.Revit.DB
Dimension
Class
Description:
An object that represents a dimension within the Revit project.
An object that represents a dimension within the Revit project.
Inheritance Hierarchy:
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Dimension
Autodesk.Revit.DB.AngularDimension
Autodesk.Revit.DB.LinearDimension
Autodesk.Revit.DB.RadialDimension
Autodesk.Revit.DB.SpotDimension
System.Object
Autodesk.Revit.DB.Element
Autodesk.Revit.DB.Dimension
Autodesk.Revit.DB.AngularDimension
Autodesk.Revit.DB.LinearDimension
Autodesk.Revit.DB.RadialDimension
Autodesk.Revit.DB.SpotDimension
Examples
public void GetInfo_Dimension(Dimension dimension)
{
string message = "Dimension : ";
// Get Dimension name
message += "\nDimension name is : " + dimension.Name;
// Get Dimension Curve
Autodesk.Revit.DB.Curve curve = dimension.Curve;
if (curve != null && curve.IsBound)
{
// Get curve start point
message += "\nCurve start point:(" + curve.GetEndPoint(0).X + ", "
+ curve.GetEndPoint(0).Y + ", " + curve.GetEndPoint(0).Z + ")";
// Get curve end point
message += "; Curve end point:(" + curve.GetEndPoint(1).X + ", "
+ curve.GetEndPoint(1).Y + ", " + curve.GetEndPoint(1).Z + ")";
}
// Get Dimension type name
message += "\nDimension type name is : " + dimension.DimensionType.Name;
// Get Dimension view name
message += "\nDimension view name is : " + dimension.View.Name;
// Get Dimension reference count
message += "\nDimension references count is " + dimension.References.Size;
if (BuiltInCategory.OST_Dimensions == dimension.Category.BuiltInCategory)
{
message += "\nDimension is a permanent dimension.";
}
else if (BuiltInCategory.OST_Constraints == dimension.Category.BuiltInCategory)
{
message += "\nDimension is a constraint element.";
}
Autodesk.Revit.UI.TaskDialog.Show("Revit",message);
}
Dimension Class Members:
Name | Description | Inherited From |
---|---|---|
Above | The text shown above the segment's value. | |
AreReferencesAvailable | Indicates if this dimension's references can be resolved. | |
AreSegmentsEqual | Indicates if all segments are forced to be equal. | |
AssemblyInstanceId | The id of the assembly instance to which the element belongs. (Inherited from Element ) | Element |
Below | The text shown below the segment's value. | |
BoundingBox | Retrieves a box that circumscribes all geometry of the element. (Inherited from Element ) | Element |
Category | Retrieves a Category object that represents the category or sub category in which the element resides. (Inherited from Element ) | Element |
CreatedPhaseId | Id of a Phase at which the Element was created. (Inherited from Element ) | Element |
Curve | A curve that represents the dimension line. | |
DemolishedPhaseId | Id of a Phase at which the Element was demolished. (Inherited from Element ) | Element |
DesignOption | Returns the design option to which the element belongs. (Inherited from Element ) | Element |
DimensionShape | The shape of this dimension. | |
DimensionType | The dimension style of this dimension. | |
Document | Returns the Document in which the Element resides. (Inherited from Element ) | Element |
FamilyLabel | The family parameter label of the dimension. | |
Geometry | Retrieves the geometric representation of the element. (Inherited from Element ) | Element |
GroupId | The id of the group to which an element belongs. (Inherited from Element ) | Element |
HasLeader | True if dimension has leader, false otherwise. | |
Id | A unique identifier for an Element in an Autodesk Revit project. (Inherited from Element ) | Element |
IsLocked | Indicates if this dimension is locked. | |
IsModifiable | Identifies if the element is modifiable. (Inherited from Element ) | Element |
IsTransient | Indicates whether an element is transient or permanent. (Inherited from Element ) | Element |
IsValid | Indicates if this dimension is valid. | |
IsValidObject | Specifies whether the .NET object represents a valid Revit entity. (Inherited from Element ) | Element |
LeaderEndPosition | The position of the dimension's leader end point. | |
LevelId | The id of the level associated with the element. (Inherited from Element ) | Element |
Location | This property is used to find the physical location of an element within a project. (Inherited from Element ) | Element |
Name | Retrieves or changes the name associated with the Dimension. | |
NumberOfSegments | The number of segments for the dimension. | |
Origin | The dimension origin. | |
OwnerViewId | The id of the view that owns the element. (Inherited from Element ) | Element |
Parameter[BuiltInParameter] | Retrieves a parameter from the element given a parameter id. (Inherited from Element ) | Element |
Parameter[Definition] | Retrieves a parameter from the element based on its definition. (Inherited from Element ) | Element |
Parameter[Guid] | Retrieves a parameter from the element given a GUID for a shared parameter. (Inherited from Element ) | Element |
Parameters | Retrieves a set containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
ParametersMap | Retrieves a map containing all of the parameters that are contained within the element. (Inherited from Element ) | Element |
Pinned | Identifies if the element has been pinned to prevent changes. (Inherited from Element ) | Element |
Prefix | The text shown before the segment's value. | |
References | Returns an array of geometric references to which the dimension is attached. | |
Segments | The segments in the dimension. | |
Suffix | The text shown after the segment's value. | |
TextPosition | The position of the dimension text's drag point. | |
UniqueId | A stable unique identifier for an element within the document. (Inherited from Element ) | Element |
Value | The value of the dimension. | |
ValueOverride | The text that replaces the segment's value. | |
ValueString | The dimension value as a user visible string. | |
VersionGuid | Get the element version Guid. (Inherited from Element ) | Element |
View | Supplies the view that contains the dimension if the dimension is view specific. | |
ViewSpecific | Identifies if the element is owned by a view. (Inherited from Element ) | Element |
WorksetId | Get Id of the Workset which owns the element. (Inherited from Element ) | Element |
Name | Description | Inherited From |
---|---|---|
ArePhasesModifiable | Returns true if the properties CreatedPhaseId and DemolishedPhaseId can be modified for this Element. (Inherited from Element ) | Element |
CanBeHidden | Indicates if the element can be hidden in the view. (Inherited from Element ) | Element |
CanBeLocked | Identifies if the element can be locked. (Inherited from Element ) | Element |
CanDeleteSubelement | Checks if given subelement can be removed from the element. (Inherited from Element ) | Element |
CanHaveTypeAssigned() | Identifies if the element can have a type assigned. (Inherited from Element ) | Element |
ChangeTypeId(ElementId) | Changes the type of the element. (Inherited from Element ) | Element |
DeleteEntity | Deletes the existing entity created by %schema% in the element (Inherited from Element ) | Element |
DeleteSubelement | Removes a subelement from the element. (Inherited from Element ) | Element |
DeleteSubelements | Removes the subelements from the element. (Inherited from Element ) | Element |
Dispose | (Inherited from Element ) | Element |
Equals | Determines whether the specified object is equal to the current object. (Inherited from Object ) | Object |
EvaluateAllParameterValues | Evaluates all the parameters' values of the element. (Inherited from Element ) | Element |
EvaluateParameterValues | Evaluate the parameters' values of the element on the given parameter ID set. (Inherited from Element ) | Element |
GetDependentElements | Get all elements that, from a logical point of view, are the children of this Element. (Inherited from Element ) | 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 ) | Element |
GetEntitySchemaGuids | Returns the Schema guids of any Entities stored in this element. (Inherited from Element ) | Element |
GetExternalFileReference | Gets information pertaining to the external file referenced by the element. (Inherited from Element ) | Element |
GetExternalResourceReference | Gets the ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
GetExternalResourceReferenceExpanded | Gets the collection of ExternalResourceReference associated with a specified external resource type. (Inherited from Element ) | Element |
GetExternalResourceReferences | Gets the map of the external resource references referenced by the element. (Inherited from Element ) | Element |
GetExternalResourceReferencesExpanded | Gets the expanded map of the external resource references referenced by the element. (Inherited from Element ) | Element |
GetGeneratingElementIds | Returns the ids of the element(s) that generated the input geometry object. (Inherited from Element ) | Element |
GetGeometryObjectFromReference | Retrieve one geometric primitive contained in the element given a reference. (Inherited from Element ) | Element |
GetHashCode | Serves as the default hash function. (Inherited from Object ) | Object |
GetMaterialArea | Gets the area of the material with the given id. (Inherited from Element ) | Element |
GetMaterialIds | Gets the element ids of all materials present in the element. (Inherited from Element ) | Element |
GetMaterialVolume | Gets the volume of the material with the given id. (Inherited from Element ) | Element |
GetMonitoredLinkElementIds | Provides the link instance IDs when the element is monitoring. (Inherited from Element ) | Element |
GetMonitoredLocalElementIds | Provides the local element IDs when the element is monitoring. (Inherited from Element ) | Element |
GetOrderedParameters | Gets the parameters associated to the element in order. (Inherited from Element ) | Element |
GetParameter | Retrieves a parameter from the element given identifier. (Inherited from Element ) | Element |
GetParameterFormatOptions | Returns a FormatOptions override for the element Parameter, or a default FormatOptions if no override exists. (Inherited from Element ) | Element |
GetParameters | Retrieves the parameters from the element via the given name. (Inherited from Element ) | Element |
GetPhaseStatus | Gets the status of a given element in the input phase (Inherited from Element ) | Element |
GetSubelements | Returns the collection of element subelements. (Inherited from Element ) | Element |
GetType | Gets the Type of the current instance. (Inherited from Object ) | Object |
GetTypeId | Returns the identifier of this element's type. (Inherited from Element ) | Element |
GetValidTypes() | Obtains a set of types that are valid for this element. (Inherited from Element ) | Element |
HasOneSegment | Determines whether a dimension has one segment. | |
HasPhases | Returns true if this Element has the properties CreatedPhaseId and DemolishedPhaseId. (Inherited from Element ) | Element |
IsCreatedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
IsDemolishedPhaseOrderValid | Returns true if createdPhaseId and demolishedPhaseId are in order. (Inherited from Element ) | Element |
IsExternalFileReference | Determines whether this Element represents an external file. (Inherited from Element ) | Element |
IsHidden | Identifies if the element has been permanently hidden in the view. (Inherited from Element ) | Element |
IsMonitoringLinkElement | Indicate whether an element is monitoring any elements in any linked models. (Inherited from Element ) | Element |
IsMonitoringLocalElement | Indicate whether an element is monitoring other local elements. (Inherited from Element ) | Element |
IsPhaseCreatedValid | Returns true if createdPhaseId is an allowed value for the property CreatedPhaseId in this Element. (Inherited from Element ) | Element |
IsPhaseDemolishedValid | Returns true if demolishedPhaseId is an allowed value for the property DemolishedPhaseId in this Element. (Inherited from Element ) | Element |
IsTextPositionAdjustable | Indicates if this dimension is supported to set/get TextPosition/LeaderEndPosition. | |
IsValidType(ElementId) | Checks if given type is valid for this element. (Inherited from Element ) | Element |
LookupParameter | Attempts to find a parameter on the element which has the given name. (Inherited from Element ) | Element |
RefersToExternalResourceReference | Determines whether this Element uses external resources associated with a specified external resource type. (Inherited from Element ) | Element |
RefersToExternalResourceReferences | Determines whether this Element uses external resources. (Inherited from Element ) | Element |
ResetTextPosition | Resets the text position of the dimension to the initial position determined by its type and parameters. | |
SetEntity | Stores the entity in the element. If an Entity described by the same Schema already exists, it is overwritten. (Inherited from Element ) | Element |
ToString | Returns a string that represents the current object. (Inherited from Object ) | Object |