GH_Format.FormatRectangleValidity Method

GH_FormatFormatRectangleValidity Method

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

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

Parameters

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

M:Grasshopper.Kernel.GH_Format.FormatRectangleValidity(Rhino.Geometry.Rectangle3d,System.String)