Get Started

API Reference

Class

PdfPageBuilder

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:16
Modifiers sealed

Page-level configuration (size, margins, default styles) and content/footers.

Inheritance

  • Object
  • PdfPageBuilder

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

Accepted by parameters

Methods

public PdfPageBuilder Background(Nullable<PdfColor> color) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:38
Returns: PdfPageBuilder

Sets or clears the page background color.

Parameters

color System.Nullable{OfficeIMO.Pdf.PdfColor} requiredposition: 0
public PdfPageBuilder BackgroundBottomBand(Double height, Nullable<PdfColor> fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:225
Returns: PdfPageBuilder

Adds a page-scoped bottom background band using the current page size.

Parameters

height System.Double requiredposition: 0
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
insetX System.Double = 0 optionalposition: 2
offsetY System.Double = 0 optionalposition: 3
cornerRadius System.Double = 0 optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public PdfPageBuilder BackgroundEllipse(Double x, Double y, Double width, Double height, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:219
Returns: PdfPageBuilder

Adds a page-scoped ellipse background shape.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
BackgroundImage 2 overloads
public PdfPageBuilder BackgroundImage(PdfPageBackgroundImage image) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:184
Returns: PdfPageBuilder

Sets or clears the page-scoped background image.

Parameters

image OfficeIMO.Pdf.PdfPageBackgroundImage requiredposition: 0
public PdfPageBuilder BackgroundImage(Byte[] imageBytes, OfficeImageFit fit = Cover, Nullable<Double> opacity = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:189
Returns: PdfPageBuilder

Sets a page-scoped background image.

Parameters

imageBytes System.Byte[] requiredposition: 0
fit OfficeIMO.Drawing.OfficeImageFit = Cover optionalposition: 1
opacity System.Nullable{System.Double} = null optionalposition: 2
public PdfPageBuilder BackgroundLeftBand(Double width, Nullable<PdfColor> fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:228
Returns: PdfPageBuilder

Adds a page-scoped left background band using the current page size.

Parameters

width System.Double requiredposition: 0
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
insetY System.Double = 0 optionalposition: 2
offsetX System.Double = 0 optionalposition: 3
cornerRadius System.Double = 0 optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public PdfPageBuilder BackgroundRectangle(Double x, Double y, Double width, Double height, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:213
Returns: PdfPageBuilder

Adds a page-scoped rectangle background shape.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public PdfPageBuilder BackgroundRightBand(Double width, Nullable<PdfColor> fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:231
Returns: PdfPageBuilder

Adds a page-scoped right background band using the current page size.

Parameters

width System.Double requiredposition: 0
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
insetY System.Double = 0 optionalposition: 2
offsetX System.Double = 0 optionalposition: 3
cornerRadius System.Double = 0 optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public PdfPageBuilder BackgroundRoundedRectangle(Double x, Double y, Double width, Double height, Double cornerRadius, Nullable<PdfColor> fill = null, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:216
Returns: PdfPageBuilder

Adds a page-scoped rounded rectangle background shape.

Parameters

x System.Double requiredposition: 0
y System.Double requiredposition: 1
width System.Double requiredposition: 2
height System.Double requiredposition: 3
cornerRadius System.Double requiredposition: 4
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 6
strokeWidth System.Double = 0 optionalposition: 7
fillOpacity System.Nullable{System.Double} = null optionalposition: 8
strokeOpacity System.Nullable{System.Double} = null optionalposition: 9
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 10
public PdfPageBuilder BackgroundShape(PdfPageBackgroundShape shape) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:198
Returns: PdfPageBuilder

Adds a page-scoped background shape rendered behind page content.

Parameters

shape OfficeIMO.Pdf.PdfPageBackgroundShape requiredposition: 0
public PdfPageBuilder BackgroundShapes(IEnumerable<PdfPageBackgroundShape> shapes) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:203
Returns: PdfPageBuilder

Replaces or clears page-scoped background shapes.

Parameters

shapes System.Collections.Generic.IEnumerable{OfficeIMO.Pdf.PdfPageBackgroundShape} requiredposition: 0
public PdfPageBuilder BackgroundTopBand(Double height, Nullable<PdfColor> fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, Nullable<PdfColor> stroke = null, Double strokeWidth = 0, Nullable<Double> fillOpacity = null, Nullable<Double> strokeOpacity = null, OfficeLinearGradient fillGradient = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:222
Returns: PdfPageBuilder

Adds a page-scoped top background band using the current page size.

Parameters

height System.Double requiredposition: 0
fill System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 1
insetX System.Double = 0 optionalposition: 2
offsetY System.Double = 0 optionalposition: 3
cornerRadius System.Double = 0 optionalposition: 4
stroke System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Nullable{System.Double} = null optionalposition: 7
strokeOpacity System.Nullable{System.Double} = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient = null optionalposition: 9
public PdfPageBuilder Canvas(Action<PdfPageCanvas> build) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:331
Returns: PdfPageBuilder

Adds foreground page content at absolute top-left page coordinates.

Parameters

build System.Action{OfficeIMO.Pdf.PdfPageCanvas} requiredposition: 0
public PdfPageBuilder ClearBackgroundShapes() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:208
Returns: PdfPageBuilder

Clears page-scoped background shapes.

public PdfPageBuilder Content(Action<PdfContentBuilder> build) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:326
Returns: PdfPageBuilder

Builds the page content through the universal content receiver.

Parameters

build System.Action{OfficeIMO.Pdf.PdfContentBuilder} requiredposition: 0
public PdfPageBuilder DefaultDrawingStyle(PdfDrawingStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:321
Returns: PdfPageBuilder

Configures the default placement style for page drawing objects.

Parameters

style OfficeIMO.Pdf.PdfDrawingStyle requiredposition: 0
public PdfPageBuilder DefaultHeadingStyle(Int32 level, PdfHeadingStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:311
Returns: PdfPageBuilder

Configures the default style for a built-in heading level on the page.

Parameters

level System.Int32 requiredposition: 0
style OfficeIMO.Pdf.PdfHeadingStyle requiredposition: 1
public PdfPageBuilder DefaultHorizontalRuleStyle(PdfHorizontalRuleStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:317
Returns: PdfPageBuilder

Configures the default style for page horizontal rules.

Parameters

style OfficeIMO.Pdf.PdfHorizontalRuleStyle requiredposition: 0
public PdfPageBuilder DefaultImageStyle(PdfImageStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:319
Returns: PdfPageBuilder

Configures the default style for page images.

Parameters

style OfficeIMO.Pdf.PdfImageStyle requiredposition: 0
public PdfPageBuilder DefaultListStyle(PdfListStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:313
Returns: PdfPageBuilder

Configures the default style for page bullet and numbered lists.

Parameters

style OfficeIMO.Pdf.PdfListStyle requiredposition: 0
public PdfPageBuilder DefaultPanelStyle(PdfPanelStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:315
Returns: PdfPageBuilder

Configures the default style for page panel paragraphs.

Parameters

style OfficeIMO.Pdf.PdfPanelStyle requiredposition: 0
public PdfPageBuilder DefaultParagraphStyle(PdfParagraphStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:305
Returns: PdfPageBuilder

Configures the default paragraph style for page paragraphs that do not provide an explicit style.

Parameters

style OfficeIMO.Pdf.PdfParagraphStyle requiredposition: 0
public PdfPageBuilder DefaultRowStyle(PdfRowStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:323
Returns: PdfPageBuilder

Configures the default row/column layout style for the page.

Parameters

style OfficeIMO.Pdf.PdfRowStyle requiredposition: 0
DefaultTableStyle 2 overloads
public PdfPageBuilder DefaultTableStyle(PdfTableStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:307
Returns: PdfPageBuilder

Configures the default table style for page tables that do not provide an explicit style.

Parameters

style OfficeIMO.Pdf.PdfTableStyle requiredposition: 0
public PdfPageBuilder DefaultTableStyle(String wordTableStyleName) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:309
Returns: PdfPageBuilder

Configures the default table style for the page from a supported Word table style name.

Parameters

wordTableStyleName System.String requiredposition: 0
DefaultTextStyle 2 overloads
public PdfPageBuilder DefaultTextStyle(Action<PdfTextStyleBuilder> style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:301
Returns: PdfPageBuilder

Configures default text style for the page.

Parameters

style System.Action{OfficeIMO.Pdf.PdfTextStyleBuilder} requiredposition: 0
public PdfPageBuilder DefaultTextStyle(PdfTextStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:303
Returns: PdfPageBuilder

Configures default text style for the page from a reusable text style object.

Parameters

style OfficeIMO.Pdf.PdfTextStyle requiredposition: 0
EvenPagesImageWatermark 2 overloads
public PdfPageBuilder EvenPagesImageWatermark(PdfImageWatermark watermark) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:149
Returns: PdfPageBuilder

Sets or clears the even-page image watermark rendered behind page content.

Parameters

watermark OfficeIMO.Pdf.PdfImageWatermark requiredposition: 0
public PdfPageBuilder EvenPagesImageWatermark(Byte[] imageBytes, Double width, Double height, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:159
Returns: PdfPageBuilder

Sets an even-page image watermark rendered behind page content.

Parameters

imageBytes System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
rotationAngle System.Nullable{System.Double} = null optionalposition: 4
EvenPagesWatermark 2 overloads
public PdfPageBuilder EvenPagesWatermark(PdfTextWatermark watermark) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:90
Returns: PdfPageBuilder

Sets or clears the even-page text watermark rendered behind page content.

Parameters

watermark OfficeIMO.Pdf.PdfTextWatermark requiredposition: 0
public PdfPageBuilder EvenPagesWatermark(String text, Nullable<Double> fontSize = null, Nullable<PdfColor> color = null, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null, Nullable<PdfStandardFont> font = null, Boolean bold = true, Boolean italic = false) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:104
Returns: PdfPageBuilder

Sets an even-page text watermark rendered behind page content.

Parameters

text System.String requiredposition: 0
fontSize System.Nullable{System.Double} = null optionalposition: 1
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
rotationAngle System.Nullable{System.Double} = null optionalposition: 4
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 5
bold System.Boolean = true optionalposition: 6
italic System.Boolean = false optionalposition: 7
FirstPageImageWatermark 2 overloads
public PdfPageBuilder FirstPageImageWatermark(PdfImageWatermark watermark) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:131
Returns: PdfPageBuilder

Sets or clears the first-page image watermark rendered behind page content.

Parameters

watermark OfficeIMO.Pdf.PdfImageWatermark requiredposition: 0
public PdfPageBuilder FirstPageImageWatermark(Byte[] imageBytes, Double width, Double height, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:141
Returns: PdfPageBuilder

Sets a first-page image watermark rendered behind page content.

Parameters

imageBytes System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
rotationAngle System.Nullable{System.Double} = null optionalposition: 4
FirstPageWatermark 2 overloads
public PdfPageBuilder FirstPageWatermark(PdfTextWatermark watermark) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:62
Returns: PdfPageBuilder

Sets or clears the first-page text watermark rendered behind page content.

Parameters

watermark OfficeIMO.Pdf.PdfTextWatermark requiredposition: 0
public PdfPageBuilder FirstPageWatermark(String text, Nullable<Double> fontSize = null, Nullable<PdfColor> color = null, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null, Nullable<PdfStandardFont> font = null, Boolean bold = true, Boolean italic = false) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:76
Returns: PdfPageBuilder

Sets a first-page text watermark rendered behind page content.

Parameters

text System.String requiredposition: 0
fontSize System.Nullable{System.Double} = null optionalposition: 1
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
rotationAngle System.Nullable{System.Double} = null optionalposition: 4
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 5
bold System.Boolean = true optionalposition: 6
italic System.Boolean = false optionalposition: 7
public PdfPageBuilder Header(Action<PdfHeaderBuilder> build) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:333
Returns: PdfPageBuilder

Defines the header layout and content.

Parameters

build System.Action{OfficeIMO.Pdf.PdfHeaderBuilder} requiredposition: 0
ImageWatermark 2 overloads
public PdfPageBuilder ImageWatermark(PdfImageWatermark watermark) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:118
Returns: PdfPageBuilder

Sets or clears the page-scoped image watermark rendered behind page content.

Parameters

watermark OfficeIMO.Pdf.PdfImageWatermark requiredposition: 0
public PdfPageBuilder ImageWatermark(Byte[] imageBytes, Double width, Double height, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:123
Returns: PdfPageBuilder

Sets a page-scoped image watermark rendered behind page content.

Parameters

imageBytes System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
rotationAngle System.Nullable{System.Double} = null optionalposition: 4
public PdfPageBuilder Landscape() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:235
Returns: PdfPageBuilder

Sets page orientation to landscape while preserving the current page size dimensions.

Margin 3 overloads
public PdfPageBuilder Margin(Double all) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:238
Returns: PdfPageBuilder

Sets uniform page margins (all sides in points).

Parameters

all System.Double requiredposition: 0
public PdfPageBuilder Margin(PageMargins margins) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:244
Returns: PdfPageBuilder

Sets page margins from a reusable margin value.

Parameters

margins OfficeIMO.Pdf.PageMargins requiredposition: 0
public PdfPageBuilder Margin(Double left, Double top, Double right, Double bottom) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:249
Returns: PdfPageBuilder

Sets page margins (left, top, right, bottom in points).

Parameters

left System.Double requiredposition: 0
top System.Double requiredposition: 1
right System.Double requiredposition: 2
bottom System.Double requiredposition: 3
public PdfPageBuilder Orientation(OfficePageOrientation orientation) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:31
Returns: PdfPageBuilder

Sets page orientation while preserving the current page size dimensions.

Parameters

orientation OfficeIMO.OfficePageOrientation requiredposition: 0
PageBorder 2 overloads
public PdfPageBuilder PageBorder(PdfPageBorder border) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:167
Returns: PdfPageBuilder

Sets or clears the page-scoped page border.

Parameters

border OfficeIMO.Pdf.PdfPageBorder requiredposition: 0
public PdfPageBuilder PageBorder(Nullable<PdfColor> color = null, Nullable<Double> width = null, Nullable<Double> inset = null, Nullable<Double> opacity = null, OfficeStrokeDashStyle dashStyle = Solid) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:172
Returns: PdfPageBuilder

Sets a page-scoped page border.

Parameters

color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 0
width System.Nullable{System.Double} = null optionalposition: 1
inset System.Nullable{System.Double} = null optionalposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
dashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 4
public PdfPageBuilder PageNumberStart(Int32 start) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:268
Returns: PdfPageBuilder

Sets the first visible page number for this page or section flow.

Parameters

start System.Int32 requiredposition: 0
public PdfPageBuilder PageNumberStyle(PdfPageNumberStyle style) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:274
Returns: PdfPageBuilder

Sets the visible page-number style for this page or section flow.

Parameters

style OfficeIMO.Pdf.PdfPageNumberStyle requiredposition: 0
public PdfPageBuilder Portrait() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:233
Returns: PdfPageBuilder

Sets page orientation to portrait while preserving the current page size dimensions.

public PdfPageBuilder PrintProductionPageBoxes(PdfPrintProductionPageBoxes boxes) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:262
Returns: PdfPageBuilder

Sets or clears page-scoped TrimBox and BleedBox geometry.

Parameters

boxes OfficeIMO.Pdf.PdfPrintProductionPageBoxes requiredposition: 0
public PdfPageBuilder RegisterEmbeddedFontFallbacks(PdfEmbeddedFontFallbackSet fallbackSet) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:285
Returns: PdfPageBuilder

Registers a planned embedded-font fallback set for generated rich text runs on this composed page or section.

Parameters

fallbackSet OfficeIMO.Pdf.PdfEmbeddedFontFallbackSet requiredposition: 0
Size 2 overloads
public PdfPageBuilder Size(PageSize size) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:16
Returns: PdfPageBuilder

Sets page size using a predefined PageSize.

Parameters

size OfficeIMO.Pdf.PageSize requiredposition: 0
public PdfPageBuilder Size(Double width, Double height) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:23
Returns: PdfPageBuilder

Sets custom page size in points.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
public PdfPageBuilder SuppressEvenPagesImageWatermark() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:154
Returns: PdfPageBuilder

Suppresses the inherited image watermark on even pages.

public PdfPageBuilder SuppressEvenPagesTextWatermark() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:95
Returns: PdfPageBuilder

Suppresses the inherited text watermark on even pages.

public PdfPageBuilder SuppressEvenPagesWatermark() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:100
Returns: PdfPageBuilder

Suppresses inherited text and image watermarks on even pages.

public PdfPageBuilder SuppressFirstPageImageWatermark() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:136
Returns: PdfPageBuilder

Suppresses the inherited image watermark on the first page.

public PdfPageBuilder SuppressFirstPageTextWatermark() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:67
Returns: PdfPageBuilder

Suppresses the inherited text watermark on the first page.

public PdfPageBuilder SuppressFirstPageWatermark() #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:72
Returns: PdfPageBuilder

Suppresses inherited text and image watermarks on the first page.

public PdfPageBuilder TextHyphenation(PdfTextHyphenationCallback callback) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:297
Returns: PdfPageBuilder

Sets or clears the page-scoped generated text hyphenation callback used for long unspaced tokens.

Parameters

callback OfficeIMO.Pdf.PdfTextHyphenationCallback requiredposition: 0
public PdfPageBuilder TextHyphenationDictionary(PdfHyphenationLexicon dictionary) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:299
Returns: PdfPageBuilder

Uses or clears an immutable first-party word hyphenation dictionary.

Parameters

dictionary OfficeIMO.Pdf.PdfHyphenationLexicon requiredposition: 0
public PdfPageBuilder TextLineBreaks(Func<String, IReadOnlyList<Int32>> callback) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:295
Returns: PdfPageBuilder

Sets or clears the page-scoped generated text line-break callback used for long unspaced tokens.

Parameters

callback System.Func{System.String,System.Collections.Generic.IReadOnlyList{System.Int32}} requiredposition: 0
public PdfPageBuilder Theme(PdfTheme theme) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:279
Returns: PdfPageBuilder

Applies reusable page-scoped default styles.

Parameters

theme OfficeIMO.Pdf.PdfTheme requiredposition: 0
public PdfPageBuilder Typography(OfficeRenderingProfile profile, OfficeRenderingProfileApplyMode mode = Replace) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:281
Returns: PdfPageBuilder

Applies a shared, page-scoped font, fallback, language, and shaping profile.

Parameters

profile OfficeIMO.Drawing.OfficeRenderingProfile requiredposition: 0
mode OfficeIMO.Drawing.OfficeRenderingProfileApplyMode = Replace optionalposition: 1
public PdfPageBuilder UseEmbeddedFontFallbacksFromSystem(String familyNames, Int32 maxFallbackFonts = 2) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:289
Returns: PdfPageBuilder

Registers generated-text fallback fonts from installed system font families without requiring callers to choose PDF font slots.

Parameters

familyNames System.String requiredposition: 0
maxFallbackFonts System.Int32 = 2 optionalposition: 1
UseFontFamily 3 overloads
public PdfPageBuilder UseFontFamily(PdfEmbeddedFontFamily fontFamily) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:283
Returns: PdfPageBuilder

Uses a caller-supplied TrueType font family for this composed page or section.

Parameters

fontFamily OfficeIMO.Pdf.PdfEmbeddedFontFamily requiredposition: 0
public PdfPageBuilder UseFontFamily(String familyName, Byte[] regular, Byte[] bold = null, Byte[] italic = null, Byte[] boldItalic = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:291
Returns: PdfPageBuilder

Uses caller-supplied TrueType font files for this composed page or section.

Parameters

familyName System.String requiredposition: 0
regular System.Byte[] requiredposition: 1
bold System.Byte[] = null optionalposition: 2
italic System.Byte[] = null optionalposition: 3
boldItalic System.Byte[] = null optionalposition: 4
public PdfPageBuilder UseFontFamily(String familyName, String regularPath, String boldPath = null, String italicPath = null, String boldItalicPath = null) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:293
Returns: PdfPageBuilder

Uses caller-supplied TrueType font files for this composed page or section.

Parameters

familyName System.String requiredposition: 0
regularPath System.String requiredposition: 1
boldPath System.String = null optionalposition: 2
italicPath System.String = null optionalposition: 3
boldItalicPath System.String = null optionalposition: 4
public PdfPageBuilder UseTextFallbacks(PdfTextFallbackFeatures features = Default) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:287
Returns: PdfPageBuilder

Applies OfficeIMO's built-in generated-text fallback groups for this composed page or section.

Parameters

features OfficeIMO.Pdf.PdfTextFallbackFeatures = Default optionalposition: 0
Watermark 2 overloads
public PdfPageBuilder Watermark(PdfTextWatermark watermark) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:43
Returns: PdfPageBuilder

Sets or clears the page-scoped text watermark rendered behind page content.

Parameters

watermark OfficeIMO.Pdf.PdfTextWatermark requiredposition: 0
public PdfPageBuilder Watermark(String text, Nullable<Double> fontSize = null, Nullable<PdfColor> color = null, Nullable<Double> opacity = null, Nullable<Double> rotationAngle = null, Nullable<PdfStandardFont> font = null, Boolean bold = true, Boolean italic = false) #
OfficeIMO.Pdf/Compose/PdfPageBuilder.cs:48
Returns: PdfPageBuilder

Sets a page-scoped text watermark rendered behind page content.

Parameters

text System.String requiredposition: 0
fontSize System.Nullable{System.Double} = null optionalposition: 1
color System.Nullable{OfficeIMO.Pdf.PdfColor} = null optionalposition: 2
opacity System.Nullable{System.Double} = null optionalposition: 3
rotationAngle System.Nullable{System.Double} = null optionalposition: 4
font System.Nullable{OfficeIMO.Pdf.PdfStandardFont} = null optionalposition: 5
bold System.Boolean = true optionalposition: 6
italic System.Boolean = false optionalposition: 7