FlowDocument.FlowDirection Property

Reference

Definition

Namespace:: System.Windows.Documents

Assembly:: PresentationFramework.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets or sets the relative direction for flow of content in a FlowDocument.

public:
 property System::Windows::FlowDirection FlowDirection { System::Windows::FlowDirection get(); void set(System::Windows::FlowDirection value); };

public System.Windows.FlowDirection FlowDirection { get; set; }

member this.FlowDirection : System.Windows.FlowDirection with get, set

Public Property FlowDirection As FlowDirection

Property Value

FlowDirection

One of the FlowDirection values that specifies the relative flow direction. The default is LeftToRight.

Examples

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

<FlowDocumentReader>
  <FlowDocument 
    FlowDirection="LeftToRight"
  >
    <Paragraph>
      The FlowDirection of content typically corresponds to the innate flow direction
      of the language being represented.  Hebrew and Arabic provide examples of
      languages that naturally flow from right-to-left.  English, German, and Russian
      provide examples of languages that naturally flow from left-to-right.
    </Paragraph>
  </FlowDocument>
</FlowDocumentReader>

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

FlowDocument flowDoc = new FlowDocument(new Paragraph(new Run("A bit of text content...")));
// Set the content flow direction to left-to-right.
flowDoc.FlowDirection = System.Windows.FlowDirection.LeftToRight;

Dim flowDoc As New FlowDocument(New Paragraph(New Run("A bit of text content...")))
' Set the content flow direction to left-to-right.
flowDoc.FlowDirection = System.Windows.FlowDirection.LeftToRight

Remarks

Getting this property returns the currently effective flow direction. Setting this property causes the contents of the FlowDocument to reflow in the indicated direction.

The FlowDirection of content typically corresponds to the innate flow direction of the language being represented. Hebrew and Arabic are examples of languages that naturally flow from right to left. English, German, and Russian are examples of languages that naturally flow from left to right.

Note

The value of this property is not automatically changed to match the language used by the operating system. If you need to use a different value then the default of LeftToRight, you must specify it yourself.

Dependency Property Information

Item	Value
Identifier field	FlowDirectionProperty
Metadata properties set to `true`	AffectsParentArrange, Inherits

Applies to

Jaa