LineBreak class

Applies to Windows and Windows Phone

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

Inheritance

Object
  DependencyObject
    TextElement
      Inline
        LineBreak

Syntax


public ref class LineBreak sealed : Inline

Attributes

[MarshalingBehavior(Agile)]
[Threading(Both)]
[Version(0x06020000)]
[WebHostHidden()]

Members

The LineBreak class has these types of members:

Constructors

The LineBreak class has these constructors.

ConstructorDescription
LineBreak Initializes a new instance of the LineBreak class.

 

Methods

The LineBreak class has these methods. It also inherits methods from the Object class.

MethodDescription
ClearValue Clears the local value of a dependency property. (Inherited from DependencyObject)
FindName 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 Returns any base value established for a dependency property, which would apply in cases where an animation is not active. (Inherited from DependencyObject)
GetValue 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 Returns the local value of a dependency property, if a local value is set. (Inherited from DependencyObject)
SetValue Sets the local value of a dependency property on a DependencyObject. (Inherited from DependencyObject)

 

Properties

The LineBreak class has these properties.

PropertyAccess typeDescription

CharacterSpacing

Read/writeGets or sets the uniform spacing between characters, in units of 1/1000 of an em. (Inherited from TextElement)

ContentEnd

Read-onlyGets a TextPointer that represents the end of the content in the element. (Inherited from TextElement)

ContentStart

Read-onlyGets a TextPointer that represents the start of content in the element. (Inherited from TextElement)

Dispatcher

Read-onlyGets the CoreDispatcher that this object is associated with. (Inherited from DependencyObject)

ElementEnd

Read-onlyGets a TextPointer that represents the position just after the end of the element. (Inherited from TextElement)

ElementStart

Read-onlyGets a TextPointer that represents the position just before the start of the element. (Inherited from TextElement)

FontFamily

Read/writeGets or sets the preferred top-level font family for the content of the element. (Inherited from TextElement)

FontSize

Read/writeGets or sets the font size for the content of the element. (Inherited from TextElement)

FontStretch

Read/writeGets or sets the glyph width of the font in a family to select. (Inherited from TextElement)

FontStyle

Read/writeGets or sets the font style for the content in this element. (Inherited from TextElement)

FontWeight

Read/writeGets or sets the top-level font weight to select from the font family for the content in this element. (Inherited from TextElement)

Foreground

Read/writeGets or sets the Brush to apply to the content in this element. (Inherited from TextElement)

IsTextScaleFactorEnabled

Read/writeGets or sets whether automatic text enlargement, to reflect the system text size setting, is enabled. (Inherited from TextElement)

Language

Read/writeGets or sets localization/globalization language information that applies to a TextElement. (Inherited from TextElement)

Name

Read-onlyGets or sets a unique identification for the object. Name can only be set from initial parsing of XAML. (Inherited from TextElement)

 

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.

Requirements

Minimum supported client

Windows 8 [Windows Store apps only]

Minimum supported server

Windows Server 2012 [Windows Store apps only]

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.UI.Xaml.Documents
Windows::UI::Xaml::Documents [C++]

Metadata

Windows.winmd

See also

Inline
TextElement
Run

 

 

Show:
© 2014 Microsoft