FlowDocument Class
定义
命名空间:
Assembly:
PresentationFramework.dll
用高级文档功能(如分页和列)承载流内容和设置流内容格式。
C#复制
[System.Windows.Localizability(System.Windows.LocalizationCategory.Inherit, Readability=System.Windows.Readability.Unreadable)]
[System.Windows.Markup.ContentProperty("Blocks")]
public class FlowDocument : System.Windows.FrameworkContentElement, IServiceProvider, System.Windows.Documents.IDocumentPaginatorSource, System.Windows.Markup.IAddChild
继承
FlowDocument
属性
LocalizabilityAttribute ContentPropertyAttribute
实现
IServiceProvider IDocumentPaginatorSource IAddChild
注解
FlowDocument 强制实施强的内容模型为子内容。 中包含的顶级子元素FlowDocument必须派生自Block。 有效的顶级子元素包括:
默认值DataTemplate有关FlowDocument包含FlowDocumentReader用于显示文档,如果您使用FlowDocument作为 XAML 文件中的根元素。 如果FlowDocument不是根元素中,可以在显示的文档FlowDocumentScrollViewer即FlowDocumentPageViewer,或FlowDocumentReader控件。 此外可以编辑FlowDocument在RichTextBox控件。
构造函数
FlowDocument() | 初始化 FlowDocument 类的新的空实例。 |
FlowDocument(Block) | 初始化 FlowDocument 类的一个新实例,将指定的 Block 元素作为初始内容添加到实例中。 |
字段
属性
AllowDrop | 获取或设置一个值,该值指示此元素能否用作拖放操作的目标。 (Inherited from ContentElement) |
AreAnyTouchesCaptured | 获取一个值,该值指示是否在此元素上捕获至少一次触摸设备。 (Inherited from ContentElement) |
AreAnyTouchesCapturedWithin | 获取一个值,该值指示此元素或其可视化树中任何子元素是否捕获至少一次触摸设备。 (Inherited from ContentElement) |
AreAnyTouchesDirectlyOver | 获取一个值,该值指示此元素上是否按下至少一次触摸设备。 (Inherited from ContentElement) |
AreAnyTouchesOver | 获取一个值,该值指示在此元素或其可视化树中的任何子元素是否按下至少一次触摸设备。 (Inherited from ContentElement) |
Background | 获取或设置要用于填充内容区域背景的 Brush。 |
BindingGroup | 获取或设置用于该元素的 BindingGroup。 (Inherited from FrameworkContentElement) |
Blocks | 获取 Block 的内容的顶级 FlowDocument 元素。 |
ColumnGap | 获取或设置列间隔值,该值指示 FlowDocument 中各列之间的间距。 |
ColumnRuleBrush | 获取或设置用于绘制列之间标尺的 Brush。 |
ColumnRuleWidth | 获取或设置列标尺宽度。 |
ColumnWidth | 获取或设置 FlowDocument 中列的所需最小宽度。 |
CommandBindings | 获取一系列CommandBinding与此元素关联的对象。 (Inherited from ContentElement) |
ContentEnd | 获取表示 TextPointer 中内容末尾的 FlowDocument。 |
ContentStart | 获取表示 TextPointer 中内容起始位置的 FlowDocument。 |
ContextMenu | 获取或设置每当通过用户界面 (UI) 从此元素中请求上下文菜单时应该显示的上下文菜单元素。 (Inherited from FrameworkContentElement) |
Cursor | 获取或设置在鼠标指针位于此元素上时显示的光标。 (Inherited from FrameworkContentElement) |
DataContext | 获取或设置元素参与数据绑定时的数据上下文。 (Inherited from FrameworkContentElement) |
DefaultStyleKey | 获取或设置用于在主题中查找此控件的样式模板的键。 (Inherited from FrameworkContentElement) |
DependencyObjectType | 获取对此实例的 CLR 类型进行包装的 DependencyObjectType。 (Inherited from DependencyObject) |
Dispatcher | 获取Dispatcher这DispatcherObject与相关联。 (Inherited from DispatcherObject) |
FlowDirection | 获取或设置 FlowDocument 中内容流的相对方向。 |
Focusable | 获取或设置一个值,该值指示元素能否得到焦点。 (Inherited from ContentElement) |
FocusVisualStyle | 获取或设置一个对象,该对象允许自定义此元素在捕获到键盘焦点时要应用于此元素的外观、效果或其他样式特征。 (Inherited from FrameworkContentElement) |
FontFamily | 获取或设置 FlowDocument 的首选顶级字体系列。 |
FontSize | 获取或设置 FlowDocument 的顶级字号。 |
FontStretch | 获取或设置 FlowDocument 的顶级字体拉伸特征。 |
FontStyle | 获取或设置 FlowDocument 的顶级字形。 |
FontWeight | 获取或设置 FlowDocument 的顶级字体粗细。 |
ForceCursor | 获取或设置一个值,该值指示此 FrameworkContentElement 是否应该强制用户界面 (UI) 按照此实例的 Cursor 属性所声明的方式呈现光标。 (Inherited from FrameworkContentElement) |
Foreground | 获取或设置要应用于 Brush 的文本内容的 FlowDocument。 |
HasAnimatedProperties | 获取一个值,该值指示此元素是否具有任何经过动画处理的属性。 (Inherited from ContentElement) |
InputBindings | 获取与此元素关联的输入绑定的集合。 (Inherited from ContentElement) |
InputScope | 获取或设置此 FrameworkContentElement 使用的输入的上下文。 (Inherited from FrameworkContentElement) |
IsColumnWidthFlexible | 获取或设置一个值,该值指示 ColumnWidth 值是可变的还是固定的。 |
IsEnabled | 获取或设置一个值,该值指示是否在启用此元素用户界面 (UI)。 (Inherited from ContentElement) |
IsEnabledCore | 获取 IsEnabled 的 FlowDocument 属性的值。 |
IsFocused | 获取一个值,该值确定此元素是否具有逻辑焦点。 (Inherited from ContentElement) |
IsHyphenationEnabled | 获取或设置一个值,该值指示是否启用文字的自动断字功能。 |
IsInitialized | 获取一个值,该值指示是否已通过将此元素作为可扩展应用程序标记语言 (XAML) 加载或显式调用它的 EndInit() 方法初始化此元素。 (Inherited from FrameworkContentElement) |
IsInputMethodEnabled | 获取一个值,该值指示是否启用输入法系统(如 输入法编辑器 (IME))来处理此元素的输入。 (Inherited from ContentElement) |
IsKeyboardFocused | 获取一个值,该值表示此元素是否具有键盘焦点。 (Inherited from ContentElement) |
IsKeyboardFocusWithin | 获取一个值,该值指示是否键盘焦点位于任何位置的元素或子元素。 (Inherited from ContentElement) |
IsLoaded | 获取一个值,该值指示是否已加载此元素以供显示。 (Inherited from FrameworkContentElement) |
IsMouseCaptured | 获取一个值,该值指示此元素是否捕获鼠标。 (Inherited from ContentElement) |
IsMouseCaptureWithin | 获取一个值,该值确定此元素或其元素树中的子元素是否有鼠标捕获。 (Inherited from ContentElement) |
IsMouseDirectlyOver | 获取一个值,该值指示在考虑元素组合的情况下,鼠标指针的位置是否与命中测试结果相对应。 (Inherited from ContentElement) |
IsMouseOver | 获取一个值,该值指示鼠标指针是否位于此元素 (包括可视子元素或其控件组合)。 (Inherited from ContentElement) |
IsOptimalParagraphEnabled | 获取或设置一个值,该值指示是否启用最佳段落布局功能。 |
IsSealed | 获取一个值,该值指示此实例当前是否为密封的(只读)。 (Inherited from DependencyObject) |
IsStylusCaptured | 获取一个值,该值指示是否将触笔捕获到此元素。 (Inherited from ContentElement) |
IsStylusCaptureWithin | 获取一个值,确定是否包括子元素和控件组合此元素具有触笔捕获。 (Inherited from ContentElement) |
IsStylusDirectlyOver | 获取一个值,该值指示在考虑元素组合的情况下,触笔的位置是否与命中测试结果相对应。 (Inherited from ContentElement) |
IsStylusOver | 获取一个值,该值指示触笔是否位于此元素 (包括可视子元素)。 (Inherited from ContentElement) |
Language | 获取或设置应用于单个元素的本地化/全球化语言信息。 (Inherited from FrameworkContentElement) |
LineHeight | 获取或设置各行内容的高度。 |
LineStackingStrategy | 获取或设置为 FlowDocument 内的每行文本确定行框的机制。 |
LogicalChildren | 获取一个可循环访问 FlowDocument 的逻辑子级的枚举器。 |
MaxPageHeight | 获取或设置 FlowDocument 中的最大页高。 |
MaxPageWidth | 获取或设置 FlowDocument 中的最大页宽。 |
MinPageHeight | 获取或设置 FlowDocument 中的最小页高。 |
MinPageWidth | 获取或设置 FlowDocument 中的最小页宽。 |
Name | 获取或设置元素的标识名称。 该名称提供实例引用,以便编程代码隐藏(如事件处理程序代码)引用曾在 XAML 的分析过程中构造的元素。 (Inherited from FrameworkContentElement) |
OverridesDefaultStyle | 获取或设置一个值,该值指示此元素是否合并了主题样式的样式属性。 (Inherited from FrameworkContentElement) |
PageHeight | 获取或设置 FlowDocument 中的首选页高。 |
PagePadding | 获取或设置一个值,该值指示页面边界与页面内容之间的边距的宽度。 |
PageWidth | 获取或设置 FlowDocument 中的首选页宽。 |
Parent | 获取此元素的逻辑树中的父级。 (Inherited from FrameworkContentElement) |
Resources | 获取或设置当前本地定义的资源字典。 (Inherited from FrameworkContentElement) |
Style | 获取或设置此元素要使用的样式。 (Inherited from FrameworkContentElement) |
Tag | 获取或设置任意对象值,该值可用于存储关于此元素的自定义信息。 (Inherited from FrameworkContentElement) |
TemplatedParent | 获取对此元素的模板父级的引用。 如果该元素不是通过模板创建的,则此属性无关。 (Inherited from FrameworkContentElement) |
TextAlignment | 获取或设置一个值,该值指示文本内容的水平对齐方式。 |
TextEffects | 获取或设置要应用于 FlowDocument 的文本的效果。 |
ToolTip | 获取或设置在用户界面 (UI) 中为此元素显示的工具提示对象。 (Inherited from FrameworkContentElement) |
TouchesCaptured | 获取此元素上捕获的所有触摸设备。 (Inherited from ContentElement) |
TouchesCapturedWithin | 获取其可视化树中捕获到此元素的所有触摸设备或任何子元素。 (Inherited from ContentElement) |
TouchesDirectlyOver | 获取此元素上的所有触摸设备。 (Inherited from ContentElement) |
TouchesOver | 获取其可视化树中此元素上的所有触摸设备或任何子元素。 (Inherited from ContentElement) |
Typography | 获取 FlowDocument 的文本内容的当前有效的版式变体。 |
方法
显式界面实现
IAddChild.AddChild(Object) | 添加子对象。 |
IAddChild.AddText(String) | 将节点的文本内容添加到对象。 |
IDocumentPaginatorSource.DocumentPaginator | 定义执行实际内容分页的源对象。 |
IQueryAmbient.IsAmbientPropertyAvailable(String) | 有关此成员的说明,请参见 IsAmbientPropertyAvailable(String) 方法。 (Inherited from FrameworkContentElement) |
IServiceProvider.GetService(Type) | 获取指定类型的服务对象。 |
事件
ContextMenuClosing | 在元素上的任何上下文菜单关闭之前发生。 (Inherited from FrameworkContentElement) |
ContextMenuOpening | 在元素上的任何上下文菜单打开时发生。 (Inherited from FrameworkContentElement) |
DataContextChanged | 当此元素的数据上下文更改时发生。 (Inherited from FrameworkContentElement) |
DragEnter | 在输入系统报告出现以此元素为拖动目标的基础拖动事件时发生。 (Inherited from ContentElement) |
DragLeave | 在输入系统报告出现以此元素为拖动起点的基础拖动事件时发生。 (Inherited from ContentElement) |
DragOver | 在输入系统报告出现以此元素为可能放置目标的基础拖动事件时发生。 (Inherited from ContentElement) |
Drop | 在输入系统报告出现将此元素作为放置目标的基础放置事件时发生。 (Inherited from ContentElement) |
FocusableChanged | 当 Focusable 属性的值更改时发生。 (Inherited from ContentElement) |
GiveFeedback | 在输入系统报告出现涉及此元素的基础拖放操作时发生。 (Inherited from ContentElement) |
GotFocus | 在此元素获得逻辑焦点时发生。 (Inherited from ContentElement) |
GotKeyboardFocus | 在此元素聚焦于键盘时发生。 (Inherited from ContentElement) |
GotMouseCapture | 在此元素捕获鼠标时发生。 (Inherited from ContentElement) |
GotStylusCapture | 在此元素捕获触笔时发生。 (Inherited from ContentElement) |
GotTouchCapture | 此元素上捕获触摸屏输入时发生。 (Inherited from ContentElement) |
Initialized | 初始化此 FrameworkContentElement 时发生。 这与 IsInitialized 属性值从 |
IsEnabledChanged | 发生时的值IsEnabled此元素的更改的属性。 (Inherited from ContentElement) |
IsKeyboardFocusedChanged | 发生时的值IsKeyboardFocused此元素上的属性更改。 (Inherited from ContentElement) |
IsKeyboardFocusWithinChanged | 发生时的值IsKeyboardFocusWithinChanged此元素上的属性更改。 (Inherited from ContentElement) |
IsMouseCapturedChanged | 发生时的值IsMouseCaptured此元素上的属性更改。 (Inherited from ContentElement) |
IsMouseCaptureWithinChanged | 发生时的值IsMouseCaptureWithinProperty此元素上的更改。 (Inherited from ContentElement) |
IsMouseDirectlyOverChanged | 发生时的值IsMouseDirectlyOver此元素上的属性更改。 (Inherited from ContentElement) |
IsStylusCapturedChanged | 发生时的值IsStylusCaptured此元素上的属性更改。 (Inherited from ContentElement) |
IsStylusCaptureWithinChanged | 发生时的值IsStylusCaptureWithin此元素上的属性更改。 (Inherited from ContentElement) |
IsStylusDirectlyOverChanged | 发生时的值IsStylusDirectlyOver此元素上的属性更改。 (Inherited from ContentElement) |
KeyDown | 当焦点在该元素上时按下某个键后发生。 (Inherited from ContentElement) |
KeyUp | 当焦点在该元素上时松开某个键后发生。 (Inherited from ContentElement) |
Loaded | 当对元素进行布局、呈现,且可将其用于交互时发生。 (Inherited from FrameworkContentElement) |
LostFocus | 在此元素丢失逻辑焦点时发生。 (Inherited from ContentElement) |
LostKeyboardFocus | 在此元素不再聚焦于键盘时发生。 (Inherited from ContentElement) |
LostMouseCapture | 在此元素丢失鼠标捕获时发生。 (Inherited from ContentElement) |
LostStylusCapture | 在此元素丢失触笔捕获时发生。 (Inherited from ContentElement) |
LostTouchCapture | 当此元素失去触摸屏输入捕获时发生。 (Inherited from ContentElement) |
MouseDown | 在指针位于此元素上并且按下任意鼠标按钮时发生。 (Inherited from ContentElement) |
MouseEnter | 在鼠标指针进入此元素的边界时发生。 (Inherited from ContentElement) |
MouseLeave | 在鼠标指针离开此元素的边界时发生。 (Inherited from ContentElement) |
MouseLeftButtonDown | 在鼠标指针位于此元素上并且按下鼠标左键时发生。 (Inherited from ContentElement) |
MouseLeftButtonUp | 在鼠标指针位于此元素上并且松开鼠标左键时发生。 (Inherited from ContentElement) |
MouseMove | 在鼠标指针位于此元素上并且移动鼠标指针时发生。 (Inherited from ContentElement) |
MouseRightButtonDown | 在鼠标指针位于此元素上并且按下鼠标右键时发生。 (Inherited from ContentElement) |
MouseRightButtonUp | 在鼠标指针位于此元素上并且松开鼠标右键时发生。 (Inherited from ContentElement) |
MouseUp | 在鼠标指针位于此元素上并且松开任意鼠标按钮时发生。 (Inherited from ContentElement) |
MouseWheel | 在鼠标指针位于此元素上并且用户滚动鼠标滚轮时发生。 (Inherited from ContentElement) |
PreviewDragEnter | 在输入系统报告出现以此元素为拖动目标的基础拖动事件时发生。 (Inherited from ContentElement) |
PreviewDragLeave | 在输入系统报告出现以此元素为拖动起点的基础拖动事件时发生。 (Inherited from ContentElement) |
PreviewDragOver | 在输入系统报告出现以此元素为可能放置目标的基础拖动事件时发生。 (Inherited from ContentElement) |
PreviewDrop | 在输入系统报告出现将此元素作为放置目标的基础放置事件时发生。 (Inherited from ContentElement) |
PreviewGiveFeedback | 在开始拖放操作时发生。 (Inherited from ContentElement) |
PreviewGotKeyboardFocus | 在此元素聚焦于键盘时发生。 (Inherited from ContentElement) |
PreviewKeyDown | 在此元素聚焦于键盘并且按下某个键时发生。 (Inherited from ContentElement) |
PreviewKeyUp | 在此元素聚焦于键盘并且松开某个键时发生。 (Inherited from ContentElement) |
PreviewLostKeyboardFocus | 在此元素不再聚焦于键盘时发生。 (Inherited from ContentElement) |
PreviewMouseDown | 在指针位于此元素上并且按下任意鼠标按钮时发生。 (Inherited from ContentElement) |
PreviewMouseLeftButtonDown | 在鼠标指针位于此元素上并且按下鼠标左键时发生。 (Inherited from ContentElement) |
PreviewMouseLeftButtonUp | 在鼠标指针位于此元素上并且松开鼠标左键时发生。 (Inherited from ContentElement) |
PreviewMouseMove | 在鼠标指针位于此元素上并且移动鼠标指针时发生。 (Inherited from ContentElement) |
PreviewMouseRightButtonDown | 在鼠标指针位于此元素上并且按下鼠标右键时发生。 (Inherited from ContentElement) |
PreviewMouseRightButtonUp | 在鼠标指针位于此元素上并且松开鼠标右键时发生。 (Inherited from ContentElement) |
PreviewMouseUp | 在鼠标指针位于此元素上并且松开任意鼠标按钮时发生。 (Inherited from ContentElement) |
PreviewMouseWheel | 在鼠标指针位于此元素上并且用户滚动鼠标滚轮时发生。 (Inherited from ContentElement) |
PreviewQueryContinueDrag | 在拖放操作期间键盘或鼠标按钮的状态改变时发生。 (Inherited from ContentElement) |
PreviewStylusButtonDown | 在指针位于此元素上并且按下触笔按钮时发生。 (Inherited from ContentElement) |
PreviewStylusButtonUp | 在指针位于此元素上并且松开触笔按钮时发生。 (Inherited from ContentElement) |
PreviewStylusDown | 当触笔位于元素上且触及数字化器时发生。 (Inherited from ContentElement) |
PreviewStylusInAirMove | 在触笔掠过元素但并未实际接触数字化器时发生。 (Inherited from ContentElement) |
PreviewStylusInRange | 在触笔位于此元素上并且触笔与数字化器之间的距离近到足以检测到触笔时发生。 (Inherited from ContentElement) |
PreviewStylusMove | 在触笔位于元素上并且移动触笔时发生。 数字化器在检测触笔时,触笔必须处于移动状态才会引发此事件,否则将改为引发 PreviewStylusInAirMove。 (Inherited from ContentElement) |
PreviewStylusOutOfRange | 在触笔与数字化仪之间的距离太远以致无法检测到触笔时发生。 (Inherited from ContentElement) |
PreviewStylusSystemGesture | 在用户采用某一种触笔笔势时发生。 (Inherited from ContentElement) |
PreviewStylusUp | 当触笔位于此元素上并且用户将触笔抬离数字化器时发生。 (Inherited from ContentElement) |
PreviewTextInput | 在此元素以设备无关模式获取文本时发生。 (Inherited from ContentElement) |
PreviewTouchDown | 当悬停在此元素上方的手指触摸屏幕时发生。 (Inherited from ContentElement) |
PreviewTouchMove | 当悬停在此元素上方的手指在屏幕上移动时发生。 (Inherited from ContentElement) |
PreviewTouchUp | 当悬停在此元素上方的手指从屏幕上移开时发生。 (Inherited from ContentElement) |
QueryContinueDrag | 在拖放操作期间键盘或鼠标按钮的状态改变时发生。 (Inherited from ContentElement) |
QueryCursor | 当请求显示光标时发生。 每次鼠标指针移至新位置时都会在一个元素上引发此事件,这意味着光标对象可能需要根据其新位置进行更改。 (Inherited from ContentElement) |
SourceUpdated | 当参与此元素上的绑定的任意关联数据源更改时发生。 (Inherited from FrameworkContentElement) |
StylusButtonDown | 在指针位于此元素上并且按下触笔按钮时发生。 (Inherited from ContentElement) |
StylusButtonUp | 在指针位于此元素上并且松开触笔按钮时发生。 (Inherited from ContentElement) |
StylusDown | 在触笔位于此元素上且同时触及数字化器时发生。 (Inherited from ContentElement) |
StylusEnter | 在触笔进入此元素的边界时发生。 (Inherited from ContentElement) |
StylusInAirMove | 在触笔掠过元素但并未实际接触数字化器时发生。 (Inherited from ContentElement) |
StylusInRange | 在触笔位于此元素上并且触笔与数字化器之间的距离近到足以检测到触笔时发生。 (Inherited from ContentElement) |
StylusLeave | 在触笔离开元素的边界时发生。 (Inherited from ContentElement) |
StylusMove | 在触笔移到此元素上时发生。 触笔必须在位于数字化器上时移动,才会引发此事件。 否则将改为引发 StylusInAirMove。 (Inherited from ContentElement) |
StylusOutOfRange | 在触笔位于此元素上并且触笔与数字化器之间的距离太远以致无法检测到触笔时发生。 (Inherited from ContentElement) |
StylusSystemGesture | 在用户采用某一种触笔笔势时发生。 (Inherited from ContentElement) |
StylusUp | 当触笔位于此元素上并且用户将触笔抬离数字化器时发生。 (Inherited from ContentElement) |
TargetUpdated | 当参与此元素上的绑定的任意关联目标属性更改时发生。 (Inherited from FrameworkContentElement) |
TextInput | 在此元素以设备无关模式获取文本时发生。 (Inherited from ContentElement) |
ToolTipClosing | 在元素上的任何工具提示关闭之前发生。 (Inherited from FrameworkContentElement) |
ToolTipOpening | 在元素上的任何工具提示打开时发生。 (Inherited from FrameworkContentElement) |
TouchDown | 当悬停在此元素上方的手指触摸屏幕时发生。 (Inherited from ContentElement) |
TouchEnter | 从移动触摸屏输入时发生外部更改到此元素的边界内。 (Inherited from ContentElement) |
TouchLeave | 从移动触摸屏输入时发生内部更改到此元素的边界之外。 (Inherited from ContentElement) |
TouchMove | 当悬停在此元素上方的手指在屏幕上移动时发生。 (Inherited from ContentElement) |
TouchUp | 当悬停在此元素上方的手指从屏幕上移开时发生。 (Inherited from ContentElement) |
Unloaded | 当从已加载元素的元素树中移除元素时发生。 (Inherited from FrameworkContentElement) |