@syncfusion/ej2-docx 0.0.0-stage → 35.1.40
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitleaksignore +35 -0
- package/README.md +68 -2
- package/core.js +4 -0
- package/dist/ej2-docx.umd.min.js +11 -0
- package/dist/ej2-docx.umd.min.js.map +1 -0
- package/dist/es6/ej2-docx.es2015.js +66697 -0
- package/dist/es6/ej2-docx.es2015.js.map +1 -0
- package/dist/es6/ej2-docx.es5.js +77568 -0
- package/dist/es6/ej2-docx.es5.js.map +1 -0
- package/dist/global/ej2-docx.min.js +11 -0
- package/dist/global/ej2-docx.min.js.map +1 -0
- package/dist/global/index.d.ts +14 -0
- package/features.js +4 -0
- package/index.js +4 -0
- package/license +10 -0
- package/package.json +30 -3
- package/src/all.d.ts +50 -0
- package/src/all.js +147 -0
- package/src/core/compat/base64.d.ts +13 -0
- package/src/core/compat/base64.js +90 -0
- package/src/core/compat/object-compat.d.ts +30 -0
- package/src/core/compat/object-compat.js +40 -0
- package/src/core/compat/sha256.d.ts +9 -0
- package/src/core/compat/sha256.js +98 -0
- package/src/core/errors/docx-error.d.ts +89 -0
- package/src/core/errors/docx-error.js +138 -0
- package/src/core/errors/error-codes.d.ts +8 -0
- package/src/core/errors/error-codes.js +0 -0
- package/src/core/errors/index.d.ts +10 -0
- package/src/core/errors/index.js +9 -0
- package/src/core/index.d.ts +12 -0
- package/src/core/index.js +12 -0
- package/src/core/mc/alternate-content.d.ts +7 -0
- package/src/core/mc/alternate-content.js +67 -0
- package/src/core/mc/attributes.d.ts +24 -0
- package/src/core/mc/attributes.js +82 -0
- package/src/core/mc/index.d.ts +7 -0
- package/src/core/mc/index.js +5 -0
- package/src/core/mc/inspect.d.ts +16 -0
- package/src/core/mc/inspect.js +148 -0
- package/src/core/mc/namespaces.d.ts +4 -0
- package/src/core/mc/namespaces.js +4 -0
- package/src/core/mc/scope.d.ts +6 -0
- package/src/core/mc/scope.js +47 -0
- package/src/core/opc/content-types.d.ts +34 -0
- package/src/core/opc/content-types.js +162 -0
- package/src/core/opc/index.d.ts +8 -0
- package/src/core/opc/index.js +4 -0
- package/src/core/opc/package.d.ts +49 -0
- package/src/core/opc/package.js +324 -0
- package/src/core/opc/part-name.d.ts +47 -0
- package/src/core/opc/part-name.js +205 -0
- package/src/core/opc/relationships.d.ts +46 -0
- package/src/core/opc/relationships.js +212 -0
- package/src/core/preservation/index.d.ts +2 -0
- package/src/core/preservation/index.js +1 -0
- package/src/core/preservation/opaque-body.d.ts +16 -0
- package/src/core/preservation/opaque-body.js +69 -0
- package/src/core/registry/block-handlers.d.ts +30 -0
- package/src/core/registry/block-handlers.js +36 -0
- package/src/core/registry/create-defaults.d.ts +39 -0
- package/src/core/registry/create-defaults.js +42 -0
- package/src/core/registry/feature-registry.d.ts +20 -0
- package/src/core/registry/feature-registry.js +29 -0
- package/src/core/registry/index.d.ts +9 -0
- package/src/core/registry/index.js +8 -0
- package/src/core/registry/inline-handlers.d.ts +20 -0
- package/src/core/registry/inline-handlers.js +30 -0
- package/src/core/registry/materialize-handlers.d.ts +35 -0
- package/src/core/registry/materialize-handlers.js +75 -0
- package/src/core/registry/multi-part-handlers.d.ts +37 -0
- package/src/core/registry/multi-part-handlers.js +206 -0
- package/src/core/registry/package-part-handlers.d.ts +28 -0
- package/src/core/registry/package-part-handlers.js +190 -0
- package/src/core/registry/part-handlers.d.ts +24 -0
- package/src/core/registry/part-handlers.js +172 -0
- package/src/core/registry/run-leaf-handlers.d.ts +26 -0
- package/src/core/registry/run-leaf-handlers.js +72 -0
- package/src/core/security/limits.d.ts +40 -0
- package/src/core/security/limits.js +26 -0
- package/src/core/xml/index.d.ts +7 -0
- package/src/core/xml/index.js +3 -0
- package/src/core/xml/model.d.ts +66 -0
- package/src/core/xml/model.js +17 -0
- package/src/core/xml/parse.d.ts +12 -0
- package/src/core/xml/parse.js +382 -0
- package/src/core/xml/serialize.d.ts +6 -0
- package/src/core/xml/serialize.js +93 -0
- package/src/core/zip/crc32.d.ts +2 -0
- package/src/core/zip/crc32.js +25 -0
- package/src/core/zip/deflate.d.ts +6 -0
- package/src/core/zip/deflate.js +6 -0
- package/src/core/zip/index.d.ts +10 -0
- package/src/core/zip/index.js +4 -0
- package/src/core/zip/inflate-raw.d.ts +17 -0
- package/src/core/zip/inflate-raw.js +450 -0
- package/src/core/zip/names.d.ts +6 -0
- package/src/core/zip/names.js +52 -0
- package/src/core/zip/read.d.ts +8 -0
- package/src/core/zip/read.js +262 -0
- package/src/core/zip/write.d.ts +7 -0
- package/src/core/zip/write.js +189 -0
- package/src/core/zip/zip-entry.d.ts +4 -0
- package/src/core/zip/zip-entry.js +0 -0
- package/src/features/bibliography/index.d.ts +100 -0
- package/src/features/bibliography/index.js +290 -0
- package/src/features/bookmarks/index.d.ts +331 -0
- package/src/features/bookmarks/index.js +1009 -0
- package/src/features/comments/comment-extensions.d.ts +157 -0
- package/src/features/comments/comment-extensions.js +356 -0
- package/src/features/comments/index.d.ts +579 -0
- package/src/features/comments/index.js +1727 -0
- package/src/features/content-controls/index.d.ts +821 -0
- package/src/features/content-controls/index.js +2857 -0
- package/src/features/custom-xml/index.d.ts +236 -0
- package/src/features/custom-xml/index.js +661 -0
- package/src/features/document/alignment.d.ts +23 -0
- package/src/features/document/alignment.js +36 -0
- package/src/features/document/alt-chunk.d.ts +103 -0
- package/src/features/document/alt-chunk.js +221 -0
- package/src/features/document/assert-never.d.ts +1 -0
- package/src/features/document/assert-never.js +4 -0
- package/src/features/document/augmentations.d.ts +578 -0
- package/src/features/document/augmentations.js +0 -0
- package/src/features/document/body-always-on.d.ts +36 -0
- package/src/features/document/body-always-on.js +66 -0
- package/src/features/document/body-blocks.d.ts +7 -0
- package/src/features/document/body-blocks.js +78 -0
- package/src/features/document/body-item-adapters.d.ts +62 -0
- package/src/features/document/body-item-adapters.js +97 -0
- package/src/features/document/body-item-collection.d.ts +151 -0
- package/src/features/document/body-item-collection.js +440 -0
- package/src/features/document/body-item.d.ts +35 -0
- package/src/features/document/body-item.js +8 -0
- package/src/features/document/body.d.ts +150 -0
- package/src/features/document/body.js +263 -0
- package/src/features/document/character-format.d.ts +413 -0
- package/src/features/document/character-format.js +2054 -0
- package/src/features/document/color.d.ts +178 -0
- package/src/features/document/color.js +495 -0
- package/src/features/document/document.d.ts +410 -0
- package/src/features/document/document.js +1049 -0
- package/src/features/document/element-type.d.ts +68 -0
- package/src/features/document/element-type.js +133 -0
- package/src/features/document/entity-type.d.ts +92 -0
- package/src/features/document/entity-type.js +93 -0
- package/src/features/document/feature-block.d.ts +16 -0
- package/src/features/document/feature-block.js +0 -0
- package/src/features/document/feature-inline.d.ts +13 -0
- package/src/features/document/feature-inline.js +0 -0
- package/src/features/document/feature-multi-package-part.d.ts +19 -0
- package/src/features/document/feature-multi-package-part.js +8 -0
- package/src/features/document/feature-package-level-part.d.ts +18 -0
- package/src/features/document/feature-package-level-part.js +8 -0
- package/src/features/document/feature-package-part.d.ts +14 -0
- package/src/features/document/feature-package-part.js +0 -0
- package/src/features/document/feature-run-leaf.d.ts +9 -0
- package/src/features/document/feature-run-leaf.js +0 -0
- package/src/features/document/headers-footers.d.ts +206 -0
- package/src/features/document/headers-footers.js +384 -0
- package/src/features/document/index.d.ts +41 -0
- package/src/features/document/index.js +34 -0
- package/src/features/document/length.d.ts +152 -0
- package/src/features/document/length.js +245 -0
- package/src/features/document/load-options.d.ts +14 -0
- package/src/features/document/load-options.js +0 -0
- package/src/features/document/locale-ids.d.ts +227 -0
- package/src/features/document/locale-ids.js +485 -0
- package/src/features/document/on-off.d.ts +9 -0
- package/src/features/document/on-off.js +27 -0
- package/src/features/document/page-setup.d.ts +339 -0
- package/src/features/document/page-setup.js +244 -0
- package/src/features/document/paragraph-format.d.ts +880 -0
- package/src/features/document/paragraph-format.js +2807 -0
- package/src/features/document/paragraph-item-collection.d.ts +162 -0
- package/src/features/document/paragraph-item-collection.js +363 -0
- package/src/features/document/paragraph-item.d.ts +83 -0
- package/src/features/document/paragraph-item.js +103 -0
- package/src/features/document/paragraph.d.ts +435 -0
- package/src/features/document/paragraph.js +888 -0
- package/src/features/document/run.d.ts +1 -0
- package/src/features/document/run.js +768 -0
- package/src/features/document/section-partition-flatten.d.ts +124 -0
- package/src/features/document/section-partition-flatten.js +217 -0
- package/src/features/document/section-properties-model.d.ts +13 -0
- package/src/features/document/section-properties-model.js +0 -0
- package/src/features/document/section.d.ts +93 -0
- package/src/features/document/section.js +178 -0
- package/src/features/document/sections.d.ts +103 -0
- package/src/features/document/sections.js +217 -0
- package/src/features/document/sub-super-script.d.ts +23 -0
- package/src/features/document/sub-super-script.js +43 -0
- package/src/features/document/text-range.d.ts +445 -0
- package/src/features/document/text-range.js +1156 -0
- package/src/features/document/typed-body-collections.d.ts +162 -0
- package/src/features/document/typed-body-collections.js +371 -0
- package/src/features/document/underline-style.d.ts +38 -0
- package/src/features/document/underline-style.js +126 -0
- package/src/features/document/units.d.ts +8 -0
- package/src/features/document/units.js +7 -0
- package/src/features/document/wml.d.ts +16 -0
- package/src/features/document/wml.js +67 -0
- package/src/features/drawing/authoring.d.ts +27 -0
- package/src/features/drawing/authoring.js +271 -0
- package/src/features/drawing/body-pr.d.ts +271 -0
- package/src/features/drawing/body-pr.js +663 -0
- package/src/features/drawing/drawing-shape.d.ts +1192 -0
- package/src/features/drawing/drawing-shape.js +3239 -0
- package/src/features/drawing/encode-builders.d.ts +176 -0
- package/src/features/drawing/encode-builders.js +390 -0
- package/src/features/drawing/fill-format.d.ts +52 -0
- package/src/features/drawing/fill-format.js +124 -0
- package/src/features/drawing/host-codec.d.ts +632 -0
- package/src/features/drawing/host-codec.js +2595 -0
- package/src/features/drawing/index.d.ts +13 -0
- package/src/features/drawing/index.js +33 -0
- package/src/features/drawing/line-format.d.ts +76 -0
- package/src/features/drawing/line-format.js +343 -0
- package/src/features/drawing/parse-register.d.ts +50 -0
- package/src/features/drawing/parse-register.js +257 -0
- package/src/features/drawing/residual-utils.d.ts +47 -0
- package/src/features/drawing/residual-utils.js +290 -0
- package/src/features/drawing/shape-types.d.ts +433 -0
- package/src/features/drawing/shape-types.js +437 -0
- package/src/features/drawing/sp-pr.d.ts +396 -0
- package/src/features/drawing/sp-pr.js +610 -0
- package/src/features/drawing/text-frame.d.ts +90 -0
- package/src/features/drawing/text-frame.js +152 -0
- package/src/features/drawing/types.d.ts +352 -0
- package/src/features/drawing/types.js +60 -0
- package/src/features/drawing/wrap-format.d.ts +62 -0
- package/src/features/drawing/wrap-format.js +114 -0
- package/src/features/editable-ranges/index.d.ts +494 -0
- package/src/features/editable-ranges/index.js +1348 -0
- package/src/features/fields/index.d.ts +428 -0
- package/src/features/fields/index.js +2148 -0
- package/src/features/fields/paragraph-field.d.ts +187 -0
- package/src/features/fields/paragraph-field.js +692 -0
- package/src/features/font-table/font-substitution-table.d.ts +75 -0
- package/src/features/font-table/font-substitution-table.js +257 -0
- package/src/features/font-table/font-table-entry.d.ts +255 -0
- package/src/features/font-table/font-table-entry.js +823 -0
- package/src/features/font-table/font-table.d.ts +128 -0
- package/src/features/font-table/font-table.js +313 -0
- package/src/features/font-table/index.d.ts +27 -0
- package/src/features/font-table/index.js +48 -0
- package/src/features/glossary/index.d.ts +97 -0
- package/src/features/glossary/index.js +286 -0
- package/src/features/headers-footers/index.d.ts +506 -0
- package/src/features/headers-footers/index.js +1666 -0
- package/src/features/hyperlinks/index.d.ts +230 -0
- package/src/features/hyperlinks/index.js +685 -0
- package/src/features/images/caption-authoring-api.d.ts +33 -0
- package/src/features/images/caption-authoring-api.js +33 -0
- package/src/features/images/caption-enums.d.ts +52 -0
- package/src/features/images/caption-enums.js +141 -0
- package/src/features/images/caption-host.d.ts +10 -0
- package/src/features/images/caption-host.js +21 -0
- package/src/features/images/captions.d.ts +13 -0
- package/src/features/images/captions.js +142 -0
- package/src/features/images/host-codec.d.ts +103 -0
- package/src/features/images/host-codec.js +720 -0
- package/src/features/images/image-sniff.d.ts +21 -0
- package/src/features/images/image-sniff.js +71 -0
- package/src/features/images/index.d.ts +506 -0
- package/src/features/images/index.js +1429 -0
- package/src/features/images/layout-types.d.ts +232 -0
- package/src/features/images/layout-types.js +294 -0
- package/src/features/images/public-entry.d.ts +9 -0
- package/src/features/images/public-entry.js +9 -0
- package/src/features/index.d.ts +35 -0
- package/src/features/index.js +36 -0
- package/src/features/mail-merge/index.d.ts +113 -0
- package/src/features/mail-merge/index.js +315 -0
- package/src/features/notes/index.d.ts +573 -0
- package/src/features/notes/index.js +1725 -0
- package/src/features/numbering/abstract-numbering.d.ts +90 -0
- package/src/features/numbering/abstract-numbering.js +292 -0
- package/src/features/numbering/index.d.ts +182 -0
- package/src/features/numbering/index.js +668 -0
- package/src/features/numbering/list-format.d.ts +158 -0
- package/src/features/numbering/list-format.js +590 -0
- package/src/features/numbering/list-string.d.ts +7 -0
- package/src/features/numbering/list-string.js +423 -0
- package/src/features/numbering/list-style.d.ts +204 -0
- package/src/features/numbering/list-style.js +1084 -0
- package/src/features/numbering/numbering-instance.d.ts +101 -0
- package/src/features/numbering/numbering-instance.js +329 -0
- package/src/features/numbering/numbering-level.d.ts +118 -0
- package/src/features/numbering/numbering-level.js +501 -0
- package/src/features/numbering/picture-bullet.d.ts +34 -0
- package/src/features/numbering/picture-bullet.js +88 -0
- package/src/features/ole-object/catalog.d.ts +300 -0
- package/src/features/ole-object/catalog.js +908 -0
- package/src/features/ole-object/index.d.ts +526 -0
- package/src/features/ole-object/index.js +1421 -0
- package/src/features/ole-object/relationship.d.ts +27 -0
- package/src/features/ole-object/relationship.js +27 -0
- package/src/features/ole-object/typed-dom.d.ts +186 -0
- package/src/features/ole-object/typed-dom.js +595 -0
- package/src/features/properties/index.d.ts +205 -0
- package/src/features/properties/index.js +549 -0
- package/src/features/revisions/index.d.ts +204 -0
- package/src/features/revisions/index.js +695 -0
- package/src/features/sections/column-collection.d.ts +119 -0
- package/src/features/sections/column-collection.js +478 -0
- package/src/features/sections/column.d.ts +15 -0
- package/src/features/sections/column.js +37 -0
- package/src/features/sections/index.d.ts +91 -0
- package/src/features/sections/index.js +1096 -0
- package/src/features/sections/margins.d.ts +40 -0
- package/src/features/sections/margins.js +105 -0
- package/src/features/sections/page-number-style.d.ts +21 -0
- package/src/features/sections/page-number-style.js +62 -0
- package/src/features/sections/page-orientation.d.ts +10 -0
- package/src/features/sections/page-orientation.js +10 -0
- package/src/features/sections/page-setup.d.ts +435 -0
- package/src/features/sections/page-setup.js +1479 -0
- package/src/features/sections/page-size.d.ts +59 -0
- package/src/features/sections/page-size.js +68 -0
- package/src/features/sections/section-break-code.d.ts +27 -0
- package/src/features/sections/section-break-code.js +60 -0
- package/src/features/sections/section-document-association.d.ts +18 -0
- package/src/features/sections/section-document-association.js +31 -0
- package/src/features/sections/section-validation.d.ts +43 -0
- package/src/features/sections/section-validation.js +97 -0
- package/src/features/settings/attached-template.d.ts +35 -0
- package/src/features/settings/attached-template.js +98 -0
- package/src/features/settings/compat-settings.d.ts +216 -0
- package/src/features/settings/compat-settings.js +508 -0
- package/src/features/settings/document-background.d.ts +59 -0
- package/src/features/settings/document-background.js +131 -0
- package/src/features/settings/document-protection.d.ts +65 -0
- package/src/features/settings/document-protection.js +157 -0
- package/src/features/settings/document-settings-facades.d.ts +108 -0
- package/src/features/settings/document-settings-facades.js +312 -0
- package/src/features/settings/document-settings-values.d.ts +43 -0
- package/src/features/settings/document-settings-values.js +60 -0
- package/src/features/settings/footnote-properties.d.ts +211 -0
- package/src/features/settings/footnote-properties.js +591 -0
- package/src/features/settings/index.d.ts +356 -0
- package/src/features/settings/index.js +829 -0
- package/src/features/settings/settings-children.d.ts +151 -0
- package/src/features/settings/settings-children.js +505 -0
- package/src/features/settings/web-settings.d.ts +88 -0
- package/src/features/settings/web-settings.js +227 -0
- package/src/features/settings/zoom.d.ts +79 -0
- package/src/features/settings/zoom.js +147 -0
- package/src/features/styles/builtin-catalog.d.ts +159 -0
- package/src/features/styles/builtin-catalog.js +963 -0
- package/src/features/styles/builtin-resolver.d.ts +49 -0
- package/src/features/styles/builtin-resolver.js +165 -0
- package/src/features/styles/default-styles.d.ts +37 -0
- package/src/features/styles/default-styles.js +186 -0
- package/src/features/styles/default-theme.d.ts +13 -0
- package/src/features/styles/default-theme.js +13 -0
- package/src/features/styles/doc-defaults.d.ts +58 -0
- package/src/features/styles/doc-defaults.js +178 -0
- package/src/features/styles/formatting-resolver.d.ts +27 -0
- package/src/features/styles/formatting-resolver.js +72 -0
- package/src/features/styles/index.d.ts +256 -0
- package/src/features/styles/index.js +1325 -0
- package/src/features/styles/latent-styles.d.ts +68 -0
- package/src/features/styles/latent-styles.js +305 -0
- package/src/features/styles/paragraph-properties.d.ts +71 -0
- package/src/features/styles/paragraph-properties.js +237 -0
- package/src/features/styles/run-properties.d.ts +93 -0
- package/src/features/styles/run-properties.js +516 -0
- package/src/features/styles/style-base.d.ts +402 -0
- package/src/features/styles/style-base.js +1026 -0
- package/src/features/styles/style-collection.d.ts +264 -0
- package/src/features/styles/style-collection.js +714 -0
- package/src/features/styles/style-format-bridge.d.ts +64 -0
- package/src/features/styles/style-format-bridge.js +100 -0
- package/src/features/styles/style.d.ts +84 -0
- package/src/features/styles/style.js +375 -0
- package/src/features/styles/styles-with-effects.d.ts +71 -0
- package/src/features/styles/styles-with-effects.js +180 -0
- package/src/features/styles/table-style.d.ts +272 -0
- package/src/features/styles/table-style.js +1226 -0
- package/src/features/styles/theme.d.ts +126 -0
- package/src/features/styles/theme.js +377 -0
- package/src/features/tables/border-style-map.d.ts +24 -0
- package/src/features/tables/border-style-map.js +81 -0
- package/src/features/tables/borders.d.ts +126 -0
- package/src/features/tables/borders.js +527 -0
- package/src/features/tables/collections.d.ts +113 -0
- package/src/features/tables/collections.js +261 -0
- package/src/features/tables/format.d.ts +208 -0
- package/src/features/tables/format.js +716 -0
- package/src/features/tables/index.d.ts +597 -0
- package/src/features/tables/index.js +2386 -0
- package/src/features/tables/paddings.d.ts +41 -0
- package/src/features/tables/paddings.js +97 -0
- package/src/features/tables/tbl-pr-positioning.d.ts +27 -0
- package/src/features/tables/tbl-pr-positioning.js +178 -0
- package/src/features/tables/tbl-pr.d.ts +528 -0
- package/src/features/tables/tbl-pr.js +1208 -0
- package/src/features/tables/tc-pr.d.ts +168 -0
- package/src/features/tables/tc-pr.js +553 -0
- package/src/features/tables/tr-pr.d.ts +60 -0
- package/src/features/tables/tr-pr.js +215 -0
- package/src/features/watermark/detect.d.ts +76 -0
- package/src/features/watermark/detect.js +219 -0
- package/src/features/watermark/index.d.ts +28 -0
- package/src/features/watermark/index.js +91 -0
- package/src/features/watermark/logical-store.d.ts +29 -0
- package/src/features/watermark/logical-store.js +31 -0
- package/src/features/watermark/model.d.ts +285 -0
- package/src/features/watermark/model.js +597 -0
- package/src/features/watermark/parse.d.ts +84 -0
- package/src/features/watermark/parse.js +815 -0
- package/src/features/watermark/serialize.d.ts +98 -0
- package/src/features/watermark/serialize.js +1517 -0
- package/src/global.js +1 -0
- package/src/index.d.ts +2 -0
- package/src/index.js +2 -0
|
@@ -0,0 +1,578 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Shared ambient augmentations for optional feature members on core types.
|
|
3
|
+
*
|
|
4
|
+
* Single source of truth for declaration merging onto the modules that
|
|
5
|
+
* actually export the classes:
|
|
6
|
+
* - `./index` (package barrel; `src/index.ts` re-exports it as `@syncfusion/ej2-docx`)
|
|
7
|
+
* - `./document`, `./paragraph`, `./section`
|
|
8
|
+
*
|
|
9
|
+
* Do not augment the package id `@syncfusion/ej2-docx` from this file.
|
|
10
|
+
* `gulp ci-publish` / `es5-scripts` type-checks `src/**` as its own program.
|
|
11
|
+
* TypeScript 3.3.1 resolves an external augmentation name before it will
|
|
12
|
+
* merge it (`resolveExternalModule`). Inside that program the package name
|
|
13
|
+
* has no resolvable module — `package.json` `main` points at a file that
|
|
14
|
+
* does not exist yet — so `declare module '@syncfusion/ej2-docx'` is TS2664.
|
|
15
|
+
* An ambient script stub is not part of the external-module resolution
|
|
16
|
+
* path that this compile uses. Augmenting `./index` merges the same
|
|
17
|
+
* interfaces onto the symbols consumers import from the package.
|
|
18
|
+
*
|
|
19
|
+
* Lives under `src/features/document/` with the document model. Package entry
|
|
20
|
+
* points side-effect-import this module. Runtime prototype installs remain in
|
|
21
|
+
* each feature module; importing this file has no runtime effect beyond
|
|
22
|
+
* ensuring the ambient merges are in the program.
|
|
23
|
+
*
|
|
24
|
+
* Headers/footers continue to augment `PageSetup` from the
|
|
25
|
+
* headers-footers feature (not WordDocument/Paragraph).
|
|
26
|
+
*
|
|
27
|
+
* @packageDocumentation
|
|
28
|
+
* @private
|
|
29
|
+
*/
|
|
30
|
+
export {};
|
|
31
|
+
declare module './index' {
|
|
32
|
+
interface WordDocument {
|
|
33
|
+
/**
|
|
34
|
+
* Gets the comments defined in this document.
|
|
35
|
+
* The collection contains the comment bodies associated with document comment ranges.
|
|
36
|
+
*/
|
|
37
|
+
readonly comments: import('../comments/index').CommentCollection;
|
|
38
|
+
/**
|
|
39
|
+
* Paired bookmarks in document order (`BookmarkCollection`).
|
|
40
|
+
* Orphan markers remain in the DOM but are omitted from this collection.
|
|
41
|
+
*/
|
|
42
|
+
readonly bookmarks: import('../bookmarks/index').BookmarkCollection;
|
|
43
|
+
/**
|
|
44
|
+
* Primary → alternate font name dictionary (`w:font/@w:name` →
|
|
45
|
+
* `w:altName/@w:val`, ECMA-376-1 §17.8.3.1).
|
|
46
|
+
*
|
|
47
|
+
* **Preferred public API** for font substitutions (TASK-8067). Map-style
|
|
48
|
+
* methods (`set` / `get` / `has` / `delete` / `clear`, iteration). Same
|
|
49
|
+
* object identity on every access for this document. Mutations dirty the
|
|
50
|
+
* font table part; save emits `word/fontTable.xml` when dirty.
|
|
51
|
+
*
|
|
52
|
+
* Requires the font-table feature (via `@syncfusion/ej2-docx/font-table`, styles, or
|
|
53
|
+
* {@link registerFontTableFeature}). Does not require calling
|
|
54
|
+
* {@link fontTableFor} — that helper remains for full `CT_Font` catalog
|
|
55
|
+
* metadata only.
|
|
56
|
+
*/
|
|
57
|
+
readonly fontSubstitutionTable: import('../font-table/index').FontSubstitutionTable;
|
|
58
|
+
/**
|
|
59
|
+
* @private
|
|
60
|
+
*/
|
|
61
|
+
readonly mailMerge: import('../mail-merge/index').MailMergeCatalog;
|
|
62
|
+
/**
|
|
63
|
+
* Document-level footnotes manager. Stable identity; enumerates interned
|
|
64
|
+
* {@link import('../notes/index').Footnote} bodies referenced from the main story.
|
|
65
|
+
*/
|
|
66
|
+
readonly footnotes: import('../notes/index').Footnotes;
|
|
67
|
+
/**
|
|
68
|
+
* Document-level endnotes manager. Stable identity; enumerates interned
|
|
69
|
+
* {@link import('../notes/index').Endnote} bodies referenced from the main story.
|
|
70
|
+
*/
|
|
71
|
+
readonly endnotes: import('../notes/index').Endnotes;
|
|
72
|
+
/**
|
|
73
|
+
* @private
|
|
74
|
+
* Document-owned live styles collection (`styleCollectionFor` / public StyleCollection). */
|
|
75
|
+
readonly styles: import('../styles/index').StyleCollection;
|
|
76
|
+
/**
|
|
77
|
+
* Create a custom table style and add it to this document's styles collection.
|
|
78
|
+
*
|
|
79
|
+
* @param name Display name used to derive a deterministic style id.
|
|
80
|
+
* @returns Live table style owned by this document.
|
|
81
|
+
*/
|
|
82
|
+
addTableStyle(name: string): import('../styles/index').TableStyle;
|
|
83
|
+
/**
|
|
84
|
+
* Create a custom list (numbering) style and add it to this document.
|
|
85
|
+
*
|
|
86
|
+
* @param listType Bulleted or numbered list category.
|
|
87
|
+
* @param styleName Display name; must be unique among document styles.
|
|
88
|
+
* @returns Live list style owned by this document.
|
|
89
|
+
*/
|
|
90
|
+
addListStyle(listType: import('../numbering/list-style').ListType, styleName: string): import('../numbering/list-style').ListStyle;
|
|
91
|
+
/**
|
|
92
|
+
* @private
|
|
93
|
+
* The theme catalog for this document. Equivalent to `themeFor(document)`.
|
|
94
|
+
* Plural name matches the product DOM surface (`document.themes`).
|
|
95
|
+
*/
|
|
96
|
+
readonly themes: import('../styles/theme').ThemePart;
|
|
97
|
+
/**
|
|
98
|
+
* View preferences for this document (`w:settings` view / zoom).
|
|
99
|
+
* Same object identity on every access.
|
|
100
|
+
*/
|
|
101
|
+
readonly viewSetup: import('../settings/document-settings-facades').ViewSetup;
|
|
102
|
+
/**
|
|
103
|
+
* Document settings facade (`compatibility`, protection-adjacent surface).
|
|
104
|
+
* Same object identity on every access.
|
|
105
|
+
*/
|
|
106
|
+
readonly settings: import('../settings/document-settings-facades').DocumentSettings;
|
|
107
|
+
/**
|
|
108
|
+
* Whether track revisions is enabled (`w:trackRevisions`). Absent → false.
|
|
109
|
+
*/
|
|
110
|
+
trackRevisions: boolean;
|
|
111
|
+
/**
|
|
112
|
+
* Default tab stop in points (`w:defaultTabStop`).
|
|
113
|
+
*/
|
|
114
|
+
defaultTabStop: number;
|
|
115
|
+
/**
|
|
116
|
+
* Attached template metadata from settings, when present.
|
|
117
|
+
*/
|
|
118
|
+
readonly attachedTemplate: import('../settings/index').AttachedTemplate | undefined;
|
|
119
|
+
/**
|
|
120
|
+
* Gets or sets the document watermark.
|
|
121
|
+
* Assign `undefined` to clear.
|
|
122
|
+
*/
|
|
123
|
+
watermark: import('../watermark/index').Watermark | undefined;
|
|
124
|
+
}
|
|
125
|
+
interface Body {
|
|
126
|
+
/**
|
|
127
|
+
* Appends a block-level content control (`w:sdt`) to this body.
|
|
128
|
+
*
|
|
129
|
+
* @param type - Authorable content-control kind.
|
|
130
|
+
* @returns The appended {@link BlockContentControl}.
|
|
131
|
+
*
|
|
132
|
+
* @example
|
|
133
|
+
* ```ts
|
|
134
|
+
* import { WordDocument, ContentControlType } from '@syncfusion/ej2-docx';
|
|
135
|
+
* const doc = WordDocument.create();
|
|
136
|
+
* const block = doc.body.addBlockContentControl(ContentControlType.Text);
|
|
137
|
+
* block.tag = 'cust';
|
|
138
|
+
* ```
|
|
139
|
+
*/
|
|
140
|
+
addBlockContentControl(type: import('../content-controls/index').ContentControlType): import('../content-controls/index').BlockContentControl;
|
|
141
|
+
/**
|
|
142
|
+
* Appends a 1×1 table to the document body. Resize with {@link Table.resetCells}.
|
|
143
|
+
*
|
|
144
|
+
* Discover existing tables by walking {@link Body.items} with
|
|
145
|
+
* {@link isTableBlock} (no document-order list accessor on the body).
|
|
146
|
+
*
|
|
147
|
+
* @returns The appended {@link Table}.
|
|
148
|
+
*/
|
|
149
|
+
appendTable(): import('../tables/index').Table;
|
|
150
|
+
}
|
|
151
|
+
interface Paragraph {
|
|
152
|
+
/**
|
|
153
|
+
* Append a bookmark start marker (`w:bookmarkStart`) at the end of this paragraph.
|
|
154
|
+
*
|
|
155
|
+
* @param name - Bookmark name (`w:name`); must be non-empty / not whitespace-only.
|
|
156
|
+
* @returns The authored start marker (pending id until save).
|
|
157
|
+
*/
|
|
158
|
+
appendBookmarkStart(name: string): import('../bookmarks/index').BookmarkStart;
|
|
159
|
+
/**
|
|
160
|
+
* Append a bookmark end marker (`w:bookmarkEnd`) pairing with `start`.
|
|
161
|
+
*
|
|
162
|
+
* @param start - Start marker previously appended (possibly in another paragraph).
|
|
163
|
+
* @returns The authored end marker.
|
|
164
|
+
*/
|
|
165
|
+
appendBookmarkEnd(start: import('../bookmarks/index').BookmarkStart): import('../bookmarks/index').BookmarkEnd;
|
|
166
|
+
/**
|
|
167
|
+
* Append a same-paragraph bookmark: start, optional text run, then end.
|
|
168
|
+
* Omitting `options.text` creates an empty bookmark (adjacent markers).
|
|
169
|
+
*/
|
|
170
|
+
appendBookmark(name: string, options?: {
|
|
171
|
+
text?: string;
|
|
172
|
+
}): import('../bookmarks/index').Bookmark;
|
|
173
|
+
/**
|
|
174
|
+
* Append a new comment (range markers + elevated {@link Comment}) on this paragraph.
|
|
175
|
+
*
|
|
176
|
+
* @param text - Initial comment body text.
|
|
177
|
+
* @param options - Optional author, initials, date, and content range indices.
|
|
178
|
+
* @returns Interned {@link Comment} shared with the document catalog.
|
|
179
|
+
*/
|
|
180
|
+
appendComment(text: string, options?: import('../comments/index').AppendCommentMetadata): import('../comments/index').Comment;
|
|
181
|
+
/**
|
|
182
|
+
* Append a new comment using a single options object (`text` required).
|
|
183
|
+
*
|
|
184
|
+
* @param options - Full {@link AppendCommentOptions}.
|
|
185
|
+
* @returns Interned {@link Comment} shared with the document catalog.
|
|
186
|
+
*/
|
|
187
|
+
appendComment(options: import('../comments/index').AppendCommentOptions): import('../comments/index').Comment;
|
|
188
|
+
/**
|
|
189
|
+
* Appends a run-level content control (`w:sdt`) to this paragraph.
|
|
190
|
+
*
|
|
191
|
+
* @param type - Authorable content-control kind.
|
|
192
|
+
* @returns The appended {@link InlineContentControl}.
|
|
193
|
+
*
|
|
194
|
+
* @example
|
|
195
|
+
* ```ts
|
|
196
|
+
* import { WordDocument, ContentControlType } from '@syncfusion/ej2-docx';
|
|
197
|
+
* const doc = WordDocument.create();
|
|
198
|
+
* const p = doc.appendParagraph();
|
|
199
|
+
* const cc = p.appendInlineContentControl(ContentControlType.CheckBox);
|
|
200
|
+
* cc.isChecked = true;
|
|
201
|
+
* ```
|
|
202
|
+
*/
|
|
203
|
+
appendInlineContentControl(type: import('../content-controls/index').ContentControlType): import('../content-controls/index').InlineContentControl;
|
|
204
|
+
/**
|
|
205
|
+
* Append a DrawingML preset shape as dual MC AlternateContent
|
|
206
|
+
* (Choice `wps` + Fallback VML stub). Default placement is anchor.
|
|
207
|
+
*/
|
|
208
|
+
appendShape(autoShapeType: import('../drawing/index').AutoShapeType, width: number, height: number): import('../drawing/index').Shape;
|
|
209
|
+
/**
|
|
210
|
+
* Append an empty wordprocessing group as dual MC AlternateContent
|
|
211
|
+
* (Choice `wpg` + Fallback VML stub). Nest children via
|
|
212
|
+
* {@link GroupShape.appendShape} on the returned group (TASK-8051).
|
|
213
|
+
* Default placement is anchor.
|
|
214
|
+
*/
|
|
215
|
+
appendGroup(options: import('../drawing/index').GroupOptions): import('../drawing/index').GroupShape;
|
|
216
|
+
/**
|
|
217
|
+
* Append a new editable range that wraps a fresh text run at the end of
|
|
218
|
+
* this paragraph (bookmark-style authoring).
|
|
219
|
+
*
|
|
220
|
+
* Allocates a pending range id (materialized on save). Optional
|
|
221
|
+
* `editorGroup` / `editor` map `w:edGrp` / `w:ed`. The library does not
|
|
222
|
+
* evaluate document protection or editor identity.
|
|
223
|
+
*
|
|
224
|
+
* @param text - Text for the enclosed run
|
|
225
|
+
* @param options - Optional `editorGroup`, `editor`, column attributes
|
|
226
|
+
* @returns Live pair view (pending id until save)
|
|
227
|
+
* @example
|
|
228
|
+
* ```ts
|
|
229
|
+
* const range = paragraph.appendEditableRange('edit me', { editorGroup: 'everyone' });
|
|
230
|
+
* ```
|
|
231
|
+
*/
|
|
232
|
+
appendEditableRange(text: string, options?: import('../editable-ranges/index').AppendEditableRangeOptions): import('../editable-ranges/index').EditableRange;
|
|
233
|
+
/**
|
|
234
|
+
* Wrap existing content in this paragraph between the given inline indices
|
|
235
|
+
* (see {@link insertEditableRangeAt}).
|
|
236
|
+
*
|
|
237
|
+
* @param options - Inclusive/exclusive indices and optional editor metadata
|
|
238
|
+
* @returns Live pair view (pending id until save)
|
|
239
|
+
*/
|
|
240
|
+
insertEditableRangeAt(options: import('../editable-ranges/index').EditableRangeWrapOptions): import('../editable-ranges/index').EditableRange;
|
|
241
|
+
/**
|
|
242
|
+
* Append a supported Word field (PAGE, NUMPAGES, IF, MERGEFIELD, HYPERLINK).
|
|
243
|
+
*
|
|
244
|
+
* @param fieldName - Logical name (merge field name, or placeholder for PAGE/NUMPAGES/IF/HYPERLINK).
|
|
245
|
+
* @param fieldType - Supported FieldType.
|
|
246
|
+
*/
|
|
247
|
+
appendField(fieldName: string, fieldType: import('../fields/index').FieldType): import('../fields/index').Field;
|
|
248
|
+
appendHyperlink(target: string, textToDisplay: string, type: import('../fields/index').HyperlinkType): import('../fields/index').Hyperlink;
|
|
249
|
+
appendHyperlink(target: string, picture: import('../images/index').Picture, type: import('../fields/index').HyperlinkType): import('../fields/index').Hyperlink;
|
|
250
|
+
appendImage(bytes: Uint8Array, options?: import('../images/index').ImageOptions): import('../images/index').Image;
|
|
251
|
+
/**
|
|
252
|
+
* Append a footnote reference and body to this paragraph.
|
|
253
|
+
*
|
|
254
|
+
* @param text - Initial body text for the note.
|
|
255
|
+
*/
|
|
256
|
+
appendFootnote(text: string): import('../notes/index').Footnote;
|
|
257
|
+
/**
|
|
258
|
+
* Append an endnote reference and body to this paragraph.
|
|
259
|
+
*
|
|
260
|
+
* @param text - Initial body text for the note.
|
|
261
|
+
*/
|
|
262
|
+
appendEndnote(text: string): import('../notes/index').Endnote;
|
|
263
|
+
/**
|
|
264
|
+
* Assign a list by numbering instance id (escape hatch). Prefer {@link Paragraph.listFormat}.
|
|
265
|
+
|
|
266
|
+
*/
|
|
267
|
+
numbering: {
|
|
268
|
+
numId: number;
|
|
269
|
+
level?: number;
|
|
270
|
+
};
|
|
271
|
+
/**
|
|
272
|
+
* Resolved list label for this paragraph (empty when not in a list).
|
|
273
|
+
* Read-only; does not mutate numbering counters.
|
|
274
|
+
*/
|
|
275
|
+
readonly listString: string;
|
|
276
|
+
/**
|
|
277
|
+
* Append an embedded or linked OLE object. Internal feature surface —
|
|
278
|
+
* not part of the public `@syncfusion/ej2-docx` / `@syncfusion/ej2-docx/all` API.
|
|
279
|
+
*
|
|
280
|
+
* @private
|
|
281
|
+
*/
|
|
282
|
+
appendOleObject(options: import('../ole-object/index').AppendOleObjectOptions): import('../ole-object/index').OleObject;
|
|
283
|
+
style: string | undefined;
|
|
284
|
+
}
|
|
285
|
+
interface Section {
|
|
286
|
+
/**
|
|
287
|
+
* Section break kind written on this section's `w:sectPr` (`w:type`).
|
|
288
|
+
* Prefer this over retired public `sectionStart` naming.
|
|
289
|
+
*
|
|
290
|
+
* @public
|
|
291
|
+
*/
|
|
292
|
+
breakCode: import('../sections/index').SectionBreakCode;
|
|
293
|
+
/**
|
|
294
|
+
* Explicit text columns for this section (`w:cols` / `w:col`).
|
|
295
|
+
* Same {@link import('../sections/index').ColumnCollection} identity
|
|
296
|
+
* as {@link import('../sections/index').PageSetup.columns}.
|
|
297
|
+
*
|
|
298
|
+
* @public
|
|
299
|
+
*/
|
|
300
|
+
readonly columns: import('../sections/index').ColumnCollection;
|
|
301
|
+
/**
|
|
302
|
+
* Appends one explicit text column (`w:col`) to {@link Section.columns}.
|
|
303
|
+
*
|
|
304
|
+
* @param width - Column width in points.
|
|
305
|
+
* @param spacing - Spacing after the column in points (default from library).
|
|
306
|
+
* @returns The appended {@link import('../sections/index').Column}.
|
|
307
|
+
*
|
|
308
|
+
* @public
|
|
309
|
+
*/
|
|
310
|
+
addColumn(width: number, spacing?: number): import('../sections/index').Column;
|
|
311
|
+
}
|
|
312
|
+
}
|
|
313
|
+
declare module './document' {
|
|
314
|
+
interface WordDocument {
|
|
315
|
+
/**
|
|
316
|
+
* Gets the comments defined in this document.
|
|
317
|
+
* The collection contains the comment bodies associated with document comment ranges.
|
|
318
|
+
*/
|
|
319
|
+
readonly comments: import('../comments/index').CommentCollection;
|
|
320
|
+
/**
|
|
321
|
+
* Paired bookmarks in document order (`BookmarkCollection`).
|
|
322
|
+
* Orphan markers remain in the DOM but are omitted from this collection.
|
|
323
|
+
*/
|
|
324
|
+
readonly bookmarks: import('../bookmarks/index').BookmarkCollection;
|
|
325
|
+
/**
|
|
326
|
+
* Primary → alternate font name dictionary (`w:font/@w:name` →
|
|
327
|
+
* `w:altName/@w:val`, ECMA-376-1 §17.8.3.1).
|
|
328
|
+
*
|
|
329
|
+
* **Preferred public API** for font substitutions (TASK-8067). Map-style
|
|
330
|
+
* methods (`set` / `get` / `has` / `delete` / `clear`, iteration). Same
|
|
331
|
+
* object identity on every access for this document. Mutations dirty the
|
|
332
|
+
* font table part; save emits `word/fontTable.xml` when dirty.
|
|
333
|
+
*
|
|
334
|
+
* Requires the font-table feature (via `@syncfusion/ej2-docx/font-table`, styles, or
|
|
335
|
+
* {@link registerFontTableFeature}). Does not require calling
|
|
336
|
+
* {@link fontTableFor} — that helper remains for full `CT_Font` catalog
|
|
337
|
+
* metadata only.
|
|
338
|
+
*/
|
|
339
|
+
readonly fontSubstitutionTable: import('../font-table/index').FontSubstitutionTable;
|
|
340
|
+
/**
|
|
341
|
+
* @private
|
|
342
|
+
*/
|
|
343
|
+
readonly mailMerge: import('../mail-merge/index').MailMergeCatalog;
|
|
344
|
+
/**
|
|
345
|
+
* Document-level footnotes manager. Stable identity; enumerates interned
|
|
346
|
+
* {@link import('../notes/index').Footnote} bodies referenced from the main story.
|
|
347
|
+
*/
|
|
348
|
+
readonly footnotes: import('../notes/index').Footnotes;
|
|
349
|
+
/**
|
|
350
|
+
* Document-level endnotes manager. Stable identity; enumerates interned
|
|
351
|
+
* {@link import('../notes/index').Endnote} bodies referenced from the main story.
|
|
352
|
+
*/
|
|
353
|
+
readonly endnotes: import('../notes/index').Endnotes;
|
|
354
|
+
/**
|
|
355
|
+
* @private
|
|
356
|
+
* Document-owned live styles collection (`styleCollectionFor` / public StyleCollection). */
|
|
357
|
+
readonly styles: import('../styles/index').StyleCollection;
|
|
358
|
+
/**
|
|
359
|
+
* Create a custom table style and add it to this document's styles collection.
|
|
360
|
+
*
|
|
361
|
+
* @param name Display name used to derive a deterministic style id.
|
|
362
|
+
* @returns Live table style owned by this document.
|
|
363
|
+
*/
|
|
364
|
+
addTableStyle(name: string): import('../styles/index').TableStyle;
|
|
365
|
+
/**
|
|
366
|
+
* Create a custom list (numbering) style and add it to this document.
|
|
367
|
+
*
|
|
368
|
+
* @param listType Bulleted or numbered list category.
|
|
369
|
+
* @param styleName Display name; must be unique among document styles.
|
|
370
|
+
* @returns Live list style owned by this document.
|
|
371
|
+
*/
|
|
372
|
+
addListStyle(listType: import('../numbering/list-style').ListType, styleName: string): import('../numbering/list-style').ListStyle;
|
|
373
|
+
/**
|
|
374
|
+
* @private
|
|
375
|
+
* The theme catalog for this document. Equivalent to `themeFor(document)`.
|
|
376
|
+
* Plural name matches the product DOM surface (`document.themes`).
|
|
377
|
+
*/
|
|
378
|
+
readonly themes: import('../styles/theme').ThemePart;
|
|
379
|
+
/**
|
|
380
|
+
* View preferences for this document (`w:settings` view / zoom).
|
|
381
|
+
* Same object identity on every access.
|
|
382
|
+
*/
|
|
383
|
+
readonly viewSetup: import('../settings/document-settings-facades').ViewSetup;
|
|
384
|
+
/**
|
|
385
|
+
* Document settings facade (`compatibility`, protection-adjacent surface).
|
|
386
|
+
* Same object identity on every access.
|
|
387
|
+
*/
|
|
388
|
+
readonly settings: import('../settings/document-settings-facades').DocumentSettings;
|
|
389
|
+
/**
|
|
390
|
+
* Whether track revisions is enabled (`w:trackRevisions`). Absent → false.
|
|
391
|
+
*/
|
|
392
|
+
trackRevisions: boolean;
|
|
393
|
+
/**
|
|
394
|
+
* Default tab stop in points (`w:defaultTabStop`).
|
|
395
|
+
*/
|
|
396
|
+
defaultTabStop: number;
|
|
397
|
+
/**
|
|
398
|
+
* Attached template metadata from settings, when present.
|
|
399
|
+
*/
|
|
400
|
+
readonly attachedTemplate: import('../settings/index').AttachedTemplate | undefined;
|
|
401
|
+
/**
|
|
402
|
+
* Gets or sets the document watermark.
|
|
403
|
+
* Assign `undefined` to clear.
|
|
404
|
+
*/
|
|
405
|
+
watermark: import('../watermark/index').Watermark | undefined;
|
|
406
|
+
}
|
|
407
|
+
interface Body {
|
|
408
|
+
/**
|
|
409
|
+
* Appends a block-level content control (`w:sdt`) to this body.
|
|
410
|
+
*
|
|
411
|
+
* @param type - Authorable content-control kind.
|
|
412
|
+
* @returns The appended {@link BlockContentControl}.
|
|
413
|
+
*/
|
|
414
|
+
addBlockContentControl(type: import('../content-controls/index').ContentControlType): import('../content-controls/index').BlockContentControl;
|
|
415
|
+
/**
|
|
416
|
+
* Appends a 1×1 table to the first section body. Resize with {@link Table.resetCells}.
|
|
417
|
+
*
|
|
418
|
+
* Discover existing tables by walking {@link Body.items} with
|
|
419
|
+
* {@link isTableBlock} (no document-order list accessor on the body).
|
|
420
|
+
*
|
|
421
|
+
* @returns The appended {@link Table}.
|
|
422
|
+
*/
|
|
423
|
+
appendTable(): import('../tables/index').Table;
|
|
424
|
+
}
|
|
425
|
+
}
|
|
426
|
+
declare module './paragraph' {
|
|
427
|
+
interface Paragraph {
|
|
428
|
+
/**
|
|
429
|
+
* Append a bookmark start marker (`w:bookmarkStart`) at the end of this paragraph.
|
|
430
|
+
*
|
|
431
|
+
* @param name - Bookmark name (`w:name`); must be non-empty / not whitespace-only.
|
|
432
|
+
* @returns The authored start marker (pending id until save).
|
|
433
|
+
*/
|
|
434
|
+
appendBookmarkStart(name: string): import('../bookmarks/index').BookmarkStart;
|
|
435
|
+
/**
|
|
436
|
+
* Append a bookmark end marker (`w:bookmarkEnd`) pairing with `start`.
|
|
437
|
+
*
|
|
438
|
+
* @param start - Start marker previously appended (possibly in another paragraph).
|
|
439
|
+
* @returns The authored end marker.
|
|
440
|
+
*/
|
|
441
|
+
appendBookmarkEnd(start: import('../bookmarks/index').BookmarkStart): import('../bookmarks/index').BookmarkEnd;
|
|
442
|
+
/**
|
|
443
|
+
* Append a same-paragraph bookmark: start, optional text run, then end.
|
|
444
|
+
* Omitting `options.text` creates an empty bookmark (adjacent markers).
|
|
445
|
+
*/
|
|
446
|
+
appendBookmark(name: string, options?: {
|
|
447
|
+
text?: string;
|
|
448
|
+
}): import('../bookmarks/index').Bookmark;
|
|
449
|
+
/**
|
|
450
|
+
* Append a new comment (range markers + elevated {@link Comment}) on this paragraph.
|
|
451
|
+
*
|
|
452
|
+
* @param text - Initial comment body text.
|
|
453
|
+
* @param options - Optional author, initials, date, and content range indices.
|
|
454
|
+
* @returns Interned {@link Comment} shared with the document catalog.
|
|
455
|
+
*/
|
|
456
|
+
appendComment(text: string, options?: import('../comments/index').AppendCommentMetadata): import('../comments/index').Comment;
|
|
457
|
+
/**
|
|
458
|
+
* Append a new comment using a single options object (`text` required).
|
|
459
|
+
*
|
|
460
|
+
* @param options - Full {@link AppendCommentOptions}.
|
|
461
|
+
* @returns Interned {@link Comment} shared with the document catalog.
|
|
462
|
+
*/
|
|
463
|
+
appendComment(options: import('../comments/index').AppendCommentOptions): import('../comments/index').Comment;
|
|
464
|
+
/**
|
|
465
|
+
* Appends a run-level content control (`w:sdt`) to this paragraph.
|
|
466
|
+
*
|
|
467
|
+
* @param type - Authorable content-control kind.
|
|
468
|
+
* @returns The appended {@link InlineContentControl}.
|
|
469
|
+
*/
|
|
470
|
+
appendInlineContentControl(type: import('../content-controls/index').ContentControlType): import('../content-controls/index').InlineContentControl;
|
|
471
|
+
/**
|
|
472
|
+
* Append a DrawingML preset shape as dual MC AlternateContent
|
|
473
|
+
* (Choice `wps` + Fallback VML stub). Default placement is anchor.
|
|
474
|
+
*/
|
|
475
|
+
appendShape(autoShapeType: import('../drawing/index').AutoShapeType, width: number, height: number): import('../drawing/index').Shape;
|
|
476
|
+
/**
|
|
477
|
+
* Append an empty wordprocessing group as dual MC AlternateContent
|
|
478
|
+
* (Choice `wpg` + Fallback VML stub). Nest children via
|
|
479
|
+
* {@link GroupShape.appendShape} on the returned group (TASK-8051).
|
|
480
|
+
* Default placement is anchor.
|
|
481
|
+
*/
|
|
482
|
+
appendGroup(options: import('../drawing/index').GroupOptions): import('../drawing/index').GroupShape;
|
|
483
|
+
/**
|
|
484
|
+
* Append a new editable range that wraps a fresh text run at the end of
|
|
485
|
+
* this paragraph (bookmark-style authoring).
|
|
486
|
+
*
|
|
487
|
+
* Allocates a pending range id (materialized on save). Optional
|
|
488
|
+
* `editorGroup` / `editor` map `w:edGrp` / `w:ed`. The library does not
|
|
489
|
+
* evaluate document protection or editor identity.
|
|
490
|
+
*
|
|
491
|
+
* @param text - Text for the enclosed run
|
|
492
|
+
* @param options - Optional `editorGroup`, `editor`, column attributes
|
|
493
|
+
* @returns Live pair view (pending id until save)
|
|
494
|
+
* @example
|
|
495
|
+
* ```ts
|
|
496
|
+
* const range = paragraph.appendEditableRange('edit me', { editorGroup: 'everyone' });
|
|
497
|
+
* ```
|
|
498
|
+
*/
|
|
499
|
+
appendEditableRange(text: string, options?: import('../editable-ranges/index').AppendEditableRangeOptions): import('../editable-ranges/index').EditableRange;
|
|
500
|
+
/**
|
|
501
|
+
* Wrap existing content in this paragraph between the given inline indices
|
|
502
|
+
* (see {@link insertEditableRangeAt}).
|
|
503
|
+
*
|
|
504
|
+
* @param options - Inclusive/exclusive indices and optional editor metadata
|
|
505
|
+
* @returns Live pair view (pending id until save)
|
|
506
|
+
*/
|
|
507
|
+
insertEditableRangeAt(options: import('../editable-ranges/index').EditableRangeWrapOptions): import('../editable-ranges/index').EditableRange;
|
|
508
|
+
/**
|
|
509
|
+
* Append a supported Word field (PAGE, NUMPAGES, IF, MERGEFIELD, HYPERLINK).
|
|
510
|
+
*
|
|
511
|
+
* @param fieldName - Logical name (merge field name, or placeholder for PAGE/NUMPAGES/IF/HYPERLINK).
|
|
512
|
+
* @param fieldType - Supported FieldType.
|
|
513
|
+
*/
|
|
514
|
+
appendField(fieldName: string, fieldType: import('../fields/index').FieldType): import('../fields/index').Field;
|
|
515
|
+
appendHyperlink(target: string, textToDisplay: string, type: import('../fields/index').HyperlinkType): import('../fields/index').Hyperlink;
|
|
516
|
+
appendHyperlink(target: string, picture: import('../images/index').Picture, type: import('../fields/index').HyperlinkType): import('../fields/index').Hyperlink;
|
|
517
|
+
appendImage(bytes: Uint8Array, options?: import('../images/index').ImageOptions): import('../images/index').Image;
|
|
518
|
+
/**
|
|
519
|
+
* Append a footnote reference and body to this paragraph.
|
|
520
|
+
*
|
|
521
|
+
* @param text - Initial body text for the note.
|
|
522
|
+
*/
|
|
523
|
+
appendFootnote(text: string): import('../notes/index').Footnote;
|
|
524
|
+
/**
|
|
525
|
+
* Append an endnote reference and body to this paragraph.
|
|
526
|
+
*
|
|
527
|
+
* @param text - Initial body text for the note.
|
|
528
|
+
*/
|
|
529
|
+
appendEndnote(text: string): import('../notes/index').Endnote;
|
|
530
|
+
/**
|
|
531
|
+
* Assign a list by numbering instance id (escape hatch). Prefer {@link Paragraph.listFormat}.
|
|
532
|
+
|
|
533
|
+
*/
|
|
534
|
+
numbering: {
|
|
535
|
+
numId: number;
|
|
536
|
+
level?: number;
|
|
537
|
+
};
|
|
538
|
+
/**
|
|
539
|
+
* Resolved list label for this paragraph (empty when not in a list).
|
|
540
|
+
* Read-only; does not mutate numbering counters.
|
|
541
|
+
*/
|
|
542
|
+
readonly listString: string;
|
|
543
|
+
/**
|
|
544
|
+
* Append an embedded or linked OLE object. Internal feature surface —
|
|
545
|
+
* not part of the public `@syncfusion/ej2-docx` / `@syncfusion/ej2-docx/all` API.
|
|
546
|
+
*
|
|
547
|
+
* @private
|
|
548
|
+
*/
|
|
549
|
+
appendOleObject(options: import('../ole-object/index').AppendOleObjectOptions): import('../ole-object/index').OleObject;
|
|
550
|
+
style: string | undefined;
|
|
551
|
+
}
|
|
552
|
+
}
|
|
553
|
+
declare module './section' {
|
|
554
|
+
interface Section {
|
|
555
|
+
/**
|
|
556
|
+
* Section break kind (`w:type` on `w:sectPr`).
|
|
557
|
+
*
|
|
558
|
+
* @public
|
|
559
|
+
*/
|
|
560
|
+
breakCode: import('../sections/index').SectionBreakCode;
|
|
561
|
+
/**
|
|
562
|
+
* Explicit text columns (`w:cols` / `w:col`).
|
|
563
|
+
*
|
|
564
|
+
* @public
|
|
565
|
+
*/
|
|
566
|
+
readonly columns: import('../sections/index').ColumnCollection;
|
|
567
|
+
/**
|
|
568
|
+
* Appends one explicit text column to {@link Section.columns}.
|
|
569
|
+
*
|
|
570
|
+
* @param width - Column width in points.
|
|
571
|
+
* @param spacing - Spacing after the column in points.
|
|
572
|
+
* @returns The appended column.
|
|
573
|
+
*
|
|
574
|
+
* @public
|
|
575
|
+
*/
|
|
576
|
+
addColumn(width: number, spacing?: number): import('../sections/index').Column;
|
|
577
|
+
}
|
|
578
|
+
}
|
|
File without changes
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Always-on body/run/inline / package-part feature bootstrap (tables,
|
|
3
|
+
* content-controls, images, drawing, bookmarks, fields, numbering, sections,
|
|
4
|
+
* headers-footers, comments, revisions).
|
|
5
|
+
*
|
|
6
|
+
* Core never imports feature modules. Feature entry side-effects (and the main
|
|
7
|
+
* `@syncfusion/ej2-docx` entry) register idempotent `register*Feature` callbacks here so
|
|
8
|
+
* every `WordDocument.create` / `fromPackage` re-arms handlers after test resets.
|
|
9
|
+
* Numbering uses the same hook to re-arm its `registerFeaturePartHandler` for
|
|
10
|
+
* `/word/numbering.xml`. Headers/footers and comments re-arm
|
|
11
|
+
* `registerFeatureMultiPartHandler` for their relationship types (comments also
|
|
12
|
+
* registers inline/run-leaf handlers for range markers and `commentReference`).
|
|
13
|
+
* Sections re-arm WordDocument.create wrapping and feature registration for typed
|
|
14
|
+
* `w:sectPr` (not classic body-block handlers). Revisions re-arm inline/block
|
|
15
|
+
* track-change handlers and move-range markers (no package part).
|
|
16
|
+
*
|
|
17
|
+
* @private
|
|
18
|
+
*/
|
|
19
|
+
/**
|
|
20
|
+
* Register a callback invoked before main-document body parse/create.
|
|
21
|
+
* Idempotent registration of the feature itself is the callee's job.
|
|
22
|
+
*
|
|
23
|
+
* @private
|
|
24
|
+
*/
|
|
25
|
+
export declare function registerAlwaysOnBodyFeatureBootstrap(fn: () => void): void;
|
|
26
|
+
/**
|
|
27
|
+
* Run all always-on body feature bootstraps. Safe when none are registered
|
|
28
|
+
* (pure core without main entry / feature imports).
|
|
29
|
+
*
|
|
30
|
+
* @private
|
|
31
|
+
*/
|
|
32
|
+
export declare function ensureAlwaysOnBodyFeaturesRegistered(): void;
|
|
33
|
+
/**
|
|
34
|
+
* @private
|
|
35
|
+
* Test hook — clear bootstrap list (does not unregister handlers). */
|
|
36
|
+
export declare function resetAlwaysOnBodyFeatureBootstrapsForTests(): void;
|