[This documentation is preliminary and is subject to change.]
Applies to: Metro style apps only
Represents a rich text display overflow container. This element cannot have direct content. The only purpose of RichTextBlockOverflow is to display text content that does not fit in the bounds of a RichTextBlock or another RichTextBlockOverflow element.
Inheritance
- Object
- DependencyObject
- UIElement
- FrameworkElement
- RichTextBlockOverflow
Syntax
<RichTextBlockOverflow .../>
Attributes
- ActivatableAttribute(NTDDI_WIN8)
- MarshalingBehaviorAttribute(Agile)
- StaticAttribute(Windows.UI.Xaml.Controls.IRichTextBlockOverflowStatics, NTDDI_WIN8)
- ThreadingAttribute(Both)
- VersionAttribute(NTDDI_WIN8)
- WebHostHiddenAttribute()
Members
The RichTextBlockOverflow class has these types of members:
Constructors
The RichTextBlockOverflow class has these constructors.
| Constructor | Description |
|---|---|
| RichTextBlockOverflow | Initializes a new instance of the RichTextBlockOverflow class. |
Events
The RichTextBlockOverflow class has these events.
| Event | Description |
|---|---|
| DoubleTapped | Occurs when an otherwise unhandled DoubleTap interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| DragEnter | Occurs when the input system reports an underlying drag event with this element as the target. (Inherited from UIElement) |
| DragLeave | Occurs when the input system reports an underlying drag event with this element as the origin. (Inherited from UIElement) |
| DragOver | Occurs when the input system reports an underlying drag event with this element as the potential drop target. (Inherited from UIElement) |
| Drop | Occurs when the input system reports an underlying drop event with this element as the drop target. (Inherited from UIElement) |
| GotFocus | Occurs when a UIElement receives focus. (Inherited from UIElement) |
| Holding | Occurs when an otherwise unhandled Hold interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| KeyDown | Occurs when a keyboard key is pressed while the UIElement has focus. (Inherited from UIElement) |
| KeyUp | Occurs when a keyboard key is released while the UIElement has focus. (Inherited from UIElement) |
| LayoutUpdated | Occurs when the layout of the visual tree changes. (Inherited from FrameworkElement) |
| Loaded | Occurs when a FrameworkElement has been constructed and added to the object tree. (Inherited from FrameworkElement) |
| LostFocus | Occurs when a UIElement loses focus. (Inherited from UIElement) |
| ManipulationCompleted | Occurs when a manipulation on the UIElement is complete. (Inherited from UIElement) |
| ManipulationDelta | Occurs when the input device changes position during a manipulation. (Inherited from UIElement) |
| ManipulationInertiaStarting | Occurs when the input device loses contact with the UIElement object during a manipulation and inertia begins. (Inherited from UIElement) |
| ManipulationStarted | Occurs when an input device begins a manipulation on the UIElement. (Inherited from UIElement) |
| ManipulationStarting | Occurs when the manipulation processor is first created. (Inherited from UIElement) |
| PointerCanceled | Occurs when a pointer that made contact abnormally loses contact. (Inherited from UIElement) |
| PointerCaptureLost | Occurs when pointer capture previously held by this element moves to another element or elsewhere. (Inherited from UIElement) |
| PointerEntered | Occurs when a pointer enters the hit test area of this element. (Inherited from UIElement) |
| PointerExited | Occurs when a pointer leaves the hit test area of this element. (Inherited from UIElement) |
| PointerMoved | Occurs when a pointer moves while the pointer remains within the hit test area of this element. (Inherited from UIElement) |
| PointerPressed | Occurs when the pointer device initiates a Press action within this element. (Inherited from UIElement) |
| PointerReleased | Occurs when the pointer device that previously initiated a Press action is released, while within this element. (Inherited from UIElement) |
| PointerWheelChanged | Occurs when the delta value of a pointer wheel changes. (Inherited from UIElement) |
| RightTapped | Occurs when a right-tap input stimulus happens while the pointer is over the element. (Inherited from UIElement) |
| SizeChanged | Occurs when either the ActualHeight or the ActualWidth property changes value on a FrameworkElement. (Inherited from FrameworkElement) |
| Tapped | Occurs when an otherwise unhandled Tap interaction occurs over the hit test area of this element. (Inherited from UIElement) |
| Unloaded | Occurs when this object is no longer connected to the main object tree. (Inherited from FrameworkElement) |
Methods
The RichTextBlockOverflow class has these methods. It also inherits methods from the Object class.
| Method | Description |
|---|---|
| AddHandler | Adds a routed event handler for a specified routed event, adding the handler to the handler collection on the current element. Specify handledEventsToo as true to have the provided handler be invoked for a routed event case that had already been marked as handled by another element along the event route. (Inherited from UIElement) |
| Arrange | Positions child objects and determines a size for a UIElement. Parent objects that implement custom layout for their child elements should call this method from their layout override implementations to form a recursive layout update. (Inherited from UIElement) |
| ArrangeOverride | Provides the behavior for the Arrange pass of layout. Classes can override this method to define their own Arrange pass behavior. (Inherited from FrameworkElement) |
| CapturePointer | Sets pointer capture to a UIElement. (Inherited from UIElement) |
| ClearValue | Clears the local value of a dependency property. (Inherited from DependencyObject) |
| FindName | Retrieves an object that has the specified identifier name. (Inherited from FrameworkElement) |
| FindSubElementsForTouchTargeting | Enables a UIElement subclass to expose child elements that assist with resolving touch targeting. (Inherited from UIElement) |
| Focus | Focuses the RichTextBlockOverflow, as if it were a conventionally focusable control. |
| GetAnimationBaseValue | Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetPositionFromPoint | Returns a TextPointer text reference from a RichTextBlockOverflow by hit-testing a specific Point within the text display area. |
| GetValue | Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| InvalidateArrange | Invalidates the arrange state (layout) for a UIElement. After the invalidation, the UIElement will have its layout updated, which will occur asynchronously. (Inherited from UIElement) |
| InvalidateMeasure | Invalidates the measurement state (layout) for a UIElement. (Inherited from UIElement) |
| Measure | Updates the DesiredSize of a UIElement. Typically, objects that implement custom layout for their layout children call this method from their own MeasureOverride implementations to form a recursive layout update. (Inherited from UIElement) |
| MeasureOverride | Provides the behavior for the Measure pass of the layout cycle. Classes can override this method to define their own Measure pass behavior. (Inherited from FrameworkElement) |
| OnApplyTemplate | Invoked whenever application code or internal processes (such as a rebuilding layout pass) call ApplyTemplate. In simplest terms, this means the method is called just before a UI element displays in your app. Override this method to influence the default post-template logic of a class. (Inherited from FrameworkElement) |
| OnCreateAutomationPeer | When implemented in a derived class, returns class-specific AutomationPeer implementations for the UI Automation infrastructure. (Inherited from UIElement) |
| OnDisconnectVisualChildren | Override this method to implement how layout and logic should behave when items are removed from a class-specific content or children property. (Inherited from UIElement) |
| ReadLocalValue | Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| ReleasePointerCapture | Releases pointer captures for capture of one specific pointer by this UIElement. (Inherited from UIElement) |
| ReleasePointerCaptures | Releases all pointer captures held by this element. (Inherited from UIElement) |
| RemoveHandler | Removes the specified routed event handler from this UIElement. Typically the handler in question was added by AddHandler. (Inherited from UIElement) |
| SetBinding | Attaches a binding to a FrameworkElement, using the provided binding object. (Inherited from FrameworkElement) |
| SetValue | Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| TransformToVisual | Returns a transform object that can be used to transform coordinates from the UIElement to the specified object. (Inherited from UIElement) |
| UpdateLayout | Ensures that all positions of child objects of a UIElement are properly updated for layout. (Inherited from UIElement) |
Properties
The RichTextBlockOverflow class has these properties.
| Property | Access type | Description |
|---|---|---|
| Read-only | Gets the rendered height of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read-only | Gets the rendered width of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines whether this UIElement can be a drop target for purposes of drag-and-drop operations. (Inherited from UIElement) | |
| Read-only | Gets a value that represents the offset in pixels from the top of the content to the baseline of the first paragraph. The baseline of the paragraph is the baseline of the first line in it. | |
| Read-only | Gets a Uniform Resource Identifier (URI) that represents the base Uniform Resource Identifier (URI) for an XAML-constructed object at XAML load time. This property is useful for Uniform Resource Identifier (URI) resolution at run time. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that indicates that rendered content should be cached when possible. (Inherited from UIElement) | |
| Read/write | Gets or sets the RectangleGeometry used to define the outline of the contents of a UIElement. (Inherited from UIElement) | |
| Read-only | Gets a TextPointer that indicates the end of content in the RichTextBlockOverflow. | |
| Read-only | Gets the RichTextBlock content source of this RichTextBlockOverflow. | |
| Read-only | Gets a TextPointer that indicates the start of content in the RichTextBlockOverflow. | |
| Read/write | Gets or sets the data context for a FrameworkElement when it participates in data binding. (Inherited from FrameworkElement) | |
| Read-only | Gets the size that this UIElement computed during the measure pass of the layout process. (Inherited from UIElement) | |
| Read-only | Gets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject) | |
| Read/write | Gets or sets the direction in which text and other UI elements flow within any parent element that controls their layout. (Inherited from FrameworkElement) | |
| Read-only | Gets a value that reports whether the RichTextBlockOverflow is receiving overflow content from its overflow source. | |
| Read-only | Identifies the HasOverflowContent dependency property. | |
| Read/write | Gets or sets the suggested height of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the horizontal alignment characteristics that are applied to a FrameworkElement when it is composed in a layout parent, such as a panel or items control. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines whether the DoubleTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets whether the contained area of this UIElement can return true values for hit testing. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Holding event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the RightTapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets a value that determines whether the Tapped event can originate from that element. (Inherited from UIElement) | |
| Read/write | Gets or sets localization/globalization language information that applies to a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the ManipulationModes value used for UIElement behavior and interaction with gestures. (Inherited from UIElement) | |
| Read/write | Gets or sets the outer margin of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the maximum height constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the maximum width constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the minimum height constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the minimum width constraint of a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the identifying name of the object. When a XAML processor creates the object tree from XAML markup, run-time code can refer to the XAML-declared object by this name. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the degree of the object's opacity. (Inherited from UIElement) | |
| Read/write | Gets or sets the reference to another RichTextBlockOverflow, which becomes the linked target for any text overflow from this RichTextBlockOverflow. | |
| Read-only | Identifies the OverflowContentTarget dependency property. | |
| Read/write | Gets or sets a value that indicates the thickness of padding space between the boundaries of the content area and the content displayed by a RichTextBlockOverflow. | |
| Read-only | Identifies the Padding dependency property. | |
| Read-only | Gets the parent object of this FrameworkElement in the object tree. (Inherited from FrameworkElement) | |
| Read-only | Gets the set of all captured pointers, represented as Pointer values. (Inherited from UIElement) | |
| Read/write | Gets or sets the perspective projection (3-D effect) to apply when rendering this element. (Inherited from UIElement) | |
| Read-only | Gets the final render size of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets transform information that affects the rendering position of a UIElement. (Inherited from UIElement) | |
| Read/write | Gets or sets the origin point of any possible render transform declared by RenderTransform, relative to the bounds of the UIElement. (Inherited from UIElement) | |
| Read/write | Gets the locally defined resource dictionary. In XAML, you can establish resource items as child object elements of a frameworkElement.Resources property element, through XAML implicit collection syntax. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets an instance Style that is applied for this object during rendering. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets an arbitrary object value that can be used to store custom information about this object. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the collection of Transition style elements that apply to a UIElement. (Inherited from UIElement) | |
| Read-only | Gets the collection of triggers for animations that are defined for a FrameworkElement. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets a value that determines whether rendering for the object and its visual subtree should use rounding behavior that aligns rendering to whole pixels. (Inherited from UIElement) | |
| Read/write | Gets or sets the vertical alignment characteristics that are applied to a FrameworkElement when it is composed in a parent object such as a panel or items control. (Inherited from FrameworkElement) | |
| Read/write | Gets or sets the visibility of a UIElement. A UIElement that is not visible is not rendered and does not communicate its desired size to layout. (Inherited from UIElement) | |
| Read/write | Gets or sets the width of a FrameworkElement. (Inherited from FrameworkElement) |
Examples
This XAML example shows how to have a RichTextBlock target a RichTextBlockOverflow to hold its text content overview. Note also how the first RichTextBlockOverflow then targets a second RichTextBlockOverflow for its text content overflow. The controlling layout factor for how the text overflow is calculated is the constrained Width and Height of the parent Grid, and the ColumnDefinition settings that divide the Grid into three equal columns of 300 pixels height/width. Overflow is also affected by FontSize and many other text formatting properties that change characters in the text; in this example the FontSize can be dynamically adjusted by a control (not shown) to illustrate overflow behavior.
<Grid x:Name="columnGrid" Background="White" Width="900" Height="300"> <Grid.ColumnDefinitions> <ColumnDefinition/> <ColumnDefinition/> <ColumnDefinition/> </Grid.ColumnDefinitions> <RichTextBlock Grid.Column="0" OverflowContentTarget="{Binding ElementName=firstOverflowContainer}" FontSize="{Binding Value, ElementName=fontSizeSlider}" IsTextSelectionEnabled="True" TextAlignment="Justify" Margin="20,0" FontFamily="Segoe UI" Foreground="#2a2a2a"> <Paragraph> Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed ac mi ipsum. Phasellus vel malesuada mauris. Donec pharetra, enim sit amet mattis tincidunt, felis nisi semper lectus, vel porta diam nisi in augue. Pellentesque lacus tortor, aliquam et faucibus id, rhoncus ut justo. Sed id lectus odio, eget pulvinar diam. Suspendisse eleifend ornare libero, in luctus purus aliquet non. Sed interdum, sem vitae rutrum rhoncus, felis ligula ultrices sem, in eleifend eros ante id neque. Vivamus quam lorem, varius vitae porta mollis, placerat quis est. Aenean eget sagittis massa. Sed tellus turpis, ullamcorper eget imperdiet vel, faucibus vel nisl. Nunc sed suscipit quam. Vivamus convallis faucibus dignissim. Fusce sollicitudin, quam vel cursus mattis, nisl velit tristique sapien, ac vestibulum ante arcu a nisl. Vestibulum commodo gravida ante at tincidunt. Vestibulum in ornare nunc. Nullam ut lorem vitae dui placerat lacinia sit amet a arcu. Nulla sit amet odio nisi. Praesent erat urna, venenatis ac adipiscing vel, congue at lectus. Proin ac metus at quam luctus ultricies. Nam vitae ligula non ligula suscipit semper. Duis sed nulla metus, id hendrerit velit. Curabitur dolor purus, bibendum eu cursus lacinia, interdum vel augue. Aenean euismod eros et sapien vehicula dictum. Duis ullamcorper, turpis nec feugiat tincidunt, dui erat luctus risus, aliquam accumsan lacus est vel quam. Nunc lacus massa, varius eget accumsan id, congue sed orci. Duis dignissim hendrerit egestas. Proin ut turpis magna, sit amet porta erat. Nunc semper metus nec magna imperdiet nec vestibulum dui fringilla. Sed sed ante libero, nec porttitor mi. Ut luctus, neque vitae placerat egestas, urna leo auctor magna, sit amet ultricies ipsum felis quis sapien. Proin eleifend varius dui, at vestibulum nunc consectetur nec. Mauris nulla elit, ultrices a sodales non, aliquam ac est. Quisque sit amet risus nulla. Quisque vestibulum posuere velit, vitae vestibulum eros scelerisque sit amet. In in risus est, at laoreet dolor. Nullam aliquet pellentesque convallis. Ut vel tincidunt nulla. Mauris auctor tincidunt auctor. Aenean orci ante, vulputate ac sagittis sit amet, consequat at mi. Nam vehicula justo vel ligula egestas dapibus. Quisque accumsan erat nec enim laoreet ac bibendum erat pulvinar. Ut pulvinar purus scelerisque arcu porta pretium. Proin a purus ut diam placerat vestibulum tempus sit amet velit. In hac habitasse platea dictumst. Maecenas eu nibh vitae nibh laoreet placerat. Duis dolor ante, semper luctus ullamcorper eget, placerat et ligula. Donec placerat tincidunt vehicula. Fusce condimentum lacus quis libero blandit semper sed vel quam. Proin eget nisl lacinia nibh convallis scelerisque at sed massa. Duis commodo tincidunt consequat. Duis malesuada, nisl a pharetra placerat, odio dui suscipit quam, vitae rhoncus sem risus quis odio. Aliquam justo nunc, adipiscing id elementum sit amet, feugiat vel enim. Aliquam pharetra arcu nec elit luctus euismod. Suspendisse potenti. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Cras metus tortor, faucibus id adipiscing sit amet, dignissim et elit. In hac habitasse platea dictumst. Phasellus sit amet facilisis purus. Suspendisse metus augue, vulputate vehicula scelerisque sit amet, cursus eget libero. Duis eu tellus non turpis elementum condimentum. Ut eu hendrerit risus. Suspendisse mattis rhoncus neque, a lobortis lacus imperdiet vitae. Nam eget purus id justo elementum facilisis quis in nisl. Morbi elementum purus consectetur nisi adipiscing vitae blandit sapien placerat. Aliquam adipiscing tortor non sem lobortis consectetur mattis felis rhoncus. Nunc eu nunc rhoncus arcu sollicitudin ultrices. In vulputate eros in mauris aliquam id dignissim nisl laoreet. </Paragraph> </RichTextBlock> <RichTextBlockOverflow x:Name="firstOverflowContainer" Grid.Column="1" OverflowContentTarget="{Binding ElementName=secondOverflowContainer}" Margin="20,0"/> <RichTextBlockOverflow x:Name="secondOverflowContainer" Grid.Column="2" Margin="20,0"/> </Grid>
Requirements
|
Minimum supported client | Windows 8 Release Preview |
|---|---|
|
Minimum supported server | Windows Server 2012 |
|
Namespace |
|
|
Metadata |
|
See also
Build date: 5/22/2012
