API Reference

Class

PdfElementBuilder

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Configures a visual and semantic envelope around a sequence of PDF flow content.

Inheritance

  • Object
  • PdfElementBuilder

Usage

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

Accepted by parameters

Methods

public PdfElementBuilder Align(PdfAlign align) #
Returns: PdfElementBuilder

Aligns a constrained element within the available content width.

Parameters

align OfficeIMO.Pdf.PdfAlign requiredposition: 0
public PdfElementBuilder Background(PdfColor color) #
Returns: PdfElementBuilder

Sets the element background fill.

Parameters

color OfficeIMO.Pdf.PdfColor requiredposition: 0
public PdfElementBuilder Border(PdfColor color, Double width = 1) #
Returns: PdfElementBuilder

Sets a uniform border around the element.

Parameters

color OfficeIMO.Pdf.PdfColor requiredposition: 0
width System.Double = 1 optionalposition: 1
public PdfElementBuilder Content(Action<PdfContentBuilder> build) #
Returns: PdfElementBuilder

Sets the content rendered inside this element.

Parameters

build System.Action{OfficeIMO.Pdf.PdfContentBuilder} requiredposition: 0
public PdfElementBuilder KeepTogether(Boolean value = true) #
Returns: PdfElementBuilder

Controls whether the entire decorated element must remain on one page.

Parameters

value System.Boolean = true optionalposition: 0
public PdfElementBuilder KeepWithNext(Boolean value = true) #
Returns: PdfElementBuilder

Controls whether this element should stay with the next flow block.

Parameters

value System.Boolean = true optionalposition: 0
public PdfElementBuilder MaxWidth(Double value) #
Returns: PdfElementBuilder

Constrains the element to a maximum width, in points.

Parameters

value System.Double requiredposition: 0
Padding 2 overloads
public PdfElementBuilder Padding(Double value) #
Returns: PdfElementBuilder

Sets equal padding on every side, in points.

Parameters

value System.Double requiredposition: 0
public PdfElementBuilder Padding(Double vertical, Double horizontal) #
Returns: PdfElementBuilder

Sets vertical and horizontal padding, in points.

Parameters

vertical System.Double requiredposition: 0
horizontal System.Double requiredposition: 1
public PdfElementBuilder Semantic(PdfSemanticRole role, String alternativeText = null) #
Returns: PdfElementBuilder

Assigns an explicit tagged-PDF semantic role to the element.

Parameters

role OfficeIMO.Pdf.PdfSemanticRole requiredposition: 0
alternativeText System.String = null optionalposition: 1
public PdfElementBuilder Spacing(Double before = 0, Double after = 0) #
Returns: PdfElementBuilder

Sets the outer vertical spacing before and after the element, in points.

Parameters

before System.Double = 0 optionalposition: 0
after System.Double = 0 optionalposition: 1
public PdfElementBuilder Style(PdfPanelStyle style) #
Returns: PdfElementBuilder

Applies a reusable visual style. The style is copied when assigned.

Parameters

style OfficeIMO.Pdf.PdfPanelStyle requiredposition: 0