OfficeIMO

API Reference

Class

HeaderFooterBuilder

Namespace OfficeIMO.Excel.Fluent
Assembly OfficeIMO.Excel
Modifiers sealed

Fluent builder for worksheet header and footer with optional images.

Inheritance

  • Object
  • HeaderFooterBuilder

Constructors

Methods

public HeaderFooterBuilder AlignWithMargins(Boolean value = true) #
Returns: HeaderFooterBuilder

Aligns header/footer with page margins.

Parameters

value System.Boolean = true optionalposition: 0
public HeaderFooterBuilder Center(String text) #
Returns: HeaderFooterBuilder

Sets center header text.

Parameters

text System.String requiredposition: 0
public HeaderFooterBuilder CenterImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a centered header image.

Parameters

bytes System.Byte[] requiredposition: 0
contentType System.String = "image/png" optionalposition: 1
widthPoints System.Nullable{System.Double} = null optionalposition: 2
heightPoints System.Nullable{System.Double} = null optionalposition: 3
public HeaderFooterBuilder CenterImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a centered header image from URL (downloaded on apply).

Parameters

url System.String requiredposition: 0
widthPoints System.Nullable{System.Double} = null optionalposition: 1
heightPoints System.Nullable{System.Double} = null optionalposition: 2
public HeaderFooterBuilder DifferentFirstPage(Boolean value = true) #
Returns: HeaderFooterBuilder

Uses a different header and footer on the first page.

Parameters

value System.Boolean = true optionalposition: 0
public HeaderFooterBuilder DifferentOddEven(Boolean value = true) #
Returns: HeaderFooterBuilder

Uses different headers/footers for odd and even pages.

Parameters

value System.Boolean = true optionalposition: 0
public HeaderFooterBuilder FooterCenter(String text) #
Returns: HeaderFooterBuilder

Sets center footer text.

Parameters

text System.String requiredposition: 0
public HeaderFooterBuilder FooterCenterImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a centered footer image.

Parameters

bytes System.Byte[] requiredposition: 0
contentType System.String = "image/png" optionalposition: 1
widthPoints System.Nullable{System.Double} = null optionalposition: 2
heightPoints System.Nullable{System.Double} = null optionalposition: 3
public HeaderFooterBuilder FooterCenterImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a centered footer image from URL (downloaded on apply).

Parameters

url System.String requiredposition: 0
widthPoints System.Nullable{System.Double} = null optionalposition: 1
heightPoints System.Nullable{System.Double} = null optionalposition: 2
public HeaderFooterBuilder FooterLeft(String text) #
Returns: HeaderFooterBuilder

Sets left footer text.

Parameters

text System.String requiredposition: 0
public HeaderFooterBuilder FooterLeftImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a left footer image.

Parameters

bytes System.Byte[] requiredposition: 0
contentType System.String = "image/png" optionalposition: 1
widthPoints System.Nullable{System.Double} = null optionalposition: 2
heightPoints System.Nullable{System.Double} = null optionalposition: 3
public HeaderFooterBuilder FooterLeftImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a left footer image from URL (downloaded on apply).

Parameters

url System.String requiredposition: 0
widthPoints System.Nullable{System.Double} = null optionalposition: 1
heightPoints System.Nullable{System.Double} = null optionalposition: 2
public HeaderFooterBuilder FooterRight(String text) #
Returns: HeaderFooterBuilder

Sets right footer text.

Parameters

text System.String requiredposition: 0
public HeaderFooterBuilder FooterRightImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a right footer image.

Parameters

bytes System.Byte[] requiredposition: 0
contentType System.String = "image/png" optionalposition: 1
widthPoints System.Nullable{System.Double} = null optionalposition: 2
heightPoints System.Nullable{System.Double} = null optionalposition: 3
public HeaderFooterBuilder FooterRightImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a right footer image from URL (downloaded on apply).

Parameters

url System.String requiredposition: 0
widthPoints System.Nullable{System.Double} = null optionalposition: 1
heightPoints System.Nullable{System.Double} = null optionalposition: 2
Image(System.Boolean arg1, OfficeIMO.Excel.HeaderFooterPosition arg2, System.Byte[] arg3, System.String arg4, System.Nullable{System.Double} arg5, System.Nullable{System.Double} arg6) #

Adds header/footer image from raw bytes.

Parameters

arg1 System.Boolean required
arg2 OfficeIMO.Excel.HeaderFooterPosition required
arg3 System.Byte[] required
arg4 System.String required
arg5 System.Nullable{System.Double} required
arg6 System.Nullable{System.Double} required
public HeaderFooterBuilder Left(String text) #
Returns: HeaderFooterBuilder

Sets left header text.

Parameters

text System.String requiredposition: 0
public HeaderFooterBuilder LeftImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a left header image.

Parameters

bytes System.Byte[] requiredposition: 0
contentType System.String = "image/png" optionalposition: 1
widthPoints System.Nullable{System.Double} = null optionalposition: 2
heightPoints System.Nullable{System.Double} = null optionalposition: 3
public HeaderFooterBuilder LeftImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a left header image from URL (downloaded on apply).

Parameters

url System.String requiredposition: 0
Direct URL to an image (PNG/JPEG/GIF/BMP).
widthPoints System.Nullable{System.Double} = null optionalposition: 1
Optional width in points; inferred from image when null.
heightPoints System.Nullable{System.Double} = null optionalposition: 2
Optional height in points; inferred from image when null.
public HeaderFooterBuilder Right(String text) #
Returns: HeaderFooterBuilder

Sets right header text.

Parameters

text System.String requiredposition: 0
public HeaderFooterBuilder RightImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a right header image.

Parameters

bytes System.Byte[] requiredposition: 0
contentType System.String = "image/png" optionalposition: 1
widthPoints System.Nullable{System.Double} = null optionalposition: 2
heightPoints System.Nullable{System.Double} = null optionalposition: 3
public HeaderFooterBuilder RightImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #
Returns: HeaderFooterBuilder

Adds a right header image from URL (downloaded on apply).

Parameters

url System.String requiredposition: 0
widthPoints System.Nullable{System.Double} = null optionalposition: 1
heightPoints System.Nullable{System.Double} = null optionalposition: 2
public HeaderFooterBuilder ScaleWithDocument(Boolean value = true) #
Returns: HeaderFooterBuilder

Scales header/footer with document scaling.

Parameters

value System.Boolean = true optionalposition: 0