TopBorder Class

Definition

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Package:

DocumentFormat.OpenXml v3.0.1

Paragraph Border Above Identical Paragraphs.

This class is available in Office 2007 and above.

When the object is serialized out as xml, it's qualified name is w:top.

public class TopBorder : DocumentFormat.OpenXml.Wordprocessing.BorderType

type TopBorder = class
    inherit BorderType

Public Class TopBorder
Inherits BorderType

Inheritance

Object

OpenXmlElement

OpenXmlLeafElement

BorderType

TopBorder

Remarks

[ISO/IEC 29500-1 1st Edition]

top (Paragraph Border Above Identical Paragraphs)

This element specifies the border which shall be displayed above a set of paragraphs which have the same set of paragraph border settings.

To determine if any two adjoining paragraphs shall have an individual top and bottom border or a between border, the set of borders on the two adjoining paragraphs are compared. If the border information on those two paragraphs is identical for all possible paragraphs borders, then the between border is displayed. Otherwise, the final paragraph shall use its bottom border and the following paragraph shall use its top border, respectively. If this border specifies a space attribute, that value determines the space above the text (ignoring any spacing above) which should be left before this border is drawn, specified in points.

If this element is omitted on a given paragraph, its value is determined by the setting previously set at any level of the style hierarchy (i.e. that previous setting remains unchanged). If this setting is never specified in the style hierarchy, then no between border shall be applied above identical paragraphs.

[Example: Consider the following two paragraphs' WordprocessingML definition:

<w:p>  
  <w:pPr>  
    <w:pBdr>  
      <w:top w:val="single" w:sz="24" w:space="1" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />   
      <w:left w:val="single" w:sz="24" w:space="4" w:color="B97034" w:themeColor="accent6" w:themeShade="BF" />   
      <w:bottom w:val="single" w:sz="24" w:space="1" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />   
      <w:right w:val="single" w:sz="24" w:space="4" w:color="C3D69B" w:themeColor="accent3" w:themeTint="99" />   
      <w:between w:val="single" w:sz="24" w:space="1" w:color="4F81BD" w:themeColor="accent1" />   
    </w:pBdr>  
  </w:pPr>  
  <w:r>  
    <w:t>First paragraph.</w:t>   
  </w:r>  
</w:p>  
<w:p>  
  <w:pPr>  
    <w:pBdr>  
      <w:top w:val="single" w:sz="24" w:space="1" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />   
      <w:left w:val="single" w:sz="24" w:space="4" w:color="B97034" w:themeColor="accent6" w:themeShade="BF" />   
      <w:bottom w:val="single" w:sz="24" w:space="0" w:color="F2DCDB" w:themeColor="accent2" w:themeTint="33" />   
      <w:right w:val="single" w:sz="24" w:space="4" w:color="C3D69B" w:themeColor="accent3" w:themeTint="99" />   
      <w:between w:val="single" w:sz="24" w:space="1" w:color="4F81BD" w:themeColor="accent1" />   
    </w:pBdr>  
  </w:pPr>  
  <w:r>  
    <w:t>Second paragraph.</w:t>   
  </w:r>  
</w:p>  

Since the paragraph border is different between the two paragraphs (the bottom space value goes from 1 to 0), paragraph two uses its top border, which is located one point above the text in that paragraph. end example]

Parent Elements
pBdr (§17.3.1.24)

This element’s content model is defined by the common border properties definition in §17.3.4.

[ISO/IEC 29500-1 1st Edition]

top (Table Cell Top Border)

This element specifies the border which shall be displayed at the top of the current table cell. The appearance of this table cell border in the document shall be determined by the following settings:

• If the net tblCellSpacing element value (§17.4.45;§17.4.44;§17.4.46) applied to the cell is non-zero, then the cell border shall always be displayed

• Otherwise, the display of the border is subject to the conflict resolution algorithm defined by the tcBorders element (§17.4.67) and the tblBorders element (§17.4.40;§17.4.39)

If this element is omitted, then the top of this table cell shall not have a cell border, and its border can use the table's border settings as appropriate.

[Example: Consider a table in which the first cell in the first row specifies a top cell border , as follows:

R1C1

R1C2

R2C1

R2C2

This top cell border is specified using the following WordprocessingML:

<w:tc>  
  <w:tcPr>  
    …    <w:tcBorders>  
      <w:top w:val="thinThickThinSmallGap" w:sz="24" w:space="0" w:color="FF0000"/>  
    </w:tcBorders>  
  </w:tcPr>  
  <w:p/>  
</w:tc>  

The top element specifies a three point border of type thinThinThickSmallGap. end example]

