devexpress-richedit 23.2.5 → 24.1.1-alpha-24085-0102

package/lib/client/model-api/sub-document.js

@@ -0,0 +1,284 @@
+import { ApiParametersChecker } from './api-utils/parameter-checker';
+import { DocumentFormat } from '../../common/document-format';
+import { InsertParagraphManipulatorParams } from '../../common/model/manipulators/paragraph-manipulator/insert-paragraph-manipulator-params';
+import { InlinePictureInfo } from '../../common/model/manipulators/picture-manipulator/insert-picture-manipulator-params';
+import { ImageLoadingOptions } from '../../common/model/manipulators/picture-manipulator/loader/image-loading-options';
+import { InsertTextManipulatorParams } from '../../common/model/manipulators/text-manipulator/insert-text-manipulator-params';
+import { ParagraphPropertiesApplier } from '../../common/model/paragraph/paragraph-properties-helper';
+import { RichUtils } from '../../common/model/rich-utils';
+import { RunType } from '../../common/model/runs/run-type';
+import { SubDocumentInterval, SubDocumentPosition } from '../../common/model/sub-document';
+import { MaskedParagraphPropertiesBundleFull } from '../../common/rich-utils/properties-bundle';
+import { InputPositionBase } from '../../common/selection/input-position-base';
+import { SelectionIntervalsInfo } from '../../common/selection/selection-intervals-info';
+import { Constants } from '@devexpress/utils/lib/constants';
+import { Size } from '@devexpress/utils/lib/geometry/size';
+import { FixedInterval } from '@devexpress/utils/lib/intervals/fixed';
+import { MathUtils } from '@devexpress/utils/lib/utils/math';
+import { getRestrictedInterval } from './api-utils/api-utils';
+import { ModelParametersChecker } from './api-utils/model-parameter-checker';
+import { getCharacterProperties, setCharacterProperties, } from './character-properties';
+import { BookmarkCollection } from './collections/bookmark-collection';
+import { FieldCollection } from './collections/field-collection';
+import { HyperlinkCollection } from './collections/hyperlink-collection';
+import { ParagraphCollection } from './collections/paragraph-collection';
+import { RangePermissionCollection } from './collections/range-permission-collection';
+import { TableCollection } from './collections/table/table-collection';
+import { insertContentInSubDocumentPublic } from './formats/importer';
+import { ImagesApi } from './images/images';
+import { convertToIntervalApi, IntervalApi } from './interval';
+import { convertFromParagraphPropertiesApi, convertToParagraphPropertiesApi, ParagraphApi } from './paragraph';
+import { SectionApi } from './section';
+import { insertTextThroughApi } from './api-utils/insert-text';
+import { isDefined } from '@devexpress/utils/lib/utils/common';
+import { getRtfFromSubDocumentPublic, insertRtfInSubDocumentPublic } from '../../common/formats/rtf/importer-in-subdocument';
+export var SubDocumentTypeApi;
+(function (SubDocumentTypeApi) {
+    SubDocumentTypeApi[SubDocumentTypeApi["Main"] = 0] = "Main";
+    SubDocumentTypeApi[SubDocumentTypeApi["Header"] = 1] = "Header";
+    SubDocumentTypeApi[SubDocumentTypeApi["Footer"] = 2] = "Footer";
+    SubDocumentTypeApi[SubDocumentTypeApi["TextBox"] = 3] = "TextBox";
+})(SubDocumentTypeApi || (SubDocumentTypeApi = {}));
+export var HeaderFooterTypeApi;
+(function (HeaderFooterTypeApi) {
+    HeaderFooterTypeApi[HeaderFooterTypeApi["First"] = 0] = "First";
+    HeaderFooterTypeApi[HeaderFooterTypeApi["Odd"] = 1] = "Odd";
+    HeaderFooterTypeApi[HeaderFooterTypeApi["Even"] = 2] = "Even";
+    HeaderFooterTypeApi[HeaderFooterTypeApi["Primary"] = 1] = "Primary";
+})(HeaderFooterTypeApi || (HeaderFooterTypeApi = {}));
+export var SectionBreakTypeApi;
+(function (SectionBreakTypeApi) {
+    SectionBreakTypeApi[SectionBreakTypeApi["NextPage"] = 0] = "NextPage";
+    SectionBreakTypeApi[SectionBreakTypeApi["OddPage"] = 1] = "OddPage";
+    SectionBreakTypeApi[SectionBreakTypeApi["EvenPage"] = 2] = "EvenPage";
+    SectionBreakTypeApi[SectionBreakTypeApi["Continuous"] = 3] = "Continuous";
+})(SectionBreakTypeApi || (SectionBreakTypeApi = {}));
+export class SubDocumentApi {
+    constructor(processor, subDocument) {
+        this._subDocument = subDocument;
+        this._processor = processor;
+    }
+    get paragraphs() {
+        return new ParagraphCollection(this._processor, this._subDocument);
+    }
+    get bookmarks() {
+        return new BookmarkCollection(this._processor, this._subDocument);
+    }
+    get rangePermissions() {
+        return new RangePermissionCollection(this._processor, this._subDocument);
+    }
+    get tables() {
+        return new TableCollection(this._processor, this._subDocument);
+    }
+    get fields() {
+        return new FieldCollection(this._processor, this._subDocument);
+    }
+    get hyperlinks() {
+        return new HyperlinkCollection(this._processor, this._subDocument);
+    }
+    get images() {
+        return new ImagesApi(this._processor, this._subDocument);
+    }
+    get parentSubDocument() {
+        const info = this._subDocument.info;
+        if (info.isTextBox)
+            return new SubDocumentApi(this._processor, this._processor.modelManager.model.subDocuments[info.parentSubDocumentId]);
+        return null;
+    }
+    get id() {
+        return this._subDocument.id;
+    }
+    get type() {
+        return this._subDocument.info.getType();
+    }
+    get interval() {
+        return new IntervalApi(0, this._subDocument.getDocumentEndPosition());
+    }
+    get length() {
+        return this._subDocument.getDocumentEndPosition();
+    }
+    insertText(position, text) {
+        position = ApiParametersChecker.check(position, 1, false, [
+            ApiParametersChecker.numberDescriptor('position', (val) => val)
+        ]);
+        position = MathUtils.restrictValue(position, 0, this._subDocument.getDocumentEndPosition() - 1);
+        text = ApiParametersChecker.check(text, 2, false, [
+            ApiParametersChecker.stringDescriptor('text', (v) => v, true)
+        ]);
+        return convertToIntervalApi(insertTextThroughApi(position, text, this._subDocument, this._processor, { wrapIntoBeginUpdate: true }));
+    }
+    insertLineBreak(position) {
+        return insertSpecialCharacter(position, RichUtils.specialCharacters.LineBreak, this._processor, this._subDocument);
+    }
+    insertColumnBreak(position) {
+        return insertSpecialCharacter(position, RichUtils.specialCharacters.ColumnBreak, this._processor, this._subDocument);
+    }
+    insertPageBreak(position) {
+        return insertSpecialCharacter(position, RichUtils.specialCharacters.PageBreak, this._processor, this._subDocument);
+    }
+    insertSectionBreak(position, type) {
+        position = ApiParametersChecker.check(position, 1, false, [
+            ApiParametersChecker.numberDescriptor('position', (val) => val)
+        ]);
+        position = MathUtils.restrictValue(position, 0, this._subDocument.getDocumentEndPosition() - 1);
+        const secStartType = ApiParametersChecker.check(type, 2, false, [
+            ApiParametersChecker.enumDescriptor('type', (val) => val, SectionBreakTypeApi, 'SectionBreakType')
+        ]);
+        const inputPos = new InputPositionBase().setIntervals(SelectionIntervalsInfo.fromPosition(this._subDocument, position));
+        this._processor.beginUpdate();
+        this._processor.modelManager.modelManipulator.section.insertSectionAndSetStartType(position, secStartType, inputPos.charPropsBundle);
+        this._processor.endUpdate();
+        return new SectionApi(this._processor, this._processor.modelManager.model.getSectionByPosition(position + 1));
+    }
+    insertPicture(position, base64, size, callback) {
+        position = ApiParametersChecker.check(position, 1, false, [
+            ApiParametersChecker.numberDescriptor('position', (val) => val)
+        ]);
+        position = MathUtils.restrictValue(position, 0, this._subDocument.getDocumentEndPosition() - 1);
+        base64 = ApiParametersChecker.check(base64, 2, false, [
+            ApiParametersChecker.stringDescriptor("base64", (s) => s, false)
+        ]);
+        size = ApiParametersChecker.check(size, 3, true, [
+            ApiParametersChecker.objectDescriptor('size', 'Size', (val) => val)
+        ]);
+        if (size) {
+            ApiParametersChecker.check(size.width, 3, false, [
+                ApiParametersChecker.numberDescriptor('size.width', (val) => val, 1, Constants.MAX_SAFE_INTEGER)
+            ]);
+            ApiParametersChecker.check(size.height, 3, false, [
+                ApiParametersChecker.numberDescriptor('size.height', (val) => val, 1, Constants.MAX_SAFE_INTEGER)
+            ]);
+        }
+        callback = ApiParametersChecker.check(callback, 4, true, [
+            ApiParametersChecker.functionDescriptor('callback', (val) => val)
+        ]);
+        if (!callback)
+            callback = () => { };
+        const imageCache = this._processor.modelManager.model.cache.imageCache;
+        const cacheInfo = imageCache.createUnloadedByBase64OrUrl(base64);
+        const actualSize = size ? new Size(size.width, size.height) : undefined;
+        const inputPos = new InputPositionBase().setIntervals(SelectionIntervalsInfo.fromPosition(this._subDocument, position));
+        this._processor.beginUpdate();
+        this._processor.modelManager.modelManipulator.picture.insertInlinePictureViaHistory(new SubDocumentPosition(this._subDocument, position), inputPos.charPropsBundle, InlinePictureInfo.defaultInfo(cacheInfo), ImageLoadingOptions.initByActualSize(actualSize, (picInterval, _cacheInfo) => callback(convertToIntervalApi(picInterval))));
+        this._processor.endUpdate();
+    }
+    insertParagraph(position) {
+        position = ApiParametersChecker.check(position, 1, false, [
+            ApiParametersChecker.numberDescriptor('position', (val) => val)
+        ]);
+        position = MathUtils.restrictValue(position, 0, this._subDocument.getDocumentEndPosition());
+        const inputPos = new InputPositionBase().setIntervals(SelectionIntervalsInfo.fromPosition(this._subDocument, position));
+        this._processor.beginUpdate();
+        this._processor.modelManager.modelManipulator.paragraph.insertParagraphViaHistory(new InsertParagraphManipulatorParams(new SubDocumentPosition(this._subDocument, position), inputPos.charPropsBundle, new MaskedParagraphPropertiesBundleFull(undefined, undefined, undefined, undefined), false));
+        this._processor.endUpdate();
+        return new ParagraphApi(this._processor, this._subDocument.getParagraphByPosition(position));
+    }
+    insertRtf(position, rtfText, callback) {
+        position = ApiParametersChecker.check(position, 1, false, [
+            ApiParametersChecker.numberDescriptor('position', (val) => val)
+        ]);
+        position = MathUtils.restrictValue(position, 0, this._subDocument.getDocumentEndPosition() - 1);
+        rtfText = ApiParametersChecker.check(rtfText, 2, false, [
+            ApiParametersChecker.stringDescriptor("rtf", (s) => s, false)
+        ]);
+        callback = ApiParametersChecker.check(callback, 3, true, [
+            ApiParametersChecker.functionDescriptor('callback', (val) => val)
+        ]);
+        if (!callback)
+            callback = () => { };
+        insertRtfInSubDocumentPublic(this._processor, this._subDocument, position, rtfText, (interval, isRtfValid) => callback(isDefined(interval) ? convertToIntervalApi(interval) : null, isRtfValid));
+    }
+    getRtf(interval) {
+        let coreInterval;
+        if (interval) {
+            coreInterval = ApiParametersChecker.check(interval, 1, true, [
+                ModelParametersChecker.intervalDescriptor("interval", (interval) => getRestrictedInterval(interval, 0, this._subDocument.getDocumentEndPosition()))
+            ]);
+        }
+        else {
+            coreInterval = this._subDocument.interval;
+        }
+        return getRtfFromSubDocumentPublic(this._processor.modelManager.richOptions, this._subDocument, coreInterval);
+    }
+    insertContent(position, content, documentFormat, callback) {
+        position = ApiParametersChecker.check(position, 1, false, [
+            ApiParametersChecker.numberDescriptor('position', (val) => val)
+        ]);
+        position = MathUtils.restrictValue(position, 0, this._subDocument.getDocumentEndPosition() - 1);
+        content = ApiParametersChecker.check(content, 2, false, [
+            ApiParametersChecker.stringDescriptor("contentAsBase64", (s) => s, false),
+            ApiParametersChecker.objectDescriptor("contentAsFile", "File", (s) => s),
+            ApiParametersChecker.objectDescriptor("contentAsBlob", "Blob", (s) => s),
+            ApiParametersChecker.objectDescriptor("contentAsArrayBuffer", "ArrayBuffer", (s) => s),
+        ]);
+        const coreDocumentFormat = ApiParametersChecker.check(documentFormat, 3, false, [
+            ApiParametersChecker.enumDescriptor('documentFormat', (val) => val, DocumentFormat, 'DevExpress.RichEdit.DocumentFormat')
+        ]);
+        callback = ApiParametersChecker.check(callback, 4, true, [
+            ApiParametersChecker.functionDescriptor('callback', (val) => val)
+        ]);
+        if (!callback)
+            callback = () => { };
+        insertContentInSubDocumentPublic(this._processor, this._subDocument, position, content, coreDocumentFormat, (interval, isRtfValid) => callback(convertToIntervalApi(interval), isRtfValid));
+    }
+    deleteText(interval) {
+        const coreInterval = ApiParametersChecker.check(interval, 1, false, [
+            ModelParametersChecker.intervalDescriptor("interval", (interval) => getRestrictedInterval(interval, 0, this._subDocument.getDocumentEndPosition()))
+        ]);
+        if (coreInterval.length) {
+            this._processor.beginUpdate();
+            this._processor.modelManager.modelManipulator.range.removeInterval(new SubDocumentInterval(this._subDocument, coreInterval), true, false);
+            this._processor.endUpdate();
+        }
+    }
+    getText(interval) {
+        if (interval) {
+            const coreInterval = ApiParametersChecker.check(interval, 1, false, [
+                ModelParametersChecker.intervalDescriptor("interval", (interval) => getRestrictedInterval(interval, 0, this._subDocument.getDocumentEndPosition()))
+            ]);
+            return this._subDocument.getText(coreInterval);
+        }
+        else
+            return this._subDocument.getText(this._subDocument.interval);
+    }
+    getCharacterProperties(interval) {
+        const coreInterval = this._checkInterval(interval);
+        return getCharacterProperties(this._processor, this._subDocument, coreInterval);
+    }
+    setCharacterProperties(interval, characterProperties) {
+        const coreInterval = this._checkInterval(interval);
+        setCharacterProperties(this._processor, this._subDocument, coreInterval, characterProperties);
+    }
+    _checkInterval(interval) {
+        const getResult = (interval) => getRestrictedInterval(interval, 0, this._subDocument.getDocumentEndPosition());
+        const intervalDescriptor = ModelParametersChecker.intervalDescriptor("interval", getResult);
+        return ApiParametersChecker.check(interval, 1, false, [intervalDescriptor]);
+    }
+    getParagraphProperties(interval) {
+        const coreInterval = ApiParametersChecker.check(interval, 1, false, [
+            ModelParametersChecker.intervalDescriptor("interval", (interval) => getRestrictedInterval(interval, 0, this._subDocument.getDocumentEndPosition()))
+        ]);
+        const inputPos = new InputPositionBase().setIntervals(new SelectionIntervalsInfo(this._subDocument, [coreInterval]));
+        return convertToParagraphPropertiesApi(inputPos.getMergedParagraphPropertiesFull(), this._processor.modelManager.model.colorProvider);
+    }
+    setParagraphProperties(interval, paragraphProperties) {
+        const coreInterval = ApiParametersChecker.check(interval, 1, false, [
+            ModelParametersChecker.intervalDescriptor("interval", (interval) => getRestrictedInterval(interval, 0, this._subDocument.getDocumentEndPosition()))
+        ]);
+        const propertiesCore = convertFromParagraphPropertiesApi(paragraphProperties, 2);
+        const inputPos = new InputPositionBase()
+            .setIntervals(new SelectionIntervalsInfo(this._subDocument, [coreInterval]));
+        this._processor.beginUpdate();
+        new ParagraphPropertiesApplier(this._processor.modelManager, inputPos, propertiesCore, this._subDocument, [coreInterval]).apply();
+        this._processor.endUpdate();
+    }
+}
+function insertSpecialCharacter(position, text, processor, subDocument) {
+    position = ApiParametersChecker.check(position, 1, false, [
+        ApiParametersChecker.numberDescriptor('position', (val) => val)
+    ]);
+    position = MathUtils.restrictValue(position, 0, subDocument.getDocumentEndPosition() - 1);
+    const inputPos = new InputPositionBase().setIntervals(new SelectionIntervalsInfo(subDocument, [new FixedInterval(position, 0)]));
+    const result = processor.modelManager.modelManipulator.text.insertTextViaHistory(new InsertTextManipulatorParams(new SubDocumentPosition(subDocument, position), inputPos.charPropsBundle, RunType.TextRun, text));
+    return convertToIntervalApi(result.insertedInterval);
+}

