API Reference

Class

PdfParagraphStyle

Namespace OfficeIMO.Pdf
Assembly OfficeIMO.Pdf

Describes layout options for rich paragraph rendering.

Inheritance

  • Object
  • PdfParagraphStyle

Usage

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

Accepted by parameters

Constructors

Methods

public PdfTabStop AddTabStop(Double position, PdfTabAlignment alignment = Left, PdfTabLeaderStyle leader = None) #
Returns: PdfTabStop

Adds an explicit paragraph tab stop.

Parameters

position System.Double requiredposition: 0
Tab stop position in points relative to the paragraph text frame.
alignment OfficeIMO.Pdf.PdfTabAlignment = Left optionalposition: 1
Text alignment anchored at this tab stop.
leader OfficeIMO.Pdf.PdfTabLeaderStyle = None optionalposition: 2
Leader fill rendered before the following text.
public Void ClearTabStops() #
Returns: Void

Removes all explicit paragraph tab stops.

public PdfParagraphStyle Clone() #
Returns: PdfParagraphStyle

Creates a copy of this paragraph style.

Properties

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

Line advance multiplier relative to the paragraph font size. When null the writer uses the default line height.

public Double LeftIndent { get; set; } #

Horizontal inset from the left edge of the paragraph frame, in points.

public Double RightIndent { get; set; } #

Horizontal inset from the right edge of the paragraph frame, in points.

public Double FirstLineIndent { get; set; } #

Additional indent for the first line, in points. Negative values create a hanging indent relative to LeftIndent.

public Double SpacingBefore { get; set; } #

Vertical space before the paragraph, in points.

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

Vertical space after the paragraph, in points. When null the writer uses the default paragraph spacing.

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

Default paragraph tab-stop width, in points. When null the writer uses the Word-compatible half-inch default.

public IList<PdfTabStop> TabStops { get; } #

Explicit paragraph tab stops, in points, relative to the paragraph text frame.

public Boolean KeepTogether { get; set; } #

When true, the paragraph starts on a new page instead of splitting across pages.

public Boolean KeepWithNext { get; set; } #

When true, the paragraph moves to the next page when it would otherwise be separated from the following paragraph.

public Boolean WidowControl { get; set; } #

When true, paragraph page splits avoid single-line widows and orphans where the page frame allows it.

public Int32 MinimumOrphanLines { get; set; } #

Minimum number of paragraph lines kept at the bottom of a page when the paragraph splits. Zero uses the two-line default when WidowControl is enabled, or disables this constraint otherwise.

public Int32 MinimumWidowLines { get; set; } #

Minimum number of paragraph lines carried to the top of the following page when the paragraph splits. Zero uses the two-line default when WidowControl is enabled, or disables this constraint otherwise.