Parent Elements
tcBorders (§17.4.67)

This element’s content model is defined by the common border properties definition in §17.3.4.

[ISO/IEC 29500-1 1st Edition]

top (Table Top Border)

This element specifies the border which shall be displayed at the top of the current table. The appearance of this table border in the document shall be determined by the following settings:

• The display of the border is subject to the conflict resolution algorithm defined by the tcBorders element (§17.4.67) and the tblBorders element (§17.4.40;§17.4.39)

If this element is omitted, then the top of this table shall have the border specified by the associated table style. If no top border is specified in the style hierarchy, then this table shall not have a top border.

[Example: Consider a table in which the table properties specifies a top table border, as follows:

R1C1

R1C2

R2C1

R2C2

This top table border is specified using the following WordprocessingML:

<w:tbl>  
  <w:tblPr>  
    <w:tblBorders>  
      <w:top w:val="thinThickThinMediumGap" w:sz="24" w:space="0" w:color="D0D0D0" w:themeColor="accent3" w:themeTint="99"/>  
    </w:tblBorders>  
  </w:tblPr>  
  …</w:tbl>  

The top element specifies a three point top table border of type thinThinThickMediumGap. end example].

Parent Elements
tblBorders (§17.4.39); tblBorders (§17.4.40)

This element’s content model is defined by the common border properties definition in §17.3.4.

[ISO/IEC 29500-1 1st Edition]

top (Top Border)

This element specifies the presentation and display of the page border displayed at the top of each page in this section.

[Example: Consider a section in which all pages must have a top border consisting of a repeated image of balloons, like this:

5cba059f-89ed-4087-86ae-32fc8ff26a57

This border would result in the following WordprocessingML:

<w:sectPr>  
  …  <w:pgBorders>  
    <w:top w:val="balloons3Colors" …/>  
  </w:pgBorders>  
  …</w:sectPr>  

Because the page only has a border at the top, only the top element is specified within the set of page borders. end example]

When a document has a top border that is relative to the page edges (using an offsetFrom attribute value of page on pgBorders), it shall span the top edge of the page at the location defined by its properties, stopping when:

• It intersects with the corresponding left or right page border (if one is specified)

• It reaches the edge of the page.

[Example: In the example above, no left or right border was specified in the WordprocessingML, so a consumer must draw the border from one edge of the page to the other. end example]

When a document has a top border that is relative to the text (using the offsetFrom attribute value of text on pgBorders), it shall only span the necessary width to satisfy the requirement of spanning the width of the text.

When a document has custom border art specified by attributes topLeft, topRight, and/or id, it shall use the corresponding relationship part item as an image for the top left corner, top right corner, and/or top border, respectively. If the corresponding relationship part item cannot be resolved the consumer shall use the border specified by the value of the val attribute. If the corresponding value of the val attribute cannot be resolved no top left corner, top right corner, or top border is present when the page is displayed.

When a document has a custom border art specified by attribute id without specifying either attributes topRight and/or topLeft, the top border as resolved by the corresponding relationship part item of attribute id shall span to the corners not specified by topRight and/or topLeft attributes.

Parent Elements
pgBorders (§17.6.10)

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

[ISO/IEC 29500-1 1st Edition]

top (Top Border for HTML div)

This element specifies the border which shall be displayed at the top of the boundaries of the current HTML div object.

If this element is omitted, then this HTML div object shall not have a top border.

[Example: Consider a simple HTML document defined as follows:

<html>  
  <body>  
    <div style=" border-left-style:solid; border-right-style:groove; border-right-width:1px; border-top-style:dashed; border-top-width:3px; border-bottom-style:outset; border-bottom-width:3px">  
      <p>paragraph of text</p>  
    </div>  
  </body>  
</html>  

This HTML would therefore normally appear as follows (image scaled appropriately):

80f86de9-0ded-4cb3-8002-c4d4140efec0

Now, when this document is saved in the WordprocessingML format, the information stored on the div elements is stored in the web setting part as follows:

<w:divs>  
  <w:div w:id="1785730240">  
    …    <w:divBdr>  
      <w:top w:val="dashed" w:sz="18" w:space="7" w:color="auto" />  
      <w:left w:val="single" w:sz="24" w:space="4" w:color="auto" />  
      <w:bottom w:val="outset" w:sz="18" w:color="auto" />  
      <w:right w:val="threeDEngrave" w:sz="6" w:color="auto" />  
    </w:divBdr>  
  </w:div>  
</w:divs>  

The top element specifies border information about the top border for the single HTML div structure in the document; in this case, a 2.25 point bottom border of type dashed. The initial 3 pixel border was converted to 2.25 points using the following logic:

end example]

