OpenXmlSdkTs - v1.0.7
    Preparing search index...

    Class XAttribute

    Represents an XML attribute on an element.

    Attributes are not nodes in the XNode sense -- they do not appear in XContainer.nodes | nodes() or descendants() results -- but they inherit from XObject and carry the same parent reference and annotation API.

    const a = new XAttribute('id', '42');
    a.name.localName; // 'id'
    a.value; // '42'

    Hierarchy

    • XObject
      • XAttribute
    Index

    Constructors

    constructor

    Properties

    name value nodeType parent

    Accessors

    isNamespaceDeclaration nextAttribute previousAttribute document

    Methods

    remove setValue equals toString addAnnotation annotation annotations removeAnnotations

    Constructors

    • Creates a new XAttribute with the given name and an empty-string value.

      Parameters

      • name: string | XName

        The qualified name of the attribute.

      Returns XAttribute

      Accepts either a name and value, a name alone (empty-string value), or an existing XAttribute to copy.

      const a = new XAttribute('id', '42');
      const copy = new XAttribute(a);

    • Creates a new XAttribute with the given name and value.

      Parameters

      • name: string | XName

        The qualified name of the attribute.

      • content: unknown

        The value, converted to a string via toString().

      Returns XAttribute

    • Creates a new XAttribute by copying an existing one.

      Parameters

      Returns XAttribute

    Properties

    name: XName

    The fully-qualified name of this attribute.

    value: string

    The string value of this attribute.

    nodeType: XmlNodeType

    The kind of XML node this object represents.

    const el = new XElement('root');
    console.log(el.nodeType); // 'Element'
    parent: XObject | null

    The parent of this object in the XML tree, or null if it is a root.

    const child = new XElement('child');
    const parent = new XElement('parent', child);
    console.log(child.parent === parent); // true

    Accessors

    • get isNamespaceDeclaration(): boolean

      Indicates whether this attribute is a namespace declaration (xmlns or xmlns:prefix).

      Returns boolean

      new XAttribute(XNamespace.xmlns + 'w', 'http://...').isNamespaceDeclaration; // true
    • get nextAttribute(): XAttribute | null

      Returns the next sibling attribute on the parent element, or null.

      Returns XAttribute | null

      const el = new XElement('a', new XAttribute('x','1'), new XAttribute('y','2'));
      el.firstAttribute?.nextAttribute?.name.localName; // 'y'
    • get previousAttribute(): XAttribute | null

      Returns the previous sibling attribute on the parent element, or null.

      Returns XAttribute | null

    • get document(): XDocument | null

      Gets the XDocument that contains this object, or null if the object is not part of a document tree.

      Returns XDocument | null

      const doc = new XDocument(new XElement('root', new XElement('child')));
      const child = doc.root!.elements()[0];
      console.log(child.document === doc); // true

    Methods

    • Removes this attribute from its parent element.

      Returns void

      Error if the attribute has no parent.

    • Sets the value of this attribute.

      Parameters

      • value: string

        The new string value. Must not be null or undefined.

      Returns void

      Error if value is null or undefined.

    • Compares this attribute to another by name and value.

      Parameters

      • other: XAttribute

        The attribute to compare against.

      Returns boolean

      true if both name and value are equal.

    • Returns the XML serialization of this attribute, e.g. name='value'.

      Returns string

      The serialized attribute string with XML-escaped value.

    • Attaches an arbitrary annotation object to this XML object.

      Parameters

      • obj: unknown

        The annotation object to attach.

      Returns void

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));

    • Returns the first annotation of the specified type, or null if none exists.

      Type Parameters

      • T

        The annotation class to look up.

      Parameters

      • ctor: new (...args: any[]) => T

        Constructor of the annotation type to retrieve.

      Returns T | null

      The first matching annotation, or null.

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));
      const m = el.annotation(MyMeta);
      console.log(m?.tag); // 'important'

    • Returns all annotations of the specified type.

      Type Parameters

      • T

        The annotation class to look up.

      Parameters

      • ctor: new (...args: any[]) => T

        Constructor of the annotation type to retrieve.

      Returns T[]

      An array of matching annotations (may be empty).

    • Removes annotations from this object.

      Returns void

      When called with no arguments, all annotations are removed. When called with a constructor, only annotations of that type are removed.

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));
      el.removeAnnotations(MyMeta);  // removes only MyMeta annotations
      el.removeAnnotations();        // removes everything

    • Removes annotations from this object.

      Type Parameters

      • T

      Parameters

      • ctor: new (...args: any[]) => T

      Returns void

      When called with no arguments, all annotations are removed. When called with a constructor, only annotations of that type are removed.

      class MyMeta { constructor(public tag: string) {} }
      const el = new XElement('item');
      el.addAnnotation(new MyMeta('important'));
      el.removeAnnotations(MyMeta);  // removes only MyMeta annotations
      el.removeAnnotations();        // removes everything

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods