Version

UltraGridBand Class Properties

For a list of all members of this type, see UltraGridBand members.

Public Properties
 NameDescription
Public PropertyAddButtonCaptionReturns or sets the caption text of the Band's Add button.  
Public PropertyAddButtonToolTipTextReturns or sets the text used as the Add button's tool tip  
Public PropertyAutoPreviewEnabledReturns or sets a value that determines whether the AutoPreview area will be displayed.  
Public PropertyAutoPreviewFieldReturns or sets the name of the field used to supply the text for the AutoPreview area.  
Public PropertyAutoPreviewIndentationReturns or sets the amount of horizontal indentation for a row's AutoPreview area.  
Public PropertyAutoPreviewMaxLinesReturns or sets the maximum number of lines to be auto-previewed  
Public PropertyBorderStyleHeaderResolvedReturns the resolved border style of the headers in this Band.  
Public PropertyBorderStyleSummaryFooterCaptionResolvedReturns the resolved value, if the band's Override value is default it will call the Layout's BorderStyleSummaryFooterCaptionDefault property.  
Public PropertyBorderStyleSummaryValueResolvedReturns the resolved value, if the band's Override value is default it will call the Layout's BorderStyleSummaryValueDefault property.  
Public PropertyCardLabelWidthResolvedThe width of the card label area  
Public PropertyCardSettingsReturns a UltraGridCardSettings object that contains information specifying how the band will appear when in card view mode.  
Public PropertyCardViewReturns or sets a value that determines whether the band is Card View mode.  
Public PropertyCardWidthResolvedThe width of a single card  
Public PropertyColHeaderLinesReturns or sets the number of lines to display for column headers.  
Public PropertyColHeadersVisibleDetermines if column headers are visible.  
Public PropertyColumnFiltersColumn filters for filtering all the rows in this band. NOTE: They will apply only if the UltraGridOverride.RowFilterMode is set to AllRowsInBand.  
Public PropertyColumnsReturns the ColumnsCollection of UltraGridColumns that make up the band. This property is read-only.  
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyExcludeFromColumnChooserForces the band to be excluded from the column chooser control. Default is resolved to False.  
Public PropertyExpandableReturns or sets a value that determines if the band is expandable.  
Public PropertyFormulaRowIndexSourceResolvedGets the resolved formula source index.  
Public PropertyGroupHeaderLinesReturns or sets the number of lines of text to display for groups headers.  
Public PropertyGroupHeadersVisibleDetermines if group headers are visible.  
Public PropertyGroupsReturns the GroupsCollection of UltraGridGroup objects that are present in the band. This property is read-only.  
Public PropertyHasCardSettingsReturns true if a CardSettings object has been created.  
Public PropertyHasOverrideReturns true if an Override object has been created.  
Public PropertyHasSortedColumnsReturns true if there are any sorted columns in the band.  
Public PropertyHeaderReturns the associated BandHeader object which represents this band's header.  
Public PropertyHeaderPlacementResolvedReturns the resolved header placement.  
Public PropertyHeaderVisibleDetermines if band headers are visible.  
Public PropertyHiddenDetermines whether the object will be displayed. This property is not available at design-time.  
Public PropertyHiddenResolvedReturns true if the Hidden property for this band is set to true or any of this band's ancestor bands have their hidden property set to true.  
Public PropertyIndentationReturns or sets a value that determines the amount of indenting used for this band.  
Public PropertyIndentationGroupByRowGets/sets the number of pixels that the band's groupby rows will be offset. The default value is -1, which means that the grid will determine the offset.  
Public PropertyIndentationGroupByRowExpansionIndicatorGets/sets the number of pixels that the expansion indicators in the band's groupby rows will be offset. The default value is -1, which means that the grid will determine the offset.  
Public PropertyIndentationGroupByRowResolvedReturns the resolved IndentationGroupByRow for this band.  
Public PropertyIndexNumber that specifies the band's position in the Bands collection..  
Public PropertyKeyOverridden. The internally assigned key value for the band. The Key property is read-only for the Band object.  
Public PropertyLayoutReturns the associated UltraGridLayout object.  
Public PropertyLevelCountReturns or sets the number of levels that will be displayed for a single record.  
Public PropertyMaxRowsGets/sets the maximum number of rows allowed in the band. This value is inclusive. The default is practical infinity (Int32.MaxValue).  
Public PropertyMinRowsGets/sets the minimum number of rows allowed in the band. This value is inclusive. The default is 0. If an attempt is made to delete rows from a band and the remaining number of rows would be less than MinRows, the rows are not deleted and the UltraGrid.Error event will fire.  
Public PropertyOverrideReturns or sets the UltraGridOverride obejct that specifies the formatting and behavior of the band.  
Public PropertyParentBandReturns the parent UltraGridBand object of the current band (if it is a child band) or Null for band 0. This property is read-only.  
Public PropertyParentColumnReturns the UltraGridColumn object for the chaptered column in the current band's parent (if the current band is a child band) or Null for band 0. This property is read-only.  
Public PropertyRowEditTemplateGets or sets the template used for editing rows in the band.  
Public PropertyRowFilterActionResolvedResolved RowFilterAction.  
Public PropertyRowLayoutLabelPositionGets or sets the label position. Label position indicates the position of the column labels in the row layout mode.  
Public PropertyRowLayoutLabelStyleGets or sets the row-layout label style. Row-layout label style specifies whether the column labels are shown in a separate area above the rows or with the cells in each row. Default is Separate.  
Public PropertyRowLayoutsReturns an instance of RowLayoutsCollection to which you can add new RowLayout objects using method.  
Public PropertyRowLayoutStyleEnables row-layout functionality in the band.  
Public PropertyRowSelectorHeaderStyleResolvedReturns the resolved value, if the band's Override value is default it will use the Layout's RowSelectorHeaderStyleDefault property.  
Public PropertyRowSelectorWidthResolvedReturns the resolved row selector width. Returns 0 if the row selectors are not visible.  
Public PropertyScrollTipFieldScrollTipField specifies the key of the column contents of which UltraGrid will use to display the scroll tips.  
Public PropertySortedColumnsReturns the SortedColumnsCollection which contains all the UltraGridColumn objects that are currently being sorted in the band.  
Public PropertySortedIndexNumber that specifies the band's position in the SortedBands collection.  
Public PropertySpecialRowPromptFieldSpecifies the key of the column whose cell to position the special row prompts in. Default value is null which specifies that the prompt should not be positioned in any particular cell but rather it should be overlaid on the special row spanning multiple cells if necessary.  
Public PropertySummariesA collection of SummarySettings objects. Use this collection to add new summaries as well as remove any existing summaries.  
Public PropertySummaryFooterCaptionGets or sets summary footer caption substitution string.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTotalHeaderHeightReturns the total height of all the headers. (Column headers, group headers and band header). If the headers are not visible, then it returns 0.  
Public PropertyVisiblePositionDetermines the position of the band relative to its siblings.  
Protected Properties
 NameDescription
Protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
See Also