Parent Elements
divBdr (§17.15.2.7)

This element’s content model is defined by the common border properties definition in §17.3.4.

� ISO/IEC29500: 2008.

Constructors

TopBorder()

Initializes a new instance of the TopBorder class.

Properties

ChildElements	Gets all the child nodes of the current element. (Inherited from OpenXmlElement)
Color	Border Color Represents the following attribute in the schema: w:color (Inherited from BorderType)
ExtendedAttributes	Gets all extended attributes (attributes not defined in the schema) of the current element. (Inherited from OpenXmlElement)
Features	Gets a IFeatureCollection for the current element. This feature collection will be read-only, but will inherit features from its parent part and package if available. (Inherited from OpenXmlElement)
FirstChild	Gets the first child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
Frame	Create Frame Effect Represents the following attribute in the schema: w:frame (Inherited from BorderType)
HasAttributes	Gets a value indicating whether the current element has any attributes. (Inherited from OpenXmlElement)
HasChildren	Gets a value that indicates whether the current element has any child elements. (Inherited from OpenXmlLeafElement)
InnerText	Gets or sets the concatenated values of the node and all of its children. (Inherited from OpenXmlElement)
InnerXml	Gets or sets the markup that only represents child elements of the current element. (Inherited from OpenXmlLeafElement)
LastChild	Gets the last child of the OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no such OpenXmlElement element. (Inherited from OpenXmlElement)
LocalName	Gets the local name of the current element. (Inherited from OpenXmlElement)
MCAttributes	Gets or sets the markup compatibility attributes. Returns null if no markup compatibility attributes are defined for the current element. (Inherited from OpenXmlElement)
NamespaceDeclarations	Gets all the namespace declarations defined in the current element. Returns an empty enumerator if there is no namespace declaration. (Inherited from OpenXmlElement)
NamespaceUri	Gets the namespace URI of the current element. (Inherited from OpenXmlElement)
OpenXmlElementContext	Gets the OpenXmlElementContext of the current element. (Inherited from OpenXmlElement)
OuterXml	Gets the markup that represents the current element and all of its child elements. (Inherited from OpenXmlElement)
Parent	Gets the parent element of the current element. (Inherited from OpenXmlElement)
Prefix	Gets the namespace prefix of current element. (Inherited from OpenXmlElement)
Shadow	Border Shadow Represents the following attribute in the schema: w:shadow (Inherited from BorderType)
Size	Border Width Represents the following attribute in the schema: w:sz (Inherited from BorderType)
Space	Border Spacing Measurement Represents the following attribute in the schema: w:space (Inherited from BorderType)
ThemeColor	Border Theme Color Represents the following attribute in the schema: w:themeColor (Inherited from BorderType)
ThemeShade	Border Theme Color Shade Represents the following attribute in the schema: w:themeShade (Inherited from BorderType)
ThemeTint	Border Theme Color Tint Represents the following attribute in the schema: w:themeTint (Inherited from BorderType)
Val	Border Style Represents the following attribute in the schema: w:val (Inherited from BorderType)
XmlQualifiedName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)
XName	Gets the qualified name of the current element. (Inherited from OpenXmlElement)

Methods

