API Reference
Class
HeaderFooterBuilder
Fluent builder for worksheet header and footer with optional images.
Inheritance
- Object
- HeaderFooterBuilder
Usage
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by
- Method HeaderFooterBuilder.AlignWithMargins
- Method HeaderFooterBuilder.Center
- Method HeaderFooterBuilder.CenterImage
- Method HeaderFooterBuilder.CenterImageUrl
- Method HeaderFooterBuilder.DifferentFirstPage
- Method HeaderFooterBuilder.DifferentOddEven
- Method HeaderFooterBuilder.FooterCenter
- Method HeaderFooterBuilder.FooterCenterImage
- Method HeaderFooterBuilder.FooterCenterImageUrl
- Method HeaderFooterBuilder.FooterLeft
- Method HeaderFooterBuilder.FooterLeftImage
- Method HeaderFooterBuilder.FooterLeftImageUrl
- Method HeaderFooterBuilder.FooterRight
- Method HeaderFooterBuilder.FooterRightImage
- Method HeaderFooterBuilder.FooterRightImageUrl
- Method HeaderFooterBuilder.Left
- Method HeaderFooterBuilder.LeftImage
- Method HeaderFooterBuilder.LeftImageUrl
- Method HeaderFooterBuilder.Right
- Method HeaderFooterBuilder.RightImage
- Method HeaderFooterBuilder.RightImageUrl
- Method HeaderFooterBuilder.ScaleWithDocument
Accepted by parameters
- Method ExcelSheet.HeaderFooter
- Method SheetComposer.HeaderFooter
Constructors
public HeaderFooterBuilder() #Methods
public HeaderFooterBuilder AlignWithMargins(Boolean value = true) #Returns:
HeaderFooterBuilderAligns header/footer with page margins.
Parameters
- value System.Boolean = true
public HeaderFooterBuilder Center(String text) #Returns:
HeaderFooterBuilderSets center header text.
Parameters
- text System.String
public HeaderFooterBuilder CenterImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #Returns:
HeaderFooterBuilderAdds a centered header image.
Parameters
- bytes System.Byte[]
- contentType System.String = "image/png"
- widthPoints System.Nullable{System.Double} = null
- heightPoints System.Nullable{System.Double} = null
public HeaderFooterBuilder CenterImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #Returns:
HeaderFooterBuilderAdds a centered header image from URL (downloaded on apply).
Parameters
- url System.String
- widthPoints System.Nullable{System.Double} = null
- heightPoints System.Nullable{System.Double} = null
public HeaderFooterBuilder DifferentFirstPage(Boolean value = true) #Returns:
HeaderFooterBuilderUses a different header and footer on the first page.
Parameters
- value System.Boolean = true
public HeaderFooterBuilder DifferentOddEven(Boolean value = true) #Returns:
HeaderFooterBuilderUses different headers/footers for odd and even pages.
Parameters
- value System.Boolean = true
public HeaderFooterBuilder Left(String text) #Returns:
HeaderFooterBuilderSets left header text.
Parameters
- text System.String
public HeaderFooterBuilder LeftImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #Returns:
HeaderFooterBuilderAdds a left header image.
Parameters
- bytes System.Byte[]
- contentType System.String = "image/png"
- widthPoints System.Nullable{System.Double} = null
- heightPoints System.Nullable{System.Double} = null
public HeaderFooterBuilder LeftImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #Returns:
HeaderFooterBuilderAdds a left header image from URL (downloaded on apply).
Parameters
- url System.String
- Direct URL to an image (PNG/JPEG/GIF/BMP).
- widthPoints System.Nullable{System.Double} = null
- Optional width in points; inferred from image when null.
- heightPoints System.Nullable{System.Double} = null
- Optional height in points; inferred from image when null.
public HeaderFooterBuilder Right(String text) #Returns:
HeaderFooterBuilderSets right header text.
Parameters
- text System.String
public HeaderFooterBuilder RightImage(Byte[] bytes, String contentType = "image/png", Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #Returns:
HeaderFooterBuilderAdds a right header image.
Parameters
- bytes System.Byte[]
- contentType System.String = "image/png"
- widthPoints System.Nullable{System.Double} = null
- heightPoints System.Nullable{System.Double} = null
public HeaderFooterBuilder RightImageUrl(String url, Nullable<Double> widthPoints = null, Nullable<Double> heightPoints = null) #Returns:
HeaderFooterBuilderAdds a right header image from URL (downloaded on apply).
Parameters
- url System.String
- widthPoints System.Nullable{System.Double} = null
- heightPoints System.Nullable{System.Double} = null
public HeaderFooterBuilder ScaleWithDocument(Boolean value = true) #Returns:
HeaderFooterBuilderScales header/footer with document scaling.
Parameters
- value System.Boolean = true