@syncfusion/ej2-docx 0.0.0-stage → 35.1.40

package/src/features/document/page-setup.d.ts

@@ -0,0 +1,339 @@
+/**
+ * Public section page-setup contract (architecture §4–10).
+ *
+ * Core types `Section.pageSetup` against this surface so consumers see the live
+ * DocIO-aligned API without the core package importing the sections feature. The
+ * feature `PageSetup` class implements this interface plus internal
+ * {@link SectionPropertiesModel} serialization.
+ *
+ * @public
+ */
+/**
+ * Page orientation (`ST_PageOrientation`).
+ *
+ * @public
+ */
+export declare enum PageOrientation {
+    Portrait = "portrait",
+    Landscape = "landscape"
+}
+/**
+ * Page number formats (`ST_NumberFormat` subset used for page numbers).
+ *
+ * Maps to `w:pgNumType/@w:fmt`.
+ *
+ * @public
+ */
+export declare enum PageNumberStyle {
+    /** Arabic decimal numerals (`decimal`). */
+    Arabic = "decimal",
+    /** Uppercase Roman numerals. */
+    UpperRoman = "upperRoman",
+    /** Lowercase Roman numerals. */
+    LowerRoman = "lowerRoman",
+    /** Uppercase letters. */
+    UpperLetter = "upperLetter",
+    /** Lowercase letters. */
+    LowerLetter = "lowerLetter",
+    /** Ordinal numbers (`1st`, `2nd`, …). */
+    Ordinal = "ordinal",
+    /** Cardinal text (`One`, `Two`, …). */
+    CardinalText = "cardinalText",
+    /** Ordinal text (`First`, `Second`, …). */
+    OrdinalText = "ordinalText",
+    /** Number in dashes. */
+    NumberInDash = "numberInDash",
+    /** Chicago style. */
+    Chicago = "chicago"
+}
+/**
+ * When line numbers restart counting (`ST_LineNumberRestart`).
+ *
+ * EJ2 member names; wire tokens are the enum values.
+ *
+ * @public
+ */
+export declare enum LineNumberingMode {
+    Continuous = "continuous",
+    RestartPage = "newPage",
+    RestartSection = "newSection"
+}
+/**
+ * Printer paper tray codes (`w:paperSrc` / Win32 `DMBIN_*` style integers).
+ *
+ * Unknown loaded codes are preserved internally and are not forced into an
+ * incorrect public member.
+ *
+ * @public
+ */
+export declare enum PrinterPaperTray {
+    /** Default / only bin (typically `1`). */
+    DefaultBin = 1,
+    /** Upper bin (`1`). */
+    UpperBin = 1,
+    /** Lower bin (`2`). */
+    LowerBin = 2,
+    /** Middle bin (`3`). */
+    MiddleBin = 3,
+    /** Manual feed (`4`). */
+    ManualFeed = 4,
+    /** Envelope feed (`5`). */
+    EnvelopeFeed = 5,
+    /** Envelope manual feed (`6`). */
+    EnvelopeManualFeed = 6,
+    /** Auto sheet feed (`7`). */
+    AutoSheetFeed = 7,
+    /** Tractor feed (`8`). */
+    TractorFeed = 8,
+    /** Small-format bin (`9`). */
+    SmallFormatBin = 9,
+    /** Large-format bin (`10`). */
+    LargeFormatBin = 10,
+    /** Large-capacity bin (`11`). */
+    LargeCapacityBin = 11,
+    /** Cassette (`14`). */
+    Cassette = 14,
+    /** Form source (`15`). */
+    FormSource = 15
+}
+/**
+ * Vertical text alignment on the page (`ST_VerticalJc` / `w:vAlign`).
+ *
+ * EJ2 member names; wire tokens are the enum values.
+ *
+ * @public
+ */
+export declare enum VerticalAlignment {
+    Top = "top",
+    Center = "center",
+    Both = "both",
+    Bottom = "bottom"
+}
+/**
+ * Page border offset origin (`CT_PageBorders/@w:offsetFrom`).
+ *
+ * @public
+ */
+export declare enum PageBorderOffsetFrom {
+    /** Measure border space from the text area (`text`). */
+    Text = "text",
+    /** Measure border space from the page edge (`page`). */
+    PageEdge = "page"
+}
+/**
+ * Which pages receive page borders (`CT_PageBorders/@w:display`).
+ *
+ * @public
+ */
+export declare enum PageBordersApplyType {
+    /** All pages in the section (`allPages`). */
+    AllPages = "allPages",
+    /** First page only (`firstPage`). */
+    FirstPage = "firstPage",
+    /** All pages except the first (`notFirstPage`). */
+    NotFirstPage = "notFirstPage"
+}
+/**
+ * Page / paragraph border line styles (`ST_Border` subset).
+ *
+ * EJ2 member names; wire tokens are the enum values.
+ *
+ * @public
+ */
+export declare enum BorderStyle {
+    Nil = "nil",
+    None = "none",
+    Single = "single",
+    Thick = "thick",
+    Double = "double",
+    Dotted = "dotted",
+    Dashed = "dashed",
+    DotDash = "dotDash",
+    DotDotDash = "dotDotDash",
+    Triple = "triple",
+    ThinThickSmallGap = "thinThickSmallGap",
+    ThickThinSmallGap = "thickThinSmallGap",
+    ThinThickThinSmallGap = "thinThickThinSmallGap",
+    ThinThickMediumGap = "thinThickMediumGap",
+    ThickThinMediumGap = "thickThinMediumGap",
+    ThinThickThinMediumGap = "thinThickThinMediumGap",
+    ThinThickLargeGap = "thinThickLargeGap",
+    ThickThinLargeGap = "thickThinLargeGap",
+    ThinThickThinLargeGap = "thinThickThinLargeGap",
+    Wave = "wave",
+    DoubleWave = "doubleWave",
+    DashSmallGap = "dashSmallGap",
+    DashDotStroked = "dashDotStroked",
+    ThreeDEmboss = "threeDEmboss",
+    ThreeDEngrave = "threeDEngrave",
+    Outset = "outset",
+    Inset = "inset"
+}
+/**
+ * Mutable page size dimensions in points (`CT_PageSz` width/height only).
+ *
+ * Orientation is owned by {@link PageSetup}. Mutating width/height notifies the
+ * owning setup (when attached) so orientation stays in sync.
+ *
+ * @public
+ */
+export declare class SizeF {
+    private widthValue;
+    private heightValue;
+    private changeListener;
+    /**
+     * @param width - Width in points.
+     * @param height - Height in points.
+     */
+    constructor(width: number, height: number);
+    /**
+     * @private
+     * Owned by {@link PageSetup} so dimension edits can recompute orientation.
+     */
+    setChangeListener(listener: ((width: number, height: number) => void) | undefined): void;
+    /**
+     * @private
+     * Replace both dimensions without re-entry through public setters.
+     */
+    replace(width: number, height: number, notify: boolean): void;
+    width: number;
+    height: number;
+}
+/**
+ * Live page margins surface (`CT_PageMar` left/top/right/bottom).
+ *
+ * @public
+ */
+export interface PageMargins {
+    all: number;
+    left: number;
+    top: number;
+    right: number;
+    bottom: number;
+}
+/**
+ * One live page-border edge (`w:top` / `w:left` / `w:bottom` / `w:right`).
+ *
+ * Edge style, color, and width are owned by {@link PageBorders}; only
+ * per-edge space is public here.
+ *
+ * @public
+ */
+export interface PageBorder {
+    space: number;
+}
+/**
+ * Live page borders surface (`CT_PageBorders`).
+ *
+ * `borderType`, `color`, and `lineWidth` apply to all four edges.
+ *
+ * @public
+ */
+export interface PageBorders {
+    borderType: BorderStyle;
+    /** Common edge color (named {@link Color} or mapped wire). */
+    color: import('./color').Color;
+    lineWidth: number;
+    readonly top: PageBorder;
+    readonly bottom: PageBorder;
+    readonly left: PageBorder;
+    readonly right: PageBorder;
+}
+/**
+ * Public live page-setup API for a document section.
+ *
+ * Always returned from {@link Section.pageSetup} when the sections feature is
+ * registered (never `undefined`, never {@link SectionPropertiesModel} alone).
+ *
+ * @public
+ */
+export interface PageSetup {
+    /**
+     * Page orientation. Setter swaps width/height only when needed.
+     */
+    orientation: PageOrientation;
+    /**
+     * Live page size (stable identity). Setter copies width/height and derives orientation.
+     */
+    pageSize: SizeF;
+    /**
+     * Live margins instance (stable identity for the life of this page setup).
+     */
+    readonly margins: PageMargins;
+    /**
+     * Distance from page top to header (`w:pgMar/@w:header`), points.
+     */
+    headerDistance: number;
+    /**
+     * Distance from page bottom to footer (`w:pgMar/@w:footer`), points.
+     */
+    footerDistance: number;
+    /**
+     * Gutter margin (`w:pgMar/@w:gutter`), points.
+     */
+    gutter: number;
+    /**
+     * Vertical text alignment on the page (`w:vAlign` / `ST_VerticalJc`).
+     */
+    verticalAlignment: VerticalAlignment;
+    /**
+     * Right-to-left section layout (`w:bidi`, ECMA-376-1 §17.6.1).
+     */
+    bidi: boolean;
+    /**
+     * Live page borders (stable identity).
+     */
+    readonly borders: PageBorders;
+    /**
+     * Page border offset origin (`w:pgBorders/@w:offsetFrom`).
+     */
+    pageBorderOffsetFrom: PageBorderOffsetFrom;
+    /**
+     * Which pages receive page borders (`w:pgBorders/@w:display`).
+     */
+    pageBordersApplyType: PageBordersApplyType;
+    /**
+     * First-page printer tray (`w:paperSrc/@w:first`).
+     */
+    firstPageTray: PrinterPaperTray;
+    /**
+     * Other-pages printer tray (`w:paperSrc/@w:other`).
+     */
+    otherPagesTray: PrinterPaperTray;
+    /**
+     * Different first page (`w:titlePg`).
+     */
+    differentFirstPage: boolean;
+    /**
+     * Different odd and even pages (document settings `w:evenAndOddHeaders`).
+     */
+    differentOddAndEvenPages: boolean;
+    /**
+     * Starting page number when restart is enabled (`w:pgNumType/@w:start`).
+     */
+    pageStartingNumber: number;
+    /**
+     * When `true`, write `w:start` with {@link pageStartingNumber}.
+     */
+    restartPageNumbering: boolean;
+    /**
+     * Page number format (`w:pgNumType/@w:fmt`).
+     */
+    pageNumberStyle: PageNumberStyle;
+    /**
+     * Distance from text to line numbers (`w:lnNumType/@w:distance`), points.
+     */
+    lineNumberingDistanceFromText: number;
+    /**
+     * Line-number restart mode (`w:lnNumType/@w:restart`).
+     */
+    lineNumberingMode: LineNumberingMode;
+    /**
+     * Line-number start value (`w:lnNumType/@w:start`).
+     */
+    lineNumberingStartValue: number;
+    /**
+     * Line-number count-by step (`w:lnNumType/@w:countBy`).
+     */
+    lineNumberingStep: number;
+}

package/src/features/document/page-setup.js

@@ -0,0 +1,244 @@
+/**
+ * Public section page-setup contract (architecture §4–10).
+ *
+ * Core types `Section.pageSetup` against this surface so consumers see the live
+ * DocIO-aligned API without the core package importing the sections feature. The
+ * feature `PageSetup` class implements this interface plus internal
+ * {@link SectionPropertiesModel} serialization.
+ *
+ * @public
+ */
+/**
+ * Page orientation (`ST_PageOrientation`).
+ *
+ * @public
+ */
+export var PageOrientation;
+(function (PageOrientation) {
+    PageOrientation["Portrait"] = "portrait";
+    PageOrientation["Landscape"] = "landscape";
+})(PageOrientation || (PageOrientation = {}));
+/**
+ * Page number formats (`ST_NumberFormat` subset used for page numbers).
+ *
+ * Maps to `w:pgNumType/@w:fmt`.
+ *
+ * @public
+ */
+export var PageNumberStyle;
+(function (PageNumberStyle) {
+    /** Arabic decimal numerals (`decimal`). */
+    PageNumberStyle["Arabic"] = "decimal";
+    /** Uppercase Roman numerals. */
+    PageNumberStyle["UpperRoman"] = "upperRoman";
+    /** Lowercase Roman numerals. */
+    PageNumberStyle["LowerRoman"] = "lowerRoman";
+    /** Uppercase letters. */
+    PageNumberStyle["UpperLetter"] = "upperLetter";
+    /** Lowercase letters. */
+    PageNumberStyle["LowerLetter"] = "lowerLetter";
+    /** Ordinal numbers (`1st`, `2nd`, …). */
+    PageNumberStyle["Ordinal"] = "ordinal";
+    /** Cardinal text (`One`, `Two`, …). */
+    PageNumberStyle["CardinalText"] = "cardinalText";
+    /** Ordinal text (`First`, `Second`, …). */
+    PageNumberStyle["OrdinalText"] = "ordinalText";
+    /** Number in dashes. */
+    PageNumberStyle["NumberInDash"] = "numberInDash";
+    /** Chicago style. */
+    PageNumberStyle["Chicago"] = "chicago";
+})(PageNumberStyle || (PageNumberStyle = {}));
+/**
+ * When line numbers restart counting (`ST_LineNumberRestart`).
+ *
+ * EJ2 member names; wire tokens are the enum values.
+ *
+ * @public
+ */
+export var LineNumberingMode;
+(function (LineNumberingMode) {
+    LineNumberingMode["Continuous"] = "continuous";
+    LineNumberingMode["RestartPage"] = "newPage";
+    LineNumberingMode["RestartSection"] = "newSection";
+})(LineNumberingMode || (LineNumberingMode = {}));
+/**
+ * Printer paper tray codes (`w:paperSrc` / Win32 `DMBIN_*` style integers).
+ *
+ * Unknown loaded codes are preserved internally and are not forced into an
+ * incorrect public member.
+ *
+ * @public
+ */
+export var PrinterPaperTray;
+(function (PrinterPaperTray) {
+    /** Default / only bin (typically `1`). */
+    PrinterPaperTray[PrinterPaperTray["DefaultBin"] = 1] = "DefaultBin";
+    /** Upper bin (`1`). */
+    PrinterPaperTray[PrinterPaperTray["UpperBin"] = 1] = "UpperBin";
+    /** Lower bin (`2`). */
+    PrinterPaperTray[PrinterPaperTray["LowerBin"] = 2] = "LowerBin";
+    /** Middle bin (`3`). */
+    PrinterPaperTray[PrinterPaperTray["MiddleBin"] = 3] = "MiddleBin";
+    /** Manual feed (`4`). */
+    PrinterPaperTray[PrinterPaperTray["ManualFeed"] = 4] = "ManualFeed";
+    /** Envelope feed (`5`). */
+    PrinterPaperTray[PrinterPaperTray["EnvelopeFeed"] = 5] = "EnvelopeFeed";
+    /** Envelope manual feed (`6`). */
+    PrinterPaperTray[PrinterPaperTray["EnvelopeManualFeed"] = 6] = "EnvelopeManualFeed";
+    /** Auto sheet feed (`7`). */
+    PrinterPaperTray[PrinterPaperTray["AutoSheetFeed"] = 7] = "AutoSheetFeed";
+    /** Tractor feed (`8`). */
+    PrinterPaperTray[PrinterPaperTray["TractorFeed"] = 8] = "TractorFeed";
+    /** Small-format bin (`9`). */
+    PrinterPaperTray[PrinterPaperTray["SmallFormatBin"] = 9] = "SmallFormatBin";
+    /** Large-format bin (`10`). */
+    PrinterPaperTray[PrinterPaperTray["LargeFormatBin"] = 10] = "LargeFormatBin";
+    /** Large-capacity bin (`11`). */
+    PrinterPaperTray[PrinterPaperTray["LargeCapacityBin"] = 11] = "LargeCapacityBin";
+    /** Cassette (`14`). */
+    PrinterPaperTray[PrinterPaperTray["Cassette"] = 14] = "Cassette";
+    /** Form source (`15`). */
+    PrinterPaperTray[PrinterPaperTray["FormSource"] = 15] = "FormSource";
+})(PrinterPaperTray || (PrinterPaperTray = {}));
+/**
+ * Vertical text alignment on the page (`ST_VerticalJc` / `w:vAlign`).
+ *
+ * EJ2 member names; wire tokens are the enum values.
+ *
+ * @public
+ */
+export var VerticalAlignment;
+(function (VerticalAlignment) {
+    VerticalAlignment["Top"] = "top";
+    VerticalAlignment["Center"] = "center";
+    VerticalAlignment["Both"] = "both";
+    VerticalAlignment["Bottom"] = "bottom";
+})(VerticalAlignment || (VerticalAlignment = {}));
+/**
+ * Page border offset origin (`CT_PageBorders/@w:offsetFrom`).
+ *
+ * @public
+ */
+export var PageBorderOffsetFrom;
+(function (PageBorderOffsetFrom) {
+    /** Measure border space from the text area (`text`). */
+    PageBorderOffsetFrom["Text"] = "text";
+    /** Measure border space from the page edge (`page`). */
+    PageBorderOffsetFrom["PageEdge"] = "page";
+})(PageBorderOffsetFrom || (PageBorderOffsetFrom = {}));
+/**
+ * Which pages receive page borders (`CT_PageBorders/@w:display`).
+ *
+ * @public
+ */
+export var PageBordersApplyType;
+(function (PageBordersApplyType) {
+    /** All pages in the section (`allPages`). */
+    PageBordersApplyType["AllPages"] = "allPages";
+    /** First page only (`firstPage`). */
+    PageBordersApplyType["FirstPage"] = "firstPage";
+    /** All pages except the first (`notFirstPage`). */
+    PageBordersApplyType["NotFirstPage"] = "notFirstPage";
+})(PageBordersApplyType || (PageBordersApplyType = {}));
+/**
+ * Page / paragraph border line styles (`ST_Border` subset).
+ *
+ * EJ2 member names; wire tokens are the enum values.
+ *
+ * @public
+ */
+export var BorderStyle;
+(function (BorderStyle) {
+    BorderStyle["Nil"] = "nil";
+    BorderStyle["None"] = "none";
+    BorderStyle["Single"] = "single";
+    BorderStyle["Thick"] = "thick";
+    BorderStyle["Double"] = "double";
+    BorderStyle["Dotted"] = "dotted";
+    BorderStyle["Dashed"] = "dashed";
+    BorderStyle["DotDash"] = "dotDash";
+    BorderStyle["DotDotDash"] = "dotDotDash";
+    BorderStyle["Triple"] = "triple";
+    BorderStyle["ThinThickSmallGap"] = "thinThickSmallGap";
+    BorderStyle["ThickThinSmallGap"] = "thickThinSmallGap";
+    BorderStyle["ThinThickThinSmallGap"] = "thinThickThinSmallGap";
+    BorderStyle["ThinThickMediumGap"] = "thinThickMediumGap";
+    BorderStyle["ThickThinMediumGap"] = "thickThinMediumGap";
+    BorderStyle["ThinThickThinMediumGap"] = "thinThickThinMediumGap";
+    BorderStyle["ThinThickLargeGap"] = "thinThickLargeGap";
+    BorderStyle["ThickThinLargeGap"] = "thickThinLargeGap";
+    BorderStyle["ThinThickThinLargeGap"] = "thinThickThinLargeGap";
+    BorderStyle["Wave"] = "wave";
+    BorderStyle["DoubleWave"] = "doubleWave";
+    BorderStyle["DashSmallGap"] = "dashSmallGap";
+    BorderStyle["DashDotStroked"] = "dashDotStroked";
+    BorderStyle["ThreeDEmboss"] = "threeDEmboss";
+    BorderStyle["ThreeDEngrave"] = "threeDEngrave";
+    BorderStyle["Outset"] = "outset";
+    BorderStyle["Inset"] = "inset";
+})(BorderStyle || (BorderStyle = {}));
+/**
+ * Mutable page size dimensions in points (`CT_PageSz` width/height only).
+ *
+ * Orientation is owned by {@link PageSetup}. Mutating width/height notifies the
+ * owning setup (when attached) so orientation stays in sync.
+ *
+ * @public
+ */
+var SizeF = /** @class */ (function () {
+    /**
+     * @param width - Width in points.
+     * @param height - Height in points.
+     */
+    function SizeF(width, height) {
+        this.widthValue = width;
+        this.heightValue = height;
+        this.changeListener = undefined;
+    }
+    /**
+     * @private
+     * Owned by {@link PageSetup} so dimension edits can recompute orientation.
+     */
+    SizeF.prototype.setChangeListener = function (listener) {
+        this.changeListener = listener;
+    };
+    /**
+     * @private
+     * Replace both dimensions without re-entry through public setters.
+     */
+    SizeF.prototype.replace = function (width, height, notify) {
+        this.widthValue = width;
+        this.heightValue = height;
+        if (notify && this.changeListener !== undefined) {
+            this.changeListener(width, height);
+        }
+    };
+    Object.defineProperty(SizeF.prototype, "width", {
+        get: function () {
+            return this.widthValue;
+        },
+        set: function (value) {
+            this.widthValue = value;
+            if (this.changeListener !== undefined) {
+                this.changeListener(this.widthValue, this.heightValue);
+            }
+        },
+        enumerable: true,
+        configurable: true
+    });
+    Object.defineProperty(SizeF.prototype, "height", {
+        get: function () {
+            return this.heightValue;
+        },
+        set: function (value) {
+            this.heightValue = value;
+            if (this.changeListener !== undefined) {
+                this.changeListener(this.widthValue, this.heightValue);
+            }
+        },
+        enumerable: true,
+        configurable: true
+    });
+    return SizeF;
+}());
+export { SizeF };