•  

FormatOptions Members

The FormatOptions type exposes the following members.

Constructors

Name Description
Public method FormatOptions
Creates a new FormatOptions object that represents default formatting.
Public method FormatOptions(DisplayUnitType)
Creates a new FormatOptions object that represents custom formatting.
Public method FormatOptions(FormatOptions)
Creates a copy of a FormatOptions object.
Public method FormatOptions(DisplayUnitType, UnitSymbolType)
Creates a new FormatOptions object that represents custom formatting.
Public method FormatOptions(DisplayUnitType, Double)
Creates a new FormatOptions object that represents custom formatting.
Public method FormatOptions(DisplayUnitType, UnitSymbolType, Double)
Creates a new FormatOptions object that represents custom formatting.

Methods

Name Description
Public method CanHaveUnitSymbol
Checks whether a unit symbol can be specified for the display unit in this FormatOptions.
Public method Static member CanHaveUnitSymbol(DisplayUnitType)
Checks whether a unit symbol can be specified for a given display unit.
Public method CanSuppressLeadingZeros
Checks whether leading zeros can be suppressed for the display unit in this FormatOptions.
Public method Static member CanSuppressLeadingZeros(DisplayUnitType)
Checks whether leading zeros can be suppressed for a given display unit.
Public method CanSuppressSpaces
Checks whether spaces can be suppressed for the display unit in this FormatOptions.
Public method Static member CanSuppressSpaces(DisplayUnitType)
Checks whether spaces can be suppressed for a given display unit.
Public method CanSuppressTrailingZeros
Checks whether trailing zeros can be suppressed for the display unit in this FormatOptions.
Public method Static member CanSuppressTrailingZeros(DisplayUnitType)
Checks whether trailing zeros can be suppressed for a given display unit.
Public method CanUsePlusPrefix
Checks whether a plus prefix can be displayed for the display unit in this FormatOptions.
Public method Static member CanUsePlusPrefix(DisplayUnitType)
Checks whether a plus prefix can be displayed for a given display unit.
Public method Dispose
Releases all resources used by the FormatOptions
Public method Equals
Determines whether the specified Object is equal to the current Object .
(Inherited from Object .)
Public method GetHashCode
Serves as a hash function for a particular type.
(Inherited from Object .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method GetValidUnitSymbols
Gets all valid unit symbols for the display unit in this FormatOptions.
Public method Static member GetValidUnitSymbols(DisplayUnitType)
Gets all valid unit symbols for a given display unit.
Public method IsValidAccuracy(Double)
Checks whether an accuracy is valid for the display unit in this FormatOptions.
Public method Static member IsValidAccuracy(DisplayUnitType, Double)
Checks whether an accuracy is valid for a given display unit.
Public method IsValidForUnitType
Checks whether this FormatOptions is valid for a given unit type.
Public method IsValidUnitSymbol(UnitSymbolType)
Checks whether a unit symbol is valid for the display unit in this FormatOptions.
Public method Static member IsValidUnitSymbol(DisplayUnitType, UnitSymbolType)
Checks whether a unit symbol is valid for a given display unit.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)

Properties

Name Description
Public property Accuracy
The accuracy to which values will be rounded.
Public property DisplayUnits
The units and display format used to format values.
Public property IsValidObject
Specifies whether the .NET object represents a valid Revit entity.
Public property RoundingMethod
The method used to round values: round to nearest, round up, or round down.
Public property SuppressLeadingZeros
Indicates if leading zeros should be suppressed in feet and fractional inches.
Public property SuppressSpaces
Indicates if spaces around the dash should be suppressed in feet and fractional inches.
Public property SuppressTrailingZeros
Indicates if trailing zeros after the decimal point should be suppressed.
Public property UnitSymbol
The unit symbol that should be displayed to indicate the units of the value.
Public property UseDefault
Indicates whether default or custom formatting should be used.
Public property UseDigitGrouping
Indicates if digit grouping symbols should be displayed.
Public property UsePlusPrefix
Indicates if a plus sign prefix should be displayed for positive and zero values.

See Also