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

PdfContentBuilder

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

Builds document flow at any supported nesting level. The same receiver is used for document content, page content, rows, columns, containers, components, and deferred content.

Inheritance

  • Object
  • PdfContentBuilder

Usage

Explore 81 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 52

Accepted by parameters 29

Methods

public PdfContentBuilder Bookmark(String name) #
PdfContentBuilder.cs:146
Returns: PdfContentBuilder

Adds a named bookmark at the current flow position.

Parameters

name System.String requiredposition: 0
public PdfContentBuilder Bullets(IEnumerable<String> items, PdfAlign align = Left, PdfColor? color = null, PdfListStyle? style = null) #
PdfContentBuilder.cs:106
Returns: PdfContentBuilder

Adds a simple bullet list.

Parameters

items System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
style OfficeIMO.Pdf.PdfListStyle? = null optionalposition: 3
public PdfContentBuilder Canvas(Action<PdfPageCanvas> build) #
PdfContentBuilder.cs:67
Returns: PdfContentBuilder

Adds page-canvas drawing commands to the current flow.

Parameters

build System.Action<OfficeIMO.Pdf.PdfPageCanvas> requiredposition: 0
public PdfContentBuilder CheckBox(String name, Boolean isChecked = false, Double size = 14, PdfAlign align = Left, Double spacingBefore = 0, Double spacingAfter = 6, String checkedValueName = "Yes", PdfFormFieldStyle? style = null) #
PdfContentBuilder.cs:150
Returns: PdfContentBuilder

Adds a simple AcroForm check box at the current flow position.

Parameters

name System.String requiredposition: 0
isChecked System.Boolean = false optionalposition: 1
size System.Double = 14 optionalposition: 2
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 3
spacingBefore System.Double = 0 optionalposition: 4
spacingAfter System.Double = 6 optionalposition: 5
checkedValueName System.String = "Yes" optionalposition: 6
style OfficeIMO.Pdf.PdfFormFieldStyle? = null optionalposition: 7
public PdfContentBuilder ChoiceField(String name, IEnumerable<String> options, String? value = null, Double width = 180, Double height = 22, PdfAlign align = Left, Double fontSize = 10, Double spacingBefore = 0, Double spacingAfter = 6, Boolean isComboBox = true, PdfFormFieldStyle? style = null) #
PdfContentBuilder.cs:152
Returns: PdfContentBuilder

Adds a simple AcroForm choice field at the current flow position.

Parameters

name System.String requiredposition: 0
options System.Collections.Generic.IEnumerable<System.String> requiredposition: 1
value System.String? = null optionalposition: 2
width System.Double = 180 optionalposition: 3
height System.Double = 22 optionalposition: 4
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 5
fontSize System.Double = 10 optionalposition: 6
spacingBefore System.Double = 0 optionalposition: 7
spacingAfter System.Double = 6 optionalposition: 8
isComboBox System.Boolean = true optionalposition: 9
style OfficeIMO.Pdf.PdfFormFieldStyle? = null optionalposition: 10
public PdfContentBuilder Column(Action<PdfContentBuilder> build) #
PdfContentBuilder.cs:26
Returns: PdfContentBuilder

Adds a vertical content sequence using this same universal receiver.

Parameters

build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 0
public PdfContentBuilder ColumnBreak() #
PdfContentBuilder.cs:53
Returns: PdfContentBuilder

Advances automatic multi-column flow to the next column.

public PdfContentBuilder Columns(Action<PdfContentBuilder> build, PdfMultiColumnOptions? options = null) #
PdfContentBuilder.cs:51
Returns: PdfContentBuilder

Flows common block content across equal-width columns in reading order.

Parameters

build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 0
options OfficeIMO.Pdf.PdfMultiColumnOptions? = null optionalposition: 1
Component 2 overloads
public PdfContentBuilder Component(IPdfComponent component, PdfFlowOptions? options = null, PdfLayoutPositionCapture? capture = null) #
PdfContentBuilder.cs:31
Returns: PdfContentBuilder

Adds a reusable typed component through the canonical flow engine.

Parameters

component OfficeIMO.Pdf.IPdfComponent requiredposition: 0
options OfficeIMO.Pdf.PdfFlowOptions? = null optionalposition: 1
capture OfficeIMO.Pdf.PdfLayoutPositionCapture? = null optionalposition: 2
public PdfContentBuilder Component(IPdfContextComponent component, PdfFlowOptions? options = null, PdfLayoutPositionCapture? capture = null) #
PdfContentBuilder.cs:33
Returns: PdfContentBuilder

Adds a reusable page-aware component through the canonical deferred-flow engine.

