API Reference

Class

PdfCanvasTextBoxStyle

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf
Modifiers sealed

Reusable visual and text defaults for fixed-position canvas text boxes.

Inheritance

  • Object
  • PdfCanvasTextBoxStyle

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

Constructors

Methods

public PdfCanvasTextBoxStyle Clone() #
Returns: PdfCanvasTextBoxStyle

Creates a copy of this canvas text box style.

Properties

public Nullable<PdfColor> Background { get; set; } #

Background fill color. Set to null for a transparent text box.

public Nullable<Double> BackgroundOpacity { get; set; } #

Optional background fill opacity from 0 (transparent) to 1 (opaque).

public Nullable<PdfColor> BorderColor { get; set; } #

Border color. Set to null for no border.

public Double BorderWidth { get; set; } #

Border stroke width in points.

public OfficeStrokeDashStyle BorderDashStyle { get; set; } #

Border dash pattern.

public Nullable<OfficeStrokeLineCap> BorderLineCap { get; set; } #

Optional border line cap.

public Nullable<OfficeStrokeLineJoin> BorderLineJoin { get; set; } #

Optional border line join.

public Double CornerRadius { get; set; } #

Corner radius for rounded text boxes. Zero renders a regular rectangle.

public Double PaddingX { get; set; } #

Horizontal padding inside the text box, in points.

public Double PaddingY { get; set; } #

Vertical padding inside the text box, in points.

public Nullable<Double> PaddingLeft { get; set; } #

Optional left padding override, in points. When null PaddingX is used.

public Nullable<Double> PaddingRight { get; set; } #

Optional right padding override, in points. When null PaddingX is used.

public Nullable<Double> PaddingTop { get; set; } #

Optional top padding override, in points. When null PaddingY is used.

public Nullable<Double> PaddingBottom { get; set; } #

Optional bottom padding override, in points. When null PaddingY is used.

public Nullable<PdfColor> TextColor { get; set; } #

Default foreground color for text runs that do not specify a color.

public PdfAlign Align { get; set; } #

Text alignment inside the text box.

public PdfVerticalAlign VerticalAlign { get; set; } #

Vertical alignment of wrapped text inside the text box.

public Nullable<Double> FontSize { get; set; } #

Default font size for text runs that do not specify a font size.

public Nullable<Double> LineHeight { get; set; } #

Default line height for wrapped text. When null, the font size is multiplied by 1.2.

public Nullable<PdfStandardFont> Font { get; set; } #

Default standard PDF font for text runs that do not specify a font.