Infragistics(R) NetAdvantage(R) Windows Forms
UltraGridBand Class Members
See Also  Fields  Properties  Methods  Events E-mail your feedback on this topic.
Infragistics.Win.UltraWinGrid Namespace : UltraGridBand Class


The following tables list the members exposed by UltraGridBand.

Protected Fields

 NameDescription
protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Top

Public Properties

 NameDescription
public PropertyAddButtonCaption Returns or sets the caption text of the Band's Add button.  
public PropertyAddButtonToolTipText Returns or sets the text used as the Add button's tool tip  
public PropertyAutoPreviewEnabled Returns or sets a value that determines whether the AutoPreview area will be displayed.  
public PropertyAutoPreviewField Returns or sets the name of the field used to supply the text for the AutoPreview area.  
public PropertyAutoPreviewIndentation Returns or sets the amount of horizontal indentation for a row's AutoPreview area.  
public PropertyAutoPreviewMaxLines Returns or sets the maximum number of lines to be auto-previewed  
public PropertyBorderStyleHeaderResolved Returns the resolved border style of the headers in this Band.  
public PropertyBorderStyleSummaryFooterCaptionResolved Returns the resolved value, if the band's Override value is default it will call the Layout's BorderStyleSummaryFooterCaptionDefault property.  
public PropertyBorderStyleSummaryValueResolved Returns the resolved value, if the band's Override value is default it will call the Layout's BorderStyleSummaryValueDefault property.  
public PropertyCardLabelWidthResolved The 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 PropertyCardView Returns or sets a value that determines whether the band is Card View mode.  
public PropertyCardWidthResolved The width of a single card  
public PropertyColHeaderLines Returns or sets the number of lines to display for column headers.  
public PropertyColHeadersVisible Determines 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 PropertyExpandable Returns or sets a value that determines if the band is expandable.  
public PropertyFormulaRowIndexSourceResolved Gets the resolved formula source index.  
public PropertyGroupHeaderLines Returns or sets the number of lines of text to display for groups headers.  
public PropertyGroupHeadersVisible Determines if group headers are visible.  
public PropertyGroupsReturns the GroupsCollection of UltraGridGroup objects that are present in the band. This property is read-only.  
public PropertyHasCardSettings Returns true if a CardSettings object has been created.  
public PropertyHasOverride Returns true if an Override object has been created.  
public PropertyHasSortedColumns Returns true if there are any sorted columns in the band.  
public PropertyHeaderReturns the associated BandHeader object which represents this band's header.  
public PropertyHeaderPlacementResolved Returns the resolved header placement.  
public PropertyHeaderVisible Determines if band headers are visible.  
public PropertyHidden Determines 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 PropertyIndentation Returns or sets a value that determines the amount of indenting used for this band.  
public PropertyIndentationGroupByRow Gets/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 PropertyIndentationGroupByRowExpansionIndicator Gets/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 PropertyIndentationGroupByRowResolved Returns the resolved IndentationGroupByRow for this band.  
public PropertyIndex Number 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 PropertyLevelCount Returns or sets the number of levels that will be displayed for a single record.  
public PropertyMaxRows Gets/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 PropertyParentBand Returns 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 PropertyParentColumn Returns 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 PropertyRowEditTemplate Gets or sets the template used for editing rows in the band.  
public PropertyRowFilterActionResolved Resolved RowFilterAction.  
public PropertyRowLayoutLabelPosition Gets 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 PropertyRowLayoutStyle Enables row-layout functionality in the band.  
public PropertyRowSelectorHeaderStyleResolved Returns the resolved value, if the band's Override value is default it will use the Layout's RowSelectorHeaderStyleDefault property.  
public PropertyRowSelectorWidthResolved Returns the resolved row selector width. Returns 0 if the row selectors are not visible.  
public PropertyScrollTipField ScrollTipField 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 PropertySortedIndex Number that specifies the band's position in the SortedBands collection.  
public PropertySpecialRowPromptField Specifies 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 PropertySummaries A collection of SummarySettings objects. Use this collection to add new summaries as well as remove any existing summaries.  
public PropertySummaryFooterCaption Gets or sets summary footer caption substitution string.  
public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
public PropertyTotalHeaderHeight Returns 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 PropertyVisiblePosition Determines the position of the band relative to its siblings.  
Top

Protected Properties

 NameDescription
