Infragistics logo
메뉴
.NET and JavaScript UI Controls
Version

Band Property (UltraGridRow)

Returns the UltraGridBand that the object belongs to, if any. This property is read-only at run-time. This property is not available at design-time.
Syntax
'Declaration
 
Public Overrides ReadOnly Property Band As UltraGridBand
public override UltraGridBand Band {get;}
Remarks

The Band property of an object refers to a specific band in the grid as defined by an UltraGridBand object. You use the Band property to access the properties of a specified UltraGridBand object, or to return a reference to the UltraGridBand object that is associated with the current object.

UltraGridBand objects are the foundation of the hierarchical data structure used by UltraWinGrid. Any row or cell in the grid must be accessed through its UltraGridBand object. Bands are also used to apply consistent formatting and behavior to the rows that they comprise. An UltraGridBand object is used to display all the data rows from a single level of a data hierarchy. UltraGridBand objects contain multiple sets of child UltraGridRow objects that actually display the data of the recordset. All of the rows that are drawn from a single Command in the DataEnvironment make up a band.

The rows of a band are generally displayed in groups of one more in order to show rows from subsequent bands that are linked to rows in the current band via the structure of the data hierarchy. For example, if a hierarchical recordset has Commands that display Customer, Order and Order Detail data, each one of these Commands maps to its own UltraGridBand in the UltraWinGrid. The rows in the Customer band will appear separated by any Order data rows that exist for the customers. By the same token, rows in the Order band will be appear separated to make room for Order Detail rows. How this looks depends on the ViewStyle settings selected for the grid, but the concept of visual separation is readily apparent when the UltraWinGrid is used with any hierarchical recordset.

Although the rows in a band may appear to be separated, they are treated contiguously. When selecting a column in a band, you will see that the cells of that column become selected in all rows for the band, regardless of any intervening rows. Also, it is possible to collapse the hierarchical display so that any children of the rows in the current band are hidden.

Example
Following code shows how to access various objects in the object model. It shows code for most commonly accessed obects.

Imports Infragistics.Shared
Imports Infragistics.Win
Imports Infragistics.Win.UltraWinGrid

  Private Sub Button41_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles button41.Click

      ' At the top level of the object hierarchy is the UltraGrid.
      Dim grid As UltraGridBase = Me.UltraGrid1

      ' Then is the layout.
      Dim layout As UltraGridLayout = grid.DisplayLayout

      ' Bands property returns the collection of bands. A band is analogous to a table in the data structure.
      ' Each band is associated with a table in the data source.
      Dim bands As BandsCollection = layout.Bands

      ' Get the first band, which is the  top-most band in case you had multple bands.
      Dim band As UltraGridBand = bands(0)

      ' Columns property off UltraGridBand returns the collection of columns associated with the band.
      Dim columns As ColumnsCollection = band.Columns

      ' You can get a particular column using the column name.
      Dim column As UltraGridColumn = columns("CustomerID")

      ' You can access the Header object associated with the column using Header property.
      Dim colHeader As Infragistics.Win.UltraWinGrid.ColumnHeader = column.Header

      ' Rows property off the UltraGridBase returns the top most rows.
      Dim rows As RowsCollection = Me.UltraGrid1.Rows

      ' You can get a row by index.
      Dim row As UltraGridRow = rows(0)

      ' You can get a cell associated with a row and a column by using Cells property off the row.
      ' You can use a column object or a column key as illustrated below.
      Dim cell As UltraGridCell = row.Cells(column)   ' Using a column object.
      cell = row.Cells("CustomerID")   ' Using a column key.

      ' These objects also have properties that back-reference the object they belong to or are
      ' associated with. Following lines illustrate some of these properties.
      column = cell.Column        ' Get the column cell is associated with.
      row = cell.Row              ' Get the row cell is associated with.
      rows = row.ParentCollection ' Get the rows collection the row belongs to.
      column = colHeader.Column   ' Get the column associated with the ColumnHeader object.
      band = column.Band          ' Get the band associated with the column.
      band = row.Band             ' Get the band associated with the row.
      layout = column.Layout      ' Get the layout using a column.
      layout = band.Layout        ' Get the layout using a band.
      grid = layout.Grid          ' Get the grid using a band.
      grid = cell.Row.Band.Layout.Grid   ' Get the grid using a cell in a single statement.

  End Sub
using Infragistics.Shared;
using Infragistics.Win;
using Infragistics.Win.UltraWinGrid;
using System.Diagnostics;

private void button41_Click(object sender, System.EventArgs e)
{

	// At the top level of the object hierarchy is the UltraGrid.
	UltraGridBase grid = this.ultraGrid1;

	// Then is the layout.
	UltraGridLayout layout = grid.DisplayLayout;

	// Bands property returns the collection of bands. A band is analogous to a table in the data structure.
	// Each band is associated with a table in the data source.
	BandsCollection bands = layout.Bands;

	// Get the first band, which is the  top-most band in case you had multple bands.
	UltraGridBand band = bands[0];

	// Columns property off UltraGridBand returns the collection of columns associated with the band.
	ColumnsCollection columns = band.Columns;

	// You can get a particular column using the column name.
	UltraGridColumn column = columns["CustomerID"];

	// You can access the Header object associated with the column using Header property.
	Infragistics.Win.UltraWinGrid.ColumnHeader colHeader = column.Header;

	// Rows property off the UltraGridBase returns the top most rows.
	RowsCollection rows = this.ultraGrid1.Rows;

	// You can get a row by index.
	UltraGridRow row = rows[0];

	// You can get a cell associated with a row and a column by using Cells property off the row.
	// You can use a column object or a column key as illustrated below.
	UltraGridCell cell = row.Cells[ column ]; // Using a column object.
	cell = row.Cells[ "CustomerID" ];         // Using a column key.

	// These objects also have properties that back-reference the object they belong to or are
	// associated with. Following lines illustrate some of these properties.
	column = cell.Column;			// Get the column cell is associated with.
	row	   = cell.Row;			// Get the row cell is associated with.
	rows   = row.ParentCollection;  		// Get the rows collection the row belongs to.
	column = colHeader.Column;		// Get the column associated with the ColumnHeader object.
	band   = column.Band;			// Get the band associated with the column.
	band   = row.Band;			// Get the band associated with the row.
	layout = column.Layout;			// Get the layout using a column.
	layout = band.Layout;			// Get the layout using a band.
	grid   = layout.Grid;			// Get the grid using a band.
	grid   = cell.Row.Band.Layout.Grid; 	// Get the grid using a cell in a single statement.

}
Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also