Units

Public Class

A document’s default settings for formatting numbers with units.

Inheritance Hierarchy

System.Object
Autodesk.Revit.DB.Units

Assembly: RevitAPI (in RevitAPI.dll) Version: 25.0.0.0 (25.0.0.0)

Syntax

public class Units : IDisposable

The Units type exposes the following members.

Constructors

Name

Description

Public Method
Units

Creates a new Units object with default settings for Metric or Imperial units.

Properties

Name

Description

Public Property

DecimalSymbol

The symbol used to separate the integer and fractional parts of a number.

Public Property
DigitGroupingAmount

The number of digits in each group when numbers are formatted with digit grouping.

Public Property
DigitGroupingSymbol

The symbol used to separate groups of digits when numbers are formatted with digit grouping.

Public Property
IsValidObject

Specifies whether the .NET object represents a valid Revit entity.

Methods

Name

Description

Public Method

Dispose

Releases all resources used by the Units

Public Method

Equals

Determines whether the specified object is equal to the current object.
(Inherited from Object)

Public Method

GetFormatOptions

Gets the default FormatOptions for a spec.

Public Method

GetHashCode

Serves as the default hash function.
(Inherited from Object)

Public Method
Static Member

GetModifiableSpecs

Gets all specs for which the default FormatOptions can be modified.

Public Method

GetType

Gets the Type of the current instance.
(Inherited from Object)

Public Method
Static Member
IsModifiableSpec

Checks whether the default FormatOptions can be modified for a given spec.

Public Method

SetFormatOptions

Sets the default FormatOptions for a spec.

Public Method

ToString

Returns a string that represents the current object.
(Inherited from Object)

Remarks

The Units class represents a document’s default settings for formatting numbers with units as strings. It contains a FormatOptions object for each unit type as well as settings related to decimal symbol and digit grouping.

The Units class stores a FormatOptions object for every valid unit type, but not all of them can be directly modified. Some, like UT_Number and UT_SiteAngle, have fixed definitions. Others have definitions which are automatically derived from other unit types. For example, UT_SheetLength is derived from UT_Length and UT_ForceScale is derived from UT_Force. See IsModifiableUnitType() and GetModifiableUnitTypes().