Click or drag to resize

GH_Format Class

Provides standard Grasshopper formatting functions.
Inheritance Hierarchy
SystemObject
  Grasshopper.KernelGH_Format

Namespace:  Grasshopper.Kernel
Assembly:  Grasshopper (in Grasshopper.dll)
Syntax
public sealed class GH_Format

The GH_Format type exposes the following members.

Methods
  NameDescription
Public methodStatic memberDefaultCulture
Public methodStatic memberFormatArc(Arc)
Public methodStatic memberFormatArc(GH_Arc)
Public methodStatic memberFormatArcValidity
If the arc is invalid, return a string describing why.
Public methodStatic memberFormatBoolean(Boolean)
Public methodStatic memberFormatBoolean(GH_Boolean)
Public methodStatic memberFormatBoundingBoxValidity
If the box is invalid, return a string describing why.
Public methodStatic memberFormatBox(Box)
Public methodStatic memberFormatBox(GH_Box)
Public methodStatic memberFormatBoxValidity
If the box is invalid, return a string describing why.
Public methodStatic memberFormatBrep(Brep)
Public methodStatic memberFormatBrep(GH_Brep)
Public methodStatic memberFormatBrepValidity
If the brep is invalid, return a string describing why.
Public methodStatic memberFormatCircle(Circle)
Public methodStatic memberFormatCircle(GH_Circle)
Public methodStatic memberFormatCircleValidity
If the circle is invalid, return a string describing why.
Public methodStatic memberFormatColour(Color)
Public methodStatic memberFormatColour(GH_Colour)
Public methodStatic memberFormatComplexNumber(Complex)
Public methodStatic memberFormatComplexNumber(GH_ComplexNumber)
Public methodStatic memberFormatComplexValidity
If the complex number is invalid, return a string describing why.
Public methodStatic memberFormatCurve(GH_Curve)
Public methodStatic memberFormatCurve(Curve, String, String)
Public methodStatic memberFormatCurveValidity
If the curve is invalid, return a string describing why.
Public methodStatic memberFormatDate(DateTime)
Public methodStatic memberFormatDate(GH_Time)
Public methodStatic memberFormatDouble(Double)
Public methodStatic memberFormatDouble(GH_Number)
Public methodStatic memberFormatDoubleValidity
If the number is invalid, return a string describing why.
Public methodStatic memberFormatFilePath(String, Int32)
Format a filepath so that it doesn't exceed a string length. If the filepath filename is already longer than maxLength it will be returned intact.
Public methodStatic memberFormatFilePath(String, Int32, Font)
Format a filepath so that it doesn't exceed width. If the filepath filename is already longer than maxLength it will be returned intact.
Public methodStatic memberFormatGeometry
Public methodStatic memberFormatInteger(Int32)
Public methodStatic memberFormatInteger(GH_Integer)
Public methodStatic memberFormatInterval(Interval)
Public methodStatic memberFormatInterval(GH_Interval)
Public methodStatic memberFormatInterval(GH_Interval2D)
Public methodStatic memberFormatInterval(Double, Double)
Public methodStatic memberFormatIntervalValidity
If the point is invalid, return a string describing why.
Public methodStatic memberFormatKeys
Format a keys enumeration as though it's a menu shortcut
Public methodStatic memberFormatLine(Line)
Public methodStatic memberFormatLine(GH_Line)
Public methodStatic memberFormatLineValidity
If the line is invalid, return a string describing why.
Public methodStatic memberFormatMatrix(Matrix)
Public methodStatic memberFormatMatrix(GH_Matrix)
Public methodStatic memberFormatMesh(GH_Mesh)
Public methodStatic memberFormatMesh(Mesh, String)
Public methodStatic memberFormatMeshFace
Public methodStatic memberFormatMeshFaceValidity
If the number is invalid, return a string describing why.
Public methodStatic memberFormatMeshValidity
If the mesh is invalid, return a string describing why.
Public methodStatic memberFormatPlane(Plane)
Public methodStatic memberFormatPlane(GH_Plane)
Public methodStatic memberFormatPlaneValidity
If the plane is invalid, return a string describing why.
Public methodStatic memberFormatPoint(Point3d)
Public methodStatic memberFormatPoint(GH_Point)
Public methodStatic memberFormatPointCloud
Public methodStatic memberFormatPointValidity
If the point is invalid, return a string describing why.
Public methodStatic memberFormatRectangleValidity
If the rectangle is invalid, return a string describing why.
Public methodStatic memberFormatSingle
Public methodStatic memberFormatSubD(SubD)
Public methodStatic memberFormatSubD(GH_SubD)
Public methodStatic memberFormatSubDValidity
If the brep is invalid, return a string describing why.
Public methodStatic memberFormatSurface(Brep)
Public methodStatic memberFormatSurface(GH_Surface)
Public methodStatic memberFormatSurfaceValidity
If the surface is invalid, return a string describing why.
Public methodStatic memberFormatTransformValidity
If the transform is invalid, return a string describing why.
Public methodStatic memberFormatVector(Vector3d)
Public methodStatic memberFormatVector(GH_Vector)
Public methodStatic memberFormatVectorValidity
If the point is invalid, return a string describing why.
Public methodStatic memberRhinoUnitName
Public methodStatic memberRhinoUnitSymbol
Public methodStatic memberTreatAsCollection
This method is used in Scripting components to determine whether a certain class was 'intended' as a collection or as a single piece of data .
Top
See Also