@progress/kendo-angular-spreadsheet 19.1.2-develop.4 → 19.1.2-develop.6

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.
@@ -6,7 +6,16 @@ import { LocalizationService } from '@progress/kendo-angular-l10n';
6
6
  import { MessagesDirective } from './messages';
7
7
  import * as i0 from "@angular/core";
8
8
  /**
9
- * Custom component messages override default component messages.
9
+ * Overrides the default Spreadsheet component messages with custom messages.
10
+ * You can use this component to provide custom text for the Spreadsheet UI elements, such as the toolbar, dialogs, and other components.
11
+ *
12
+ * @example
13
+ * ```html
14
+ * <kendo-spreadsheet [sheets]="sheets">
15
+ * <kendo-spreadsheet-messages home="Home" file="File">
16
+ * </kendo-spreadsheet-messages>
17
+ * </kendo-spreadsheet>
18
+ * ```
10
19
  */
11
20
  export declare class CustomMessagesComponent extends MessagesDirective {
12
21
  protected service: LocalizationService;
@@ -9,447 +9,447 @@ import * as i0 from "@angular/core";
9
9
  */
10
10
  export declare class MessagesDirective extends ComponentMessages {
11
11
  /**
12
- * The name of the "Home" toolbar tab
12
+ * Sets the name for the **Home** toolbar tab.
13
13
  */
14
14
  home: string;
15
15
  /**
16
- * The name of the "File" toolbar tab
16
+ * Sets the name for the **File** toolbar tab.
17
17
  */
18
18
  file: string;
19
19
  /**
20
- * The name of the "Insert" toolbar tab
20
+ * Sets the name for the **Insert** toolbar tab.
21
21
  */
22
22
  insert: string;
23
23
  /**
24
- * The name of the "Format" toolbar tab
24
+ * Sets the name for the **Format** toolbar tab.
25
25
  */
26
26
  formatTab: string;
27
27
  /**
28
- * The name of the "Data" toolbar tab
28
+ * Sets the name for the **Data** toolbar tab.
29
29
  */
30
30
  dataTab: string;
31
31
  /**
32
- * The title of the Save File tool
32
+ * Sets the title for the **Save** File tool.
33
33
  */
34
34
  saveFile: string;
35
35
  /**
36
- * The title of the Load File tool
36
+ * Sets the title for the **Load File** tool.
37
37
  */
38
38
  loadFile: string;
39
39
  /**
40
- * The title of the Bold tool
40
+ * Sets the title for the **Bold** tool.
41
41
  */
42
42
  bold: string;
43
43
  /**
44
- * The title of the Data Validation tool
44
+ * Sets the title for the **Data Validation** tool.
45
45
  */
46
46
  dataValidation: string;
47
47
  /**
48
- * The text of the Cell Range input label in the data validation dialog
48
+ * Sets the label text for the Cell Range input in the data validation dialog.
49
49
  */
50
50
  validationCellRange: string;
51
51
  /**
52
- * The text of the Criteria dropdown list label in the data validation dialog.
52
+ * Sets the label text for the Criteria dropdown in the data validation dialog.
53
53
  */
54
54
  validationCriteria: string;
55
55
  /**
56
- * The text of the Comparer dropdown list label in the data validation dialog.
56
+ * Sets the label text for the Comparer dropdown in the data validation dialog.
57
57
  */
58
58
  validationComparer: string;
59
59
  /**
60
- * The text of the Min value label in the data validation dialog.
60
+ * Sets the label text for the Min value in the data validation dialog.
61
61
  */
62
62
  validationMinValue: string;
63
63
  /**
64
- * The text of the Max value label in the data validation dialog.
64
+ * Sets the label text for the Max value in the data validation dialog.
65
65
  */
66
66
  validationMaxValue: string;
67
67
  /**
68
- * The text of the Start value label in the data validation dialog.
68
+ * Sets the label text for the Start value in the data validation dialog.
69
69
  */
70
70
  validationStartValue: string;
71
71
  /**
72
- * The text of the End value label in the data validation dialog.
72
+ * Sets the label text for the End value in the data validation dialog.
73
73
  */
74
74
  validationEndValue: string;
75
75
  /**
76
- * The text of the Value label in the data validation dialog.
76
+ * Sets the label text for the Value in the data validation dialog.
77
77
  */
78
78
  validationValue: string;
79
79
  /**
80
- * The text for the Show list button checkbox label in the data validation dialog.
80
+ * Sets the label text for the Show list button checkbox in the data validation dialog.
81
81
  */
82
82
  validationShowListButtonCheckbox: string;
83
83
  /**
84
- * The text for the Show date button checkbox label in the data validation dialog.
84
+ * Sets the label text for the Show date button checkbox in the data validation dialog.
85
85
  */
86
86
  validationShowDateButtonCheckbox: string;
87
87
  /**
88
- * The text for the Ignore blank checkbox label in the data validation dialog.
88
+ * Sets the label text for the Ignore blank checkbox in the data validation dialog.
89
89
  */
90
90
  validationIgnoreBlankCheckbox: string;
91
91
  /**
92
- * The text for the On invalid data label in the data validation dialog.
92
+ * Sets the label text for the On invalid data option in the data validation dialog.
93
93
  */
94
94
  validationOnInvalidData: string;
95
95
  /**
96
- * The text for the Reject input radio button label in the data validation dialog.
96
+ * Sets the label text for the Reject input radio button in the data validation dialog.
97
97
  */
98
98
  validationRejectInput: string;
99
99
  /**
100
- * The text for the Show warning radio button label in the data validation dialog.
100
+ * Sets the label text for the Show warning radio button in the data validation dialog.
101
101
  */
102
102
  validationShowWarning: string;
103
103
  /**
104
- * The text for the Show hint checkbox label in the data validation dialog.
104
+ * Sets the label text for the Show hint checkbox in the data validation dialog.
105
105
  */
106
106
  validationShowHint: string;
107
107
  /**
108
- * The text of the Any value validation criteria.
108
+ * Sets the text for the Any value validation criteria.
109
109
  */
110
110
  anyValueValidationCriteria: string;
111
111
  /**
112
- * The text of the Number validation criteria.
112
+ * Sets the text for the Number validation criteria.
113
113
  */
114
114
  numberValidationCriteria: string;
115
115
  /**
116
- * The text of the Text validation criteria.
116
+ * Sets the text for the Text validation criteria.
117
117
  */
118
118
  textValidationCriteria: string;
119
119
  /**
120
- * The text of the Date validation criteria.
120
+ * Sets the text for the Date validation criteria.
121
121
  */
122
122
  dateValidationCriteria: string;
123
123
  /**
124
- * The text of the Custom Formula validation criteria.
124
+ * Sets the text for the Custom Formula validation criteria.
125
125
  */
126
126
  customFormulaValidationCriteria: string;
127
127
  /**
128
- * The text of the List validation criteria.
128
+ * Sets the text for the List validation criteria.
129
129
  */
130
130
  listValidationCriteria: string;
131
131
  /**
132
- * The text of the greater than validation comparer.
132
+ * Sets the text for the greater than validation comparer.
133
133
  */
134
134
  greaterThanValidationComparer: string;
135
135
  /**
136
- * The text of the less than validation comparer.
136
+ * Sets the text for the less than validation comparer.
137
137
  */
138
138
  lessThanValidationComparer: string;
139
139
  /**
140
- * The text of the between validation comparer.
140
+ * Sets the text for the between validation comparer.
141
141
  */
142
142
  betweenValidationComparer: string;
143
143
  /**
144
- * The text of the not between validation comparer.
144
+ * Sets the text for the not between validation comparer.
145
145
  */
146
146
  notBetweenValidationComparer: string;
147
147
  /**
148
- * The text of the equal to validation comparer.
148
+ * Sets the text for the equal to validation comparer.
149
149
  */
150
150
  equalToValidationComparer: string;
151
151
  /**
152
- * The text of the not equal to validation comparer.
152
+ * Sets the text for the not equal to validation comparer.
153
153
  */
154
154
  notEqualToValidationComparer: string;
155
155
  /**
156
- * The text of the greater than or equal to validation comparer.
156
+ * Sets the text for the greater than or equal to validation comparer.
157
157
  */
158
158
  greaterThanOrEqualToValidationComparer: string;
159
159
  /**
160
- * The text of the less than or equal to validation comparer.
160
+ * Sets the text for the less than or equal to validation comparer.
161
161
  */
162
162
  lessThanOrEqualToValidationComparer: string;
163
163
  /**
164
- * The text for the Custom hint input label in the data validation dialog.
164
+ * Sets the label text for the Custom hint input in the data validation dialog.
165
165
  */
166
166
  validationHintMessage: string;
167
167
  /**
168
- * The text for the Custom hint title input label in the data validation dialog.
168
+ * Sets the label text for the Custom hint title input in the data validation dialog.
169
169
  */
170
170
  validationHintTitle: string;
171
171
  /**
172
- * The title of the Italic tool
172
+ * Sets the title for the **Italic** tool.
173
173
  */
174
174
  italic: string;
175
175
  /**
176
- * The title of the Underline tool
176
+ * Sets the title for the **Underline** tool.
177
177
  */
178
178
  underline: string;
179
179
  /**
180
- * The title of the Format tool
180
+ * Sets the title for the **Format** tool.
181
181
  */
182
182
  format: string;
183
183
  /**
184
- * The title of the Font Family tool
184
+ * Sets the title for the **Font Family** tool.
185
185
  */
186
186
  fontFamily: string;
187
187
  /**
188
- * The title of the Font Size tool
188
+ * Sets the title for the **Font Size** tool.
189
189
  */
190
190
  fontSize: string;
191
191
  /**
192
- * The title of the Undo tool
192
+ * Sets the title for the **Undo** tool.
193
193
  */
194
194
  undo: string;
195
195
  /**
196
- * The title of the Redo tool
196
+ * Sets the title for the **Redo** tool.
197
197
  */
198
198
  redo: string;
199
199
  /**
200
- * The title of the tool that changes the text background color
200
+ * Sets the title for the tool that changes the text background color.
201
201
  */
202
202
  background: string;
203
203
  /**
204
- * The title of the tool that changes the text font color
204
+ * Sets the title for the tool that changes the text font color.
205
205
  */
206
206
  color: string;
207
207
  /**
208
- * The title of the Grid Lines tool
208
+ * Sets the title for the **Grid Lines** tool.
209
209
  */
210
210
  gridLines: string;
211
211
  /**
212
- * The title of the tool that adds new column before currently selected column
212
+ * Sets the title for the tool that adds a new column before the selected column.
213
213
  */
214
214
  addColumnLeft: string;
215
215
  /**
216
- * The title of the tool that adds new column after currently selected column
216
+ * Sets the title for the tool that adds a new column after the selected column.
217
217
  */
218
218
  addColumnRight: string;
219
219
  /**
220
- * The title of the tool that adds new row below currently selected row
220
+ * Sets the title for the tool that adds a new row below the selected row.
221
221
  */
222
222
  addRowBelow: string;
223
223
  /**
224
- * The title of the tool that adds new row above currently selected row
224
+ * Sets the title for the tool that adds a new row above the selected row.
225
225
  */
226
226
  addRowAbove: string;
227
227
  /**
228
- * The title of the tool that deletes a column
228
+ * Sets the title for the tool that deletes a column.
229
229
  */
230
230
  deleteColumn: string;
231
231
  /**
232
- * The title of the tool that deletes a row
232
+ * Sets the title for the tool that deletes a row.
233
233
  */
234
234
  deleteRow: string;
235
235
  /**
236
- * The title of the Text Wrap tool
236
+ * Sets the title for the **Text Wrap** tool.
237
237
  */
238
238
  wrap: string;
239
239
  /**
240
- * The title of the Text Align tool
240
+ * Sets the title for the **Text Align** tool.
241
241
  */
242
242
  align: string;
243
243
  /**
244
- * The title of the Text Align Horizontal tool
244
+ * Sets the title for the **Text Align Horizontal** tool.
245
245
  */
246
246
  alignHorizontal: string;
247
247
  /**
248
- * The title of the Text Align Vertical tool
248
+ * Sets the title for the **Text Align Vertical** tool.
249
249
  */
250
250
  alignVertical: string;
251
251
  /**
252
- * The title of the Text Align Left tool
252
+ * Sets the title for the **Text Align Left** tool.
253
253
  */
254
254
  alignLeft: string;
255
255
  /**
256
- * The title of the Text Align Center tool
256
+ * Sets the title for the **Text Align Center** tool.
257
257
  */
258
258
  alignCenter: string;
259
259
  /**
260
- * The title of the Text Align Right tool
260
+ * Sets the title for the **Text Align Right** tool.
261
261
  */
262
262
  alignRight: string;
263
263
  /**
264
- * The title of the Text Align Justify tool
264
+ * Sets the title for the **Text Align Justify** tool.
265
265
  */
266
266
  alignJustify: string;
267
267
  /**
268
- * The title of the Text Align Top tool
268
+ * Sets the title for the **Text Align Top** tool.
269
269
  */
270
270
  alignTop: string;
271
271
  /**
272
- * The title of the Text Align Middle tool
272
+ * Sets the title for the **Text Align Middle** tool.
273
273
  */
274
274
  alignMiddle: string;
275
275
  /**
276
- * The title of the Text Align Bottom tool
276
+ * Sets the title for the **Text Align Bottom** tool.
277
277
  */
278
278
  alignBottom: string;
279
279
  /**
280
- * The text of the Apply button in all Spreadsheet dialogs
280
+ * Sets the text for the **Apply** button in all Spreadsheet dialogs.
281
281
  */
282
282
  dialogApply: string;
283
283
  /**
284
- * The text of the Cancel button in all Spreadsheet dialogs
284
+ * Sets the text for the **Cancel** button in all Spreadsheet dialogs.
285
285
  */
286
286
  dialogCancel: string;
287
287
  /**
288
- * The text of the Delete button in the Delete sheet dialog
288
+ * Sets the text for the **Delete** button in the Delete sheet dialog.
289
289
  */
290
290
  dialogDelete: string;
291
291
  /**
292
- * The text of the Rename button in the Rename sheet dialog
292
+ * Sets the text for the **Rename** button in the Rename sheet dialog.
293
293
  */
294
294
  dialogRename: string;
295
295
  /**
296
- * The text of the **Insert** button in all Spreadsheet dialogs
296
+ * Sets the text for the **Insert** button in all Spreadsheet dialogs.
297
297
  */
298
298
  dialogInsert: string;
299
299
  /**
300
- * The text of the **Remove** button in all Spreadsheet dialogs
300
+ * Sets the text for the **Remove** button in all Spreadsheet dialogs.
301
301
  */
302
302
  dialogRemove: string;
303
303
  /**
304
- * The text of the **Remove link** button in the Link tool dialog
304
+ * Sets the text for the **Remove link** button in the Link tool dialog.
305
305
  */
306
306
  dialogRemoveLink: string;
307
307
  /**
308
- * The title of the Delete sheet dialog
308
+ * Sets the title for the Delete sheet dialog.
309
309
  */
310
310
  delete: string;
311
311
  /**
312
- * The title of the Rename sheet dialog
312
+ * Sets the title for the Rename sheet dialog.
313
313
  */
314
314
  rename: string;
315
315
  /**
316
- * The title of the Name Box input
316
+ * Sets the title for the Name Box input.
317
317
  */
318
318
  nameBox: string;
319
319
  /**
320
- * The title of the Formula input
320
+ * Sets the title for the Formula input.
321
321
  */
322
322
  formulaInput: string;
323
323
  /**
324
- * The title of the Add new sheet button
324
+ * Sets the title for the Add new sheet button.
325
325
  */
326
326
  addSheet: string;
327
327
  /**
328
- * The title of the Sheets menu button
328
+ * Sets the title for the Sheets menu button.
329
329
  */
330
330
  sheetsMenu: string;
331
331
  /**
332
- * The text of the View toolbar tab
332
+ * Sets the text for the View toolbar tab.
333
333
  */
334
334
  view: string;
335
335
  /**
336
- * The title of the Cells Merge tool
336
+ * Sets the title for the Cells Merge tool.
337
337
  */
338
338
  merge: string;
339
339
  /**
340
- * The title of the Merge horizontally tool
340
+ * Sets the title for the Merge horizontally tool.
341
341
  */
342
342
  mergeHorizontally: string;
343
343
  /**
344
- * The title of the Merge vertically tool
344
+ * Sets the title for the Merge vertically tool.
345
345
  */
346
346
  mergeVertically: string;
347
347
  /**
348
- * The title of the Merge all tool
348
+ * Sets the title for the Merge all tool.
349
349
  */
350
350
  mergeAll: string;
351
351
  /**
352
- * The title of the Unmerge tool
352
+ * Sets the title for the Unmerge tool.
353
353
  */
354
354
  unmerge: string;
355
355
  /**
356
- * The title of the tool that inserts a link
356
+ * Sets the title for the tool that inserts a link.
357
357
  */
358
358
  insertLink: string;
359
359
  /**
360
- * The title of the tool that inserts a link
360
+ * Sets the title for the tool that increases decimals.
361
361
  */
362
362
  increaseDecimal: string;
363
363
  /**
364
- * The title of the tool that inserts a link
364
+ * Sets the title for the tool that decreases decimals.
365
365
  */
366
366
  decreaseDecimal: string;
367
367
  /**
368
- * The title of the tool that increases the cell font size
368
+ * Sets the title for the tool that increases the cell font size.
369
369
  */
370
370
  increaseFontSize: string;
371
371
  /**
372
- * The title of the tool that decreases the cell font size
372
+ * Sets the title for the tool that decreases the cell font size.
373
373
  */
374
374
  decreaseFontSize: string;
375
375
  /**
376
- * The content of the dialog that warns about an unsupported file type
376
+ * Sets the content for the dialog that warns about an unsupported file type.
377
377
  */
378
378
  openUnsupported: string;
379
379
  /**
380
- * The content of the dialog that warns about modifying a merged cell
380
+ * Sets the content for the dialog that warns about modifying a merged cell.
381
381
  */
382
382
  modifyMerged: string;
383
383
  /**
384
- * The content of the dialog that warns about modifying a disabled cell
384
+ * Sets the content for the dialog that warns about modifying a disabled cell.
385
385
  */
386
386
  cannotModifyDisabled: string;
387
387
  /**
388
- * The text of the **OK** dialog button
388
+ * Sets the text for the **OK** dialog button.
389
389
  */
390
390
  dialogOk: string;
391
391
  /**
392
- * The title of an error dialog
392
+ * Sets the title for an error dialog.
393
393
  */
394
394
  dialogError: string;
395
395
  /**
396
- * The content of the dialog that warns about duplicated sheet name
396
+ * Sets the content for the dialog that warns about duplicated sheet name.
397
397
  */
398
398
  duplicateSheetName: string;
399
399
  /**
400
- * The Copy command text
400
+ * Sets the Copy command text.
401
401
  */
402
402
  copy: string;
403
403
  /**
404
- * The Cut command text
404
+ * Sets the Cut command text.
405
405
  */
406
406
  cut: string;
407
407
  /**
408
- * The Paste command text
408
+ * Sets the Paste command text.
409
409
  */
410
410
  paste: string;
411
411
  /**
412
- * The Hide row command text
412
+ * Sets the Hide row command text.
413
413
  */
414
414
  hideRow: string;
415
415
  /**
416
- * The Unhide row command text
416
+ * Sets the Unhide row command text.
417
417
  */
418
418
  unhideRow: string;
419
419
  /**
420
- * The Hide column command text
420
+ * Sets the Hide column command text.
421
421
  */
422
422
  hideColumn: string;
423
423
  /**
424
- * The Unhide column command text
424
+ * Sets the Unhide column command text.
425
425
  */
426
426
  unhideColumn: string;
427
427
  /**
428
- * The text of the Sheet menu Delete option
428
+ * Sets the text for the Sheet menu Delete option.
429
429
  */
430
430
  sheetDelete: string;
431
431
  /**
432
- * The text of the Sheet menu Rename option
432
+ * Sets the text for the Sheet menu Rename option.
433
433
  */
434
434
  sheetRename: string;
435
435
  /**
436
- * The text of the Sheet menu Hide option
436
+ * Sets the text for the Sheet menu Hide option.
437
437
  */
438
438
  sheetHide: string;
439
439
  /**
440
- * The text of the Sheet menu Duplicate option
440
+ * Sets the text for the Sheet menu Duplicate option.
441
441
  */
442
442
  sheetDuplicate: string;
443
443
  /**
444
- * The text of the Sheet menu Move Left option
444
+ * Sets the text for the Sheet menu Move Left option.
445
445
  */
446
446
  sheetMoveLeft: string;
447
447
  /**
448
- * The text of the Sheet menu Move Right option
448
+ * Sets the text for the Sheet menu Move Right option.
449
449
  */
450
450
  sheetMoveRight: string;
451
451
  /**
452
- * The content of the dialog that warns about invalid name input.
452
+ * Sets the content for the dialog that warns about invalid name input.
453
453
  *
454
454
  * The content consists of a two-part message - the input value and a localizable string.
455
455
  * For user value input **A1%**, the default dialog content will be **Invalid name: A1%**.
@@ -4,62 +4,62 @@
4
4
  *-------------------------------------------------------------------------------------------*/
5
5
  import { Range, Sheet, SpreadsheetWidget, Workbook } from "@progress/kendo-spreadsheet-common";
6
6
  /**
7
- * The event data of the Spreadsheet `change` event.
7
+ * Provides the event data for the Spreadsheet `change` event.
8
8
  */
9
9
  export interface SpreadsheetChangeEvent {
10
10
  /**
11
- * The selected `Range` in the active sheet.
11
+ * Specifies the selected `Range` in the active sheet.
12
12
  */
13
13
  range: Range;
14
14
  /**
15
- * The `SpreadsheetWidget` instance, used in the Spreadsheet component.
15
+ * Specifies the `SpreadsheetWidget` instance used in the Spreadsheet component.
16
16
  */
17
17
  sender: SpreadsheetWidget;
18
18
  }
19
19
  /**
20
- * The event data of the Spreadsheet `excelExport` event.
20
+ * Provides the event data for the Spreadsheet `excelExport` event.
21
21
  */
22
22
  export interface SpreadsheetExcelExportEvent {
23
23
  /**
24
- * The `SpreadsheetWidget` instance.
24
+ * Specifies the `SpreadsheetWidget` instance.
25
25
  */
26
26
  sender: SpreadsheetWidget;
27
27
  /**
28
- * The Excel workbook configuration object. Modifications of the workbook will be reflected in the output Excel document.
28
+ * Specifies the Excel `Workbook` configuration object. Changes to the `Workbook` are reflected in the output Excel document.
29
29
  */
30
30
  workbook: Workbook;
31
31
  /**
32
- * If invoked, the Spreadsheet will not save the generated file.
32
+ * Prevents the Spreadsheet from saving the generated file when invoked.
33
33
  */
34
34
  preventDefault: Function;
35
35
  }
36
36
  /**
37
- * The event data of the Spreadsheet `excelImport` event.
37
+ * Provides the event data for the Spreadsheet `excelImport` event.
38
38
  */
39
39
  export interface SpreadsheetExcelImportEvent {
40
40
  /**
41
- * The `SpreadsheetWidget` instance.
41
+ * Specifies the `SpreadsheetWidget` instance.
42
42
  */
43
43
  sender: SpreadsheetWidget;
44
44
  /**
45
- * The selected file.
45
+ * Specifies the selected file.
46
46
  */
47
47
  file: File | Blob;
48
48
  /**
49
- * If invoked, the Spreadsheet will not load the selected file.
49
+ * Prevents the Spreadsheet from loading the selected file when invoked.
50
50
  */
51
51
  preventDefault: Function;
52
52
  }
53
53
  /**
54
- * The event data of the Spreadsheet `activeSheetChange` event.
54
+ * Provides the event data for the Spreadsheet `activeSheetChange` event.
55
55
  */
56
56
  export interface SpreadsheetActiveSheetChangeEvent {
57
57
  /**
58
- * The `SpreadsheetWidget` instance.
58
+ * Specifies the `SpreadsheetWidget` instance.
59
59
  */
60
60
  sender: SpreadsheetWidget;
61
61
  /**
62
- * The new active sheet.
62
+ * Specifies the new active sheet.
63
63
  */
64
64
  sheet: Sheet;
65
65
  }