protected PropertyKeyLowercaseInterned (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected PropertyPrimaryCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Top

Public Methods

 NameDescription
public MethodAddNewDisplays the AddNew row for the band. If the current ActiveRow does not provide enough context, an error occurs.  
public MethodCalcGroupByConnectorsExtent Figures out the amount by which to extend left the headers in order to have them occupy the space over the group-by row connectors.  
public MethodCalcGroupBySummariesIndent Returns a value that specifies the amount by which to indent the summaries in the summary footers of the specified group-by row collection.  
public MethodClearGroupByColumns Removes all the Group-By columns, ungrouping the rows in the band.  
public MethodCreateObjRef Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from System.MarshalByRefObject)
public MethodDispose (Inherited from Infragistics.Shared.DisposableObject)
public MethodGetColumnHeaderHeight Returns the total height of the column headers for the band.  
public MethodGetExtentOverloaded.  Returns the absolute width of the band.  
public MethodGetFirstVisibleColOverloaded.  Returns the first visible column in the passed in column scrolling region.  
public MethodGetLifetimeService Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
public MethodGetOriginOverloaded.  Returns the absolute coordinate of the leftmost point on the band, taking into consideration the control's entire virtual area.  
public MethodGetRowEnumerator Gets the rows associated with this band.  
public MethodInitializeLifetimeService Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
public MethodPerformAutoResizeCards Resizes the width of all cards in the band based on cell values in all rows.  
public MethodPerformAutoResizeColumnsOverloaded.  Resizes all columns in the band based on cell values in either currently visible rows or all rows depending on the value of autoSizeType argument.  
public MethodReset Resets all properties on this object and all of its sub objects to their default value  
public MethodResetAddButtonCaption Resets AddButtoCaption to its default value (null).  
public MethodResetAddButtonToolTipText Resets AddButtonToolTip Text to its default value (null).  
public MethodResetAutoPreviewEnabled Resets AutoPreviewEnabled to its default value (False).  
public MethodResetAutoPreviewField Resets AutoPreviewField to its default value (null).  
public MethodResetAutoPreviewIndentation Resets AutoPreviewIndentation to its default value (0).  
public MethodResetAutoPreviewMaxLines Resets AutoPreviewMaxLines to its default value (3).  
public MethodResetCardSettings Resets the card settings  
public MethodResetCardView Resets CardView to its default value (false).  
public MethodResetColHeaderLines Resets ColumnHeaderLines to its default value (1).  
public MethodResetColHeadersVisible Resets ColumnHeaderVisible to its default value (True).  
public MethodResetColumns Resets the Columns collection for the band.  
public MethodResetExcludeFromColumnChooser Resets the property to its default value.  
public MethodResetExpandable Resets Expandable to its default value (True).  
public MethodResetGroupHeaderLines Resets GroupHeaderLines to its default value (1).  
public MethodResetGroupHeadersVisible Resets GroupHeadersVisible to its default value (True).  
public MethodResetGroups Resets the Groups collection for the band.  
public MethodResetHeader Resets Header  
public MethodResetHeaderVisible Resets HeaderVisible to its default value (False).  
public MethodResetHidden Resets Hidden to its default value (False).  
public MethodResetIndentation Resets Indentation its default value (-1).  
public MethodResetIndentationGroupByRow Resets IndentationGroupByRow its default value (-1).  
public MethodResetIndentationGroupByRowExpansionIndicator Resets IndentationGroupByRowExpansionIndicator its default value (-1).  
public MethodResetKeyOverridden. Resets the key to its default value. This method does nothing for the Band object since the band key can never be changed.  
public MethodResetLevelCount Resets LevelCount to its default value (1).  
public MethodResetMaxRows Resets MaxRows its default value (Int32.MaxValue).  
public MethodResetMinRows Resets MinRows its default value (0).  
public MethodResetOverride Resets the Override  
public MethodResetRowEditTemplate Resets the RowEditTemplate property to its default value  
public MethodResetRowLayoutLabelPositionResets the RowLayoutLabelPosition property to its default value of Default.  
public MethodResetRowLayoutLabelStyleResets the property to its default value of Separate.  
public MethodResetRowLayouts Resets RowLayouts property to its default value.  
public MethodResetRowLayoutStyle Resets RowLayoutStyle property to its default value.  
public MethodResetScrollTipField Resets ScrollTipField to its default value (null).  
public MethodResetSortedColumns Resets the sorted column's collection.  
public MethodResetSpecialRowPromptField Resets the property to its default value.  
public MethodResetSummaries Resets Summaries property to its default value.  
public MethodResetSummaryFooterCaption Resets SummaryFooterCaption property to its default value.  
public MethodResetUseRowLayout Resets UseRowLayout property to its default value.  
public MethodResetVisiblePosition Resets VisiblePosition to its default value (0).  
public MethodShouldSerializeKeyOverridden. Returns true if this property is not set to its default value. ShouldSerializeKey always returns False for the Band object since the band key can never be changed.  
public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
public MethodToString Returns the key property  
public MethodUnfixAllHeaders Unfixes all the headers in this band.  
public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Top

