WPF学习笔记-FlowDocument流文档基础知识和基本操作

文章目录

概述
一、块元素和内联元素
1.1 块元素（Block类）
1.2 内联元素（Inline类）
二、Paragraph元素
- 2.1 基本属性设置
- 2.2 将内联元素Inline添加到Inlines中
- 2.3 设置中西文字体不一样
三、Table元素
- 3.1 添加新的Table
- 3.2 添加列
- 3.3 添加行
- 3.4 设置隔行不同颜色
总结

天踦爵
诗号：三年寻龙，十年点穴，肩负青囊走南北；三寸知息，十面洞心，掌握乾坤通天阙。

概述

WPF中提供了FlowDocument类，用于高级文档功能（如分页和列）承载流内容和设置流内容格式，可以根据自己的需要进行在线编辑，是自定义显示样式，展示大段文章的绝佳利器。
FlowDocument的默认值DataTemplateFlowDocument包含一个 FlowDocumentReader ，如果使用作为 XAML 文件中的根元素，则用于FlowDocument显示文档。
如果 FlowDocument 不是根元素，则可以在、 FlowDocumentPageViewer或 FlowDocumentReader 控件中FlowDocumentScrollViewer显示文档。
还可以在控件中RichTextBox编辑 FlowDocument 。

一、块元素和内联元素

1.1 块元素（Block类）

FlowDocument 为子内容强制实施强内容模型。中包含的 FlowDocument 顶级子元素必须派生自 Block。有效的顶级子元素包括：

BlockUIContainer
List
Paragraph
Section
Table

1.2 内联元素（Inline类）

为所有内联流内容元素提供基类的抽象类，有效的子元素包括：

Bold
Figure
Floater
Hyperlink
InlineUIContainer
Italic
LineBreak
Run
Span
Underline

二、Paragraph元素

Paragraph是段落，可以承载其他的Inline元素。一个段落按照一个新行开始添加。

2.1 基本属性设置

Background：背景颜色
BorderBrush：边框颜色
BorderThickness：边框线条
FontFamily：字体
FontSize：字体大小
FontStretch：字体拉伸特性
FontStyle：字体样式
FontWeight：字体粗细
Foreground：字体颜色
Inlines：内联元素集合
TextAlignment：文本对齐方式
ToolTip：提示对象

2.2 将内联元素Inline添加到Inlines中

	Inline inline = new Run();
	paragraph.Inlines.Add(inline); // 添加内联元素

2.3 设置中西文字体不一样

//					西文字体	中文字体
FontFamily("Times New Roman,楷体");

开发文档中是这样介绍的：指定多个字体系列名称的字符串，每个名称用逗号分隔 (逗号后的任何空格将被忽略) 。指定的第一个字体系列用作主要字体系列;后续字体系列用作回退系列，用于主要字体系列不可用或不适用的情况。例如， “Arial, Century Gothic” 指定 Arial 作为主要字体系列，将 Century 哥特作为回退字体系列。
而设置中西文，我们需要将西文字体设置在前面，这样自当匹配到中文之后，就会采用第二个设置的中文字体，如果将中文字体放前面，那就会无法显示西文字体，因为中文字体中一般西文也有，而西文字体中很少有中文。

三、Table元素

Table元素类似于Grid元素，但是具体有更多的功能，总体来说Table元素非常接近于word中的表格，但是有一点就是没有垂直居中功能，有需要垂直居中的话需要另行处理。

3.1 添加新的Table

public static Table AddTable(FlowDocument flowDocument, double cellSpacing = 0)
{
    Table table = new Table();
    table.BorderThickness = new Thickness(0, 1, 0, 0);
    table.BorderBrush = new SolidColorBrush(Colors.Black);
    table.CellSpacing = cellSpacing;
    table.Margin = new Thickness(0, 5, 0, 10);

    flowDocument.Blocks.Add(table);
    return table;
}

3.2 添加列

        /// <summary>
        /// 添加列
        /// </summary>
        public static void AddColumn(Table table, uint colCnt)
        {
            if (table == null) return;

            for (int i = 0; i < colCnt; i++)
            {
                TableColumn column = new TableColumn();
                table.Columns.Add(column);
            }
        }

3.3 添加行

Table需要保证至少有一个TableRowGroup的情况才能添加行数据，向其中添加行组合，然后将行添加到行组合中。

        public static void AddRow(TableRowGroup rowGroup, params object[] datas)
        {
            if (rowGroup == null || datas == null) return;

            TableRow row;
            TableCell cell;

            // row.
            row = new TableRow();
            rowGroup.Rows.Add(row);

            for (int i = 0; i < datas.Length; i++)
            {
                cell = new TableCell();
                cell.BorderThickness = new Thickness(0, 0, 0, 1);
                cell.BorderBrush = new SolidColorBrush(Colors.Black);
                cell.TextAlignment = TextAlignment.Center;
                row.Cells.Add(cell);
                BlockUIContainer blockUIContainer = new BlockUIContainer();
                cell.Blocks.Add(blockUIContainer);
                Grid grid = new Grid();
                TextBlock textBlock = new TextBlock();
                textBlock.VerticalAlignment = VerticalAlignment.Center;
                textBlock.TextAlignment = TextAlignment.Center;
                textBlock.HorizontalAlignment = HorizontalAlignment.Center;
                grid.Children.Add(textBlock);
                blockUIContainer.Child = grid;

                if ((datas[i] as Paragraph) == null)
                {
                    textBlock.Inlines.Add(Convert.ToString(datas[i]));
                }
                else
                {
                    textBlock.Inlines.AddRange((datas[i] as Paragraph).Inlines);
                }

            }
        }

3.4 设置隔行不同颜色

Table本身并没有直接实现隔行不同颜色，但是可以通过遍历行，对不同行进行颜色设置实现该功能。

        /// <summary>
        /// Set table color.
        /// </summary>
        /// <param name="table"></param>
        public static void SetTableColor(Table table,SolidColorBrush mainBrush, SolidColorBrush underBrush)
        {
            if (table == null)
            {
                return;
            }

            for (int i = 0; i < table.RowGroups.Count; i++)
            {
                for (int rowIndex = 0; rowIndex < table.RowGroups[i].Rows.Count; rowIndex++)
                {
                    table.RowGroups[i].Rows[rowIndex].Background = rowIndex % 2 == 0 ? mainBrush : underBrush;
                }
            }
        }