Class TableProperties

Represents table properties (tblPr) in a WordprocessingML document.

The tblPr element specifies the properties for a table including width, alignment, borders, margins, and layout.

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

Hierarchy (View Summary)

IgnoreIfEmptyXmlComponent
- TableProperties

Index

Constructors

Accessors

Methods

addChildElement prepForXml

Constructors

constructor

new TableProperties(options: ITablePropertiesOptions): TableProperties
Parameters
- options: ITablePropertiesOptions
Returns TableProperties
Overrides IgnoreIfEmptyXmlComponent.constructor
- Defined in file/table/table-properties/table-properties.ts:107

Accessors

writtenAs

get writtenAs(): readonly BaseXmlComponent[] | undefined
Internal
The components written in this one's place, one after another, when it can't be written as a single element, such as a run with another run in its children. Undefined when it is written as itself.

Returns readonly BaseXmlComponent[] | undefined
Inherited from IgnoreIfEmptyXmlComponent.writtenAs
- Defined in file/xml-components/base.ts:84

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:128

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:175