GH_PanelAttributes

GH_ResizableAttributes<1>GH_Attributes<1>
public class GH_PanelAttributes : GH_ResizableAttributes<GH_Panel>

Constructors

GH_PanelAttributes

#
public GH_PanelAttributes(GH_Panel owner)
Parameters:
owner (GH_Panel)

Properties

AllowMessageBalloon

public virtual bool AllowMessageBalloon { get; }
Gets a value indicating whether these attributes allow warning and error balloons to be drawn on top of them.
inherited fromGH_Attributes<T>
Implements: AllowMessageBalloon

Bounds

public virtual RectangleF Bounds { get; set; }
Gets the rectangle that contains the active content of the attributes. Typically the Contents determine the active area for menus, tooltips etc. Attributes are not supposed to draw objects beyond the Bounds.
inherited fromGH_Attributes<T>
Implements: Bounds

ContentBounds

#
public Rectangle ContentBounds { get; }
Gets the bounds of the panel content. The content is basically the PanelBounds minus the TitleBounds and margins.

DocObject

public IGH_DocumentObject DocObject { get; }
Gets the owner object of these attributes.
inherited fromGH_Attributes<T>
Implements: DocObject

GetTopLevel

public IGH_Attributes GetTopLevel { get; }
Gets the top-level attributes of the attribute stack these attributes belong to.
inherited fromGH_Attributes<T>
Implements: GetTopLevel

HasInputGrip

public virtual bool HasInputGrip { get; }
Gets a value indicating whether or not these attributes have an input grip.
inherited fromGH_Attributes<T>
Implements: HasInputGrip

HasOutputGrip

public virtual bool HasOutputGrip { get; }
Gets a value indicating whether or not these attributes have an output grip.
inherited fromGH_Attributes<T>
Implements: HasOutputGrip

IndexBounds

#
public Rectangle IndexBounds { get; }
Gets the bounds of the panel index column. These bounds will have a width of zero if the indices are not displayed.

InputGrip

public virtual PointF InputGrip { get; }
Gets the input grip location for these attributes. If HasInputGrip equals False, this point is meaningless.
inherited fromGH_Attributes<T>
Implements: InputGrip

InstanceGuid

public Guid InstanceGuid { get; }
Gets the instance ID of the document object that owns these attributes.
inherited fromGH_Attributes<T>
Implements: InstanceGuid

IsTopLevel

public bool IsTopLevel { get; }
Gets whether these attributes are top_level (i.e. no Parent attributes)
inherited fromGH_Attributes<T>
Implements: IsTopLevel

ItemBounds

#
public Rectangle ItemBounds { get; }
Gets the bounds of the panel item column.

MarginLeft

#
public int MarginLeft { get; set; }
Gets or sets the value for the left margin. Use MarginLeftActual to get the adjusted margin for the current layout.

MarginLeftActual

#
public int MarginLeftActual { get; }
Gets the actual current value for the left margin.

MarginRight

#
public int MarginRight { get; set; }
Gets or sets the value for the right margin. Use MarginRightActual to get the adjusted margin for the current layout.

MarginRightActual

#
public int MarginRightActual { get; }
Gets the actual current value for the right margin.

MarginTop

#
public int MarginTop { get; set; }
Gets or sets the value for the top margin. Use MarginTopActual to get the adjusted margin for the current layout.

MarginTopActual

#
public int MarginTopActual { get; }
Gets the actual current value for the top margin.

MaximumSize

protected virtual Size MaximumSize { get; }
inherited fromGH_ResizableAttributes<T>

MinimumSize

#
protected override Size MinimumSize { get; }
Overrides: GH_ResizableAttributes<T>.MinimumSize

OutputGrip

public virtual PointF OutputGrip { get; }
Gets the output grip location for these attributes. If HasOutputGrip equals False, this point is meaningless.
inherited fromGH_Attributes<T>
Implements: OutputGrip

Owner

public T Owner { get; }
Gets the type-safe owner object of these attributes. This property is identical to the DocObject property.
inherited fromGH_Attributes<T>

PanelBounds

#
public Rectangle PanelBounds { get; }
Gets the bounds (in integer accuracy) of the entire panel.

Parent

public IGH_Attributes Parent { get; set; }
Gets or sets the parent attributes. Top level attributes do not have parents.
inherited fromGH_Attributes<T>
Implements: Parent

PathName

#
public override string PathName { get; }
Overrides: GH_Attributes<T>.PathName

Pivot