Protected Methods

 NameDescription
protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
protected MethodOnAddedToCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected MethodOnDisposeOverridden.  Called when the object is disposed of  
protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodOnRemovedFromCollection (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected MethodOnSubObjectPropChangedOverridden.  Called when a property has changed on a sub object  
protected MethodResetInternedKey (Inherited from Infragistics.Shared.KeyedSubObjectBase)
protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
protected MethodShouldSerializeAddButtonCaption Returns true if this property is not set to its default value.  
protected MethodShouldSerializeAddButtonToolTipText Returns true if this property is not set to its default value.  
protected MethodShouldSerializeAutoPreviewEnabled Returns true if this property is not set to its default value.  
protected MethodShouldSerializeAutoPreviewField Returns true if this property is not set to its default value.  
protected MethodShouldSerializeAutoPreviewIndentation Returns true if this property is not set to its default value.  
protected MethodShouldSerializeAutoPreviewMaxLines Returns true if this property is not set to its default value.  
protected MethodShouldSerializeCardSettings Returns true if this property is not set to its default value.  
protected MethodShouldSerializeCardView Returns true if this property is not set to its default value.  
protected MethodShouldSerializeColHeaderLines Returns true if this property is not set to its default value.  
protected MethodShouldSerializeColHeadersVisible Returns true if this property is not set to its default value.  
protected MethodShouldSerializeColumns Returns true if this property is not set to its default value.  
protected MethodShouldSerializeExpandable Returns true if this property is not set to its default value.  
protected MethodShouldSerializeGroupHeaderLines Returns true if this property is not set to its default value.  
protected MethodShouldSerializeGroupHeadersVisible Returns true if this property is not set to its default value.  
protected MethodShouldSerializeGroups Returns true if this property is not set to its default value.  
protected MethodShouldSerializeHeader Returns true if this property is not set to its default value.  
protected MethodShouldSerializeHeaderVisible Returns true if this property is not set to its default value.  
protected MethodShouldSerializeHidden Returns true if this property is not set to its default value.  
protected MethodShouldSerializeIndentation Returns true if this property is not set to its default value.  
protected MethodShouldSerializeIndentationGroupByRow Returns true if this property is not set to its default value.  
protected MethodShouldSerializeIndentationGroupByRowExpansionIndicator Returns true if this property is not set to its default value.  
protected MethodShouldSerializeLevelCount Returns true if this property is not set to its default value.  
protected MethodShouldSerializeMaxRows Returns true if this property is not set to its default value.  
protected MethodShouldSerializeMinRows Returns true if this property is not set to its default value.  
protected MethodShouldSerializeOverride Returns true if this property is not set to its default value.  
protected MethodShouldSerializeRowEditTemplate Returns whether the RowEditTemplate property is set to a non-default value.  
protected MethodShouldSerializeRowLayoutLabelPositionReturns true if the RowLayoutLabelPosition property is set to a value other than the default value of Default.  
protected MethodShouldSerializeRowLayoutLabelStyle Retruns true if the property is set to a non-default value.  
protected MethodShouldSerializeRowLayouts Returns true if this property is not set to its default value.  
protected MethodShouldSerializeRowLayoutStyle Returns true if this property is not set to its default value  
protected MethodShouldSerializeScrollTipField Returns true if this property is not set to its default value.  
protected MethodShouldSerializeSortedColumns Returns true if this property is not set to its default value.  
protected MethodShouldSerializeSpecialRowPromptField Returns true if the property is set to a non-default value.  
protected MethodShouldSerializeSummaries Returns true if this property is not set to its default value.  
protected MethodShouldSerializeSummaryFooterCaption Returns true if this property is not set to its default value.  
protected MethodShouldSerializeUseRowLayout Returns true if this property is not set to its default value  
protected MethodShouldSerializeVisiblePosition Returns true if this property is not set to its default value.  
Top

Public Events

 NameDescription
public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Top

See Also