TcxGridBand Members
A grid View band.Constructors
| Name | Description |
|---|---|
| Create(TCollection) | Inherited from TCollectionItem. |
Properties
| Name | Description |
|---|---|
| ActuallyVisible | Determines whether the current band is visible within a View. |
| Alignment | Specifies the band caption text alignment. |
| AlternateCaption | Specifies an alternative caption for the current band. |
| BandLevelIndex | Returns the nesting (band) level of the current band within a View. |
| Bands | Returns the band collection which the current band belongs to. |
| Caption | Specifies the text representing a band within a View. |
| ChildBandCount | Returns the number of immediate child bands which are assigned to the current band. |
| ChildBands | Provides indexed access to the child bands which are assigned to the current band. |
| Collection | Inherited from TCollectionItem. |
| ColumnCount | Returns the number of columns belonging to the current band. |
| Columns | Provides indexed access to the columns associated with the current band. |
| DisplayCaption | |
| DisplayName | Inherited from TCollectionItem. |
| FirstChildBottomBand | Returns the first (left-most) child band, which is displayed at the bottom of the current band. |
| FirstVisibleChildBottomBand | Returns the first (leftmost) visible child band, which is displayed at the bottom of the current band. |
| FixedKind | Specifies the active band anchor mode. |
| FormattedText | |
| GridView | Returns the View owning the Bands collection to which the current band belongs. |
| HeaderAlignmentHorz | Specifies the horizontal alignment of a band’s caption. |
| HeaderAlignmentVert | Specifies the vertical alignment of a band’s caption. |
| Hidden |
Deprecated. This property exists for backward compatibility only. Tip Use the VisibleForCustomization property instead of |
| ID | |
| Index | Inherited from TCollectionItem. |
| IsBottom | Specifies whether the band is at the bottom of the View’s band hierarchy. |
| IsEmpty | Indicates whether the current band displays information within a View. |
| IsFirst | Indicates whether the current band is the left-most bottom band within a View. |
| IsFirstNonEmpty | |
| IsLast | Indicates whether the current band is the right-most bottom band within a View. |
| IsLastAsChild | Indicates whether the current band is the last (rightmost) band within the current band hierarchy level. |
| IsLastNonEmpty | |
| IsMostRight | Indicates whether the current band is the last (rightmost) visible band within a View. |
| IsRoot | Indicates if the band is at the top of the View’s band hierarchy (that is, a root band). |
| IsVisibleBottom | Specifies whether the band is visible as a bottom band. |
| MinWidth | Returns the band’s minimum width. |
| Options | Contains settings defining the possibility of the runtime band manipulations, such as moving and resizing. |
| ParentBand | Provides access to the band that nests the current band (also called parent band). |
| Position | Specifies the position of a band within a banded table View. |
| RootIndex | Specifies the band’s position among the View’s root bands. |
| RootParentBand | Returns the root parent band for the current band. |
| Rows | Returns the band rows collection associated with the current band. |
| Styles | Specifies the set of styles defining the appearance of elements of the current band. |
| Tag | Stores a value associated with the current band. |
| Visible | Specifies the current band’s visibility. |
| VisibleBandLevelCount | Returns the number of nesting (band) levels occupied by the current band and all its nested bands which are visible within a View. |
| VisibleBottomIndex | Returns the band’s horizontal position from amongst the View’s bottom bands which are visible within a View. |
| VisibleChildBandCount | Returns the number of the current band’s immediate child bands which are visible in a View. |
| VisibleChildBands | Provides indexed access to the current band’s child bands which are visible within a View. |
| VisibleForCustomization | Specifies whether a band is shown in the Customization Form when moved into the form. |
| VisibleIndex | Returns the band’s position within a View. |
| VisibleRootIndex | Returns the root band’s horizontal position from amongst the View’s root bands which are visible within a View. |
| Width | Specifies the band’s width, in pixels. |
Methods
| Name | Description |
|---|---|
| ApplyBestFit(Boolean,Boolean) | Adjusts the width of the band in order to display its full content. |
| Assign(TPersistent) | Inherited from TPersistent. |
| AssignTo(TPersistent) | Inherited from TPersistent. |
| Equals(TObject) | Inherited from TObject. |
| GetAlternateCaption | Returns a string specifying an alternative caption for the current band. |
| GetDisplayName | Inherited from TCollectionItem. |
| GetHashCode | Inherited from TObject. |
| GetNamePath | Inherited from TPersistent. |
| GetOwner | Inherited from TPersistent. |
| HasAsParent(TcxGridBand) | Indicates whether the current band has the specified TcxGridBand as a parent band. |
| IsCaptionFormatted | |
| MoveBand(TcxGridBand,Integer) | Moves the specified band with respect to the other child bands within the current band. |
| MoveColumn(TcxGridBandedColumn,Integer,Integer) | Moves the specified column in respect to other columns within the band. |
| MoveColumns(TcxGridBand) | Moves all columns from the current band to the specified band. |
| Release | Inherited from TCollectionItem. |
| SetDisplayName(String) | Inherited from TCollectionItem. |
| ToString | Inherited from TObject. |
Events
| Name | Description |
|---|---|
| OnGetStoredProperties | Occurs when the list of the current band’s properties that will be stored in external storage is produced. |
| OnGetStoredPropertyValue | Occurs when the values of the current band’s properties are stored in external storage. |
| OnHeaderClick | Occurs on clicking the band header. |
| OnSetStoredPropertyValue | Occurs when the values of the current band’s properties are restored from external storage. |
| StylesEvents |
See Also