Class Attributes

Common XML attributes used across WordprocessingML elements.

This class provides a convenient way to add common attributes to XML elements. It automatically maps JavaScript-friendly property names to their corresponding w: (WordprocessingML) namespace prefixed XML attribute names.

Example

// Create an element with a value attribute
new Attributes({ val: "someValue" });
// Generates: <element w:val="someValue"/>

// Multiple attributes
new Attributes({ color: "FF0000", sz: "24" });
// Generates: <element w:color="FF0000" w:sz="24"/>

Hierarchy (View Summary)

XmlAttributeComponent<
    {
        bottom?: string;
        color?: string;
        fill?: string;
        footer?: string;
        gutter?: string;
        h?: string;
        header?: string;
        left?: string;
        linePitch?: string;
        pos?: string
        | number;
        right?: string;
        rsidR?: string;
        rsidRPr?: string;
        rsidSect?: string;
        space?: string;
        sz?: string;
        top?: string;
        type?: string;
        val?: string | number | boolean;
        w?: string;
    },
>
- Attributes

Index

Constructors

constructor

Methods

prepForXml

Constructors

constructor

new Attributes(
    root: {
        bottom?: string;
        color?: string;
        fill?: string;
        footer?: string;
        gutter?: string;
        h?: string;
        header?: string;
        left?: string;
        linePitch?: string;
        pos?: string | number;
        right?: string;
        rsidR?: string;
        rsidRPr?: string;
        rsidSect?: string;
        space?: string;
        sz?: string;
        top?: string;
        type?: string;
        val?: string | number | boolean;
        w?: string;
    },
): Attributes
Creates a new attribute component.
Parameters
- root: {
      bottom?: string;
      color?: string;
      fill?: string;
      footer?: string;
      gutter?: string;
      h?: string;
      header?: string;
      left?: string;
      linePitch?: string;
      pos?: string | number;
      right?: string;
      rsidR?: string;
      rsidRPr?: string;
      rsidSect?: string;
      space?: string;
      sz?: string;
      top?: string;
      type?: string;
      val?: string | number | boolean;
      w?: string;
  }
  The attribute data object
  - Optional Readonlybottom?: string
    Bottom margin/spacing (w:bottom).
  - Optional Readonlycolor?: string
    Color value (w:color).
  - Optional Readonlyfill?: string
    Fill color (w:fill).
  - Optional Readonlyfooter?: string
    Footer margin (w:footer).
  - Optional Readonlygutter?: string
    Gutter margin (w:gutter).
  - Optional Readonlyh?: string
    Height (w:h).
  - Optional Readonlyheader?: string
    Header margin (w:header).
  - Optional Readonlyleft?: string
    Left margin/spacing (w:left).
  - Optional ReadonlylinePitch?: string
    Line pitch (w:linePitch).
  - Optional Readonlypos?: string | number
    Position value (w:pos).
  - Optional Readonlyright?: string
    Right margin/spacing (w:right).
  - Optional ReadonlyrsidR?: string
    Revision ID for run content (w:rsidR).
  - Optional ReadonlyrsidRPr?: string
    Revision ID for run properties (w:rsidRPr).
  - Optional ReadonlyrsidSect?: string
    Revision ID for section (w:rsidSect).
  - Optional Readonlyspace?: string
    Space preservation (w:space).
  - Optional Readonlysz?: string
    Size value (w:sz).
  - Optional Readonlytop?: string
    Top margin/spacing (w:top).
  - Optional Readonlytype?: string
    Type specification (w:type).
  - Optional Readonlyval?: string | number | boolean
    Generic value attribute (w:val).
  - Optional Readonlyw?: string
    Width (w:w).
Returns Attributes
Inherited from XmlAttributeComponent.constructor
- Defined in file/xml-components/default-attributes.ts:60

Methods

prepForXml

prepForXml(_: IContext): IXmlableObject
Converts the attribute data to an XML-serializable object.

This method transforms the property names using xmlKeys (if defined) and filters out undefined values.
Parameters
- _: IContext
  Context (unused for attributes)
Returns IXmlableObject
Object with _attr key containing the mapped attributes
Inherited from XmlAttributeComponent.prepForXml
- Defined in file/xml-components/default-attributes.ts:73

Class Attributes

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

`Optional` `Readonly`bottom?: string

`Optional` `Readonly`color?: string

`Optional` `Readonly`fill?: string

`Optional` `Readonly`footer?: string

`Optional` `Readonly`gutter?: string

`Optional` `Readonly`h?: string

`Optional` `Readonly`header?: string

`Optional` `Readonly`left?: string

`Optional` `Readonly`linePitch?: string

`Optional` `Readonly`pos?: string | number

`Optional` `Readonly`right?: string

`Optional` `Readonly`rsidR?: string

`Optional` `Readonly`rsidRPr?: string

`Optional` `Readonly`rsidSect?: string

`Optional` `Readonly`space?: string

`Optional` `Readonly`sz?: string

`Optional` `Readonly`top?: string

`Optional` `Readonly`type?: string

`Optional` `Readonly`val?: string | number | boolean

`Optional` `Readonly`w?: string

Returns Attributes

Methods

prepForXml

Parameters

Returns IXmlableObject

Settings

On This Page

Class Attributes

Example

Hierarchy (View Summary)

Index

Constructors

Methods

Constructors

constructor

Parameters

Optional Readonlybottom?: string

Optional Readonlycolor?: string

Optional Readonlyfill?: string

Optional Readonlyfooter?: string

Optional Readonlygutter?: string

Optional Readonlyh?: string

Optional Readonlyheader?: string

Optional Readonlyleft?: string

Optional ReadonlylinePitch?: string

Optional Readonlypos?: string | number

Optional Readonlyright?: string

Optional ReadonlyrsidR?: string

Optional ReadonlyrsidRPr?: string

Optional ReadonlyrsidSect?: string

Optional Readonlyspace?: string

Optional Readonlysz?: string

Optional Readonlytop?: string

Optional Readonlytype?: string

Optional Readonlyval?: string | number | boolean

Optional Readonlyw?: string

Returns Attributes

Methods

prepForXml

Parameters

Returns IXmlableObject

Settings

On This Page

`Optional` `Readonly`bottom?: string

`Optional` `Readonly`color?: string

`Optional` `Readonly`fill?: string

`Optional` `Readonly`footer?: string

`Optional` `Readonly`gutter?: string

`Optional` `Readonly`h?: string

`Optional` `Readonly`header?: string

`Optional` `Readonly`left?: string

`Optional` `Readonly`linePitch?: string

`Optional` `Readonly`pos?: string | number

`Optional` `Readonly`right?: string

`Optional` `Readonly`rsidR?: string

`Optional` `Readonly`rsidRPr?: string

`Optional` `Readonly`rsidSect?: string

`Optional` `Readonly`space?: string

`Optional` `Readonly`sz?: string

`Optional` `Readonly`top?: string

`Optional` `Readonly`type?: string

`Optional` `Readonly`val?: string | number | boolean

`Optional` `Readonly`w?: string