M

FormatOptions.IsValidForSpec

Description:
Checks whether this FormatOptions is valid for a given spec.

Remarks:
The FormatOptions is valid if UseDefault is true or if the unit in the FormatOptions is valid for the spec. See UnitUtils.IsValidUnit(ForgeTypeId, ForgeTypeId) and UnitUtils.GetValidUnits(ForgeTypeId).

public bool IsValidForSpec(
	ForgeTypeId specTypeId
)

Public Function IsValidForSpec ( 
	specTypeId As ForgeTypeId
) As Boolean

public:
bool IsValidForSpec(
	ForgeTypeId^ specTypeId
)

member IsValidForSpec : 
        specTypeId : ForgeTypeId -> bool

Return Value Boolean True if the FormatOptions is valid, false otherwise.

ArgumentException

specTypeId is not a measurable spec identifier. See UnitUtils.IsMeasurableSpec(ForgeTypeId).
ArgumentNullException

A non-optional argument was null

Loading…

Syntax