Class Border

Represents paragraph borders in a WordprocessingML document.

The pBdr element specifies borders that surround the paragraph.

Reference: http://officeopenxml.com/WPborders.php

XSD Schema

<xsd:complexType name="CT_PBdr">
  <xsd:sequence>
    <xsd:element name="top" type="CT_Border" minOccurs="0"/>
    <xsd:element name="left" type="CT_Border" minOccurs="0"/>
    <xsd:element name="bottom" type="CT_Border" minOccurs="0"/>
    <xsd:element name="right" type="CT_Border" minOccurs="0"/>
    <xsd:element name="between" type="CT_Border" minOccurs="0"/>
    <xsd:element name="bar" type="CT_Border" minOccurs="0"/>
  </xsd:sequence>
</xsd:complexType>

Example

new Paragraph({
  border: {
    top: { style: BorderStyle.SINGLE, size: 6, color: "FF0000" },
    bottom: { style: BorderStyle.SINGLE, size: 6, color: "FF0000" },
  },
  children: [new TextRun("Paragraph with top and bottom borders")],
});

Hierarchy (View Summary)

IgnoreIfEmptyXmlComponent
- Border

Index

Constructors

constructor

Methods

addChildElement prepForXml

Constructors

constructor

new Border(options: IBordersOptions): Border
Parameters
- options: IBordersOptions
Returns Border
Overrides IgnoreIfEmptyXmlComponent.constructor
- Defined in file/paragraph/formatting/border.ts:70

Methods

addChildElement

addChildElement(child: string | XmlComponent): XmlComponent
Adds a child element to this component.
Parameters
- child: string | XmlComponent
  The child component or text string to add
Returns XmlComponent
This component (for chaining)

Deprecated
Do not use this method. It is only used internally by the library. It will be removed in a future version.
Inherited from IgnoreIfEmptyXmlComponent.addChildElement
- Defined in file/xml-components/xml-component.ts:126

prepForXml

prepForXml(context: IContext): IXmlableObject | undefined
Prepares the component for XML serialization, excluding it if empty.
Parameters
- context: IContext
  The serialization context
Returns IXmlableObject | undefined
The XML-serializable object, or undefined if empty
Inherited from IgnoreIfEmptyXmlComponent.prepForXml
- Defined in file/xml-components/xml-component.ts:173

Class Border

XSD Schema

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns Border

Methods

addChildElement

Parameters

Returns XmlComponent

Deprecated

prepForXml

Parameters

Returns IXmlableObject | undefined

Settings

On This Page