public virtual PointF Pivot { get; set; }
Gets or sets the pivot for these attributes. The pivot controls the general placement of the attributes. If you want to move the attributes, change the pivot location.
inherited fromGH_Attributes<T>
Implements: Pivot

ScrollerBounds

#
public Rectangle ScrollerBounds { get; }
Gets the bounds of the panel scrollbar track. These bounds may have a width of zero if the scrollbar is not active.

ScrollGripBounds

#
public Rectangle ScrollGripBounds { get; }
Gets the bounds of the panel scrollbar grip. These bounds may have be empty if the scrollbar is not active.

ScrollGripControlBounds

#
public Rectangle ScrollGripControlBounds { get; }
Gets the bounds of the panel scrollbar grip in control coordinates rather than canvas coordinates.

Selected

public virtual bool Selected { get; set; }
Gets or sets the selected state of the top-level attributes.
inherited fromGH_Attributes<T>
Implements: Selected

SizingBorders

#
protected override Padding SizingBorders { get; }
Overrides: GH_ResizableAttributes<T>.SizingBorders

TitleBounds

#
public Rectangle TitleBounds { get; }
Gets the bounds of the panel title. If there is no title the height of this box will be 0.

TooltipEnabled

public virtual bool TooltipEnabled { get; }
Gets the tooltip enabled value. If False, no further tooltip functions will be called.
inherited fromGH_Attributes<T>
Implements: TooltipEnabled

Methods

AppendToAttributeTree

public virtual void AppendToAttributeTree(List<IGH_Attributes> attributes)
Recursively append these attributes and all child attributes to the attribute list.
inherited fromGH_Attributes<T>
Parameters:
attributes (List<IGH_Attributes>)List to append to.
Implements: AppendToAttributeTree

ExpireLayout

#
public override void ExpireLayout()
Overrides: GH_Attributes<T>.ExpireLayout

GetContentAsString

#
public string GetContentAsString(bool includeIndices, bool includePaths)
Parameters:
includeIndices (bool)
includePaths (bool)

InvalidateCanvas

public virtual bool InvalidateCanvas(GH_Canvas canvas, GH_CanvasMouseEvent e)
If the mouse location should cause a canvas invalidation then return true. You only need to override this function if you draw objects that are dependant on cursor positions outside the bounds of the attributes.
inherited fromGH_Attributes<T>
Parameters:
canvas (GH_Canvas)Canvas to potentially invalidate.
e (GH_CanvasMouseEvent)Event arguments for canvas mousemove.
Returns: True if the canvas ought to be invalidated.
Implements: InvalidateCanvas

IsMenuRegion

public virtual bool IsMenuRegion(PointF point)
Determines whether a point is available for context menu popups. By default, IsMenuRegion calls IsPickRegion(PointF).
inherited fromGH_Attributes<T>
Parameters:
point (PointF)Point location to test.
Implements: IsMenuRegion

IsPickRegion

public virtual bool IsPickRegion(PointF point)
Determines whether a point is within the pickable region for this object. By default, any point inside the Bounds is treated as pickable.
inherited fromGH_Attributes<T>
Parameters:
point (PointF)Point location to test.
Implements: IsPickRegion

IsPickRegion

public virtual bool IsPickRegion(RectangleF box, GH_PickBox method)
Determines whether a rectangle is a valid pick region for this object. By default, the picking rectangle is intersected with the Bounds rectangle.
inherited fromGH_Attributes<T>
Parameters:
box (RectangleF)Selection box.
method (GH_PickBox)Selection method.
Implements: IsPickRegion

IsTooltipRegion

public virtual bool IsTooltipRegion(PointF point)
Determines whether a point is available for tooltip popups. By default, IsMenuRegion calls IsTooltipRegion(PointF).
inherited fromGH_Attributes<T>
Parameters:
point (PointF)Point location to test.
Implements: IsTooltipRegion

Layout

#
protected override void Layout()
Overrides: GH_Attributes<T>.Layout

NewInstanceGuid

public void NewInstanceGuid()
Generate a new instance GUID for the owner object.
inherited fromGH_Attributes<T>
Implements: NewInstanceGuid

NewInstanceGuid

public void NewInstanceGuid(Guid newId)
Generate a new instance GUID for the owner object. Do not use this overload unless you're > 1.95m and called David.
inherited fromGH_Attributes<T>
Parameters:
newId (Guid)
Implements: NewInstanceGuid

PerformLayout

public void PerformLayout()
Recompute the layout for these attributes. This function is automatically called during Drawing operations, so you typically don't have to.
inherited fromGH_Attributes<T>
Implements: PerformLayout

