Xceed Logo
Shop
Xceed Grid for WinForms v4.3 Documentation
Xceed.Grid.Reporting.v4.3 Assembly / Xceed.Grid.Reporting Namespace / HeaderFooter Class
Members


In This Topic
    HeaderFooter Class
    In This Topic
    Represents the section above and below each page in a Report which contains three horizontal elements (HeaderFooterElement).
    Syntax
    'Declaration
 
Public Class HeaderFooter 
    'Usage
 
Dim instance As HeaderFooter
    public class HeaderFooter
    Remarks

    Each HeaderFooter section contains 3 HeaderFooterElements: the LeftElement, the CenterElement, and the RightElement. These elements cannot be removed nor can other elements be added.

    Inheritance Hierarchy

    System.Object
       Xceed.Grid.Reporting.HeaderFooter

    Public Constructors
     NameDescription
    Public ConstructorHeaderFooter ConstructorOverloaded.   
    Top
    Public Properties
     NameDescription
    Public PropertyBackColorGets or sets the background color of the header or footer section.  
    Public PropertyBackgroundImageGets or sets the background image of the header or footer section.  
    Public PropertyBackgroundImageAlignmentGets or sets the style of the header or footer sections' BackgroundImage.  
    Public PropertyBackgroundImageStyleGets or sets the style of the header or footer sections' BackgroundImage.  
    Public PropertyBottomBorderGets the report style of the header or footer's bottom border.  
    Public PropertyBottomMarginGets or sets the height of the header or footer section's bottom margin, in hundredths of an inch.  
    Public PropertyCenterElementGets the center element of the header or footer section.  
    Public PropertyFontGets or sets the header or footer sections' font.  
    Public PropertyForeColorGets or sets the foreground color of the header or footer section.  
    Public PropertyFormatProviderGets or sets the custom Format Provider that will be used to format the HeaderFooterElement's content when the HeaderFooterElement.TextFormat property contains macros that use the format parameter.  
    Public PropertyIsBottomBorderDefinedGets a boolean value indicating if one or more properties of the BottomBorder report style have been explicitly set.  
    Public PropertyIsCenterElementDefinedGets a boolean value indicating if one or more properties of the CenterElement have been explicitly set.  
    Public PropertyIsLeftElementDefinedGets a boolean value indicating if one or more properties of the LeftElement have been explicitly set.  
    Public PropertyIsRightElementDefinedGets a boolean value indicating if one or more properties of the RightElement have been explicitly set.  
    Public PropertyIsTopBorderDefinedGets a boolean value indicating if one or more properties of the TopBorder report style have been explicitly set.  
    Public PropertyLeftElementGets the left element of the header or footer section.  
    Public PropertyMaxHeightGets or sets the maximum height of the header or footer section, in hundredths of an inch.  
    Public PropertyMinHeightGets or sets the minimum height of the header or footer section, in hundredths of an inch.  
    Public PropertyPreserveImageAspectRatioGets or sets a boolean value indicating if the aspect ratio of the BackgroundImage should be preserved.  
    Public PropertyRightElementGets the right element of the header or footer section.  
    Public PropertyTopBorderGets the report style of the header or footer's top border.  
    Public PropertyTopMarginGets or sets the height of the header or footer section's top margin, in hundredths of an inch.  
    Public PropertyVerticalAlignmentGets or sets the vertical alignment of the header or footer section's content.  
    Top
    Public Methods
     NameDescription
    Public MethodResetBackColorResets the value of the BackColor property to its default value, Color.Empty.  
    Public MethodResetBackgroundImageResets the value of the BackgroundImage property to its default value, a null reference (Nothing in Visual Basic).  
    Public MethodResetBottomBorderResets the property values of the BottomBorder report style.  
    Public MethodResetCenterElementResets the property values of the CenterElement.  
    Public MethodResetFontResets the value of the Font property to its default value, a null reference (Nothing in Visual Basic).  
    Public MethodResetForeColorResets the value of the ForeColor property to its default value, Color.Empty.  
    Public MethodResetLeftElementResets the property values of the LeftElement.  
    Public MethodResetRightElementResets the property values of the RightElement.  
    Public MethodResetTopBorderResets the property values of the TopBorder report style.  
    Top
    Protected Methods
     NameDescription
    Protected MethodOnBackColorChangedRaises the BackColorChanged event.  
    Protected MethodOnBackgroundImageAlignmentChangedRaises the BackgroundImageAlignmentChanged event.  
    Protected MethodOnBackgroundImageChangedRaises the BackgroundImageChanged event.  
    Protected MethodOnBackgroundImageStyleChangedRaises the BackgroundImageStyleChanged event.  
    Protected MethodOnBottomMarginChangedRaises the BottomMarginChanged event.  
    Protected MethodOnFontChangedRaises the FontChanged event.  
    Protected MethodOnForeColorChangedRaises the ForeColorChanged event.  
    Protected MethodOnFormatProviderChangedRaises the FormatProviderChanged event.  
    Protected MethodOnMaxHeightChangedRaises the MaxHeightChanged event.  
    Protected MethodOnMinHeightChangedRaises the MinHeightChanged event.  
    Protected MethodOnPreserveImageAspectRatioChangedRaises the PreserveImageAspectRatioChanged event.  
    Protected MethodOnTopMarginChangedRaises the TopMarginChanged event.  
    Protected MethodOnVerticalAlignmentChangedRaises the VerticalAlignmentChanged event.  
    Top
    Public Events
     NameDescription
    Public EventBackColorChangedRaised when the value of the BackColor property is changed.  
    Public EventBackgroundImageAlignmentChangedRaised when the value of the BackgroundImageAlignment property is changed.  
    Public EventBackgroundImageChangedRaised when the value of the BackgroundImage property is changed.  
    Public EventBackgroundImageStyleChangedRaised when the value of the BackgroundImageStyle property is changed.  
    Public EventBottomMarginChangedRaised when the value of the BottomMargin property is changed.  
    Public EventFontChangedRaised when the value of the Font property is changed.  
    Public EventForeColorChangedRaised when the value of the ForeColor property is changed.  
    Public EventFormatProviderChangedRaised when the value of the FormatProvider property is changed.  
    Public EventMaxHeightChangedRaised when the value of the MaxHeight property is changed.  
    Public EventMinHeightChangedRaised when the value of the MinHeight property is changed.  
    Public EventPreserveImageAspectRatioChangedRaised when the value of the PreserveImageAspectRatio property is changed.  
    Public EventTopMarginChangedRaised when the value of the TopMargin property is changed.  
    Public EventVerticalAlignmentChangedRaised when the value of the VerticalAlignment property is changed.  
    Top
    Requirements

    Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

    See Also

    Reference

    HeaderFooter Members
    Xceed.Grid.Reporting Namespace

    Send Feedback