Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, PowerShell module, CLI, Studio and browser tools 622 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

PdfPageBuilder

Edit on GitHub
Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Source revision 33d062b583cb with working tree changes
Source PdfPageBuilder.cs:16
Modifiers sealed

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

Inheritance

  • Object
  • PdfPageBuilder

Usage

Explore 60 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 58

Accepted by parameters 2

Methods

public PdfPageBuilder Background(PdfColor? color) #
PdfPageBuilder.cs:45
Returns: PdfPageBuilder

Sets or clears the page background color.

Parameters

color OfficeIMO.Pdf.PdfColor? requiredposition: 0
public PdfPageBuilder BackgroundBottomBand(Double height, PdfColor? fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:232
Returns: PdfPageBuilder

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

Parameters

height System.Double requiredposition: 0
fill 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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Double? = null optionalposition: 7
strokeOpacity System.Double? = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient? = null optionalposition: 9
public PdfPageBuilder BackgroundEllipse(Double x, Double y, Double width, Double height, PdfColor? fill = null, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:226
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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 4
stroke OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Double? = null optionalposition: 7
strokeOpacity System.Double? = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient? = null optionalposition: 9
BackgroundImage 2 overloads
public PdfPageBuilder BackgroundImage(PdfPageBackgroundImage? image) #
PdfPageBuilder.cs:191
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, Double? opacity = null) #
PdfPageBuilder.cs:196
Returns: PdfPageBuilder

Sets a page-scoped background image.

Parameters

imageBytes System.Byte[] requiredposition: 0
fit OfficeIMO.Drawing.OfficeImageFit = Cover optionalposition: 1
opacity System.Double? = null optionalposition: 2
public PdfPageBuilder BackgroundLeftBand(Double width, PdfColor? fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:235
Returns: PdfPageBuilder

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

Parameters

width System.Double requiredposition: 0
fill 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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Double? = null optionalposition: 7
strokeOpacity System.Double? = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient? = null optionalposition: 9
public PdfPageBuilder BackgroundRectangle(Double x, Double y, Double width, Double height, PdfColor? fill = null, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:220
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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 4
stroke OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Double? = null optionalposition: 7
strokeOpacity System.Double? = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient? = null optionalposition: 9
public PdfPageBuilder BackgroundRightBand(Double width, PdfColor? fill = null, Double insetY = 0, Double offsetX = 0, Double cornerRadius = 0, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:238
Returns: PdfPageBuilder

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

Parameters

width System.Double requiredposition: 0
fill 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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Double? = null optionalposition: 7
strokeOpacity 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, PdfColor? fill = null, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:223
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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
stroke OfficeIMO.Pdf.PdfColor? = null optionalposition: 6
strokeWidth System.Double = 0 optionalposition: 7
fillOpacity System.Double? = null optionalposition: 8
strokeOpacity System.Double? = null optionalposition: 9
fillGradient OfficeIMO.Drawing.OfficeLinearGradient? = null optionalposition: 10
public PdfPageBuilder BackgroundShape(PdfPageBackgroundShape shape) #
PdfPageBuilder.cs:205
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) #
PdfPageBuilder.cs:210
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, PdfColor? fill = null, Double insetX = 0, Double offsetY = 0, Double cornerRadius = 0, PdfColor? stroke = null, Double strokeWidth = 0, Double? fillOpacity = null, Double? strokeOpacity = null, OfficeLinearGradient? fillGradient = null) #
PdfPageBuilder.cs:229
Returns: PdfPageBuilder

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

Parameters

height System.Double requiredposition: 0
fill 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 OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
strokeWidth System.Double = 0 optionalposition: 6
fillOpacity System.Double? = null optionalposition: 7
strokeOpacity System.Double? = null optionalposition: 8
fillGradient OfficeIMO.Drawing.OfficeLinearGradient? = null optionalposition: 9
public PdfPageBuilder Canvas(Action<PdfPageCanvas> build) #
PdfPageBuilder.cs:343
Returns: PdfPageBuilder

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

Parameters

build System.Action<OfficeIMO.Pdf.PdfPageCanvas> requiredposition: 0
public PdfPageBuilder ClearBackgroundShapes() #
PdfPageBuilder.cs:215
Returns: PdfPageBuilder

Clears page-scoped background shapes.

public PdfPageBuilder Content(Action<PdfContentBuilder> build) #
PdfPageBuilder.cs:338
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) #
PdfPageBuilder.cs:333
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) #
PdfPageBuilder.cs:323
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) #
PdfPageBuilder.cs:329
Returns: PdfPageBuilder

