Break Class

Text Line Break.When the object is serialized out as xml, its qualified name is a:br.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlCompositeElement
      DocumentFormat.OpenXml.Drawing.Break

Namespace:  DocumentFormat.OpenXml.Drawing
Assembly:  DocumentFormat.OpenXml (in DocumentFormat.OpenXml.dll)

Syntax

'Declaration
<ChildElementInfoAttribute(GetType(RunProperties))> _
Public Class Break _
    Inherits OpenXmlCompositeElement
'Usage
Dim instance As Break
[ChildElementInfoAttribute(typeof(RunProperties))]
public class Break : OpenXmlCompositeElement

Remarks

The following table lists the possible child types:

  • RunProperties <a:rPr>

[ISO/IEC 29500-1 1st Edition]

21.1.2.2.1 br (Text Line Break)

This element specifies the existence of a vertical line break between two runs of text within a paragraph. In addition to specifying a vertical space between two runs of text, this element can also have run properties specified via the rPr child element. This sets the formatting of text for the line break so that if text is later inserted there that a new run can be generated with the correct formatting.

[Example: Consider the DrawingML shown below.

<p:txBody>
…
<a:p>
<a:r>
…
<a:t>Text Run 1.</a:t>
…
</a:r>
    <a:br/>
<a:r>
…
<a:t>Text Run 2.</a:t>
…
</a:r>
</a:p>
</p:txBody>

This paragraph has two runs of text laid out in a vertical fashion with a line break in between them. This line break acts much like a carriage return would within a normal run of text. end example]

Parent Elements

p (§21.1.2.2.6)

Child Elements

Subclause

rPr (Text Run Properties)

§21.1.2.3.9

[Note: The W3C XML Schema definition of this element’s content model (CT_TextLineBreak) is located in §A.4.1. end note]

© ISO/IEC29500: 2008.

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

Break Members

DocumentFormat.OpenXml.Drawing Namespace