GH_CapsuleCreateTextCapsule Method (RectangleF, RectangleF, GH_Palette, String, Int32, Int32)

Create a new capsule with content text.

Namespace: Grasshopper.GUI.Canvas
Assembly: Grasshopper (in Grasshopper.dll)

Syntax

Copy

public static GH_Capsule CreateTextCapsule(
	RectangleF box,
	RectangleF textbox,
	GH_Palette palette,
	string text,
	int radius,
	int highlight
)

Public Shared Function CreateTextCapsule ( 
	box As RectangleF,
	textbox As RectangleF,
	palette As GH_Palette,
	text As String,
	radius As Integer,
	highlight As Integer
) As GH_Capsule

Parameters

box: Type: System.DrawingRectangleF
Box for capsule dimensions. The box will be grown until it is at least 3 pixels wide and high.
textbox: Type: System.DrawingRectangleF
Box into which the text will be drawn.
palette: Type: Grasshopper.GUI.CanvasGH_Palette
Colour palette to apply.
text: Type: SystemString
Text to display inside the capsule.
radius: Type: SystemInt32
Radius of rounded corners. A radius of zero or lower disables corner fillets.
highlight: Type: SystemInt32
Height of the highlight bar. A value of zero or lower disables the highlight.

Return Value

Type: GH_Capsule
A new instance of GH_Capsule. Caller is responsible for disposing of the object.

Reference

GH_Capsule Class

CreateTextCapsule Overload

Grasshopper.GUI.Canvas Namespace

GH_CapsuleAddLanguageSpecificTextSet("LSTBAAC6C3B_0?cpp=::|nu=.");CreateTextCapsule Method (RectangleF, RectangleF, GH_Palette, String, Int32, Int32)

Parameters

Return Value

Reference

GH_CapsuleCreateTextCapsule Method (RectangleF, RectangleF, GH_Palette, String, Int32, Int32)