Configures the default style for page horizontal rules.

Parameters

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

Configures the default style for page images.

Parameters

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

Configures the default style for page bullet and numbered lists.

Parameters

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

Configures the default style for page panel paragraphs.

Parameters

style OfficeIMO.Pdf.PdfPanelStyle requiredposition: 0
public PdfPageBuilder DefaultParagraphStyle(PdfParagraphStyle style) #
PdfPageBuilder.cs:317
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) #
PdfPageBuilder.cs:335
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) #
PdfPageBuilder.cs:319
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) #
PdfPageBuilder.cs:321
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) #
PdfPageBuilder.cs:313
Returns: PdfPageBuilder

Configures default text style for the page.

Parameters

style System.Action<OfficeIMO.Pdf.PdfTextStyleBuilder> requiredposition: 0
public PdfPageBuilder DefaultTextStyle(PdfTextStyle style) #
PdfPageBuilder.cs:315
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) #
PdfPageBuilder.cs:156
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, Double? opacity = null, Double? rotationAngle = null) #
PdfPageBuilder.cs:166
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.Double? = null optionalposition: 3
rotationAngle System.Double? = null optionalposition: 4
EvenPagesWatermark 2 overloads
public PdfPageBuilder EvenPagesWatermark(PdfTextWatermark? watermark) #
PdfPageBuilder.cs:97
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, Double? fontSize = null, PdfColor? color = null, Double? opacity = null, Double? rotationAngle = null, PdfStandardFont? font = null, Boolean bold = true, Boolean italic = false) #
PdfPageBuilder.cs:111
Returns: PdfPageBuilder

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

Parameters

text System.String requiredposition: 0
fontSize System.Double? = null optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
opacity System.Double? = null optionalposition: 3
rotationAngle System.Double? = null optionalposition: 4
font 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) #
PdfPageBuilder.cs:138
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, Double? opacity = null, Double? rotationAngle = null) #
PdfPageBuilder.cs:148
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.Double? = null optionalposition: 3
rotationAngle System.Double? = null optionalposition: 4
FirstPageWatermark 2 overloads
public PdfPageBuilder FirstPageWatermark(PdfTextWatermark? watermark) #
PdfPageBuilder.cs:69
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, Double? fontSize = null, PdfColor? color = null, Double? opacity = null, Double? rotationAngle = null, PdfStandardFont? font = null, Boolean bold = true, Boolean italic = false) #
PdfPageBuilder.cs:83
Returns: PdfPageBuilder

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

Parameters

text System.String requiredposition: 0
fontSize System.Double? = null optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
opacity System.Double? = null optionalposition: 3
rotationAngle System.Double? = null optionalposition: 4
font OfficeIMO.Pdf.PdfStandardFont? = null optionalposition: 5
bold System.Boolean = true optionalposition: 6
italic System.Boolean = false optionalposition: 7
public PdfPageBuilder Header(Action<PdfHeaderBuilder> build) #
PdfPageBuilder.cs:345
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) #
PdfPageBuilder.cs:125
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, Double? opacity = null, Double? rotationAngle = null) #
PdfPageBuilder.cs:130
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.Double? = null optionalposition: 3
rotationAngle System.Double? = null optionalposition: 4
public PdfPageBuilder Landscape() #
PdfPageBuilder.cs:242
Returns: PdfPageBuilder

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

Margin 3 overloads
public PdfPageBuilder Margin(Double all) #
PdfPageBuilder.cs:245
Returns: PdfPageBuilder

Sets uniform page margins (all sides in points).

Parameters

all System.Double requiredposition: 0
public PdfPageBuilder Margin(PageMargins margins) #
PdfPageBuilder.cs:251
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) #
PdfPageBuilder.cs:261
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 MirrorMargins(Boolean enabled = true) #
PdfPageBuilder.cs:256
Returns: PdfPageBuilder

Swaps left and right margins on even visible page numbers, including numbering restarts.

Parameters

enabled System.Boolean = true optionalposition: 0
public PdfPageBuilder Orientation(OfficePageOrientation orientation) #
PdfPageBuilder.cs:38
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) #
PdfPageBuilder.cs:174
Returns: PdfPageBuilder

