UserInterfaceGrid Class |
Arranges child controls in a grid of rows and columns. The common case is a
two or three column grid where the first column holds labels describing
values and the remaining columns hold the controls that edit those values,
which produces something that looks like the Rhino object properties pages.
Children fill the grid in row major order: a new row starts every
ColumnCount children, so a two column grid built by adding label, control,
label, control, ... reads the way it looks.
Settings can be made before or after the grid is added to a document. The
ones made beforehand are held here and applied when the native grid is
created.
Inheritance HierarchyNamespace: Rhino.UI
Assembly: RhinoCommon (in RhinoCommon.dll)
SyntaxThe UserInterfaceGrid type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | UserInterfaceGrid | Initializes a new instance of the UserInterfaceGrid class |
| UserInterfaceGrid(Int32) | Initializes a new instance of the UserInterfaceGrid class |
Properties| Name | Description | |
|---|---|---|
 | BackgroundClaimsMouse |
Whether a click where the grid has no child control belongs to the grid or
to whatever is behind it. The default is false, so clicks on the padding,
on the gaps between cells and on empty cells go through to the viewport,
which is what a heads up display over a model wants.
|
| BackgroundColor |
Color the grid fills its rectangle with. Color.Empty, the default, means
draw no background at all.
|
| BorderColor | |
| BorderThickness | |
| BoundToActiveView | (Inherited from UserInterfaceObjectBase.) |
| ChildCount |
Number of cells that have been filled, including the empty ones added with
AddEmptyCell. This is not the same as ColumnCount * RowCount.
|
| ColumnCount |
Number of columns in the grid. The default is 1. Changing the column count
reflows the children that have already been added.
|
| ColumnSpacing |
Space between columns in logical pixels. The default is 6.
|
| CornerRadius | |
| HorizontalAlignment | (Inherited from UserInterfaceControl.) |
| Location | (Inherited from UserInterfaceControl.) |
| RowCount |
Number of rows the current children occupy, computed from the child count,
the column count and any column spans.
|
| RowHeight |
Height of every row in logical pixels. The default is 0, which means each
row is as tall as the tallest control in it.
|
| RowSeparatorColor | |
| RowSeparators |
Draw a horizontal line between every pair of rows. Off by default.
|
| RowSpacing |
Space between rows in logical pixels. The default is 2.
|
| Size | (Inherited from UserInterfaceControl.) |
| Text | (Inherited from UserInterfaceControl.) |
| TextColor |
Color used to draw the text. Color.Empty, the default, means use the
standard text color for the theme that is in use.
(Inherited from UserInterfaceControl.) |
| TextHeight |
Height of the text in logical pixels. A value of 0, the default, means
use the standard control font height. Controls that draw no text ignore
this setting.
(Inherited from UserInterfaceControl.) |
| TextHorizontalAlignment |
Where the text sits inside the control's rectangle. This is not the same
as HorizontalAlignment, which is where the control sits inside its parent.
(Inherited from UserInterfaceControl.) |
| TextVerticalAlignment |
Where the text sits inside the control's rectangle. This is not the same
as VerticalAlignment, which is where the control sits inside its parent.
(Inherited from UserInterfaceControl.) |
| TrackingPoint |
3d location that control "sticks" to if not null
(Inherited from UserInterfaceControl.) |
| VerticalAlignment | (Inherited from UserInterfaceControl.) |
| Visible |
Is the user interface object visible? Objects that are not visible will
not be drawn and will not receive mouse events
(Inherited from UserInterfaceObjectBase.) |
Methods| Name | Description | |
|---|---|---|
| AddChild |
Append a control to the next cell.
|
| AddEmptyCell |
Append a cell with nothing in it. Use this to leave a hole in a row.
|
| AddHeading |
Append a label that spans every column, for a section heading.
|
| AddLabel |
Append a label to the next cell, which is what most first column cells are.
The label is returned so that its text alignment, color or height can be
adjusted.
|
| Cell |
Control in a cell by row and column, or null when that cell is empty. The
grid has to have been added to a document for this to find anything, since
it is the native grid that knows which cell a child ended up in.
|
| Child |
Control in a cell, or null for an empty cell or an out of range index.
|
| ComputedRectangle | (Inherited from UserInterfaceControl.) |
| EnableRowSeparatorBelowRow |
Draw a horizontal line under one row, for a heading row that wants a rule
under it when a line between every row would be too much. RowSeparators
draws them all whatever this is set to.
|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetChildColumnSpan | |
| GetColumnSizing | |
| GetColumnWidth |
Width of a column in logical pixels as of the most recent layout. This is 0
until the grid has been drawn once.
|
| GetComputedRowHeight |
Height of a row in logical pixels as of the most recent layout. This is 0
until the grid has been drawn once.
|
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| InsertChild |
Insert a control at a cell index, shifting the controls after it along.
|
| IsMouseOver |
Called to test if the mouse is actively over this object
(Inherited from UserInterfaceObjectBase.) |
| IsRegistered |
Is this user interface object active
(Inherited from UserInterfaceObjectBase.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnDraw |
All user interface objects are drawn and can customize their look
with the OnDraw function
(Inherited from UserInterfaceObjectBase.) |
| OnMouseClick |
Called during a mouse click event on this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseDoubleClick |
Called during a mouse double click event on this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseDown |
Called when the mouse goes down on this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseEnter |
Called when the mouse goes over this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseLeave |
Called when the mouse leaves this object
(Inherited from UserInterfaceObjectBase.) |
| OnMouseMove |
Called when the mouse is moved
(Inherited from UserInterfaceObjectBase.) |
| OnMouseUp |
Called when the mouse is released on this object
(Inherited from UserInterfaceObjectBase.) |
| OnRunCommand |
Called after the above RunCommand function is called. This will be
executing while inside of a Rhino command.
(Inherited from UserInterfaceObjectBase.) |
| RegisterForAllDocuments |
Make this object visible for all documents. Typically you will only have user
interface objects work with single documents. For that case, call
doc.ViewUserInterface.Add
(Inherited from UserInterfaceObjectBase.) |
| RemoveAllChildren |
Empty the grid.
|
| RemoveChild |
Take a control out of the grid. Returns the control that was in the cell, or
null for an empty cell or an out of range index.
|
| RunCommand |
Call RunCommand to have the virtual OnRunCommand function executed in the
scope of a Rhino command. If you are modifying the document from one of
the mouse functions on this object, this is the best approach to do so
since changes made inside of a command are recorded for undo.
(Inherited from UserInterfaceObjectBase.) |
| SetChildColumnSpan |
Number of columns a cell occupies. The default is 1. Use this for a section
heading or a control that runs the full width of the grid. A span is clamped
to the number of columns left in the row.
|
| SetColumnAutoWidth |
Make a column as wide as the widest control in it. Controls report their
width from their computed size, so a label column sized this way is exactly
as wide as its longest description.
|
| SetColumnContentAlignment |
How the controls in a column sit in their cells. The default is
Stretch / Center, which makes a control fill the column width and center
itself in the row. Any horizontal setting other than Stretch gives the
control the width it reports from its computed size.
|
| SetColumnFixedWidth |
Give a column a width in logical pixels that is never resized.
|
| SetColumnFlexibleWidth |
Have a column share the width the fixed and auto columns do not use. With
one flexible column that column gets all of the remaining width; with more
than one the remainder is divided in proportion to the weights.
|
| SetColumnMinimumWidth |
Width a column never goes below, in logical pixels. The default is 0.
|
| SetPadding(Double) |
Space between the edges of the grid and its cells in logical pixels. The
default is 6 on all four sides.
|
| SetPadding(Double, Double, Double, Double) | |
| SetSvg | (Inherited from UserInterfaceControl.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Unregister |
Unregister this object
(Inherited from UserInterfaceObjectBase.) |
See Also