FormatOptions.SetSymbolTypeId
Method
Description:
Sets the symbol that should be displayed to indicate the unit quantifying the value.
Sets the symbol that should be displayed to indicate the unit quantifying the value.
Parameters
Parameter | Type | Description |
---|---|---|
symbolTypeId | ForgeTypeId | The symbol identifier. An empty identifier string indicates no symbol. |
Return Value
Exceptions
Exception | Condition |
---|---|
ArgumentException | symbolTypeId is not a valid symbol for the unit in this FormatOptions. |
ArgumentNullException | A non-optional argument was null |
InvalidOperationException | UseDefault is true in this FormatOptions. |