Parameters

component OfficeIMO.Pdf.IPdfContextComponent requiredposition: 0
options OfficeIMO.Pdf.PdfFlowOptions? = null optionalposition: 1
capture OfficeIMO.Pdf.PdfLayoutPositionCapture? = null optionalposition: 2
public PdfContentBuilder Deferred(Func<PdfFlowContext, Action<PdfContentBuilder>> build, PdfFlowOptions? options = null, PdfLayoutPositionCapture? capture = null) #
PdfContentBuilder.cs:37
Returns: PdfContentBuilder

Adds replayable content materialized from the live page context during layout.

Parameters

build System.Func<OfficeIMO.Pdf.PdfFlowContext, System.Action<OfficeIMO.Pdf.PdfContentBuilder>> requiredposition: 0
options OfficeIMO.Pdf.PdfFlowOptions? = null optionalposition: 1
capture OfficeIMO.Pdf.PdfLayoutPositionCapture? = null optionalposition: 2
public PdfContentBuilder Drawing(OfficeDrawing drawing, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:166
Returns: PdfContentBuilder

Adds a shared OfficeIMO.Drawing scene.

Parameters

drawing OfficeIMO.Drawing.OfficeDrawing requiredposition: 0
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 1
spacingBefore System.Double? = null optionalposition: 2
spacingAfter System.Double? = null optionalposition: 3
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 4
linkUri System.String? = null optionalposition: 5
linkContents System.String? = null optionalposition: 6
public PdfContentBuilder Element(Action<PdfElementBuilder> build) #
PdfContentBuilder.cs:132
Returns: PdfContentBuilder

Builds a visual and semantic envelope around nested flow content.

Parameters

build System.Action<OfficeIMO.Pdf.PdfElementBuilder> requiredposition: 0
Element layout, semantics, and content configuration.
public PdfContentBuilder Ellipse(Double width, Double height, PdfColor? strokeColor = null, Double strokeWidth = 1, PdfColor? fillColor = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, OfficeStrokeLineCap? strokeLineCap = null, OfficeStrokeLineJoin? strokeLineJoin = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:174
Returns: PdfContentBuilder

Adds an ellipse vector shape.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
strokeColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
strokeWidth System.Double = 1 optionalposition: 3
fillColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 4
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 5
spacingBefore System.Double? = null optionalposition: 6
spacingAfter System.Double? = null optionalposition: 7
strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 8
strokeLineCap OfficeIMO.Drawing.OfficeStrokeLineCap? = null optionalposition: 9
strokeLineJoin OfficeIMO.Drawing.OfficeStrokeLineJoin? = null optionalposition: 10
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 11
linkUri System.String? = null optionalposition: 12
linkContents System.String? = null optionalposition: 13
public PdfContentBuilder Flow(Action<PdfContentBuilder> build, PdfFlowOptions? options = null, PdfLayoutPositionCapture? capture = null) #
PdfContentBuilder.cs:35
Returns: PdfContentBuilder

Adds a nested flow group with optional constraints and position capture.

Parameters

build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 0
options OfficeIMO.Pdf.PdfFlowOptions? = null optionalposition: 1
capture OfficeIMO.Pdf.PdfLayoutPositionCapture? = null optionalposition: 2
public PdfContentBuilder FreeTextAnnotation(String contents, Double width, Double height, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, Double fontSize = 10, PdfColor? textColor = null, PdfColor? borderColor = null, Double borderWidth = 1, PdfColor? fillColor = null, PdfAlign textAlign = Left, Double padding = 3, Double? lineHeight = null) #
PdfContentBuilder.cs:160
Returns: PdfContentBuilder

Adds a PDF free-text annotation at the current flow position.

Parameters

contents System.String requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 3
spacingBefore System.Double? = null optionalposition: 4
spacingAfter System.Double? = null optionalposition: 5
fontSize System.Double = 10 optionalposition: 6
textColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 7
borderColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 8
borderWidth System.Double = 1 optionalposition: 9
fillColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 10
textAlign OfficeIMO.Pdf.PdfAlign = Left optionalposition: 11
padding System.Double = 3 optionalposition: 12
lineHeight System.Double? = null optionalposition: 13
H1 2 overloads
public PdfContentBuilder H1(String text, PdfHeadingStyle? style = null, String? linkUri = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:82
Returns: PdfContentBuilder

Adds an H1 heading.

Parameters

text System.String requiredposition: 0
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 1
linkUri System.String? = null optionalposition: 2
linkContents System.String? = null optionalposition: 3
linkDestinationName System.String? = null optionalposition: 4
public PdfContentBuilder H1(String text, PdfAlign align, PdfColor? color = null, String? linkUri = null, PdfHeadingStyle? style = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:84
Returns: PdfContentBuilder

Adds an H1 heading with explicit alignment and color.

Parameters

text System.String requiredposition: 0
align OfficeIMO.Pdf.PdfAlign requiredposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
linkUri System.String? = null optionalposition: 3
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 4
linkContents System.String? = null optionalposition: 5
linkDestinationName System.String? = null optionalposition: 6
H2 2 overloads
public PdfContentBuilder H2(String text, PdfHeadingStyle? style = null, String? linkUri = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:86
Returns: PdfContentBuilder

Adds an H2 heading.

Parameters

text System.String requiredposition: 0
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 1
linkUri System.String? = null optionalposition: 2
linkContents System.String? = null optionalposition: 3
linkDestinationName System.String? = null optionalposition: 4
public PdfContentBuilder H2(String text, PdfAlign align, PdfColor? color = null, String? linkUri = null, PdfHeadingStyle? style = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:88
Returns: PdfContentBuilder

Adds an H2 heading with explicit alignment and color.

Parameters

text System.String requiredposition: 0
align OfficeIMO.Pdf.PdfAlign requiredposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
linkUri System.String? = null optionalposition: 3
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 4
linkContents System.String? = null optionalposition: 5
linkDestinationName System.String? = null optionalposition: 6
H3 2 overloads
public PdfContentBuilder H3(String text, PdfHeadingStyle? style = null, String? linkUri = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:90
Returns: PdfContentBuilder

Adds an H3 heading.

Parameters

text System.String requiredposition: 0
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 1
linkUri System.String? = null optionalposition: 2
linkContents System.String? = null optionalposition: 3
linkDestinationName System.String? = null optionalposition: 4
public PdfContentBuilder H3(String text, PdfAlign align, PdfColor? color = null, String? linkUri = null, PdfHeadingStyle? style = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:92
Returns: PdfContentBuilder

Adds an H3 heading with explicit alignment and color.

Parameters

text System.String requiredposition: 0
align OfficeIMO.Pdf.PdfAlign requiredposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
linkUri System.String? = null optionalposition: 3
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 4
linkContents System.String? = null optionalposition: 5
linkDestinationName System.String? = null optionalposition: 6
public PdfContentBuilder Heading(Int32 level, String text, PdfAlign align = Left, PdfColor? color = null, String? linkUri = null, PdfHeadingStyle? style = null, String? linkContents = null, String? linkDestinationName = null) #
PdfContentBuilder.cs:77
Returns: PdfContentBuilder

Adds a heading at an authored level from 1 through 9.

Parameters

level System.Int32 requiredposition: 0
text System.String requiredposition: 1
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 2
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 3
linkUri System.String? = null optionalposition: 4
style OfficeIMO.Pdf.PdfHeadingStyle? = null optionalposition: 5
linkContents System.String? = null optionalposition: 6
linkDestinationName System.String? = null optionalposition: 7
public PdfContentBuilder HighlightAnnotation(String contents, Double width, Double height, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfColor? color = null) #
PdfContentBuilder.cs:162
Returns: PdfContentBuilder

Adds a PDF highlight annotation rectangle at the current flow position.

Parameters

contents System.String requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 3
spacingBefore System.Double? = null optionalposition: 4
spacingAfter System.Double? = null optionalposition: 5
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 6
public PdfContentBuilder HR(Double? thickness = null, PdfColor? color = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfHorizontalRuleStyle? style = null) #
PdfContentBuilder.cs:144
Returns: PdfContentBuilder

Adds a horizontal rule.

Parameters

thickness System.Double? = null optionalposition: 0
Line thickness (pt).
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 1
Optional color; inherited from the current default rule style when omitted.
spacingBefore System.Double? = null optionalposition: 2
Top spacing (pt), inherited from the current default rule style when omitted.
spacingAfter System.Double? = null optionalposition: 3
Bottom spacing (pt), inherited from the current default rule style when omitted.
style OfficeIMO.Pdf.PdfHorizontalRuleStyle? = null optionalposition: 4
Optional reusable rule style.
Image 3 overloads
public PdfContentBuilder Image(Byte[] jpegBytes, Double width, Double height, PdfAlign? align = null, OfficeClipPath? clipPath = null, OfficeImageFit? fit = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfImageStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:202
Returns: PdfContentBuilder

Adds a raster image supported by OfficeIMO.Drawing.

Parameters

jpegBytes System.Byte[] requiredposition: 0
Supported image bytes.
width System.Double requiredposition: 1
Target width in points.
height System.Double requiredposition: 2
Target height in points.
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 3
Image alignment inside content width.
clipPath OfficeIMO.Drawing.OfficeClipPath? = null optionalposition: 4
Optional local clipping path applied before drawing the image.
fit OfficeIMO.Drawing.OfficeImageFit? = null optionalposition: 5
Image fitting mode inside the target box.
spacingBefore System.Double? = null optionalposition: 6
Top spacing (pt), inherited from the current default image style when omitted.
spacingAfter System.Double? = null optionalposition: 7
Bottom spacing (pt), inherited from the current default image style when omitted.
style OfficeIMO.Pdf.PdfImageStyle? = null optionalposition: 8
Optional reusable image placement style.
linkUri System.String? = null optionalposition: 9
Optional absolute URI or catalog-base-relative URI for an image link annotation.
linkContents System.String? = null optionalposition: 10
Optional link annotation contents metadata.
public PdfContentBuilder Image(Byte[] jpegBytes, Double width, Double height, String? alternativeText) #
PdfContentBuilder.cs:206
Returns: PdfContentBuilder

Adds a meaningful image from supported image bytes with alternate text.

Parameters

jpegBytes System.Byte[] requiredposition: 0
width System.Double requiredposition: 1
height System.Double requiredposition: 2
alternativeText System.String? requiredposition: 3
public PdfContentBuilder Image(Byte[] jpegBytes, Double width, Double height, PdfAlign? align, OfficeClipPath? clipPath, OfficeImageFit? fit, Double? spacingBefore, Double? spacingAfter, PdfImageStyle? style, String? linkUri, String? linkContents, String? alternativeText) #
PdfContentBuilder.cs:222
Returns: PdfContentBuilder

Adds a raster image supported by OfficeIMO.Drawing.

Parameters

jpegBytes System.Byte[] requiredposition: 0
Supported image bytes.
width System.Double requiredposition: 1
Target width in points.
height System.Double requiredposition: 2
Target height in points.
align OfficeIMO.Pdf.PdfAlign? requiredposition: 3
Image alignment inside content width.
clipPath OfficeIMO.Drawing.OfficeClipPath? requiredposition: 4
Optional local clipping path applied before drawing the image.
fit OfficeIMO.Drawing.OfficeImageFit? requiredposition: 5
Image fitting mode inside the target box.
spacingBefore System.Double? requiredposition: 6
Top spacing (pt), inherited from the current default image style when omitted.
spacingAfter System.Double? requiredposition: 7
Bottom spacing (pt), inherited from the current default image style when omitted.
style OfficeIMO.Pdf.PdfImageStyle? requiredposition: 8
Optional reusable image placement style.
linkUri System.String? requiredposition: 9
Optional absolute URI or catalog-base-relative URI for an image link annotation.
linkContents System.String? requiredposition: 10
Optional link annotation contents metadata.
alternativeText System.String? requiredposition: 11
Optional alternate text for meaningful generated images.
Item 2 overloads
public PdfContentBuilder Item() #
PdfContentBuilder.cs:17
Returns: PdfContentBuilder

Returns this content receiver for readable grouping in fluent chains.

public PdfContentBuilder Item(Action<PdfContentBuilder> build) #
PdfContentBuilder.cs:20
Returns: PdfContentBuilder

Adds a logical group of content without introducing layout behavior.

Parameters

build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 0
KeyValueTable 2 overloads
public PdfContentBuilder KeyValueTable(IEnumerable<KeyValuePair<String, String?>> rows, PdfAlign align = Left, PdfTableStyle? style = null, Boolean includeHeader = false, String keyHeader = "Key", String valueHeader = "Value") #
PdfContentBuilder.cs:63
Returns: PdfContentBuilder

Adds a two-column key/value table.

Parameters

rows System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.String, System.String?>> requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
style OfficeIMO.Pdf.PdfTableStyle? = null optionalposition: 2
includeHeader System.Boolean = false optionalposition: 3
keyHeader System.String = "Key" optionalposition: 4
valueHeader System.String = "Value" optionalposition: 5
public PdfContentBuilder KeyValueTable(IEnumerable<PdfKeyValueRow> rows, PdfAlign align = Left, PdfTableStyle? style = null, Boolean includeHeader = false, String keyHeader = "Key", String valueHeader = "Value") #
PdfContentBuilder.cs:65
Returns: PdfContentBuilder

Adds a two-column key/value table with rich row values.

Parameters

rows System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfKeyValueRow> requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
style OfficeIMO.Pdf.PdfTableStyle? = null optionalposition: 2
includeHeader System.Boolean = false optionalposition: 3
keyHeader System.String = "Key" optionalposition: 4
valueHeader System.String = "Value" optionalposition: 5
public PdfContentBuilder Layer(String name, Action<PdfContentBuilder> build, PdfLayerOptions? options = null) #
PdfContentBuilder.cs:49
Returns: PdfContentBuilder

Adds flow content controlled by a generated optional-content layer.

Parameters

name System.String requiredposition: 0
build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 1
options OfficeIMO.Pdf.PdfLayerOptions? = null optionalposition: 2
public PdfContentBuilder Line(Double x1, Double y1, Double x2, Double y2, PdfColor? strokeColor = null, Double strokeWidth = 1, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, OfficeStrokeLineCap? strokeLineCap = null, OfficeStrokeLineJoin? strokeLineJoin = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:168
Returns: PdfContentBuilder

Adds a line vector shape.

Parameters

x1 System.Double requiredposition: 0
y1 System.Double requiredposition: 1
x2 System.Double requiredposition: 2
y2 System.Double requiredposition: 3
strokeColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 4
strokeWidth System.Double = 1 optionalposition: 5
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 6
spacingBefore System.Double? = null optionalposition: 7
spacingAfter System.Double? = null optionalposition: 8
strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 9
strokeLineCap OfficeIMO.Drawing.OfficeStrokeLineCap? = null optionalposition: 10
strokeLineJoin OfficeIMO.Drawing.OfficeStrokeLineJoin? = null optionalposition: 11
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 12
linkUri System.String? = null optionalposition: 13
linkContents System.String? = null optionalposition: 14
public PdfContentBuilder MultiSelectChoiceField(String name, IEnumerable<String> options, IEnumerable<String>? values = null, Double width = 180, Double height = 72, PdfAlign align = Left, Double fontSize = 10, Double spacingBefore = 0, Double spacingAfter = 6, PdfFormFieldStyle? style = null) #
PdfContentBuilder.cs:154
Returns: PdfContentBuilder

Adds a simple AcroForm multi-select choice field at the current flow position.

Parameters

name System.String requiredposition: 0
options System.Collections.Generic.IEnumerable<System.String> requiredposition: 1
values System.Collections.Generic.IEnumerable<System.String>? = null optionalposition: 2
width System.Double = 180 optionalposition: 3
height System.Double = 72 optionalposition: 4
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 5
fontSize System.Double = 10 optionalposition: 6
spacingBefore System.Double = 0 optionalposition: 7
spacingAfter System.Double = 6 optionalposition: 8
style OfficeIMO.Pdf.PdfFormFieldStyle? = null optionalposition: 9
public PdfContentBuilder Numbered(IEnumerable<String> items, PdfAlign align = Left, PdfColor? color = null, Int32 startNumber = 1, PdfListStyle? style = null) #
PdfContentBuilder.cs:110
Returns: PdfContentBuilder

Adds a simple numbered list.

Parameters

items System.Collections.Generic.IEnumerable<System.String> requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
startNumber System.Int32 = 1 optionalposition: 3
style OfficeIMO.Pdf.PdfListStyle? = null optionalposition: 4
PageBreak 2 overloads
public PdfContentBuilder PageBreak() #
PdfContentBuilder.cs:69
Returns: PdfContentBuilder

Starts a new page.

public PdfContentBuilder PageBreak(Boolean preserveEmptyPage) #
PdfContentBuilder.cs:71
Returns: PdfContentBuilder

Starts a new page, optionally preserving an empty current page for consecutive explicit breaks.

Parameters

preserveEmptyPage System.Boolean requiredposition: 0
public PdfContentBuilder Panel(Action<PdfContentBuilder> build, PdfPanelStyle? style = null) #
PdfContentBuilder.cs:188
Returns: PdfContentBuilder

Adds a styled element while preserving its paragraphs, tables, links, and semantic structure.

Parameters

build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 0
Panel content builder.
style OfficeIMO.Pdf.PdfPanelStyle? = null optionalposition: 1
Panel style (padding, background, border, etc.).
public PdfContentBuilder PanelParagraph(Action<PdfParagraphBuilder> build, PdfPanelStyle? style = null, PdfAlign align = Left, PdfColor? defaultColor = null) #
PdfContentBuilder.cs:184
Returns: PdfContentBuilder

Adds a paragraph inside a styled panel.

Parameters

build System.Action<OfficeIMO.Pdf.PdfParagraphBuilder> requiredposition: 0
Paragraph content builder.
style OfficeIMO.Pdf.PdfPanelStyle? = null optionalposition: 1
Panel style (padding, background, border, etc.).
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 2
Paragraph alignment.
defaultColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 3
Optional default text color.
public PdfContentBuilder Paragraph(Action<PdfParagraphBuilder> build, PdfAlign align = Left, PdfColor? defaultColor = null, PdfParagraphStyle? style = null) #
PdfContentBuilder.cs:104
Returns: PdfContentBuilder

Adds a paragraph built from styled text runs.

Parameters

build System.Action<OfficeIMO.Pdf.PdfParagraphBuilder> requiredposition: 0
Paragraph content builder.
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
Paragraph alignment.
defaultColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
Optional default text color.
style OfficeIMO.Pdf.PdfParagraphStyle? = null optionalposition: 3
Optional paragraph layout style.
public PdfContentBuilder Path(IEnumerable<OfficePathCommand> commands, PdfColor? strokeColor = null, Double strokeWidth = 1, PdfColor? fillColor = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, OfficeStrokeLineCap? strokeLineCap = null, OfficeStrokeLineJoin? strokeLineJoin = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:178
Returns: PdfContentBuilder

Adds a freeform path vector shape.

Parameters

commands System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficePathCommand> requiredposition: 0
strokeColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 1
strokeWidth System.Double = 1 optionalposition: 2
fillColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 3
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 4
spacingBefore System.Double? = null optionalposition: 5
spacingAfter System.Double? = null optionalposition: 6
strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 7
strokeLineCap OfficeIMO.Drawing.OfficeStrokeLineCap? = null optionalposition: 8
strokeLineJoin OfficeIMO.Drawing.OfficeStrokeLineJoin? = null optionalposition: 9
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 10
linkUri System.String? = null optionalposition: 11
linkContents System.String? = null optionalposition: 12
public PdfContentBuilder Polygon(IEnumerable<OfficePoint> points, PdfColor? strokeColor = null, Double strokeWidth = 1, PdfColor? fillColor = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, OfficeStrokeLineCap? strokeLineCap = null, OfficeStrokeLineJoin? strokeLineJoin = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:176
Returns: PdfContentBuilder

Adds a polygon vector shape.

Parameters

points System.Collections.Generic.IEnumerable<OfficeIMO.Drawing.OfficePoint> requiredposition: 0
strokeColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 1
strokeWidth System.Double = 1 optionalposition: 2
fillColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 3
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 4
spacingBefore System.Double? = null optionalposition: 5
spacingAfter System.Double? = null optionalposition: 6
strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 7
strokeLineCap OfficeIMO.Drawing.OfficeStrokeLineCap? = null optionalposition: 8
strokeLineJoin OfficeIMO.Drawing.OfficeStrokeLineJoin? = null optionalposition: 9
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 10
linkUri System.String? = null optionalposition: 11
linkContents System.String? = null optionalposition: 12
public PdfContentBuilder RadioButtonGroup(String name, IEnumerable<String> options, String? value = null, Double size = 14, Double gap = 6, PdfAlign align = Left, Double spacingBefore = 0, Double spacingAfter = 6, PdfFormFieldStyle? style = null) #
PdfContentBuilder.cs:156
Returns: PdfContentBuilder

Adds a simple AcroForm radio button group at the current flow position.

Parameters

name System.String requiredposition: 0
options System.Collections.Generic.IEnumerable<System.String> requiredposition: 1
value System.String? = null optionalposition: 2
size System.Double = 14 optionalposition: 3
gap System.Double = 6 optionalposition: 4
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 5
spacingBefore System.Double = 0 optionalposition: 6
spacingAfter System.Double = 6 optionalposition: 7
style OfficeIMO.Pdf.PdfFormFieldStyle? = null optionalposition: 8
public PdfContentBuilder Rectangle(Double width, Double height, PdfColor? strokeColor = null, Double strokeWidth = 1, PdfColor? fillColor = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, OfficeStrokeLineCap? strokeLineCap = null, OfficeStrokeLineJoin? strokeLineJoin = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:170
Returns: PdfContentBuilder

Adds a rectangle vector shape.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
strokeColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
strokeWidth System.Double = 1 optionalposition: 3
fillColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 4
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 5
spacingBefore System.Double? = null optionalposition: 6
spacingAfter System.Double? = null optionalposition: 7
strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 8
strokeLineCap OfficeIMO.Drawing.OfficeStrokeLineCap? = null optionalposition: 9
strokeLineJoin OfficeIMO.Drawing.OfficeStrokeLineJoin? = null optionalposition: 10
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 11
linkUri System.String? = null optionalposition: 12
linkContents System.String? = null optionalposition: 13
public PdfContentBuilder RichBullets(IEnumerable<PdfListItem> items, PdfAlign align = Left, PdfColor? color = null, PdfListStyle? style = null) #
PdfContentBuilder.cs:108
Returns: PdfContentBuilder

Adds a bullet list whose items can contain rich inline text runs.

Parameters

items System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfListItem> requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
style OfficeIMO.Pdf.PdfListStyle? = null optionalposition: 3
public PdfContentBuilder RichNumbered(IEnumerable<PdfListItem> items, PdfAlign align = Left, PdfColor? color = null, Int32 startNumber = 1, PdfListStyle? style = null) #
PdfContentBuilder.cs:112
Returns: PdfContentBuilder

Adds a numbered list whose items can contain rich inline text runs.

Parameters

items System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfListItem> requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
startNumber System.Int32 = 1 optionalposition: 3
style OfficeIMO.Pdf.PdfListStyle? = null optionalposition: 4
public PdfContentBuilder RoundedRectangle(Double width, Double height, Double cornerRadius, PdfColor? strokeColor = null, Double strokeWidth = 1, PdfColor? fillColor = null, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, OfficeStrokeDashStyle strokeDashStyle = Solid, OfficeStrokeLineCap? strokeLineCap = null, OfficeStrokeLineJoin? strokeLineJoin = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:172
Returns: PdfContentBuilder

Adds a rounded rectangle vector shape.

Parameters

width System.Double requiredposition: 0
height System.Double requiredposition: 1
cornerRadius System.Double requiredposition: 2
strokeColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 3
strokeWidth System.Double = 1 optionalposition: 4
fillColor OfficeIMO.Pdf.PdfColor? = null optionalposition: 5
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 6
spacingBefore System.Double? = null optionalposition: 7
spacingAfter System.Double? = null optionalposition: 8
strokeDashStyle OfficeIMO.Drawing.OfficeStrokeDashStyle = Solid optionalposition: 9
strokeLineCap OfficeIMO.Drawing.OfficeStrokeLineCap? = null optionalposition: 10
strokeLineJoin OfficeIMO.Drawing.OfficeStrokeLineJoin? = null optionalposition: 11
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 12
linkUri System.String? = null optionalposition: 13
linkContents System.String? = null optionalposition: 14
public PdfContentBuilder Row(Action<PdfRowBuilder> build) #
PdfContentBuilder.cs:55
Returns: PdfContentBuilder

Adds a row whose columns can use relative, fixed, automatic, or percentage sizing.

Parameters

build System.Action<OfficeIMO.Pdf.PdfRowBuilder> requiredposition: 0
public PdfContentBuilder Section(String title, Action<PdfContentBuilder> build, PdfSectionOptions? options = null) #
PdfContentBuilder.cs:39
Returns: PdfContentBuilder

Adds a semantic section backed by an outline entry and named destination.

Parameters

title System.String requiredposition: 0
build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 1
options OfficeIMO.Pdf.PdfSectionOptions? = null optionalposition: 2
public PdfContentBuilder Semantic(PdfSemanticRole role, Action<PdfContentBuilder> build, String? alternativeText = null) #
PdfContentBuilder.cs:42
Returns: PdfContentBuilder

Groups content under an explicit tagged-PDF semantic role without changing its visual layout.

Parameters

role OfficeIMO.Pdf.PdfSemanticRole requiredposition: 0
build System.Action<OfficeIMO.Pdf.PdfContentBuilder> requiredposition: 1
alternativeText System.String? = null optionalposition: 2
public PdfContentBuilder Shape(OfficeShape shape, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfDrawingStyle? style = null, String? linkUri = null, String? linkContents = null) #
PdfContentBuilder.cs:164
Returns: PdfContentBuilder

Adds a shared OfficeIMO.Drawing shape.

Parameters

shape OfficeIMO.Drawing.OfficeShape requiredposition: 0
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 1
spacingBefore System.Double? = null optionalposition: 2
spacingAfter System.Double? = null optionalposition: 3
style OfficeIMO.Pdf.PdfDrawingStyle? = null optionalposition: 4
linkUri System.String? = null optionalposition: 5
linkContents System.String? = null optionalposition: 6
public PdfContentBuilder Spacer(Double height) #
PdfContentBuilder.cs:73
Returns: PdfContentBuilder

Adds invisible vertical space to the current flow.

Parameters

height System.Double requiredposition: 0
Table 2 overloads
public PdfContentBuilder Table(IEnumerable<String[]> rows, PdfAlign align = Left, PdfTableStyle? style = null) #
PdfContentBuilder.cs:117
Returns: PdfContentBuilder

Adds a simple text table.

Parameters

rows System.Collections.Generic.IEnumerable<System.String[]> requiredposition: 0
Sequence of row arrays.
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
Table alignment.
style OfficeIMO.Pdf.PdfTableStyle? = null optionalposition: 2
Optional table styling.
public PdfContentBuilder Table(IEnumerable<PdfTableCell[]> rows, PdfAlign align = Left, PdfTableStyle? style = null) #
PdfContentBuilder.cs:122
Returns: PdfContentBuilder

Adds a table with explicit cells, including optional column spans.

Parameters

rows System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfTableCell[]> requiredposition: 0
Sequence of rows made from explicit table cells.
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
Table alignment.
style OfficeIMO.Pdf.PdfTableStyle? = null optionalposition: 2
Optional table styling.
TableDeferred 2 overloads
public PdfContentBuilder TableDeferred(Func<IEnumerable<String[]>> rowFactory, Int32 batchSize = 256, PdfAlign align = Left, PdfTableStyle? style = null) #
PdfContentBuilder.cs:58
Returns: PdfContentBuilder

Adds a deferred simple-text table whose rows are materialized in bounded batches.

Parameters

rowFactory System.Func<System.Collections.Generic.IEnumerable<System.String[]>> requiredposition: 0
batchSize System.Int32 = 256 optionalposition: 1
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 2
style OfficeIMO.Pdf.PdfTableStyle? = null optionalposition: 3
public PdfContentBuilder TableDeferred(Func<IEnumerable<PdfTableCell[]>> rowFactory, Int32 batchSize = 256, PdfAlign align = Left, PdfTableStyle? style = null) #
PdfContentBuilder.cs:61
Returns: PdfContentBuilder

Adds a deferred explicit-cell table whose rows are materialized in bounded batches.

Parameters

rowFactory System.Func<System.Collections.Generic.IEnumerable<OfficeIMO.Pdf.PdfTableCell[]>> requiredposition: 0
batchSize System.Int32 = 256 optionalposition: 1
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 2
style OfficeIMO.Pdf.PdfTableStyle? = null optionalposition: 3
public PdfContentBuilder TableOfContents(PdfTableOfContentsOptions? options = null) #
PdfContentBuilder.cs:47
Returns: PdfContentBuilder

Adds an automatically generated, internally linked table of contents.

Parameters

options OfficeIMO.Pdf.PdfTableOfContentsOptions? = null optionalposition: 0
public PdfContentBuilder Text(String text, PdfAlign align = Left, PdfColor? color = null, PdfParagraphStyle? style = null) #
PdfContentBuilder.cs:95
Returns: PdfContentBuilder

Adds a plain paragraph using the current text defaults.

Parameters

text System.String requiredposition: 0
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 1
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 2
style OfficeIMO.Pdf.PdfParagraphStyle? = null optionalposition: 3
public PdfContentBuilder TextAnnotation(String contents, Double width = 18, Double height = 18, PdfAlign? align = null, Double? spacingBefore = null, Double? spacingAfter = null, PdfTextAnnotationIcon icon = Comment, PdfColor? color = null, Boolean open = false) #
PdfContentBuilder.cs:158
Returns: PdfContentBuilder

Adds a PDF text annotation at the current flow position.

Parameters

contents System.String requiredposition: 0
width System.Double = 18 optionalposition: 1
height System.Double = 18 optionalposition: 2
align OfficeIMO.Pdf.PdfAlign? = null optionalposition: 3
spacingBefore System.Double? = null optionalposition: 4
spacingAfter System.Double? = null optionalposition: 5
icon OfficeIMO.Pdf.PdfTextAnnotationIcon = Comment optionalposition: 6
color OfficeIMO.Pdf.PdfColor? = null optionalposition: 7
open System.Boolean = false optionalposition: 8
public PdfContentBuilder TextField(String name, Double width = 180, Double height = 22, String value = "", PdfAlign align = Left, Double fontSize = 10, Double spacingBefore = 0, Double spacingAfter = 6, PdfFormFieldStyle? style = null) #
PdfContentBuilder.cs:148
Returns: PdfContentBuilder

Adds a simple AcroForm text field at the current flow position.

Parameters

name System.String requiredposition: 0
width System.Double = 180 optionalposition: 1
height System.Double = 22 optionalposition: 2
value System.String = "" optionalposition: 3
align OfficeIMO.Pdf.PdfAlign = Left optionalposition: 4
fontSize System.Double = 10 optionalposition: 5
spacingBefore System.Double = 0 optionalposition: 6
spacingAfter System.Double = 6 optionalposition: 7
style OfficeIMO.Pdf.PdfFormFieldStyle? = null optionalposition: 8