docx
    Preparing search index...

    Class HpsMeasureElement

    XML element representing a half-point size measurement (CT_HpsMeasure).

    HpsMeasure elements are used for font sizes and other measurements in WordprocessingML. Values can be specified as numbers (interpreted as half-points) or with explicit units.

    OOXML Reference:

    <xsd:complexType name="CT_HpsMeasure">
      <xsd:attribute name="val" type="ST_HpsMeasure" use="required"/>
    </xsd:complexType>

    <xsd:simpleType name="ST_HpsMeasure">
      <xsd:union memberTypes="s:ST_UnsignedDecimalNumber s:ST_PositiveUniversalMeasure" />
    </xsd:simpleType>

    // Font size of 24 half-points (12pt)
    new HpsMeasureElement("w:sz", 24);
    // Generates: <w:sz w:val="24"/>

    // Using explicit units
    new HpsMeasureElement("w:sz", "12pt");

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Methods

    addChildElement prepForXml

    Constructors

    • Creates an HpsMeasureElement.

      Parameters

      • name: string

        The XML element name

      • val:
            | number
            | `${number}mm`
            | `${number}cm`
            | `${number}in`
            | `${number}pt`
            | `${number}pc`
            | `${number}pi`

        The measurement value (number in half-points or string with units)

      Returns HpsMeasureElement

    Methods

    • Prepares this component and its children for XML serialization.

      This method is called by the Formatter to convert the component tree into an object structure compatible with the xml library (https://www.npmjs.com/package/xml). It recursively processes all children and handles special cases like attribute-only elements and empty elements.

      The method can be overridden by subclasses to customize XML representation or execute side effects during serialization (e.g., creating relationships).

      Parameters

      • context: IContext

        The serialization context containing document state

      Returns IXmlableObject | undefined

      The XML-serializable object, or undefined to exclude from output

      // Override to add custom serialization logic
      prepForXml(context: IContext): IXmlableObject | undefined {
        // Custom logic here
        return super.prepForXml(context);
      }

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods