Version

HeaderBase Class Members

The following tables list the members exposed by HeaderBase.

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  
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.  
Public PropertyAppearanceReturns or sets the Appearance object that controls the object's formatting.  
Public PropertyBandReturns the Band that the object belongs to, if any. This property is read-only at run-time. This property is not available at design-time. (Inherited from Infragistics.Win.UltraWinGrid.GridItemBase)
Public PropertyCaptionReturns or sets the caption text of the header.  
Public PropertyColumnThe UltraGridColumn object associated with the header. Returns null if the header is not a column header. This property is read-only.  
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.  
Public PropertyEditorResolvedReturns the editor used for rendering and editing the cell.  
Public PropertyEnabledDetermines if the object associated with the header is enabled.  
Public PropertyExclusiveColScrollRegionReturns or sets the only colscrollregion in which a column is displayed.  
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.  
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.  
Public PropertyFixOnRightGets or sets a value which indicates whether the column or group will be fixed to the right side of the grid when Fixed is True.  
Public PropertyFixOnRightResolvedGets the resolved value which determines whether the column or group will be fixed on the right side of the grid when Fixed is True.  
Public PropertyGroupThe UltraGridGroup object associated with the header. Returns null if the header is not a group header. This property is read-only.  
Public PropertyHasAppearanceReturns true if an appearance object has been created.  
Public PropertyHeightReturns or sets the height of the row (excluding spacing).  
Public PropertyIsTabStopOverridden. Always returns false for headers  
Public PropertySelectedOverridden. Returns or sets the selected state of the header.  
Public PropertySizeResolvedResolved 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.  
Public PropertyTextOrientationResolvedGets the resolved value of TextOrientation.  
Public PropertyToolTipTextSpecifies the tooltip to display when the user hovers the mouse over the header.  
Public PropertyVisiblePositionReturns or sets the visible position of a header.  
Protected Properties
 NameDescription
Protected PropertySubObjectPropChangeHandler (Inherited from Infragistics.Shared.SubObjectBase)
Public Methods
 NameDescription
Public MethodActivateActivates header.  
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.  
Public MethodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from System.MarshalByRefObject)
Public MethodGetUIElementOverloaded. Overridden. Returns the UIElement associated with the object, in the specified row and column scrolling regions.  
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.  
Public MethodResetAllowEditingResets the AllowEditing property to its default value.  
Public MethodResetAppearanceResets Appearance to its default settings.  
Public MethodResetCaptionResets Caption to null.  
Public MethodResetEditorResets Editor to null.  
Public MethodResetEnabledResets Enabled to its default value (True).  
Public MethodResetExclusiveColScrollRegionResets to null  
Public MethodResetFixedResets the property to its default value of false.  
Public MethodResetFixedHeaderIndicatorResets the property to its default value.  
Public MethodResetFixOnRightResets the FixOnRight property to its default value.  
Public MethodResetTextOrientationResets the TextOrientation property to its default value.  
Public MethodResetToolTipTextResets the property to its default value of false.  
Public MethodResolveAppearanceOverloaded. Returns an Appearance object with its properties set to the actual values that will be used to display the object.  
Public MethodSelectAllSelects all of the text in the cell. If the cell does not contain text then this method does nothing.  
Public MethodShouldSerializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Public MethodToStringReturns an empty string so that property window display nothing  
Public MethodVerifyNotDisposed (Inherited from Infragistics.Shared.DisposableObject)
Protected Methods
 NameDescription
Protected MethodDeserializeHelperCalled by the constructor used for de-serialization  
Protected MethodDeserializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodGetObjectDataSerialize the header properties  
Protected MethodInitializeTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodMemberwiseCloneOverloaded. Creates a shallow copy of the current System.MarshalByRefObject object. (Inherited from System.MarshalByRefObject)
Protected MethodOnDisposeOverridden. Called when the object is disposed of  
Protected MethodOnObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodOnSubObjectPropChangedOverridden. Called when another sub object that we are listening to notifies us that one of its properties has changed.  
Protected MethodResetTag (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodSerializeTagOverloaded.  (Inherited from Infragistics.Shared.SubObjectBase)
Protected MethodShouldSerializeAllowEditingReturns true if the AllowEditing property needs to be serialized.  
Protected MethodShouldSerializeAppearanceReturns true if this property is not set to its default value  
Protected MethodShouldSerializeCaptionReturns true if this property is not set to its default value  
Protected MethodShouldSerializeEditorReturns true if this property is not set to its default value  
Protected MethodShouldSerializeEnabledReturns true if this property is not set to its default value  
Protected MethodShouldSerializeExclusiveColScrollRegionReturns true if this property is not set to its default value  
Protected MethodShouldSerializeFixedReturns true if the property has been set to a non-default value of true.  
Protected MethodShouldSerializeFixedHeaderIndicatorRetruns true if the property is set to a non-default value.  
Protected MethodShouldSerializeFixOnRightReturns true if the FixOnRight property needs to be serialized.  
Protected MethodShouldSerializeTextOrientationReturns true if the TextOrientation property needs to be serialized.  
Protected MethodShouldSerializeToolTipTextReturns true if the property has been set to a non-default value of true.  
Protected MethodShouldSerializeVisiblePositionReturns true if this property is not set to its default value  
Public Events
 NameDescription
Public EventSubObjectDisposed (Inherited from Infragistics.Shared.SubObjectBase)
Public EventSubObjectPropChanged (Inherited from Infragistics.Shared.SubObjectBase)
See Also