Block Class
Definition
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.
An abstract class that provides a base for all block-level content elements.
public ref class Block : TextElement/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class Block : TextElement[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public class Block : TextElementPublic Class Block
Inherits TextElement- Inheritance
- Derived
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
Remarks
Block defines text formatting properties that should apply to all types of Block content. These properties are: LineHeight, LineStackingStrategy, Margin, and TextAlignment. Block also inherits the text formatting properties and other API of TextElement.
In the Windows Runtime XAML vocabulary the only block type is Paragraph. You use Paragraph to define the blocks of text to display within a RichTextBlock control. Every RichTextBlock should include at least one Paragraph.
BlockCollection is a strongly typed collection class that is used by the RichTextBlock.Blocks property. By specifying XAML object elements within a RichTextBlock, you can assign the block text content for the RichTextBlock. This is usually done using an implicit collection and XAML property syntax, such that the Paragraph elements appear as direct children of RichTextBlock in XAML markup. For example:
<RichTextBlock>
<Paragraph>First paragraph.</Paragraph>
<Paragraph>Second paragraph.</Paragraph>
<Paragraph>Third paragraph. <Bold>With an inline.</Bold></Paragraph>
</RichTextBlock>
Block derived classes
Block is the parent class for Paragraph.
Migration notes
The Windows Runtime XAML vocabulary doesn't support a Section class. If you're migrating XAML from Windows Presentation Foundation (WPF) or Microsoft Silverlight, use a Paragraph block element instead.
Version history
| Windows version | SDK version | Value added |
|---|---|---|
| 1709 | 16299 | HorizontalTextAlignment |
Constructors
| Block() |
Provides base class initialization behavior for Block derived classes. |
Properties
| AccessKey |
Gets or sets the access key for this element. (Inherited from TextElement) |
| AccessKeyScopeOwner |
Gets or sets a source element that provides the access key scope for this element, even if it's not in the visual tree of the source element. (Inherited from TextElement) |
| AllowFocusOnInteraction |
Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it. (Inherited from TextElement) |
| CharacterSpacing |
Gets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from TextElement) |
| ContentEnd |
Gets a TextPointer that represents the end of the content in the element. (Inherited from TextElement) |
| ContentStart |
Gets a TextPointer that represents the start of content in the element. (Inherited from TextElement) |
| Dispatcher |
Gets the CoreDispatcher that this object is associated with. The CoreDispatcher represents a facility that can access the DependencyObject on the UI thread even if the code is initiated by a non-UI thread. (Inherited from DependencyObject) |
| ElementEnd |
Gets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement) |
| ElementStart |
Gets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement) |
| ExitDisplayModeOnAccessKeyInvoked |
Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked. (Inherited from TextElement) |
| FontFamily |
Gets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement) |
| FontSize |
Gets or sets the font size for the content of the element. (Inherited from TextElement) |
| FontStretch |
Gets or sets the glyph width of the font in a family to select. (Inherited from TextElement) |
| FontStyle |
Gets or sets the font style for the content in this element. (Inherited from TextElement) |
| FontWeight |
Gets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement) |
| Foreground |
Gets or sets the Brush to apply to the content in this element. (Inherited from TextElement) |
| HorizontalTextAlignment |
Gets or sets a value that indicates how text is aligned in the Block. |
| HorizontalTextAlignmentProperty |
Identifies the HorizontalTextAlignment dependency property. |
| IsAccessKeyScope |
Gets or sets a value that indicates whether an element defines its own access key scope. (Inherited from TextElement) |
| IsTextScaleFactorEnabled |
Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from TextElement) |
| KeyTipHorizontalOffset |
Gets or sets a value that indicates how far left or right the keytip is placed in relation to the text element. (Inherited from TextElement) |
| KeyTipPlacementMode |
Gets or sets a value that indicates where the KeyTip is placed in relation to the text element. (Inherited from TextElement) |
| KeyTipVerticalOffset |
Gets or sets a value that indicates how far up or down the keytip is placed in relation to the text element. (Inherited from TextElement) |
| Language |
Gets or sets localization/globalization language information that applies to a TextElement. (Inherited from TextElement) |
| LineHeight |
Gets or sets the height of each line of content. |
| LineHeightProperty |
Identifies the LineHeight dependency property. |
| LineStackingStrategy |
Gets or sets a value that indicates how a line box is determined for each line of text in the Block. |
| LineStackingStrategyProperty |
Identifies the LineStackingStrategy dependency property. |
| Margin |
Gets or sets the amount of space around a Block element. |
| MarginProperty |
Identifies the Margin dependency property. |
| Name |
Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement) |
| TextAlignment |
Gets or sets the horizontal alignment of the text content. |
| TextAlignmentProperty |
Identifies the TextAlignment dependency property. |
| TextDecorations |
Gets or sets a value that indicates what decorations are applied to the text. (Inherited from TextElement) |
| XamlRoot |
Gets or sets the XamlRoot in which this element is being viewed. (Inherited from TextElement) |
Methods
| ClearValue(DependencyProperty) |
Clears the local value of a dependency property. (Inherited from DependencyObject) |
| FindName(String) |
Retrieves an object in the object model / runtime object graph by referencing the object's x:Name or Name attribute value. (Inherited from TextElement) |
| GetAnimationBaseValue(DependencyProperty) |
Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject) |
| GetValue(DependencyProperty) |
Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject) |
| OnDisconnectVisualChildren() |
Override this method to implement how layout and logic should behave when items are removed from a class-specific content or child property. (Inherited from TextElement) |
| ReadLocalValue(DependencyProperty) |
Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject) |
| RegisterPropertyChangedCallback(DependencyProperty, DependencyPropertyChangedCallback) |
Registers a notification function for listening to changes to a specific DependencyProperty on this DependencyObject instance. (Inherited from DependencyObject) |
| SetValue(DependencyProperty, Object) |
Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject) |
| UnregisterPropertyChangedCallback(DependencyProperty, Int64) |
Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback. (Inherited from DependencyObject) |
Events
| AccessKeyDisplayDismissed |
Occurs when the access key sequence is complete to notify controls that they should hide access key visuals. (Inherited from TextElement) |
| AccessKeyDisplayRequested |
Occurs when the access key sequence is started to notify controls that they should show access key visuals. (Inherited from TextElement) |
| AccessKeyInvoked |
Occurs when a user completes an access key sequence to notify the element that the access key action should be invoked. (Inherited from TextElement) |