GemBox.Spreadsheet
  • Overview
  • Examples
  • Free version
  • Support
  • Pricelist

    Show / Hide Table of Contents

    HeaderFooterSection Class

    Namespace:
    GemBox.Spreadsheet
    Assembly:
    GemBox.Spreadsheet.dll

    Represents HeaderFooter section.

    • C#
    • VB.NET
    public sealed class HeaderFooterSection
    Public NotInheritable Class HeaderFooterSection
    Inheritance:
    System.Object
    HeaderFooterSection

    Constructors

    HeaderFooterSection()

    HeaderFooterSection constructor.

    • C#
    • VB.NET
    public HeaderFooterSection()
    Public Sub New

    Properties

    Content

    Gets or sets HeaderFooter section content.

    • C#
    • VB.NET
    public string Content { get; set; }
    Public Property Content As String
    Property Value
    System.String
    Remarks

    The header string may contain special commands, for example placeholders for the page number, current date, or text formatting attributes. These fields are represented by single letters (exception: font name and size) with a leading ampersand. If the ampersand is part of the regular header text, it will be duplicated.

    For more information consult Microsoft Excel documentation.

    Methods

    Append(HeaderFooterFieldType)

    Appends special header/footer field to Content.

    • C#
    • VB.NET
    public HeaderFooterSection Append(HeaderFooterFieldType fieldType)
    Public Function Append(fieldType As HeaderFooterFieldType) As HeaderFooterSection
    Parameters
    fieldType
    HeaderFooterFieldType

    Special Header/Footer field.

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    Append(HeaderFooterFieldType, ExcelFont)

    Appends special header/footer field to Content.

    • C#
    • VB.NET
    public HeaderFooterSection Append(HeaderFooterFieldType fieldType, ExcelFont font)
    Public Function Append(fieldType As HeaderFooterFieldType, font As ExcelFont) As HeaderFooterSection
    Parameters
    fieldType
    HeaderFooterFieldType

    Special Header/Footer field.

    font
    ExcelFont

    Desired ExcelFont font.

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    Append(String)

    Appends text to Content.

    • C#
    • VB.NET
    public HeaderFooterSection Append(string text)
    Public Function Append(text As String) As HeaderFooterSection
    Parameters
    text
    System.String

    Text to append.

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    Append(String, ExcelFont)

    Appends text to Content.

    • C#
    • VB.NET
    public HeaderFooterSection Append(string text, ExcelFont font)
    Public Function Append(text As String, font As ExcelFont) As HeaderFooterSection
    Parameters
    text
    System.String

    Text to append.

    font
    ExcelFont

    Desired ExcelFont font.

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    AppendPicture(MemoryStream, ExcelPictureFormat)

    Appends picture to this HeaderFooterSection instance.

    • C#
    • VB.NET
    public HeaderFooterSection AppendPicture(MemoryStream pictureStream, ExcelPictureFormat imageFormat)
    Public Function AppendPicture(pictureStream As MemoryStream, imageFormat As ExcelPictureFormat) As HeaderFooterSection
    Parameters
    pictureStream
    System.IO.MemoryStream

    Stream of the picture to be added.

    imageFormat
    ExcelPictureFormat

    Picture format.

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    AppendPicture(MemoryStream, ExcelPictureFormat, Int32, Int32)

    Appends picture to this HeaderFooterSection instance.

    • C#
    • VB.NET
    public HeaderFooterSection AppendPicture(MemoryStream pictureStream, ExcelPictureFormat imageFormat, int width, int height)
    Public Function AppendPicture(pictureStream As MemoryStream, imageFormat As ExcelPictureFormat, width As Integer, height As Integer) As HeaderFooterSection
    Parameters
    pictureStream
    System.IO.MemoryStream

    Stream of the picture to be added.

    imageFormat
    ExcelPictureFormat

    Picture format.

    width
    System.Int32

    Picture width (in pixels).

    height
    System.Int32

    Picture height (in pixels).

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    AppendPicture(String)

    Appends picture to this HeaderFooterSection instance.

    • C#
    • VB.NET
    public HeaderFooterSection AppendPicture(string fileName)
    Public Function AppendPicture(fileName As String) As HeaderFooterSection
    Parameters
    fileName
    System.String

    The fileName of the file that contains picture.

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    AppendPicture(String, Int32, Int32)

    Appends picture to this HeaderFooterSection instance.

    • C#
    • VB.NET
    public HeaderFooterSection AppendPicture(string fileName, int width, int height)
    Public Function AppendPicture(fileName As String, width As Integer, height As Integer) As HeaderFooterSection
    Parameters
    fileName
    System.String

    The fileName of the file that contains picture.

    width
    System.Int32

    Picture width (in pixels).

    height
    System.Int32

    Picture height (in pixels).

    Returns
    HeaderFooterSection

    A reference to this instance after the append operation has completed.

    Back to top

    Facebook • Twitter • LinkedIn

    © GemBox Ltd. — All rights reserved.