Version

GroupHeader Class Members

The following tables list the members exposed by GroupHeader.

Protected Fields
 NameDescription
Protected FieldselectedValueThe internal selectedValue state of the item. (Inherited from Infragistics.Win.UltraWinGrid.GridItemBase)
Protected FieldtagValue (Inherited from Infragistics.Shared.SubObjectBase)
Protected FieldvisiblePosvisible position of header (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public Properties
 NameDescription
Public PropertyActivatedProperty: Returns true only if activated (Inherited from Infragistics.Win.UltraWinGrid.GridItemBase)
Public PropertyAllowEditingGets or sets a value which indicates whether the header can be edited by the user. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyAppearanceReturns or sets the Appearance object that controls the object's formatting. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyBandOverridden. The header owner's band object. This property is read-only.  
Public PropertyCaptionReturns or sets the caption text of the header. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyColumnThe UltraGridColumn object associated with the header. Returns null if the header is not a column header. This property is read-only. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyDisposed (Inherited from Infragistics.Shared.DisposableObject)
Public PropertyEditorUse this property to set the editor that will be used for rendering and editing the cell. This property returns null if it wasn't set to an editor before. By default, UltraGridColumn.Editor property off the associated column is used for rendering and editing the cell. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyEditorResolvedReturns the editor used for rendering and editing the cell. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyEnabledDetermines if the object associated with the header is enabled. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyExclusiveColScrollRegionReturns or sets the only colscrollregion in which a column is displayed. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyFixedSpecifies whether the header is fixed. When a header is fixed column(s) associated with the header remain in view when the grid is scrolled horizontally. This property is settable on column headers and group headers. If there are groups, then the Fixed property settings off the group headers will be used and fixed property settings off the column headers will be ignored. Attempting to set it on a BandHeader object will lead to a NotSupportedException. NOTE: This property is ignored in Row-Layout mode as headers can't be fixed in Row-Layout mode. You must enable the fixed-headers functionality by setting UltraGridLayout.UseFixedHeaders to true in order for this property to have any effect. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyFixedHeaderIndicatorSpecifies whether the user is allowed to fix or unfix the header. NOTE: This property is ignored in Row-Layout mode as headers can't be fixed in Row-Layout mode. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyFixOnRightGets or sets a value which indicates whether the column or group will be fixed to the right side of the grid when HeaderBase.Fixed is True. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyFixOnRightResolvedGets the resolved value which determines whether the column or group will be fixed on the right side of the grid when HeaderBase.Fixed is True. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyGroupOverridden. Returns the Group object that the object is associated with. This property is not available at design-time.  
Public PropertyHasAppearanceReturns true if an appearance object has been created. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyHeightOverridden. Returns the height of the group header.  
Public PropertyIsTabStopAlways returns false for headers (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertySelectedOverridden. Returns or sets the selected state of the header.  
Public PropertySizeResolvedOverridden. Resolved header size. This property returns the actual width and the height of the header.  
Public PropertyTag (Inherited from Infragistics.Shared.SubObjectBase)
Public PropertyTextOrientationGets or sets the orientation of text in the header. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyTextOrientationResolvedGets the resolved value of HeaderBase.TextOrientation. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyToolTipTextSpecifies the tooltip to display when the user hovers the mouse over the header. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public PropertyVisiblePositionOverridden. Returns or sets the visible position of a header.  
Public PropertyVisiblePositionWithinBandThe overall visible position of the groups within its band (read-only).  
Protected Properties
 NameDescription
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodActivateActivates header. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodCreateObjRefCreates 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 MethodGetExportTextGets the export text for a header. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetUIElementOverloaded. Returns the UIElement associated with the object, in the specified row and column scrolling regions. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodNotifyPropChangeOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodResetResets all properties back to their default values. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetAllowEditingResets the HeaderBase.AllowEditing property to its default value. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetAppearanceResets Appearance to its default settings. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetCaptionResets Caption to null. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetEditorResets Editor to null. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetEnabledResets Enabled to its default value (True). (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetExclusiveColScrollRegionResets to null (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetFixedResets the property to its default value of false. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetFixedHeaderIndicatorResets the property to its default value. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetFixOnRightResets the HeaderBase.FixOnRight property to its default value. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetTextOrientationResets the HeaderBase.TextOrientation property to its default value. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResetToolTipTextResets the property to its default value of false. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodResolveAppearanceOverloaded. Returns an Appearance object with its properties set to the actual values that will be used to display the object. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodSelectAllSelects all of the text in the cell. If the cell does not contain text then this method does nothing. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodToStringReturns an empty string so that property window display nothing (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodDeserializeHelperCalled by the constructor used for de-serialization (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodGetObjectDataSerialize the header properties (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnDisposeCalled when the object is disposed of (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnSubObjectPropChangedCalled when another sub object that we are listening to notifies us that one of its properties has changed. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeAllowEditingReturns true if the HeaderBase.AllowEditing property needs to be serialized. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeAppearanceReturns true if this property is not set to its default value (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeCaptionReturns true if this property is not set to its default value (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeEditorReturns true if this property is not set to its default value (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeEnabledReturns true if this property is not set to its default value (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeExclusiveColScrollRegionReturns true if this property is not set to its default value (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeFixedReturns true if the property has been set to a non-default value of true. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeFixedHeaderIndicatorRetruns true if the property is set to a non-default value. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeFixOnRightReturns true if the HeaderBase.FixOnRight property needs to be serialized. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeTextOrientationReturns true if the HeaderBase.TextOrientation property needs to be serialized. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeToolTipTextReturns true if the property has been set to a non-default value of true. (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Protected MethodShouldSerializeVisiblePositionReturns true if this property is not set to its default value (Inherited from Infragistics.Win.UltraWinGrid.HeaderBase)
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also