package/lib/client/model-api/table/enums.d.ts

@@ -0,0 +1,213 @@
+export declare enum BorderLineStyleApi {
+    Nil = -1,
+    None = 0,
+    Single = 1,
+    Thick = 2,
+    Double = 3,
+    Dotted = 4,
+    Dashed = 5,
+    DotDash = 6,
+    DotDotDash = 7,
+    Triple = 8,
+    ThinThickSmallGap = 9,
+    ThickThinSmallGap = 10,
+    ThinThickThinSmallGap = 11,
+    ThinThickMediumGap = 12,
+    ThickThinMediumGap = 13,
+    ThinThickThinMediumGap = 14,
+    ThinThickLargeGap = 15,
+    ThickThinLargeGap = 16,
+    ThinThickThinLargeGap = 17,
+    Wave = 18,
+    DoubleWave = 19,
+    DashSmallGap = 20,
+    DashDotStroked = 21,
+    ThreeDEmboss = 22,
+    ThreeDEngrave = 23,
+    Outset = 24,
+    Inset = 25,
+    Apples = 26,
+    ArchedScallops = 27,
+    BabyPacifier = 28,
+    BabyRattle = 29,
+    Balloons3Colors = 30,
+    BalloonsHotAir = 31,
+    BasicBlackDashes = 32,
+    BasicBlackDots = 33,
+    BasicBlackSquares = 34,
+    BasicThinLines = 35,
+    BasicWhiteDashes = 36,
+    BasicWhiteDots = 37,
+    BasicWhiteSquares = 38,
+    BasicWideInline = 39,
+    BasicWideMidline = 40,
+    BasicWideOutline = 41,
+    Bats = 42,
+    Birds = 43,
+    BirdsFlight = 44,
+    Cabins = 45,
+    CakeSlice = 46,
+    CandyCorn = 47,
+    CelticKnotwork = 48,
+    CertificateBanner = 49,
+    ChainLink = 50,
+    ChampagneBottle = 51,
+    CheckedBarBlack = 52,
+    CheckedBarColor = 53,
+    Checkered = 54,
+    ChristmasTree = 55,
+    CirclesLines = 56,
+    CirclesRectangles = 57,
+    ClassicalWave = 58,
+    Clocks = 59,
+    Compass = 60,
+    Confetti = 61,
+    ConfettiGrays = 62,
+    ConfettiOutline = 63,
+    ConfettiStreamers = 64,
+    ConfettiWhite = 65,
+    CornerTriangles = 66,
+    CouponCutoutDashes = 67,
+    CouponCutoutDots = 68,
+    CrazyMaze = 69,
+    CreaturesButterfly = 70,
+    CreaturesFish = 71,
+    CreaturesInsects = 72,
+    CreaturesLadyBug = 73,
+    CrossStitch = 74,
+    Cup = 75,
+    DecoArch = 76,
+    DecoArchColor = 77,
+    DecoBlocks = 78,
+    DiamondsGray = 79,
+    DoubleD = 80,
+    DoubleDiamonds = 81,
+    Earth1 = 82,
+    Earth2 = 83,
+    EclipsingSquares1 = 84,
+    EclipsingSquares2 = 85,
+    EggsBlack = 86,
+    Fans = 87,
+    Film = 88,
+    Firecrackers = 89,
+    FlowersBlockPrint = 90,
+    FlowersDaisies = 91,
+    FlowersModern1 = 92,
+    FlowersModern2 = 93,
+    FlowersPansy = 94,
+    FlowersRedRose = 95,
+    FlowersRoses = 96,
+    FlowersTeacup = 97,
+    FlowersTiny = 98,
+    Gems = 99,
+    GingerbreadMan = 100,
+    Gradient = 101,
+    Handmade1 = 102,
+    Handmade2 = 103,
+    HeartBalloon = 104,
+    HeartGray = 105,
+    Hearts = 106,
+    HeebieJeebies = 107,
+    Holly = 108,
+    HouseFunky = 109,
+    Hypnotic = 110,
+    IceCreamCones = 111,
+    LightBulb = 112,
+    Lightning1 = 113,
+    Lightning2 = 114,
+    MapleLeaf = 115,
+    MapleMuffins = 116,
+    MapPins = 117,
+    Marquee = 118,
+    MarqueeToothed = 119,
+    Moons = 120,
+    Mosaic = 121,
+    MusicNotes = 122,
+    Northwest = 123,
+    Ovals = 124,
+    Packages = 125,
+    PalmsBlack = 126,
+    PalmsColor = 127,
+    PaperClips = 128,
+    Papyrus = 129,
+    PartyFavor = 130,
+    PartyGlass = 131,
+    Pencils = 132,
+    People = 133,
+    PeopleHats = 134,
+    PeopleWaving = 135,
+    Poinsettias = 136,
+    PostageStamp = 137,
+    Pumpkin1 = 138,
+    PushPinNote1 = 139,
+    PushPinNote2 = 140,
+    Pyramids = 141,
+    PyramidsAbove = 142,
+    Quadrants = 143,
+    Rings = 144,
+    Safari = 145,
+    Sawtooth = 146,
+    SawtoothGray = 147,
+    ScaredCat = 148,
+    Seattle = 149,
+    ShadowedSquares = 150,
+    SharksTeeth = 151,
+    ShorebirdTracks = 152,
+    Skyrocket = 153,
+    SnowflakeFancy = 154,
+    Snowflakes = 155,
+    Sombrero = 156,
+    Southwest = 157,
+    Stars = 158,
+    Stars3d = 159,
+    StarsBlack = 160,
+    StarsShadowed = 161,
+    StarsTop = 162,
+    Sun = 163,
+    Swirligig = 164,
+    TornPaper = 165,
+    TornPaperBlack = 166,
+    Trees = 167,
+    TriangleParty = 168,
+    Triangles = 169,
+    Tribal1 = 170,
+    Tribal2 = 171,
+    Tribal3 = 172,
+    Tribal4 = 173,
+    Tribal5 = 174,
+    Tribal6 = 175,
+    TwistedLines1 = 176,
+    TwistedLines2 = 177,
+    Vine = 178,
+    Waveline = 179,
+    WeavingAngles = 180,
+    WeavingBraid = 181,
+    WeavingRibbon = 182,
+    WeavingStrips = 183,
+    WhiteFlowers = 184,
+    Woodwork = 185,
+    XIllusions = 186,
+    ZanyTriangles = 187,
+    ZigZag = 188,
+    ZigZagStitch = 189
+}
+export declare enum TableWidthTypeApi {
+    Auto = 1,
+    Percent = 2,
+    Twips = 3
+}
+export declare enum TableRowHeightTypeApi {
+    Minimum = 0,
+    Auto = 1,
+    Exact = 2
+}
+export declare enum TableContentHorizontalAlignmentApi {
+    Left = 0,
+    Right = 1,
+    Center = 2
+}
+export declare enum TableContentVerticalAlignmentApi {
+    Top = 0,
+    Center = 2,
+    Bottom = 3
+}