@syncfusion/ej2-docx 0.0.0-stage → 35.1.39

package/src/features/sections/index.d.ts

@@ -0,0 +1,91 @@
+export * from './column-collection';
+export * from './column';
+export * from './margins';
+export * from './page-number-style';
+export * from './page-orientation';
+export * from './page-size';
+export * from './section-break-code';
+export * from './section-document-association';
+export * from './section-validation';
+import { WordDocument } from '../document/document';
+import { Paragraph } from '../document/paragraph';
+import { OpenXmlElement } from '../../core/xml/index';
+import { HeaderFooterTarget, PageSetup } from './page-setup';
+export { BorderStyle, defaultLetterPageSetup, HeaderFooterReference, HeaderFooterReferenceType, HeaderFooterTarget, LineNumbering, LineNumberingMode, LineNumberRestart, PageBorder, PageBorderOffsetFrom, PageBorders, PageBordersApplyType, PageBorderStyle, PageSetup, PaperSource, ParsedPageBorder, ParsedPageBorders, PrinterPaperTray, SectionVerticalAlignment, VerticalAlignment, ChapterNumbering, } from './page-setup';
+/**
+ * Parse `w:sectPr` into a live {@link PageSetup}.
+ *
+ * @private
+ */
+export declare function parseSectionProperties(element: OpenXmlElement | undefined): PageSetup | undefined;
+/**
+ * Enable line numbering on every line (`w:lnNumType/@w:countBy="1"`).
+ *
+ * Sets {@link PageSetup.lineNumberingStep} to `1` (and marks line numbering present).
+ *
+ * @private
+ */
+export declare function everyLineNumbers(setup: PageSetup): void;
+/**
+ * `true` when the section has no explicit reference for the target slot (inherits).
+ *
+ * @private
+ */
+export declare function inheritsFromPrevious(section: PageSetup, target: HeaderFooterTarget): boolean;
+/**
+ * Stop inheriting a header/footer slot by creating an empty part and reference.
+ * Requires the headers-footers feature and a document-associated page setup.
+ *
+ * @private
+ */
+export declare function unlinkFromPrevious(section: PageSetup, target: HeaderFooterTarget): Promise<void>;
+/**
+ * @private
+ * Test hook
+ */
+export declare function resetSectionsFeatureForTests(): void;
+/**
+ * @private
+ * Register the sections feature. Idempotent.
+ */
+export declare function registerSectionsFeature(): void;
+/**
+ * Body-final section properties (`w:body/w:sectPr`).
+ *
+ * Returns the same object identity across calls once materialised.
+ *
+ * @private
+ */
+export declare function finalSection(document: WordDocument): PageSetup | undefined;
+/**
+ * Replace body-final section properties.
+ *
+ * @private
+ */
+export declare function setFinalSection(document: WordDocument, properties: PageSetup): void;
+/**
+ * Paragraph section-break properties (`w:pPr/w:sectPr`), when present.
+ *
+ * Returns the same object identity across calls once materialised.
+ *
+ * @private
+ */
+export declare function paragraphSectionBreak(paragraph: Paragraph): PageSetup | undefined;
+/**
+ * Set or clear paragraph section-break properties (`w:pPr/w:sectPr`).
+ *
+ * After dual-hold update, repartitions {@link Document.sections} so non-final
+ * pageSetup lives on its own section and flatten emits mid-body + body-final
+ * `w:sectPr` (TASK-8075/8076 authoring path).
+ *
+ * @private
+ */
+export declare function setParagraphSectionBreak(paragraph: Paragraph, properties: PageSetup | undefined): void;
+/**
+ * Body-final properties for internal authoring bridges. Seeds a default letter
+ * page setup when none is present so flatten/serialize always has live
+ * {@link PageSetup} while the sections feature is registered.
+ *
+ * @private
+ */
+export declare function ensureFinalSectionProperties(document: WordDocument): PageSetup;