Sign in
2021 Members
Changes 8
M

FormatOptions

Name Return Type Description Inherited From
M CanHaveSymbol.() bool Checks whether a symbol can be specified to display the unit in this FormatOptions.
M CanHaveSymbol(ForgeTypeId) bool Checks whether a symbol can be specified to display a given unit.
M CanHaveUnitSymbol.() bool Obsolete. Checks whether a unit symbol can be specified for the display unit in this FormatOptions.
M CanHaveUnitSymbol(DisplayUnitType) bool Obsolete. Checks whether a unit symbol can be specified for a given display unit.
M CanSuppressLeadingZeros.() bool Checks whether leading zeros can be suppressed for the display unit in this FormatOptions.
M CanSuppressLeadingZeros(DisplayUnitType) bool Obsolete. Checks whether leading zeros can be suppressed for a given display unit.
M CanSuppressLeadingZeros(ForgeTypeId) bool Checks whether leading zeros can be suppressed for a given unit.
M CanSuppressSpaces.() bool Checks whether spaces can be suppressed for the display unit in this FormatOptions.
M CanSuppressSpaces(DisplayUnitType) bool Obsolete. Checks whether spaces can be suppressed for a given display unit.
M CanSuppressSpaces(ForgeTypeId) bool Checks whether spaces can be suppressed for a given unit.
M CanSuppressTrailingZeros.() bool Checks whether trailing zeros can be suppressed for the display unit in this FormatOptions.
M CanSuppressTrailingZeros(DisplayUnitType) bool Obsolete. Checks whether trailing zeros can be suppressed for a given display unit.
M CanSuppressTrailingZeros(ForgeTypeId) bool Checks whether trailing zeros can be suppressed for a given unit.
M CanUsePlusPrefix.() bool Checks whether a plus prefix can be displayed for the display unit in this FormatOptions.
M CanUsePlusPrefix(DisplayUnitType) bool Obsolete. Checks whether a plus prefix can be displayed for a given display unit.
M CanUsePlusPrefix(ForgeTypeId) bool Checks whether a plus prefix can be displayed for a given unit.
M Dispose() None Releases all resources used by the FormatOptions
M Equals None (Inherited from Object .) Object .
M GetHashCode None (Inherited from Object .) Object .
M GetSymbolTypeId() ForgeTypeId Gets the identifier of the symbol indicating the unit quantifying the value.
M GetType None (Inherited from Object .) Object .
M GetUnitTypeId() ForgeTypeId Gets the identifier of the unit used to quantify values.
M GetValidSymbols.() IList<ForgeTypeId> Gets the identifiers of all valid symbols for the unit in this FormatOptions.
M GetValidSymbols(ForgeTypeId) IList<ForgeTypeId> Gets the identifiers of all valid symbols for a given unit.
M GetValidUnitSymbols.() IList<UnitSymbolType> Obsolete. Gets all valid unit symbols for the display unit in this FormatOptions.
M GetValidUnitSymbols(DisplayUnitType) IList<UnitSymbolType> Obsolete. Gets all valid unit symbols for a given display unit.
M IsValidAccuracy(Double) bool Checks whether an accuracy is valid for the display unit in this FormatOptions.
M IsValidAccuracy(DisplayUnitType, Double) bool Obsolete. Checks whether an accuracy is valid for a given display unit.
M IsValidAccuracy(ForgeTypeId, Double) bool Checks whether an accuracy is valid for a given unit.
M IsValidForSpec(ForgeTypeId) bool Checks whether this FormatOptions is valid for a given spec.
M IsValidForUnitType(UnitType) bool Obsolete. Checks whether this FormatOptions is valid for a given unit type.
M IsValidSymbol(ForgeTypeId) bool Checks whether a symbol is valid for the unit in this FormatOptions.
M IsValidSymbol(ForgeTypeId, ForgeTypeId) bool Checks whether a symbol is valid for a given unit.
M IsValidUnitSymbol(UnitSymbolType) bool Obsolete. Checks whether a unit symbol is valid for the display unit in this FormatOptions.
M IsValidUnitSymbol(DisplayUnitType, UnitSymbolType) bool Obsolete. Checks whether a unit symbol is valid for a given display unit.
M SetSymbolTypeId(ForgeTypeId) None Sets the symbol that should be displayed to indicate the unit quantifying the value.
M SetUnitTypeId(ForgeTypeId) FormatOptions Sets the unit used to quantify values.
M ToString None (Inherited from Object .) Object .
Name Return Type Description Inherited From
P Accuracy double The accuracy to which values will be rounded.
P DisplayUnits DisplayUnitType Obsolete. The units and display format used to format values.
P IsValidObject bool Specifies whether the .NET object represents a valid Revit entity.
P RoundingMethod RoundingMethod The method used to round values: round to nearest, round up, or round down.
P SuppressLeadingZeros bool Indicates if leading zeros should be suppressed in feet and fractional inches.
P SuppressSpaces bool Indicates if spaces around the dash should be suppressed in feet and fractional inches.
P SuppressTrailingZeros bool Indicates if trailing zeros after the decimal point should be suppressed.
P UnitSymbol UnitSymbolType Obsolete. The unit symbol that should be displayed to indicate the units of the value.
P UseDefault bool Indicates whether default or custom formatting should be used.
P UseDigitGrouping bool Indicates if digit grouping symbols should be displayed.
P UsePlusPrefix bool Indicates if a plus sign prefix should be displayed for positive and zero values.