# ScribbleObject class

Namespace: [Grasshopper2.SpecialObjects](https://developer.rhino3d.com/api/gh2/namespace/grasshopper2.specialobjects.md) · Assembly: [Grasshopper2](https://developer.rhino3d.com/api/gh2/assembly/grasshopper2.md)

```cs
[IoId("00000000-8a6e-46ef-8fbd-f7be5aaee57c")]
[Author("DavidR")]
public sealed class ScribbleObject : DocumentObject
```

## Constructors

- [ScribbleObject](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/ctor.md): (3 overloads)

## Fields

- [AlignKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/alignkey.md): (static)
- [AngleKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/anglekey.md): (static)
- [CodeColourKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/codecolourkey.md): (static)
- [ColourKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/colourkey.md): (static)
- [DefaultText](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/defaulttext.md): (static)
- [DefaultWrapWidth](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/defaultwrapwidth.md): (static) The wrap width adopted when wrapping is switched on without one being given.
- [FontKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/fontkey.md): (static)
- [MathColourKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/mathcolourkey.md): (static)
- [MinimumWrapWidth](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/minimumwrapwidth.md): (static) Narrowest wrap width a scribble will accept, in canvas units.
- [StyleKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/stylekey.md): (static)
- [TextKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textkey.md): (static) Gets the key under which the scribble text is stored in the [IDocumentObject.CustomValues](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.idocumentobject/customvalues.md).
- [WrapKey](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/wrapkey.md): (static)

## Properties

- [CodeColour](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/codecolour.md): Gets the colour of code runs. If set to [OpenColor.Family.Flat](https://developer.rhino3d.com/api/gh2/type/grasshopper2.eto.drawing.opencolor.family.md) the code follows [ScribbleObject.TextColour](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textcolour.md).
- [Connectivity](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/connectivity.md)
- [MathColour](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/mathcolour.md): Gets the colour of maths runs. If set to [OpenColor.Family.Flat](https://developer.rhino3d.com/api/gh2/type/grasshopper2.eto.drawing.opencolor.family.md) the maths follows [ScribbleObject.TextColour](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textcolour.md).
- [Phase](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/phase.md)
- [State](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/state.md)
- [Text](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/text.md): Gets or sets the text. The text may contain the inline markup understood by [TeXMarkup.ExpandInlineMarkup(string)](https://developer.rhino3d.com/api/gh2/type/grasshopper2.ui.typography.texmarkup/expandinlinemarkup.md) as well as the TeX macros themselves.
- [TextAlign](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textalign.md): Gets the aligment of the text.
- [TextAngle](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textangle.md): Gets or sets the angle of the text around the pivot.
- [TextColour](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textcolour.md): Gets the colour of the text. If set to [OpenColor.Family.Flat](https://developer.rhino3d.com/api/gh2/type/grasshopper2.eto.drawing.opencolor.family.md) the skin shading will be used.
- [TextFont](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textfont.md): Gets or sets the font family to use.
- [TextStyle](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/textstyle.md): Gets or sets the font style.
- [Wrapped](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/wrapped.md): Gets whether the text wraps at [ScribbleObject.WrapWidth](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/wrapwidth.md).
- [WrapWidth](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/wrapwidth.md): Gets or sets the width at which the text wraps, in canvas units. Zero or less means the text does not wrap and every line is as wide as its content.

## Methods

- [AppendToInputPanel](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/appendtoinputpanel.md)
- [Compute](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/compute.md)
- [CreateAttributes](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/createattributes.md)
- [Expire](https://developer.rhino3d.com/api/gh2/type/grasshopper2.specialobjects.scribbleobject/expire.md)

## Inherited Members

- From [DocumentObject](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject.md): [Activity](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/activity.md), [Attributes](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/attributes.md), [ChildrenObjects](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/childrenobjects.md), [CustomValues](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/customvalues.md), [Display](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/display.md), [DisplayCapable](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displaycapable.md), [DisplayName](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displayname.md), [DisplayStyle](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displaystyle.md), [Document](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/document.md), [EntireFamily](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/entirefamily.md), [FoundingObject](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/foundingobject.md), [Icon](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/icon.md), [IconInternal](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/iconinternal.md), [InstanceId](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/instanceid.md), [Nomen](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/nomen.md), [Obsolete](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/obsolete.md), [ParentObject](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/parentobject.md), [ProgressPercentage](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/progresspercentage.md), [Relevance](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/relevance.md), [Selected](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/selected.md), [Selection](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/selection.md), [SiblingObjects](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/siblingobjects.md), [UserName](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/username.md), [ActivityChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/activitychanged.md), [AutosaveRequested](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/autosaverequested.md), [DisplayChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displaychanged.md), [DocumentChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/documentchanged.md), [Expired](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/expired.md), [InstanceIdChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/instanceidchanged.md), [LayoutChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/layoutchanged.md), [NameChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/namechanged.md), [RelevanceChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/relevancechanged.md), [SelectedChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/selectedchanged.md), [AddUndoRecord](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/addundorecord.md), [AppendBakeInput](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/appendbakeinput.md), [AppendStateInput](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/appendstateinput.md), [AppendUserNameInput](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/appendusernameinput.md), [ChangeInstanceIds](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/changeinstanceids.md), [DisplayBounds](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displaybounds.md), [DisplayFaces](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displayfaces.md), [DisplayWires](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/displaywires.md), [ExpireDisplay](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/expiredisplay.md), [GetCreationInfo](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/getcreationinfo.md), [GetModificationInfo](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/getmodificationinfo.md), [InvalidateExistingLayout](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/invalidateexistinglayout.md), [ModifyIcon](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/modifyicon.md), [ModifyNameAndInfo](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/modifynameandinfo.md), [OnDisplayChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/ondisplaychanged.md), [OnExpired](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/onexpired.md), [OnLayoutChanged](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/onlayoutchanged.md), [OverrideAttributes](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/overrideattributes.md), [RequestAutoSave](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/requestautosave.md), [SetCreationInfo](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/setcreationinfo.md), [SetModificationInfo](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/setmodificationinfo.md), [SetProgressPercentage](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/setprogresspercentage.md), [Store](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/store.md), [UpdateDisplay](https://developer.rhino3d.com/api/gh2/type/grasshopper2.doc.documentobject/updatedisplay.md)