C

Units

Description:
A document's default settings for formatting numbers with units.
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().

Inheritance Hierarchy:
System.Object
  Autodesk.Revit.DB.Units
public class Units : IDisposable
Name Return Type Description
C Units(UnitSystem) None Creates a new Units object with default settings for Metric or Imperial units.
Name Return Type Description
M Dispose() None Releases all resources used by the
M GetFormatOptions(ForgeTypeId) FormatOptions Gets the default FormatOptions for a spec.
M GetFormatOptions(UnitType) FormatOptions Gets the default FormatOptions for a unit type.
M GetModifiableSpecs() IList<ForgeTypeId> Gets all specs for which the default FormatOptions can be modified.
M GetModifiableUnitTypes() IList<UnitType> Gets all unit types for which the default FormatOptions can be modified.
M IsModifiableSpec(ForgeTypeId) bool Checks whether the default FormatOptions can be modified for a given spec.
M IsModifiableUnitType(UnitType) bool Checks whether the default FormatOptions can be modified for a given unit type.
M SetFormatOptions(ForgeTypeId, FormatOptions) None Sets the default FormatOptions for a spec.
M SetFormatOptions(UnitType, FormatOptions) None Sets the default FormatOptions for a unit type.
Name Return Type Description
P DecimalSymbol DecimalSymbol The symbol used to separate the integer and fractional parts of a number.
P DigitGroupingAmount DigitGroupingAmount The number of digits in each group when numbers are formatted with digit grouping.
P DigitGroupingSymbol DigitGroupingSymbol The symbol used to separate groups of digits when numbers are formatted with digit grouping.
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.