GH_PanelProperties

References
public class GH_PanelProperties : GH_ISerializable
Aggregates all properties of a Text Panel object.

Constructors

GH_PanelProperties

#
public GH_PanelProperties()

GH_PanelProperties

#
public GH_PanelProperties(GH_PanelProperties other)
Parameters:
other (GH_PanelProperties)

Properties

Alignment

#
public GH_Panel.Alignment Alignment { get; set; }
Gets or sets the String alignment for loose items in the Text Panel.

Colour

#
public Color Colour { get; set; }
Gets or sets the current background colour.

DrawIndices

#
public bool DrawIndices { get; set; }
Gets or sets whether item indices are included in the panel.

DrawPaths

#
public bool DrawPaths { get; set; }
Gets or sets a value indicating whether or not Branch Paths should be included in the display.

Font

#
public Font Font { get; set; }
Gets or sets the font for this panel.

InferredBackColour

#
public Color InferredBackColour { get; }
Gets the current inferred background colour.

InferredBackColourSelected

#
public Color InferredBackColourSelected { get; }
Gets the current inferred selected background colour.

InferredForeColour

#
public Color InferredForeColour { get; }
Gets the current inferred foreground colour.

InferredForeColourSelected

#
public Color InferredForeColourSelected { get; }
Gets the current inferred selected foreground colour.

Multiline

#
public bool Multiline { get; set; }
Gets the sets the usertext multiline parsing option. If false, every new line in the panel results in a new string item in the volatile data.

SpecialCodes

#
public bool SpecialCodes { get; set; }
Gets or sets whether special codes are replaced in the panel volatile data.

StreamContents

#
public bool StreamContents { get; set; }
Gets or sets whether the panel streams the contents to a file.

StreamPath

#
public string StreamPath { get; set; }
Gets or sets the filepath for content streaming.

Wrap

#
public bool Wrap { get; set; }
Gets or sets whether items are wrapped or trimmed.

Methods

DecreaseFont

#
public bool DecreaseFont()
Decrease the font one level.
Returns: True if font was decreased, false if not.

IncreaseFont

#
public bool IncreaseFont()
Increase the font one level.
Returns: True if font was increased, false if not.

Read

#
public bool Read(GH_IReader reader)
Parameters:
reader (GH_IReader)
Implements: Read

ResetToDefault

#
public void ResetToDefault()

Write

#
public bool Write(GH_IWriter writer)
Parameters:
writer (GH_IWriter)
Implements: Write