TcxGridBand Class
A grid View band.
Declaration
TcxGridBand = class(
TcxInterfacedCollectionItem,
IcxStoredObject,
IdxScaleFactor
)
Remarks
A band can group multiple columns in a Banded Table View. You can use the Position property of banded columns to arrange them into multiple rows within a band. Users can drag and drop column headers to rearrange the columns.
The TcxGridBand
class members allow you to do the following:
- Position the band within a Banded Table View (Position).
- Specify if the band is visible in the Customization Form (VisibleForCustomization).
- Obtain the band’s identifier (ID).
- Identify if the band is visible in the Banded Table View (ActuallyVisible).
- Hide or display the band (Visible).
- Obtain the band’s minimum width (MinWidth).
- Adjust the band’s width (Width and ApplyBestFit).
- Anchor the band (FixedKind).
- Obtain the number of columns associated with the band (ColumnCount).
- Access banded columns (Columns).
- Rearrange columns within the band and move them between bands (MoveColumn and MoveColumns).
- Identify the band’s nesting level and access the parent band (BandLevelIndex and ParentBand).
- Obtain the total number of nested bands (ChildBandCount).
- Access all nested bands (ChildBands).
- Obtain the number of visible nested bands (VisibleChildBandCount).
- Access visible nested bands (VisibleChildBands).
- Configure user permissions for band customization operations (Options).
- Specify the base and alternative captions for the band (Caption and AlternateCaption).
- Identify if the band is empty (IsEmpty).
- Position the band’s caption (Alignment, HeaderAlignmentHorz, and HeaderAlignmentVert).
- Access the band row collection (Rows).
- Respond to a click on the band header (OnHeaderClick).
- Access the band’s root (RootParentBand).
- Identify the band’s position in the Banded Table View’s hierarchy (IsRoot, IsLastAsChild, IsFirst, IsLast, IsBottom, IsMostRight, and HasAsParent).
- Access the grid View and band collection to which this band belongs (GridView and Bands).
A Banded Table View’s Bands property references a TcxGridBand
object.
Inheritance
See Also