LineBreak LineBreak LineBreak Class

Definition

Represents an inline element that causes a new line to begin in content when rendered in a text container.

public : sealed class LineBreak : Inline, ILineBreak
public sealed class LineBreak : Inline, ILineBreak
Public NotInheritable Class LineBreak Inherits Inline Implements ILineBreak
<LineBreak />
Inheritance
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)

Remarks

LineBreak is most commonly used when formatting text within the TextBlock.Inlines collection. RichTextBlock supports the Paragraph element as an element that separately renders text blocks, so you don't typically need to use LineBreak content as often. (LineBreak is supported in the RichTextBlock text model, for example you can place a LineBreak in Paragraph.Inlines, between other Run or Span elements, and a line break will render at that position.)

LineBreak inherits properties from the TextElement class. However, most of these properties don't have any visible effect. It's most common to declare a LineBreak object element in XAML without there being any attributes set, similar to how you might use a <br/> tag in HTML.

Setting properties on LineBreak that otherwise affect the character line height of a text element (such as FontSize, FontFamily ) has no effect on the text rendering and appearance. The height of a text line is inferred from the other text elements that precedes the LineBreak, and the properties of a LineBreak don't modify that line height even if set explicitly.

Constructors

LineBreak() LineBreak() LineBreak()

Initializes a new instance of the LineBreak class.

public : LineBreak()
public LineBreak()
Public Sub New()

Properties

AccessKey AccessKey AccessKey

Gets or sets the access key for this element.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyProperty AccessKeyProperty AccessKeyProperty

Identifies the AccessKey dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AccessKeyScopeOwner AccessKeyScopeOwner 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)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty AccessKeyScopeOwnerProperty

Identifies the AccessKeyScopeOwner dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

AllowFocusOnInteraction AllowFocusOnInteraction AllowFocusOnInteraction

Gets or sets a value that indicates whether the element automatically gets focus when the user interacts with it.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty AllowFocusOnInteractionProperty

Identifies the AllowFocusOnInteraction dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

CharacterSpacing CharacterSpacing CharacterSpacing

Gets or sets the uniform spacing between characters, in units of 1/1000 of an em.

(Inherited from TextElement)

CharacterSpacingProperty CharacterSpacingProperty CharacterSpacingProperty

Identifies the CharacterSpacing dependency property.

(Inherited from TextElement)

ContentEnd ContentEnd ContentEnd

Gets a TextPointer that represents the end of the content in the element.

(Inherited from TextElement)

ContentStart ContentStart ContentStart

Gets a TextPointer that represents the start of content in the element.

(Inherited from TextElement)

Dispatcher Dispatcher 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 ElementEnd ElementEnd

Gets a TextPointer that represents the position just after the end of the element.

(Inherited from TextElement)

ElementStart ElementStart ElementStart

Gets a TextPointer that represents the position just before the start of the element.

(Inherited from TextElement)

ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked ExitDisplayModeOnAccessKeyInvoked

Gets or sets a value that specifies whether the access key display is dismissed when an access key is invoked.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty ExitDisplayModeOnAccessKeyInvokedProperty

Identifies the ExitDisplayModeOnAccessKeyInvoked dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Anniversary Edition (introduced v10.0.14393.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v3)

FontFamily FontFamily FontFamily

Gets or sets the preferred top-level font family for the content of the element.

(Inherited from TextElement)

FontFamilyProperty FontFamilyProperty FontFamilyProperty

Identifies the FontFamily dependency property.

(Inherited from TextElement)

FontSize FontSize FontSize

Gets or sets the font size for the content of the element.

(Inherited from TextElement)

FontSizeProperty FontSizeProperty FontSizeProperty

Identifies the FontSize dependency property.

(Inherited from TextElement)

FontStretch FontStretch FontStretch

Gets or sets the glyph width of the font in a family to select.

(Inherited from TextElement)

FontStretchProperty FontStretchProperty FontStretchProperty

Identifies the FontStretch dependency property.

(Inherited from TextElement)

FontStyle FontStyle FontStyle

Gets or sets the font style for the content in this element.

(Inherited from TextElement)

FontStyleProperty FontStyleProperty FontStyleProperty

