Click or drag to resize

UserInterfaceGrid Methods

The UserInterfaceGrid type exposes the following members.

Methods
  NameDescription
Public methodAddChild
Append a control to the next cell.
Public methodAddEmptyCell
Append a cell with nothing in it. Use this to leave a hole in a row.
Public methodAddHeading
Append a label that spans every column, for a section heading.
Public methodAddLabel
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.
Public methodCell
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.
Public methodChild
Control in a cell, or null for an empty cell or an out of range index.
Public methodComputedRectangle (Inherited from UserInterfaceControl.)
Public methodEnableRowSeparatorBelowRow
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.
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetChildColumnSpan
Public methodGetColumnSizing
Public methodGetColumnWidth
Width of a column in logical pixels as of the most recent layout. This is 0 until the grid has been drawn once.
Public methodGetComputedRowHeight
Height of a row in logical pixels as of the most recent layout. This is 0 until the grid has been drawn once.
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodInsertChild
Insert a control at a cell index, shifting the controls after it along.
Protected methodIsMouseOver
Called to test if the mouse is actively over this object
(Inherited from UserInterfaceObjectBase.)
Public methodIsRegistered
Is this user interface object active
(Inherited from UserInterfaceObjectBase.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDraw
All user interface objects are drawn and can customize their look with the OnDraw function
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseClick
Called during a mouse click event on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseDoubleClick
Called during a mouse double click event on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseDown
Called when the mouse goes down on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseEnter
Called when the mouse goes over this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseLeave
Called when the mouse leaves this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseMove
Called when the mouse is moved
(Inherited from UserInterfaceObjectBase.)
Protected methodOnMouseUp
Called when the mouse is released on this object
(Inherited from UserInterfaceObjectBase.)
Protected methodOnRunCommand
Called after the above RunCommand function is called. This will be executing while inside of a Rhino command.
(Inherited from UserInterfaceObjectBase.)
Public methodRegisterForAllDocuments
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.)
Public methodRemoveAllChildren
Empty the grid.
Public methodRemoveChild
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.
Public methodRunCommand
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.)
Public methodSetChildColumnSpan
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.
Public methodSetColumnAutoWidth
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.
Public methodSetColumnContentAlignment
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.
Public methodSetColumnFixedWidth
Give a column a width in logical pixels that is never resized.
Public methodSetColumnFlexibleWidth
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.
Public methodSetColumnMinimumWidth
Width a column never goes below, in logical pixels. The default is 0.
Public methodSetPadding(Double)
Space between the edges of the grid and its cells in logical pixels. The default is 6 on all four sides.
Public methodSetPadding(Double, Double, Double, Double)
Public methodSetSvg (Inherited from UserInterfaceControl.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUnregister
Unregister this object
(Inherited from UserInterfaceObjectBase.)
Top
See Also