Namespace: Autodesk.Revit.DB Class: Units

Units.SetFormatOptions

Method

Description:
Sets the default FormatOptions for a spec.

Syntax

public void SetFormatOptions(
	ForgeTypeId specTypeId,
	FormatOptions options
)

Public Sub SetFormatOptions ( 
	specTypeId As ForgeTypeId,
	options As FormatOptions
)

public:
void SetFormatOptions(
	ForgeTypeId^ specTypeId, 
	FormatOptions^ options
)

member SetFormatOptions : 
        specTypeId : ForgeTypeId * 
        options : FormatOptions -> unit

Parameters

Parameter	Type	Description
specTypeId	ForgeTypeId	Identifier of the spec.
options	FormatOptions	The FormatOptions.

Return Value

Exceptions

Exception	Condition
ArgumentException	specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId). -or- FormatOptions cannot be modified for specTypeId. See Units.IsModifiableSpec(ForgeTypeId) and Units.GetModifiableSpecs(). -or- UseDefault is true in options. -or- The unit in options is not valid for specTypeId. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId). -or- The rounding method in options is not set to Nearest.
ArgumentNullException	A non-optional argument was null

Exception

Condition

ArgumentException

specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId). -or- FormatOptions cannot be modified for specTypeId. See Units.IsModifiableSpec(ForgeTypeId) and Units.GetModifiableSpecs(). -or- UseDefault is true in options. -or- The unit in options is not valid for specTypeId. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId). -or- The rounding method in options is not set to Nearest.

ArgumentNullException

A non-optional argument was null