Identifies the FontStyle dependency property.

(Inherited from TextElement)

FontWeight FontWeight FontWeight

Gets or sets the top-level font weight to select from the font family for the content in this element.

(Inherited from TextElement)

FontWeightProperty FontWeightProperty FontWeightProperty

Identifies the FontWeight dependency property.

(Inherited from TextElement)

Foreground Foreground Foreground

Gets or sets the Brush to apply to the content in this element.

(Inherited from TextElement)

ForegroundProperty ForegroundProperty ForegroundProperty

Identifies the Foreground dependency property.

(Inherited from TextElement)

IsAccessKeyScope IsAccessKeyScope IsAccessKeyScope

Gets or sets a value that indicates whether an element defines its own access key scope.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

IsAccessKeyScopeProperty IsAccessKeyScopeProperty IsAccessKeyScopeProperty

Identifies the IsAccessKeyScope dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

IsTextScaleFactorEnabled IsTextScaleFactorEnabled IsTextScaleFactorEnabled

Gets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled.

(Inherited from TextElement)

IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty IsTextScaleFactorEnabledProperty

Identifies the IsTextScaleFactorEnabled dependency property.

(Inherited from TextElement)

KeyTipHorizontalOffset KeyTipHorizontalOffset 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)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty KeyTipHorizontalOffsetProperty

Identifies the KeyTipHorizontalOffset dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipPlacementMode KeyTipPlacementMode KeyTipPlacementMode

Gets or sets a value that indicates where the KeyTip is placed in relation to the text element.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipPlacementModeProperty KeyTipPlacementModeProperty KeyTipPlacementModeProperty

Identifies the KeyTipPlacementMode dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipVerticalOffset KeyTipVerticalOffset 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)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty KeyTipVerticalOffsetProperty

Identifies the KeyTipVerticalOffset dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Language Language Language

Gets or sets localization/globalization language information that applies to a TextElement.

(Inherited from TextElement)

LanguageProperty LanguageProperty LanguageProperty

Identifies the Language dependency property.

(Inherited from TextElement)

Name Name Name

Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML.

(Inherited from TextElement)

TextDecorations TextDecorations TextDecorations

Gets or sets a value that indicates what decorations are applied to the text.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

TextDecorationsProperty TextDecorationsProperty TextDecorationsProperty

Identifies the TextDecorations dependency property.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Events

AccessKeyDisplayDismissed AccessKeyDisplayDismissed AccessKeyDisplayDismissed

Occurs when the access key sequence is complete to notify controls that they should hide access key visuals.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

AccessKeyDisplayRequested AccessKeyDisplayRequested AccessKeyDisplayRequested

Occurs when the access key sequence is started to notify controls that they should show access key visuals.

(Inherited from TextElement)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

AccessKeyInvoked AccessKeyInvoked 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)
Additional features and requirements
Device family
Windows 10 Creators Update (introduced v10.0.15063.0)
API contract
Windows.Foundation.UniversalApiContract (introduced v4)

Methods

ClearValue(DependencyProperty) ClearValue(DependencyProperty) ClearValue(DependencyProperty)

Clears the local value of a dependency property.

(Inherited from DependencyObject)

FindName(String) FindName(String) 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) GetAnimationBaseValue(DependencyProperty) 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) GetValue(DependencyProperty) GetValue(DependencyProperty)

Returns the current effective value of a dependency property from a DependencyObject.

(Inherited from DependencyObject)

OnDisconnectVisualChildren OnDisconnectVisualChildren 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) ReadLocalValue(DependencyProperty) ReadLocalValue(DependencyProperty)

Returns the local value of a dependency property, if a local value is set.

(Inherited from DependencyObject)

RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) RegisterPropertyChangedCallback(DependencyProperty,DependencyPropertyChangedCallback) 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) SetValue(DependencyProperty,Object) SetValue(DependencyProperty,Object)

Sets the local value of a dependency property on a DependencyObject.

(Inherited from DependencyObject)

UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64) UnregisterPropertyChangedCallback(DependencyProperty,Int64)

Cancels a change notification that was previously registered by calling RegisterPropertyChangedCallback.

(Inherited from DependencyObject)

See Also