AddAnnotation(Object)	Adds an object to the current OpenXmlElement element's list of annotations. (Inherited from OpenXmlElement)
AddNamespaceDeclaration(String, String)	Adds a namespace declaration to the current node. (Inherited from OpenXmlElement)
Ancestors()	Enumerates all of the current element's ancestors. (Inherited from OpenXmlElement)
Ancestors<T>()	Enumerates only the current element's ancestors that have the specified type. (Inherited from OpenXmlElement)
Annotation(Type)	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotation<T>()	Get the first annotation object of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations(Type)	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Annotations<T>()	Gets a collection of annotations with the specified type for the current OpenXmlElement element. (Inherited from OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Appends each element from a list of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
Append(OpenXmlElement[])	Appends each element from an array of elements to the end of the current element's list of child elements. (Inherited from OpenXmlElement)
AppendChild<T>(T)	Appends the specified element to the end of the current element's list of child nodes. (Inherited from OpenXmlElement)
ClearAllAttributes()	Clears all of the attributes, including both known attributes and extended attributes. (Inherited from OpenXmlElement)
Clone()	Creates a duplicate of the current node. (Inherited from OpenXmlElement)
CloneNode(Boolean)	Creates a duplicate of this node.
Descendants()	Enumerates all of the current element's descendants. (Inherited from OpenXmlElement)
Descendants<T>()	Enumerate all of the current element's descendants of type T. (Inherited from OpenXmlElement)
Elements()	Enumerates all of the current element's children. (Inherited from OpenXmlElement)
Elements<T>()	Enumerates only the current element's children that have the specified type. (Inherited from OpenXmlElement)
ElementsAfter()	Enumerates all of the sibling elements that follow the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
ElementsBefore()	Enumerates all of the sibling elements that precede the current element and have the same parent as the current element. (Inherited from OpenXmlElement)
GetAttribute(String, String)	Gets an Open XML attribute with the specified tag name and namespace URI. (Inherited from OpenXmlElement)
GetAttributes()	Gets a list that contains a copy of all the attributes. (Inherited from OpenXmlElement)
GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)
GetFirstChild<T>()	Finds the first child element in type T. (Inherited from OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserts the specified element immediately after the specified reference element. (Inherited from OpenXmlElement)
InsertAfterSelf<T>(T)	Inserts the specified element immediately after the current element. (Inherited from OpenXmlElement)
InsertAt<T>(T, Int32)	Inserts the specified element at the specified index in the current element's list of child elements. (Inherited from OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserts the specified element immediately before the specified reference element. (Inherited from OpenXmlElement)
InsertBeforeSelf<T>(T)	Inserts the specified element immediately before the current element. (Inherited from OpenXmlElement)
IsAfter(OpenXmlElement)	Determines if the current element appears after a specified element in document order. (Inherited from OpenXmlElement)
IsBefore(OpenXmlElement)	Determines if the current element appears before a specified element in document order. (Inherited from OpenXmlElement)
LookupNamespace(String)	Resolves the namespace prefix in the context of the current node. (Inherited from OpenXmlElement)
LookupPrefix(String)	Finds the corresponding prefix for a namespace uri in the current element scope. (Inherited from OpenXmlElement)
NextSibling()	Gets the OpenXmlElement element that immediately follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement element. (Inherited from OpenXmlElement)
NextSibling<T>()	Gets the OpenXmlElement element with the specified type that follows the current OpenXmlElement element. Returns null (Nothing in Visual Basic) if there is no next OpenXmlElement. (Inherited from OpenXmlElement)
PrependChild<T>(T)	Inserts the specified element at the beginning of the current element's list of child elements. (Inherited from OpenXmlElement)
PreviousSibling()	Gets the OpenXmlElement element that immediately precedes the current OpenXmlElement element. Returns null (Nothing in Visual Basic ) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
PreviousSibling<T>()	Gets the OpenXmlElement element with the specified type that precedes the current OpenXmlElement. Returns null (Nothing in Visual Basic) if there is no preceding OpenXmlElement element. (Inherited from OpenXmlElement)
Remove()	Removes the current element from its parent. (Inherited from OpenXmlElement)
RemoveAllChildren()	Removes all child elements of the current element. (Inherited from OpenXmlLeafElement)
RemoveAllChildren<T>()	Remove all of the current element's child elements that are of type T. (Inherited from OpenXmlElement)
RemoveAnnotations(Type)	Removes the annotations of the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAnnotations<T>()	Removes the annotations with the specified type from the current OpenXmlElement element. (Inherited from OpenXmlElement)
RemoveAttribute(String, String)	Removes the attribute from the current element. (Inherited from OpenXmlElement)
RemoveChild<T>(T)	Removes the specified child element from the current element's list of child elements. (Inherited from OpenXmlElement)
RemoveNamespaceDeclaration(String)	Removes the namespace declaration for the specified prefix. Removes nothing if there is no prefix. (Inherited from OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Replaces a child element with another child element in the current element's list of child elements. (Inherited from OpenXmlElement)
SetAttribute(OpenXmlAttribute)	Sets an attribute to the specified element. If the attribute is a known attribute, the value of the attribute is set. If the attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Sets a number of attributes to the element. If an attribute is a known attribute, the value of the attribute is set. If an attribute is an extended attribute, the 'openxmlAttribute' is added to the extended attributes list. (Inherited from OpenXmlElement)
WriteTo(XmlWriter)	Saves the current node to the specified XmlWriter. (Inherited from OpenXmlElement)

Explicit Interface Implementations

IEnumerable.GetEnumerator()	(Inherited from OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Returns an enumerator that iterates through the child collection. (Inherited from OpenXmlElement)