Sign in
2024 Members
Changes 6
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 CanSuppressLeadingZeros.() bool Checks whether leading zeros can be suppressed for the display unit in this FormatOptions.
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(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(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(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 Determines whether the specified Object is equal to the current Object . (Inherited from Object .) Object .
M GetHashCode None Serves as a hash function for a particular type. (Inherited from Object .) Object .
M GetSymbolTypeId() ForgeTypeId Gets the identifier of the symbol indicating the unit quantifying the value.
M GetType None Gets the Type of the current instance. (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 IsValidAccuracy(Double) bool Checks whether an accuracy is valid for the display unit in this FormatOptions.
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 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 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 Returns a string that represents the current object. (Inherited from Object .) Object .
Name Return Type Description Inherited From
P Accuracy double The accuracy to which values will be rounded.
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 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.