GH_Format.FormatComplexValidity Method

GH_FormatFormatComplexValidity Method

If the complex number is invalid, return a string describing why.

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
Copy
public static string FormatComplexValidity(
	Complex val,
	string identifier = "Complex"
)
Public Shared Function FormatComplexValidity ( 
	val As Complex,
	Optional identifier As String = "Complex"
) As String

Parameters

val
Type: Grasshopper.Kernel.TypesComplex
Value to format.
identifier (Optional)
Type: SystemString
Name used to refer to the value in the format.

Return Value

Type: String
A string describing why the complex number is invalid or String.Empty if the value is not invalid.
See Also

M:Grasshopper.Kernel.GH_Format.FormatComplexValidity(Grasshopper.Kernel.Types.Complex,System.String)