Version

Band Class Members

The following tables list the members exposed by Band.

Public Constructors
 NameDescription
Public ConstructorBand Constructor  
Public Properties
 NameDescription
Public PropertyAltItemCssClassCSS class name that should be used for alternative (the ones with even index) rows. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyAutoGenerateColumnsDefines whether the grid generates columns automatically during the data binding process.  
Public PropertyAutoPostBackFlagsReturns the AutoPostBackFlags object which will be applied to this band's grids  
Public PropertyBandHasBehaviorsReturns true is the band has one or more behaviors. Otherwise false.  
Public PropertyBandsA collection of child Bands of this band.  
Public PropertyBehaviorsBand behaviors.  
Public PropertyCellSpacingDetermines number of pixels between the cells of the grid. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyCollapseButtonThe button object that will be displayed when a grid's row is expanded and can be clicked to collapse the row. If the button is left with default parameters on the Band, but is changed on WebHierarchicalDataGrid then the band will inherit these settings.  
Public PropertyColumnsContains definition of the band's columns.  
Public PropertyDataKeyFieldsContains datakeys of the shown data.  
Public PropertyDataMemberGets or sets a string value that identifies a particular data member of the DataSource property that is to be used to enumerate the data during a DataBind operation.  
Public PropertyDefaultColumnWidthThe default column width that will be applied to all columns, for whom the width has not been set.  
Public PropertyExpandableAreaCssClassThe name of the css class that will be used to style the TD in which the RowIslands appear. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyExpandButtonThe button object that will be displayed when a grid's row is collapsed and the row has child row islands. It can be clicked to expand the row to show the child row islands. If the button is left with default parameters on the Band, but is changed on WebHierarchicalDataGrid then the band will inherit these settings.  
Public PropertyExpansionColumnCssThe name of the css class that will be used to style the column in which the Expand/Collapse buttons appear. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyFooterCaptionCssClassCSS class name that should be used for the footers. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyGroupingSettingsContains settings for column grouping.  
Public PropertyHasBandsIndicates whether the Bands property was instantiated.  
Public PropertyHasColumnsIndicates whether the Columns property was instantiated.  
Public PropertyHeaderCaptionCssClassCSS class name that should be used for the headers. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyHeightThe height of each row island that will be generated from the band.  
Public PropertyIndexReturns the index of the band in the BandCollection  
Public PropertyIsEmptyChecks if ViewState has any property with not a default value. This property should be overriden by extended class when additional subobjects are supported. IsEmpty will then check each subobject and return a value based on the check of those objects plus itself. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public PropertyIsSelfReferenceDetermines if the current Band is representing a self reference relationship.  
Public PropertyItemCssClassCSS class name that should be used for the cells. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyKeyThe Key of the Band  
Public PropertyOwnerCollectionGets the instance of the parent collection of the Band  
Public PropertyShowFooterDetermines if the column footers will be visible in the Grid. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyShowHeaderDetermines if the column headers will be visible on the Grid. If this property is not set on the band, it will be resolved by traveling up the band hierarchy.  
Public PropertyWidthThe width of each row island that will be generated from the band.  
Protected Properties
 NameDescription
