SuppressTopSpacing Class

Ignore Minimum and Exact Line Height for First Line on Page.When the object is serialized out as xml, its qualified name is w:suppressTopSpacing.

Inheritance Hierarchy

System.Object
  DocumentFormat.OpenXml.OpenXmlElement
    DocumentFormat.OpenXml.OpenXmlLeafElement
      DocumentFormat.OpenXml.Wordprocessing.OnOffType
        DocumentFormat.OpenXml.Wordprocessing.SuppressTopSpacing

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

Syntax

'Declaration
Public Class SuppressTopSpacing _
    Inherits OnOffType
'Usage
Dim instance As SuppressTopSpacing

public class SuppressTopSpacing : OnOffType

Remarks

[ISO/IEC 29500-1 1st Edition]

9.7.3.43 suppressTopSpacing (Ignore Minimum and Exact Line Height for First Line on Page)

This element specifies whether the minimum line height specified using the spacing element (Part 1, §17.3.1.33) with a lineRule attribute value of atLeast or exact shall be ignored for the first line on each page.

Typically, if a minimum or exact line height has been specified using the spacing element, then all lines within that paragraph have the necessary line spacing added to them in order to meet this constraint. This element, when present with a val attribute value of true (or equivalent), specifies that no additional spacing shall be added above the first line on each page as a result of these line spacing requirements - the top of the text characters on the first line shall be at the top edge of the page.

[Example: Consider a WordprocessingML document whose first paragraph has a line spacing setting requiring exactly 25 points of space per line:

<w:p>
<w:pPr>
<w:spacing w:line="500" w:lineRule="exact" />
</w:pPr>
…
</w:p>

The default presentation would have the necessary amount of space added between each line such that all lines in the paragraph are centered within 25 points of spacing (highlighting has been added to the image below in order to illustrate the additional spacing above the first line):

However, if this compatibility setting is turned on:

<w:compat>
<w:suppressTopSpacing />
</w:compat>

Then no additional line spacing must be added above the first line on the page (although all other lines are unaffected), resulting in the following output:

end example]

Parent Elements
compat (Part 1, §17.15.1.21)

This element’s content model is defined by the common boolean property definition in Part 1, §17.17.4.

© 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

SuppressTopSpacing Members

DocumentFormat.OpenXml.Wordprocessing Namespace