GH_Format.FormatBoxValidity Method

GH_FormatFormatBoxValidity Method

If the box is invalid, return a string describing why.

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

Parameters

val
Type: Box
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 box is invalid or String.Empty if the value is not invalid.
See Also

M:Grasshopper.Kernel.GH_Format.FormatBoxValidity(Rhino.Geometry.Box,System.String)