Protected PropertyAdditionalClientState (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyCollectionData (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyDelayLoadingClientCollectionsCustomizes the client collections loading. If true the collections will be loaded after view state has been loaded. If false the collections will be loaded in RunBot.HandleOnInit. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyIsTrackingViewStateThis method returns a boolean value which indicates whether ViewState is being tracked for the object. Once viewstate is being tracked, all property changes are roundtripped from server to client and back within the ViewState hidden field. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyPropCountThis property is used to track the number of properties this object is sending to ClientState. Each derived class overrides this property to indicate the new total of properties. The number consists of the PropCount value of the base class plus the number of ClientState properties utilized by each derived class. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyTransactionLists (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected PropertyViewStateProperty to return the ViewState bag for the object. If none exist, then one is created. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Methods
 NameDescription
Public MethodCloneClones the object (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public MethodGetObjectTypeGets the name of the object type  
Public MethodIsDirtyOverloaded. This method determines if the property with the specified Id within the ViewState bag is dirty and needs to be sent to and from the client. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected Methods
 NameDescription
Protected MethodCreateNewInstanceCreates a new instance of the current type using the default constructor. Derived classes may override the method if there is no parameterless constructor or any other custom logic applies. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodFlushEmpties the positional and occasional property stringBuffers and converts them to a string representation that can be written to the response stream. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodGetClientPropertiesArray (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadAdditionalClientStateThis method is called when additional information is passed from the client, via the _saveAdditionalClientState javascript method (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsLoads the Collections that were sent down to the client, back into the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientCollectionsTransactionListReads the TransactionList and repopulates the collections of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientObjectsOverridden. Loads the Objects that were sent down to the client, back into the control.  
Protected MethodLoadClientObjectsTransactionListReads the Transaction List and repopulates the objects of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientPropsTransactionListReads the Transaction List and repopulates the properties of the control. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateThis method takes the state from the client and loads the control's Properties, Objects, and Collections, that were sent down to the client on the last post. It also stores the TransactionLists for the Properties, Objects, and Collections. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadClientStateFromViewStateChecks to see if ClientState was saved into Viewstate, if so, then it loads. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadCollectionsStateFromViewStateLoads the saved into view state client collections and deserializes the string as it came from the client side. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadOccasionalProperty (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertiesLoads client state properties from the client (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadPositionalPropertyLoad positional property at index (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadTransactionListLoads the transaction list. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodLoadViewStateOverridden. Load data modified at run time.  
Protected MethodOnPropertyChangeOverloaded. Virtual method that is called whenever a server state property within the object has been changed. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodPreFetchPositionalClientPropertyFetch a positional property from the transaction list before the properties are loaded. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodResetClientStateResets the positional and occasional property stringBuffers to initial empty values. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientCollectionsSaves all Collections that should go to the client into a javascript array. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveClientObjectsOverridden. Saves all objects that should go to the client into a javascript array.  
Protected MethodSaveClientPropertiesOverloaded. Overridden. Serializes the ClientState properties of the object to a JSON stream that will be accessed from the client. The FullAddress property of the Object is also accessed in this process to identify the object being serialized to JSON.  
Protected MethodSaveClientStateToViewStateIf the control is not visible, we don't want to loose our ClientState during the next postback, so lets store it in ViewState. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveCollectionsStateToViewStateSaves the client collections state as string into the view state. This way we can skip the expensive serialization on the client side and not send them at all. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodSaveViewStateOverridden. Saves the view state of the grid when rendering down to the client.  
Protected MethodShouldSerializeColumnsDetermines wheather columns should be persisted.  
Protected MethodTrackViewStateOverridden. Overrides base class' method. Enables the view state tracking for the behavior.  
Protected MethodWriteAdditionalClientPropertiesIf an object needs to render additional information that needs to be accessed on the client, this is where they can add this information. Note that each object that they need to render should be prefixed with a Comma because the information is being rendered inside of a javascript array. This method is called by WriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientCollections (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientObjects (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientOnlyPropertyStores the property in hashtable, that will be rendered down to the client. Client only properties only get sent down to the client, they do not get sent back to the server. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientProperties (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWriteClientStateResponsible for rendering javascript array of all client properties, events, objects and collections Calls helper methods to render each in turn. That method is called to render parameter for initialization (constructor) java-script function. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Protected MethodWritePositionalPropertyWrites the passed in property value at the current position of the ClientState serialization. The property is serialized to the positional properties string of the ClientState string. (Inherited from Infragistics.Web.UI.Framework.ObjectBase)
Public Events
 NameDescription
Public EventCalculateCustomSummaryEvent that is fired whenever each custom summary needs to be calculated  
Public EventCalculateSummaryEvent that is fired whenever each normal summary type needs to be calculated because the grid is doing custom binding  
Public EventColumnMovedOccurs when a column is moved by a user.  
Public EventColumnResizedOccurs when a column is resized by a user.  
Public EventColumnSortedOccurs when a column is sorted by a user.  
Public EventDataFilteredOccurs when a filters have be applied to the grid's data.  
Public EventDataFilteringOccurs when a filters are about to be applied to the grid's data.  
Public EventPageIndexChangedOccurs when a page has changed by a user.  
Public EventPopulateUniqueFilterValuesOccurs when a filters have be applied to the grid's data.  
Public EventRowAddedEvent that is fired every time a row has been added.  
Public EventRowAddingEvent that is fired every time a row about to be added.  
Public EventRowDeletedEvent that is fired every time a row is deleted.  
Public EventRowsDeletingEvent that is fired every time a row is about to be deleted.  
Public EventRowUpdatedEvent that is fired every time a row has been updated.  
Public EventRowUpdatingEvent that is fired every time a row is about to be updated in the database.  
Public EventSummaryCalculatedEvent that is fired whenever a standard summary is calculated (any summary which is not a custom summary).  
See Also