Click here to Skip to main content
Click here to Skip to main content

WPF Flow Document For Beginners

, 17 Jun 2009
Rate this:
Please Sign up or sign in to vote.
As part of an article that I am creating for www.codeproject.com I decided to look into using the System.Windows.Documents namespace and have a look at seeing if I could make a semi-cool’ish looking document.Now when you use FlowDocuments, there are several container WPF container controls wh

As part of an article that I am creating for www.codeproject.com I decided to look into using the System.Windows.Documents namespace and have a look at seeing if I could make a semi-cool’ish looking document.

Now when you use FlowDocuments, there are several container WPF container controls which you may host a FlowDocument in. These WPF container controls vary in what they provide. Lets see the difference shall we

  • FlowDocumentScrollViewer : Simply displays the entire document and provides a scroll bar. Like a web page
  • FlowDocumentPageViewer : Shows document as individual pages, and allows user to adjust zoom level.
  • FlowDocumentReader : Combines FlowDocumentScrollViewer and FlowDocumentPageViewer into a single control, and exposes text search facilities.

For example a FlowDocumentPageViewer is as shown below

flowdocumentpageviewer.png

For those of who have not come across the FlowDocument, here is a list of some of the things that can be done with it

  • Allow paragraphing
  • Allow anchoring of images
  • Allow hyperlinks
  • Allow text blocks
  • Allow tables
  • Allow subscript/superscript text
  • Allow UIElements (such as Button etc etc)
  • Allow text effects

Think of FlowDocument(s) as a mini desktop publishing type interface. Though I’m sure things like Quark are going to yield more flexability. Never the less, the results of FlowDocument(s) could be thought as be able to create that sort of page publishing type layout.

What I’m going to do now is show you how to create a few of the various FlowDocument elements both in XAML and in code as they are little different actually.

PARAGRAPH

In XAML

<!– FLOW DOCUMENT VIEWER START –>    
<FlowDocumentPageViewer x:Name=”flowDocViewer”  Margin=”0,0,0,0″ 
    Background=”#FF414141″ Zoom=”80″ >         
<!– FLOW DOCUMENT START –>
<FlowDocument x:Name=”flowDoc” Foreground=”White” FontFamily=”Arial”  >
<Paragraph x:Name=”para1″ FontSize=”11″>

The following details have been obtained from Amazon to match your initial query. Some of the returned values may have been empty, so have been ommitted from theresults shown here. Also where there have been more than one value returned viathe Amazon Details, these to have been omitted for the sake of keeping things simplefor this small demo application. Simple is good, when trying to show how something works

</Paragraph>
</FlowDocument>
</FlowDocumentPageViewer>

In C# code behind

Paragraph paraHeader = new Paragraph();
paraHeader.FontSize = 12;
paraHeader.Foreground = headerBrsh;
paraHeader.FontWeight = FontWeights.Bold;
paraHeader.Inlines.Add(new Run(“Paragraph Text”));
flowDoc.Blocks.Add(paraHeader);

HYPERLINKS

In XAML

<Paragraph FontSize=”11″>

     <Hyperlink  Click=”hl_Click” NavigateUri=”www.google.com”>Click Here</Hyperlink>

</Paragraph>

In C# code behind

Paragraph paraValue = new Paragraph();Hyperlink hl = new Hyperlink(new Run(
    “Click Here To View The Link Data”));

hl.FontSize = 11;hl.NavigateUri = new Uri(nonNullprop.PropertyValue);

hl.Click += new RoutedEventHandler(hl_Click);paraValue.Inlines.Add(hl);

flowDoc.Blocks.Add(paraValue);

EMBEDDING UI ELEMENTS

In XAML

<BlockUIContainer>

    <Button Width=”60″ Height=”60″ Click=”Button_Click”>

        Click me

    </Button>

</BlockUIContainer>

In C# code behind

BlockUIContainer uiCont = new BlockUIContainer();

Button b = new Button();

b.Width = b.Height = 60;

b.Click += new RoutedEventHandler(Button_Click);

b.Content = “Click me”;

flowDoc.Blocks.Add(uiCont);

Of course this is only touching the surface of what can be done with FlowDocuments. But it gives you an idea of how flexable the formatting of documents is with WPF.

The screen shot below shows an example with some Paragraphs/Tables/Hyperlinks and UIElements in place

flowdocumentexample.png

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Sacha Barber
Software Developer (Senior)
United Kingdom United Kingdom
I currently hold the following qualifications (amongst others, I also studied Music Technology and Electronics, for my sins)
 
- MSc (Passed with distinctions), in Information Technology for E-Commerce
- BSc Hons (1st class) in Computer Science & Artificial Intelligence
 
Both of these at Sussex University UK.
 
Award(s)

I am lucky enough to have won a few awards for Zany Crazy code articles over the years

  • Microsoft C# MVP 2014
  • Codeproject MVP 2014
  • Microsoft C# MVP 2013
  • Codeproject MVP 2013
  • Microsoft C# MVP 2012
  • Codeproject MVP 2012
  • Microsoft C# MVP 2011
  • Codeproject MVP 2011
  • Microsoft C# MVP 2010
  • Codeproject MVP 2010
  • Microsoft C# MVP 2009
  • Codeproject MVP 2009
  • Microsoft C# MVP 2008
  • Codeproject MVP 2008
  • And numerous codeproject awards which you can see over at my blog

Comments and Discussions

 
GeneralMy vote of 5 PinmemberKoopakiller2-Feb-12 9:00 
GeneralMy vote of 5 PinmemberShlomiO9-Dec-11 1:49 
GeneralLet's Say Thanks Pinmembermikefried21-Oct-10 0:02 
GeneralRe: Let's Say Thanks PinmvpSacha Barber21-Oct-10 1:24 
GeneralMy vote of 4 PinmemberDanishAbbas15-Oct-10 0:27 
GeneralCool Sasha! Flowdocuments seem to be the elephant in the room PinmemberTawani Anyangwe17-Jun-09 9:21 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140721.1 | Last Updated 17 Jun 2009
Article Copyright 2009 by Sacha Barber
Everything else Copyright © CodeProject, 1999-2014
Terms of Service
Layout: fixed | fluid