LineBreak Class

Microsoft Silverlight will reach end of support after October 2021. Learn more.

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

Inheritance Hierarchy

System.Object
  System.Windows.DependencyObject
    System.Windows.Documents.TextElement
      System.Windows.Documents.Inline
        System.Windows.Documents.LineBreak

Namespace:  System.Windows.Documents
Assembly:  System.Windows (in System.Windows.dll)

Syntax

'Declaration
Public NotInheritable Class LineBreak _
    Inherits Inline
public sealed class LineBreak : Inline
<LineBreak />

The LineBreak type exposes the following members.

Constructors

  Name Description
Public methodSupported by Silverlight for Windows Phone LineBreak Initializes a new instance of the LineBreak class.

Top

Properties

  Name Description
Public property CharacterSpacing Gets or sets the distance between characters of text in the control measured in 1000ths of the font size. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone ContentEnd Gets a TextPointer that represents the end of the content in the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone ContentStart Gets a TextPointer that represents the start of content in the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone Dispatcher Gets the Dispatcher this object is associated with. (Inherited from DependencyObject.)
Public propertySupported by Silverlight for Windows Phone ElementEnd Gets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone ElementStart Gets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone FontFamily Gets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone FontSize Gets or sets the font size for the content of the element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone FontStretch Gets or sets the glyph width of the font in a family to select. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone FontStyle Gets or sets the font style for the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone FontWeight Gets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone Foreground Gets or sets the Brush to apply to the content in this element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone Language Gets or sets the language of the content within an TextElement element. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone Name Gets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement.)
Public propertySupported by Silverlight for Windows Phone TextDecorations Gets or sets a value that specifies the text decorations that are applied to the content in an Inline element. (Inherited from Inline.)

Top

Methods

  Name Description
Public methodSupported by Silverlight for Windows Phone CheckAccess Determines whether the calling thread has access to this object. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone Finalize Allows an object to try to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone FindName Gets an object in the Silverlight object model by referencing the object's x:Name or Name attribute value. (Inherited from TextElement.)
Public methodSupported by Silverlight for Windows Phone GetAnimationBaseValue Returns any base value established for a Silverlight dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetType Gets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Silverlight for Windows Phone GetValue Returns the current effective value of a dependency property from a DependencyObject. (Inherited from DependencyObject.)
Protected methodSupported by Silverlight for Windows Phone MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected methodSupported by Silverlight for Windows Phone OnCreateAutomationPeer Returns a class-specific AutomationPeer implementation for use by the Silverlight automation infrastructure. (Inherited from TextElement.)
Public methodSupported by Silverlight for Windows Phone ReadLocalValue Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject.)
Public methodSupported by Silverlight for Windows Phone ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

You can think of LineBreak as being analogous to the <br /> tag in HTML. The typical XAML usage is the similar self-closing form <LineBreak />.

LineBreak inherits various text formatting properties from Inline. Most of these properties are ignored when rendering text. Setting the FontSize of a LineBreak has no effect on the vertical space between the previous and next lines of text. Instead, the FontSize set on the preceding and following text runs determines the vertical spacing. Multiple line breaks in succession use the default 11 pixel height.

Version Information

Silverlight

Supported in: 5, 4, 3

Silverlight for Windows Phone

Supported in: Windows Phone OS 7.1, Windows Phone OS 7.0

Platforms

For a list of the operating systems and browsers that are supported by Silverlight, see Supported Operating Systems and Browsers.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Run

Other Resources