PrepareForRender

protected virtual void PrepareForRender(GH_Canvas canvas)
This method will always be called exactly once prior to Render(). This would be a good place to make sure all the necessary GUI data is up and running.
inherited fromGH_Attributes<T>
Parameters:
canvas (GH_Canvas)Canvas that is about to render these attributes.

Read

#
public override bool Read(GH_IReader reader)
Parameters:
reader (GH_IReader)
Overrides: GH_Attributes<T>.Read

Render

#
protected override void Render(GH_Canvas canvas, Graphics graphics, GH_CanvasChannel channel)
Parameters:
canvas (GH_Canvas)
graphics (Graphics)
channel (GH_CanvasChannel)
Overrides: GH_Attributes<T>.Render

RenderIncomingWires

protected void RenderIncomingWires(GH_Painter painter, IEnumerable<IGH_Param> sources, GH_ParamWireDisplay style)
Utility function for derived classes. This method draws all the wires going into the left side of the attributes.
inherited fromGH_Attributes<T>
Parameters:
painter (GH_Painter)The graphics object to paint with
sources (IEnumerable<IGH_Param>)A list of sources that will be connected with the input grip of this attribute
style (GH_ParamWireDisplay)Style for wire display.

RenderIncomingWires

protected void RenderIncomingWires(GH_Painter painter, IEnumerable<IGH_Param> sources, IEnumerable<Pen> styles)
Utility function for derived classes. This method draws all the wires going into the left side of the attributes.
inherited fromGH_Attributes<T>
Parameters:
painter (GH_Painter)The graphics object to paint with
sources (IEnumerable<IGH_Param>)A list of sources that will be connected with the input grip of this attribute
styles (IEnumerable<Pen>)A collection of pen objects to use for each source. If a pen is null, the default wire style will be used instead.

RenderToCanvas

public void RenderToCanvas(GH_Canvas canvas, GH_CanvasChannel channel)
Render these attributes into a Canvas control. This function places calls to PrepareForRender() and Render(), you should override those.
inherited fromGH_Attributes<T>
Parameters:
canvas (GH_Canvas)Canvas to draw on.
channel (GH_CanvasChannel)Current drawing channel.
Implements: RenderToCanvas

RespondToKeyDown

public virtual GH_ObjectResponse RespondToKeyDown(GH_Canvas sender, KeyEventArgs e)
inherited fromGH_Attributes<T>
Parameters:
sender (GH_Canvas)
e (KeyEventArgs)
Implements: RespondToKeyDown

RespondToKeyUp

public virtual GH_ObjectResponse RespondToKeyUp(GH_Canvas sender, KeyEventArgs e)
inherited fromGH_Attributes<T>
Parameters:
sender (GH_Canvas)
e (KeyEventArgs)
Implements: RespondToKeyUp

RespondToMouseDoubleClick

#
public override GH_ObjectResponse RespondToMouseDoubleClick(GH_Canvas sender, GH_CanvasMouseEvent e)
Parameters:
sender (GH_Canvas)
e (GH_CanvasMouseEvent)
Overrides: GH_Attributes<T>.RespondToMouseDoubleClick

RespondToMouseDown

#
public override GH_ObjectResponse RespondToMouseDown(GH_Canvas sender, GH_CanvasMouseEvent e)
Parameters:
sender (GH_Canvas)
e (GH_CanvasMouseEvent)
Overrides: GH_ResizableAttributes<T>.RespondToMouseDown

RespondToMouseMove

#
public override GH_ObjectResponse RespondToMouseMove(GH_Canvas sender, GH_CanvasMouseEvent e)
Parameters:
sender (GH_Canvas)
e (GH_CanvasMouseEvent)
Overrides: GH_ResizableAttributes<T>.RespondToMouseMove

RespondToMouseUp

#
public override GH_ObjectResponse RespondToMouseUp(GH_Canvas sender, GH_CanvasMouseEvent e)
Parameters:
sender (GH_Canvas)
e (GH_CanvasMouseEvent)
Overrides: GH_ResizableAttributes<T>.RespondToMouseUp

SetupTooltip

#
public override void SetupTooltip(PointF point, GH_TooltipDisplayEventArgs e)
Parameters:
point (PointF)
e (GH_TooltipDisplayEventArgs)
Overrides: GH_Attributes<T>.SetupTooltip

Write

#
public override bool Write(GH_IWriter writer)
Parameters:
writer (GH_IWriter)
Overrides: GH_Attributes<T>.Write