forked from syncfusion/ej2-javascript-ui-controls
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathdocument-editor-model.d.ts
910 lines (774 loc) · 26.6 KB
/
document-editor-model.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
import { Component, Property, INotifyPropertyChanged, NotifyPropertyChanges, Event, ModuleDeclaration, ChildProperty, classList, Complex, formatUnit, Base } from '@syncfusion/ej2-base';import { isNullOrUndefined, L10n, EmitType, Browser } from '@syncfusion/ej2-base';import { Save } from '@syncfusion/ej2-file-utils';import { DocumentChangeEventArgs, ViewChangeEventArgs, ZoomFactorChangeEventArgs, StyleType, WStyle, BeforePaneSwitchEventArgs, LayoutType, FormFieldFillEventArgs, FormFieldData } from './index';import { SelectionChangeEventArgs, RequestNavigateEventArgs, ContentChangeEventArgs, DocumentEditorKeyDownEventArgs, CustomContentMenuEventArgs, BeforeOpenCloseCustomContentMenuEventArgs, CommentDeleteEventArgs, RevisionActionEventArgs, BeforeFileOpenArgs, CommentActionEventArgs, XmlHttpRequestEventArgs } from './index';import { LayoutViewer, PageLayoutViewer, WebLayoutViewer, BulletsAndNumberingDialog } from './index';import { Print, SearchResultsChangeEventArgs } from './index';import { Page, BodyWidget, ParagraphWidget } from './index';import { WSectionFormat, WParagraphFormat, WCharacterFormat } from './index';import { SfdtReader } from './index';import { Selection } from './index';import { TextPosition } from './index';import { Editor, EditorHistory } from './index';import { WStyles } from './index';import { HeaderFooters } from './index';import { Search } from './index';import { OptionsPane } from './index';import { WordExport } from './index';import { TextExport } from './index';import { FormatType, PageFitType, DialogType, FormattingExceptions, CompatibilityMode } from './index';import { ContextMenu } from './index';import { ImageResizer } from './index';import { SfdtExport } from './index';import { HyperlinkDialog, TableDialog, BookmarkDialog, StylesDialog, TableOfContentsDialog } from './index';import { PageSetupDialog, ParagraphDialog, ListDialog, StyleDialog, FontDialog } from './index';import { TablePropertiesDialog, BordersAndShadingDialog, CellOptionsDialog, TableOptionsDialog } from './index';import { SpellChecker } from './implementation/spell-check/spell-checker';import { SpellCheckDialog } from './implementation/dialogs/spellCheck-dialog';import { CharacterFormatProperties, ParagraphFormatProperties, SectionFormatProperties, DocumentHelper, listsProperty, abstractListsProperty } from './index';import { PasteOptions } from './index';import { CommentReviewPane, CheckBoxFormFieldDialog, DropDownFormField, TextFormField, CheckBoxFormField, FieldElementBox, TextFormFieldInfo, CheckBoxFormFieldInfo, DropDownFormFieldInfo, ContextElementInfo, CollaborativeEditing, CollaborativeEditingEventArgs, Operation, ProtectionInfo, HistoryInfo, BaseHistoryInfo, WParagraphStyle, WList, WCharacterStyle, CollaborativeEditingHandler, ActionInfo } from './implementation/index';import { TextFormFieldDialog } from './implementation/dialogs/form-field-text-dialog';import { DropDownFormFieldDialog } from './implementation/dialogs/form-field-drop-down-dialog';import { FormFillingMode, TrackChangeEventArgs, ServiceFailureArgs, ImageFormat, ProtectionType } from './base';import { TrackChangesPane } from './implementation/track-changes/track-changes-pane';import { RevisionCollection } from './implementation/track-changes/track-changes';import { NotesDialog } from './implementation/dialogs/notes-dialog';import { FootNoteWidget } from './implementation/viewer/page';import { internalZoomFactorChange, contentChangeEvent, documentChangeEvent, selectionChangeEvent, zoomFactorChangeEvent, beforeFieldFillEvent, afterFieldFillEvent, serviceFailureEvent, viewChangeEvent, customContextMenuSelectEvent, customContextMenuBeforeOpenEvent, internalviewChangeEvent, internalDocumentEditorSettingsChange, trackChanges } from './base/constants';import { Optimized, Regular, HelperMethods } from './index';import { ColumnsDialog } from './implementation/dialogs/columns-dialog';import { DocumentCanvasElement } from './implementation/viewer/document-canvas';import { ZipArchiveItem, ZipArchive } from '@syncfusion/ej2-compression';import { Ruler } from './implementation/ruler/index';import { TabDialog } from './implementation/dialogs/tab-dialog';import { RulerHelper } from './implementation/utility/dom-util';import { ColorPickerModel } from '@syncfusion/ej2-inputs';import { MentionModel } from '@syncfusion/ej2-dropdowns';
import {ComponentModel} from '@syncfusion/ej2-base';
/**
* Interface for a class DocumentEditorSettings
*/
export interface DocumentEditorSettingsModel {
/**
* Gets or sets a value indicating where to append the pop up element
*
* @returns {HTMLElement}
* @aspType HTMLElement
* @default null
*/
popupTarget?: HTMLElement;
/**
* Specifies the user preferred Search Highlight Color of Document Editor.
*
* @default '#FFE97F'
*/
searchHighlightColor?: string;
/**
* Specifies the user preferred font family of Document Editor.
* @default ['Algerian','Arial','Calibri','Cambria','CambriaMath','Candara','CourierNew','Georgia','Impact','SegoePrint','SegoeScript','SegoeUI','Symbol','TimesNewRoman','Verdana','Wingdings']
*/
fontFamilies?: string[];
/**
* Gets or sets the form field settings.
*/
formFieldSettings?: FormFieldSettingsModel;
/**
* Specified the auto resize settings.
*/
autoResizeSettings?: AutoResizeSettingsModel;
/**
* Gets ot sets the collaborative editing settings.
*/
collaborativeEditingSettings?: CollaborativeEditingSettingsModel;
/**
* Specifies the device pixel ratio for the image generated for printing.
* > Increasing the device pixel ratio will increase the image file size, due to high resolution of image.
*/
printDevicePixelRatio?: number;
/**
* Gets or sets a value indicating whether to use optimized text measuring approach to match Microsoft Word pagination.
*
* @default true
* @aspType bool
* @returns {boolean} Returns `true` if uses optimized text measuring approach to match Microsoft Word pagination; otherwise, `false`
*/
enableOptimizedTextMeasuring?: boolean;
/**
* Enable or Disable moving selected content within Document Editor
*
* @default true
* @aspType bool
* @returns {boolean} Returns `true` moving selected content within Document Editor is enabled; otherwise, `false`
*/
allowDragAndDrop?: boolean;
/**
* Gets or sets the maximum number of rows allowed while inserting a table in Document editor component.
* > The maximum value is 32767, as per Microsoft Word application and you can set any value less than 32767 to this property. If you set any value greater than 32767, then Syncfusion Document editor will automatically reset as 32767.
* @default 32767
* @returns {number}
*/
maximumRows?: number;
/**
* Gets or sets the maximum number of columns allowed while inserting a table in Document editor component.
* > The maximum value is 63, as per Microsoft Word application and you can set any value less than 63 to this property. If you set any value greater than 63, then Syncfusion Document editor will automatically reset as 63.
* @default 63
* @returns {number}
*/
maximumColumns?: number;
/**
* Gets or sets a value indicating whether to show the hidden characters like spaces, tab, paragraph marks, and breaks.
*
* @default false
* @aspType bool
* @returns {boolean} Returns `false` if hides the hidden characters like spaces, tab, paragraph marks, and breaks. Otherwise `true`.
*/
showHiddenMarks?: boolean;
/**
* Gets or sets a value indicating whether to show square brackets around bookmarked items.
*
* @returns {boolean}
* @aspType bool
* @default false
*/
showBookmarks?: boolean;
/**
* Gets or sets a value indicating whether to highlight the editable ranges in the document where the current user can edit.
*
* @default true
* @aspType bool
* @returns {boolean} Returns `true` if editable ranges in the document is highlighted. Otherwise `false`.
*/
highlightEditableRanges?: boolean;
/**
* Describes whether to reduce the resultant SFDT file size by minifying the file content
*
* @default true
* @aspType bool
* @returns {boolean} Returns `true` if sfdt content generated is optimized. Otherwise `false`.
*/
optimizeSfdt?: boolean;
/**
* Gets or sets a value indicating whether to display ruler in Document Editor.
*
* @default false
* @aspType bool
* @returns {boolean} Returns `true` if ruler is visible in Document Editor. Otherwise `false`.
*/
showRuler?: boolean;
/**
* Gets or sets color picker settings to customize the color picker used in Document Editor.
*/
colorPickerSettings?: ColorPickerModel;
/**
* Gets or sets a value indicating whether to display navigation pane in Document Editor.
*
* @default false
* @aspType bool
* @returns {boolean} Returns `true` if navigation pane is visible in Document Editor. Otherwise `false`.
*/
showNavigationPane?: boolean;
/**
* Gets ot sets the mention configuration used in Document Editor.
*/
mentionSettings?: MentionModel;
}
/**
* Interface for a class DocumentSettings
*/
export interface DocumentSettingsModel {
/**
* Gets or sets the compatibility mode of the current document.
*
* @default `Word2013`
* @returns {CompatibilityMode}
*/
compatibilityMode?: CompatibilityMode;
}
/**
* Interface for a class AutoResizeSettings
*/
export interface AutoResizeSettingsModel {
/**
* Gets or sets the time interval in milliseconds to validate whether the parent element's height and width is non-zero.
*
* @default 2000
* @returns {number}
*/
interval?: number;
/**
* Gets or sets the number of times the Document editor has to validate whether the parent element's height and width is non-zero.
*
* @default 5
* @returns {number}
*/
iterationCount?: number;
}
/**
* Interface for a class DocumentEditor
*/
export interface DocumentEditorModel extends ComponentModel{
/**
* Enable collaborative editing in document editor.
* @default false
*/
enableCollaborativeEditing?: boolean;
/**
* Gets or sets the default Paste Formatting Options
*
* @default KeepSourceFormatting
*/
defaultPasteOption?: PasteOptions;
/**
* Gets or sets the Layout Type.
*
* @default Pages
*/
layoutType?: LayoutType;
/**
* Gets or sets the current user.
*
* @default ''
*/
currentUser?: string;
/**
* Gets or sets the color used for highlighting the editable ranges or regions of the `currentUser` in Document Editor. The default value is "#FFFF00".
* > If the visibility of text affected due this highlight color matching with random color applied for the track changes, then modify the color value of this property to resolve text visibility problem.
*
* @default '#FFFF00'
*/
userColor?: string;
/**
* Gets or sets the page gap value in document editor.
*
* @default 20
*/
pageGap?: number;
/**
* Gets or sets the name of the document.
*
* @default ''
*/
documentName?: string;
/**
* Defines the width of the DocumentEditor component.
*
* @default '100%'
*/
width?: string;
/**
* Defines the height of the DocumentEditor component.
*
* @default '200px'
*/
height?: string;
/**
* Gets or sets the Sfdt Service URL.
*
* @default ''
*/
serviceUrl?: string;
/**
* Gets or sets the zoom factor in document editor.
*
* @default 1
*/
zoomFactor?: number;
/**
* Specifies the z-order for rendering that determines whether the dialog is displayed in front or behind of another component.
*
* @default 2000
* @aspType int
*/
zIndex?: number;
/**
* Gets or sets a value indicating whether the document editor is in read only state or not.
*
* @default true
*/
isReadOnly?: boolean;
/**
* Gets or sets a value indicating whether print needs to be enabled or not.
*
* @default false
*/
enablePrint?: boolean;
/**
* Gets or sets a value indicating whether selection needs to be enabled or not.
*
* @default false
*/
enableSelection?: boolean;
/**
* Gets or sets a value indicating whether editor needs to be enabled or not.
*
* @default false
*/
enableEditor?: boolean;
/**
* Gets or sets a value indicating whether editor history needs to be enabled or not.
*
* @default false
*/
enableEditorHistory?: boolean;
/**
* Gets or sets a value indicating whether Sfdt export needs to be enabled or not.
*
* @default false
*/
enableSfdtExport?: boolean;
/**
* Gets or sets a value indicating whether word export needs to be enabled or not.
*
* @default false
*/
enableWordExport?: boolean;
/**
* Gets or sets a value indicating whether the automatic focus behavior is enabled for Document editor or not.
*
* > By default, the Document editor gets focused automatically when the page loads. If you want the Document editor not to be focused automatically, then set this property to false.
*
* @returns {boolean}
* @aspType bool
* @default true
*/
enableAutoFocus?: boolean;
/**
* Gets or sets a value indicating whether text export needs to be enabled or not.
*
* @default false
*/
enableTextExport?: boolean;
/**
* Gets or sets a value indicating whether options pane is enabled or not.
*
* @default false
*/
enableOptionsPane?: boolean;
/**
* Gets or sets a value indicating whether context menu is enabled or not.
*
* @default false
*/
enableContextMenu?: boolean;
/**
* Gets or sets a value indicating whether hyperlink dialog is enabled or not.
*
* @default false
*/
enableHyperlinkDialog?: boolean;
/**
* Gets or sets a value indicating whether bookmark dialog is enabled or not.
*
* @default false
*/
enableBookmarkDialog?: boolean;
/**
* Gets or sets a value indicating whether table of contents dialog is enabled or not.
*
* @default false
*/
enableTableOfContentsDialog?: boolean;
/**
* Gets or sets a value indicating whether search module is enabled or not.
*
* @default false
*/
enableSearch?: boolean;
/**
* Gets or sets a value indicating whether paragraph dialog is enabled or not.
*
* @default false
*/
enableParagraphDialog?: boolean;
/**
* Gets or sets a value indicating whether list dialog is enabled or not.
*
* @default false
*/
enableListDialog?: boolean;
/**
* Gets or sets a value indicating whether table properties dialog is enabled or not.
*
* @default false
*/
enableTablePropertiesDialog?: boolean;
/**
* Gets or sets a value indicating whether borders and shading dialog is enabled or not.
*
* @default false
*/
enableBordersAndShadingDialog?: boolean;
/**
* Gets or sets a value indicating whether notes dialog is enabled or not.
*
* @default false
*/
enableFootnoteAndEndnoteDialog?: boolean;
/**
* Gets or sets a value indicating whether margin dialog is enabled or not.
*
* @default false
*/
enableColumnsDialog?: boolean;
/**
* Gets or sets a value indicating whether font dialog is enabled or not.
*
* @default false
*/
enablePageSetupDialog?: boolean;
/**
* Gets or sets a value indicating whether font dialog is enabled or not.
*
* @default false
*/
enableStyleDialog?: boolean;
/**
* Gets or sets a value indicating whether font dialog is enabled or not.
*
* @default false
*/
enableFontDialog?: boolean;
/**
* Gets or sets a value indicating whether table options dialog is enabled or not.
*
* @default false
*/
enableTableOptionsDialog?: boolean;
/**
* Gets or sets a value indicating whether table dialog is enabled or not.
*
* @default false
*/
enableTableDialog?: boolean;
/**
* Gets or sets a value indicating whether image resizer is enabled or not.
*
* @default false
*/
enableImageResizer?: boolean;
/**
* Gets or sets a value indicating whether editor need to be spell checked.
*
* @default false
*/
enableSpellCheck?: boolean;
/**
* Gets or sets a value indicating whether comment is enabled or not
*
* @default false
*/
enableComment?: boolean;
/**
* Gets or sets a value indicating whether track changes is enabled or not
*
* @default false
*/
enableTrackChanges?: boolean;
/**
* Gets or sets a value indicating whether form fields is enabled or not.
*
* @default false
*/
enableFormField?: boolean;
/**
* Gets or sets a value indicating whether tab key can be accepted as input or not.
*
* @default false
*/
acceptTab?: boolean;
/**
* Gets or sets a value indicating whether holding Ctrl key is required to follow hyperlink on click. The default value is true.
*
* @default true
*/
useCtrlClickToFollowHyperlink?: boolean;
/**
* Gets or sets the page outline color.
*
* @default '#000000'
*/
pageOutline?: string;
/**
* Gets or sets a value indicating whether to enable cursor in document editor on read only state or not. The default value is false.
*
* @default false
*/
enableCursorOnReadOnly?: boolean;
/**
* Gets or sets a value indicating whether local paste needs to be enabled or not.
*
* @default false
*/
enableLocalPaste?: boolean;
/**
* Enables the partial lock and edit module.
*
* @default false
*/
enableLockAndEdit?: boolean;
/**
* Defines the settings for DocumentEditor customization.
*
* @default {}
*/
documentEditorSettings?: DocumentEditorSettingsModel;
/**
* Gets the settings and properties of the document that is opened in Document editor component.
*
* @default {}
*/
documentSettings?: DocumentSettingsModel;
/**
* Defines the settings of the DocumentEditor services
*/
serverActionSettings?: ServerActionSettingsModel;
/**
* Adds the custom headers to XMLHttpRequest.
*
* @default []
*/
headers?: object[];
/**
* Shows the comment in the document.
*
* @default false
*/
showComments?: boolean;
/**
* Shows the revision changes in the document.
*
* @default false
*/
showRevisions?: boolean;
/**
* Gets or sets a value indicating whether to start automatic resize with the specified time interval and iteration count.
*
* > * Resize action triggers automatically for the specified number of iterations, or till the parent element's height and width is non-zero.
*
* > * If the parent element's height and width is zero even in the last iteration, then the default height and width (200) is allocated for the Document editor.
*
* @default false
* @returns {boolean}
*/
autoResizeOnVisibilityChange?: boolean;
/**
* Triggers whenever the document changes in the document editor.
*
* @event documentChange
*/
documentChange?: EmitType<DocumentChangeEventArgs>;
/**
* Triggers whenever the container view changes in the document editor.
*
* @event viewChange
*/
viewChange?: EmitType<ViewChangeEventArgs>;
/**
* Triggers whenever the zoom factor changes in the document editor.
*
* @event zoomFactorChange
*/
zoomFactorChange?: EmitType<ZoomFactorChangeEventArgs>;
/**
* Triggers whenever the selection changes in the document editor.
*
* @event selectionChange
*/
selectionChange?: EmitType<SelectionChangeEventArgs>;
/**
* Triggers whenever the hyperlink is clicked or tapped in the document editor.
*
* @event requestNavigate
*/
requestNavigate?: EmitType<RequestNavigateEventArgs>;
/**
* Triggers whenever the content changes in the document editor.
*
* @event contentChange
*/
contentChange?: EmitType<ContentChangeEventArgs>;
/**
* Triggers whenever the key is pressed in the document editor.
*
* @event keyDown
*/
keyDown?: EmitType<DocumentEditorKeyDownEventArgs>;
/**
* Triggers whenever search results changes in the document editor.
*
* @event searchResultsChange
*/
searchResultsChange?: EmitType<SearchResultsChangeEventArgs>;
/**
* Triggers when the component is created.
*
* @event created
*/
created?: EmitType<Object>;
/**
* Triggers when the component is destroyed.
*
* @event destroyed
*/
destroyed?: EmitType<Object>;
/**
* Triggers while selecting the custom context-menu option.
*
* @event customContextMenuSelect
*/
customContextMenuSelect?: EmitType<CustomContentMenuEventArgs>;
/**
* Triggers before opening the custom context-menu option.
*
* @event customContextMenuBeforeOpen
*/
customContextMenuBeforeOpen?: EmitType<BeforeOpenCloseCustomContentMenuEventArgs>;
/**
* Triggers before opening the comment pane.
*
* @event beforePaneSwitch
*/
beforePaneSwitch?: EmitType<BeforePaneSwitchEventArgs>;
/**
* Triggers after inserting the comment.
*
* @event commentBegin
*/
commentBegin?: EmitType<Object>;
/**
* Triggers after posting the comment.
*
* @event commentEnd
*/
commentEnd?: EmitType<Object>;
/**
* Triggers before a file is opened.
*
* @event beforeFileOpen
*/
beforeFileOpen?: EmitType<BeforeFileOpenArgs>;
/**
* Triggers after deleting the comment.
*
* @event commentDelete
*/
commentDelete?: EmitType<CommentDeleteEventArgs>;
/**
* Triggers before accepting or rejecting changes.
*
* @event beforeAcceptRejectChanges
*/
beforeAcceptRejectChanges?: EmitType<RevisionActionEventArgs>;
/**
* Triggers on comment actions(Post, edit, reply, resolve, reopen).
*
* @event beforeCommentAction
*/
beforeCommentAction?: EmitType<CommentActionEventArgs>;
/**
* Triggers when the trackChanges enabled / disabled.
*
* @event trackChange
*/
trackChange?: EmitType<TrackChangeEventArgs>;
/**
* Triggers before the form field fill.
*
* @event beforeFormFieldFill
*/
beforeFormFieldFill?: EmitType<FormFieldFillEventArgs>;
/**
* Triggers when the server side action fails.
*
* @event serviceFailure
*/
serviceFailure?: EmitType<ServiceFailureArgs>;
/**
* Triggers after the form field fill.
*
* @event afterFormFieldFill
*/
afterFormFieldFill?: EmitType<FormFieldFillEventArgs>;
/**
* Triggers when the document editor collaborative actions (such as LockContent, SaveContent, UnlockContent) gets completed.
*
* @event actionComplete
*/
actionComplete?: EmitType<CollaborativeEditingEventArgs>;
/**
* Triggers when user interaction prevented in content control.
*
* @event contentControl
*/
contentControl?: EmitType<Object>;
/**
* Triggers before a server request is started, allows you to modify the XMLHttpRequest object (setting additional headers, if needed).
*/
beforeXmlHttpRequestSend?: EmitType<XmlHttpRequestEventArgs>;
}
/**
* Interface for a class ServerActionSettings
*/
export interface ServerActionSettingsModel {
/**
* Specifies the system clipboard action of Document Editor.
*
* @default 'SystemClipboard'
*/
systemClipboard?: string;
/**
* Specifies the spell check action of Document Editor.
*
* @default 'SpellCheck'
*/
spellCheck?: string;
/**
* Specifies the spell check by page action of Document Editor.
*
* @default 'SpellCheckByPage'
*/
spellCheckByPage?: string;
/**
* Specifies the restrict editing encryption/decryption action of Document Editor.
*
* @default 'RestrictEditing'
*/
restrictEditing?: string;
/**
* Specifies the server action name to lock selected region.
*
* @default 'CanLock'
*/
canLock?: string;
/**
* Specifies the server action name to pull pending actions.
*
* @default 'GetPendingActions'
*/
getPendingActions?: string;
}
/**
* Interface for a class FormFieldSettings
*/
export interface FormFieldSettingsModel {
/**
* Gets or sets the form fields shading color.
* You can customize shading color in application level, but cannot be exported in file level
*
* @default '#cfcfcf'
*/
shadingColor?: string;
/**
* Gets or sets the whether apply shadings for field or not.
*
* @default true
*/
applyShading?: boolean;
/**
* Gets or sets the field selection color.
*
* @default '#cccccc'
*/
selectionColor?: string;
/**
* Gets or sets the form filling mode type.
*
* @default 'Popup'
*/
formFillingMode?: FormFillingMode;
/**
* Gets or sets the formatting exception.
*
* @default []
*/
formattingExceptions?: FormattingExceptions[];
}
/**
* Interface for a class CollaborativeEditingSettings
*/
export interface CollaborativeEditingSettingsModel {
/**
* Gets or sets the collaborative editing room name.
*
* @default ''
*/
roomName?: string;
/**
* Gets or sets the editable region color.
*/
editableRegionColor?: string;
/**
* Gets or sets the locked region color.
*/
lockedRegionColor?: string;
/**
* Gets or sets the timeout for syncing content in milliseconds.
*/
saveTimeout?: number;
}
/**
* Interface for a class ContainerServerActionSettings
*/
export interface ContainerServerActionSettingsModel extends ServerActionSettingsModel{
/**
* Specifies the load action of Document Editor.
*
* @default 'Import'
*/
import?: string;
}