RcpGroup

RcpItemReferences

public class RcpGroup : RcpItem, GH_ISerializable

Represents a container for GH_Object instances. Containers are top-level objects in the RCP.

Constructors

RcpGroup

public RcpGroup()

Properties

Bounds

public virtual Rectangle Bounds { get; set; }

inherited fromRcpItem

Implements: Bounds

Collapsed

public bool Collapsed { get; }

Colour

public Color Colour { get; set; }

Gets or sets the color of this group.

ContentRectangle

public Rectangle ContentRectangle { get; }

Gets the rectangle taken up by the part of the control that is not the title bar or the borders. If the container is collapsed then this area will have a height of zero.

DesiredHeight

public override int DesiredHeight { get; }

Overrides: RcpItem.DesiredHeight

Expanded

public bool Expanded { get; }

IconRectangle

public Rectangle IconRectangle { get; }

Gets the rectangle taken up by the icon in the container bar.

ItemCount

public int ItemCount { get; }

ItemLayoutRectangle

public Rectangle ItemLayoutRectangle { get; }

Gets the rectangle used for item layouts. This is basically the ContentRectangle minus itempadding on all edges.

Items

public IEnumerable<IRcpItem> Items { get; }

Name

public string Name { get; set; }

Gets or sets the name of this group.

NameRectangle

public Rectangle NameRectangle { get; }

Gets the rectangle taken up by the title text in the container bar.

OwnerInstanceId

public virtual Guid OwnerInstanceId { get; }

inherited fromRcpItem

Implements: OwnerInstanceId

TitleRectangle

public Rectangle TitleRectangle { get; }

Gets the rectangle taken up by the entire container bar.

Methods

AddItem

public void AddItem(IRcpItem item, int index)

Parameters:

item (IRcpItem)
index (int)

AddItem

public void AddItem(IRcpItem item, IRcpAwareObject rcpObject, int index)

Parameters:

item (IRcpItem)
rcpObject (IRcpAwareObject)
index (int)

AddItem

public void AddItem(IRcpItem item, IRcpAwareObject rcpObject)

Parameters:

item (IRcpItem)
rcpObject (IRcpAwareObject)

AddItem

public void AddItem(IRcpItem item)

Parameters:

item (IRcpItem)

Collapse

public void Collapse()

Expand

public void Expand()

FindItem

public IRcpItem FindItem(IRcpAwareObject rcpAware)

Parameters:

rcpAware (IRcpAwareObject)

ImpliedInsertionIndex

public bool ImpliedInsertionIndex(Point pt, ref double distance, ref int index)

Finds the insertion index implied by the position of a point.

Parameters:

pt (Point)	Point for insertion test.
distance (ref double)	Distance from insertion location to test point.
index (ref int)	Insertion index.

IndexAt

public int IndexAt(Point pt)

Gets the item index at the given point.

Parameters:

pt (Point)

Point to search from.

Returns: The index of the item at pt or -1 if no item exists at this location.

ItemAt

public IRcpItem ItemAt(Point pt)

Gets the item at the given point.

Parameters:

pt (Point)

Point to search from.

Returns: The item at the given point or null if no such item could be found.

LayoutItems

public void LayoutItems()

Layout all items within the content area. It is the responsibility of the caller to assign the correct dimensions and position to the group bounds. I.e. make sure that the height of the of the Bounds are the same as the DesiredHeight. Layout will not occur when a group is collapsed.