[Table of Contents] [docx version]

WordprocessingML Reference Material - Table of Contents

ST_BrClear (Line Break Text Wrapping Restart Location)

This simple type specifies the set of possible restart locations which may be used as to determine the next available line when a break’s type attribute has a value of textWrapping. This property only affects the restart location when the current run is being displayed on a line which does not span the full text extents due to the presence of a floating object (see enumeration values for details).

[Example: Consider a text wrapping break character which should force the restart location to the next line which spans the full width of the text extents of the page (there are no floating objects which interrupt the line).

This line break is of type textWrapping, since it shall only advance to the next line, but the clear value shall specify that this restart location shall ignore all lines which are not of the full line width by specifying a value of all, as follows:

<w:br w:type="textWrapping" w:clear="all" />

This break shall therefore not use the next available line, but rather the next available line ignoring all lines which do not span the full text width. end example]

This simple type's contents are a restriction of the XML Schema string datatype.

The following are possible enumeration values for this type:

Enumeration Value

Description

all (Restart On Next Full Line)

Specifies that the text wrapping break shall advance the text to the next line in the WordprocessingML document which spans the full width of the line (i.e. the next line which is not interrupted by any floating objects when those objects are positioned on the page at display time.

 

[Note: This setting is typically used to place a single line of text next to a floating object for use as a caption. end note]

left (Restart In Next Text Region When In Leftmost Position)

Specifies that the text wrapping break shall behave as follows:

 

If this line is broken into multiple regions (a floating object in the center of the page has text wrapping on both sides:

If this is the leftmost region of text flow on this line, advance the text to the next position on the line

Otherwise, treat this as a text wrapping break of type all.

 

If this line is not broken into multiple regions, then treat this break as a text wrapping break of type none.

 

If the parent paragraph is right to left, then these behaviors are also reversed.

 

[Note: This break type is used to control the text wrapping on the left side of a floating image without preventing text from appearing on the opposite side. end note]

none (Restart On Next Line)

Specifies that the text wrapping break shall advance the text to the next line in the WordprocessingML document, regardless of its position left to right or the presence of any floating objects which intersect with the line,

 

This is the setting for a typical line break in a document.

right (Restart In Next Text Region When In Rightmost Position)

Specifies that the text wrapping break shall behave as follows:

 

If this line is broken into multiple regions (a floating object in the center of the page has text wrapping on both sides:

If this is the rightmost region of text flow on this line, advance the text to the next position on the next line

Otherwise, treat this as a text wrapping break of type all.

 

If this line is not broken into multiple regions, then treat this break as a text wrapping break of type none.

 

If the parent paragraph is right to left, then these behaviors are also reversed.

 

[Note: This break type is used to control the text wrapping on the right side of a floating image without preventing text from appearing on the opposite side. end note]

 

Referenced By

br@clear2.3.3.1)

The following XML Schema fragment defines the contents of this simple type:

<simpleType name="ST_BrClear">

   <restriction base="xsd:string">

   <enumeration value="none"/>

   <enumeration value="left"/>

   <enumeration value="right"/>

   <enumeration value="all"/>

   </restriction>

</simpleType>