This documentation is archived and is not being maintained.

FlowDocument.IsOptimalParagraphEnabled Property

Gets or sets a value that indicates whether optimal paragraph layout is enabled or disabled.

Namespace: System.Windows.Documents
Assembly: PresentationFramework (in presentationframework.dll)
XML Namespace:

public bool IsOptimalParagraphEnabled { get; set; }
/** @property */
public boolean get_IsOptimalParagraphEnabled ()

/** @property */
public void set_IsOptimalParagraphEnabled (boolean value)

public function get IsOptimalParagraphEnabled () : boolean

public function set IsOptimalParagraphEnabled (value : boolean)

<object IsOptimalParagraphEnabled="bool" .../>

Property Value

true to indicate that optimal paragraph layout is enabled; false otherwise. The default value is false.

Optimal paragraph layout is a feature that, when enabled, lays out paragraphs in the FlowDocument such that white space is distributed as evenly as possible. Theoretically, this provides an optimized reading experience by eliminating distracting whitespace that can occur with line-justified text and other layout routines. Optimal paragraph layout is particularly effective when coupled with automatic hyphenation (represented by the IsHyphenationEnabled property).

For a sample that explores the IsOptimalParagraphEnabled property in real time, see theOptimal Paragraph and Hyphenation in a FlowDocument Sample.

The following example shows how to set the IsOptimalParagraphEnabled attribute of a FlowDocument element.

    PageWidth="400" PageHeight="480"
      <Hyperlink NavigateUri="">
        Perfect Dark Zero
      Joanna Dark returns in the Xbox 360 exclusive <Bold><Italic>Perfect Dark Zero</Italic></Bold>, the 
      prequel to the internationally award-winning and multi-million selling first-person shooter 
      <Italic>Perfect Dark</Italic> from famed game developer Rare.
      A secret war has begun between shadowy corporations bent on world domination. Joanna Dark and her father 
      Jack are caught up in the fight for the future of the planet. A routine bounty hunting mission rips open 
      a global conspiracy that will change Joanna's destiny—forever.
      Guide Joanna Dark on her journey to become the perfect agent. Featuring a compelling and captivating story, 
      <Italic>Perfect Dark Zero</Italic> plunges you into a world of corporate espionage and conspiracy. The title 
      merges the excitement and intrigue of its predecessor with revolutionary game design, cutting-edge online play,
      and amazing graphics to deliver an experience that defines next-generation gaming and entertainment...

The following figure shows how the FlowDocument declared above renders.

Screenshot: FlowDocument hyphen enabled

The following figure shows how the same FlowDocument renders with the default setting of IsOptimalParagraphEnabled=false.

Screenshot: FlowDocument with disabled hyphens

The following example shows how to set the IsOptimalParagraphEnabled property programmatically.

FlowDocument flowDoc = new FlowDocument(new Paragraph(new Run("A bit of text content...")));

// Enable automatic hyphenation.
flowDoc.IsHyphenationEnabled = true;
// Enable optimal paragraph layout.
flowDoc.IsOptimalParagraphEnabled = true;

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0