Sets or clears the page-scoped page border.

Parameters

border OfficeIMO.Pdf.PdfPageBorder? requiredposition: 0
public PdfPageBuilder PageBorder(PdfColor? color = null, Double? width = null, Double? inset = null, Double? opacity = null, OfficeStrokeDashStyle dashStyle = Solid) #
PdfPageBuilder.cs:179
Returns: PdfPageBuilder

Sets a page-scoped page border.

Parameters

color OfficeIMO.Pdf.PdfColor? = null optionalposition: 0
width System.Double? = null optionalposition: 1
inset System.Double? = null optionalposition: 2
opacity System.Double? = null optionalposition: 3
dashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 4
public PdfPageBuilder PageNumberStart(Int32 start) #
PdfPageBuilder.cs:280
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) #
PdfPageBuilder.cs:286
Returns: PdfPageBuilder

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

Parameters

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

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

public PdfPageBuilder PrintProductionPageBoxes(PdfPrintProductionPageBoxes? boxes) #
PdfPageBuilder.cs:274
Returns: PdfPageBuilder

Sets or clears page-scoped TrimBox and BleedBox geometry.

Parameters

boxes OfficeIMO.Pdf.PdfPrintProductionPageBoxes? requiredposition: 0
public PdfPageBuilder RegisterEmbeddedFontFallbacks(PdfEmbeddedFontFallbackSet fallbackSet) #
PdfPageBuilder.cs:297
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) #
PdfPageBuilder.cs:23
Returns: PdfPageBuilder

Sets page size using a predefined PageSize.

Parameters

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

Sets custom page size in points.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
public PdfPageBuilder StartOnPageParity(PdfPageParity? parity, Boolean useContinuingPageNumber = false) #
PdfPageBuilder.cs:16
Returns: PdfPageBuilder

Sets or clears the parity required at the start of a later page group. Optionally uses the continuing page number before this group's numbering restart.

Parameters

parity OfficeIMO.Pdf.PdfPageParity? requiredposition: 0
useContinuingPageNumber System.Boolean = false optionalposition: 1
public PdfPageBuilder SuppressEvenPagesImageWatermark() #
PdfPageBuilder.cs:161
Returns: PdfPageBuilder

Suppresses the inherited image watermark on even pages.

public PdfPageBuilder SuppressEvenPagesTextWatermark() #
PdfPageBuilder.cs:102
Returns: PdfPageBuilder

Suppresses the inherited text watermark on even pages.

public PdfPageBuilder SuppressEvenPagesWatermark() #
PdfPageBuilder.cs:107
Returns: PdfPageBuilder

Suppresses inherited text and image watermarks on even pages.

public PdfPageBuilder SuppressFirstPageImageWatermark() #
PdfPageBuilder.cs:143
Returns: PdfPageBuilder

Suppresses the inherited image watermark on the first page.

public PdfPageBuilder SuppressFirstPageTextWatermark() #
PdfPageBuilder.cs:74
Returns: PdfPageBuilder

Suppresses the inherited text watermark on the first page.

public PdfPageBuilder SuppressFirstPageWatermark() #
PdfPageBuilder.cs:79
Returns: PdfPageBuilder

Suppresses inherited text and image watermarks on the first page.

public PdfPageBuilder TextHyphenation(PdfTextHyphenationCallback? callback) #
PdfPageBuilder.cs:309
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) #
PdfPageBuilder.cs:311
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) #
PdfPageBuilder.cs:307
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) #
PdfPageBuilder.cs:291
Returns: PdfPageBuilder

Applies reusable page-scoped default styles.

Parameters

theme OfficeIMO.Pdf.PdfTheme requiredposition: 0
public PdfPageBuilder Typography(OfficeRenderingProfile profile, OfficeRenderingProfileApplyMode mode = Replace) #
PdfPageBuilder.cs:293
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) #
PdfPageBuilder.cs:301
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) #
PdfPageBuilder.cs:295
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) #
PdfPageBuilder.cs:303
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) #
PdfPageBuilder.cs:305
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) #
PdfPageBuilder.cs:299
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) #
PdfPageBuilder.cs:50
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, Double? fontSize = null, PdfColor? color = null, Double? opacity = null, Double? rotationAngle = null, PdfStandardFont? font = null, Boolean bold = true, Boolean italic = false) #
PdfPageBuilder.cs:55
Returns: PdfPageBuilder

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

Parameters

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