-
Notifications
You must be signed in to change notification settings - Fork 64
/
excel.worksheet.yml
1799 lines (1568 loc) · 67 KB
/
excel.worksheet.yml
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
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
### YamlMime:TSType
name: Excel.Worksheet
uid: 'excel!Excel.Worksheet:class'
package: excel!
fullName: Excel.Worksheet
summary: >-
An Excel worksheet is a grid of cells. It can contain data, tables, charts, etc. To learn more about the worksheet
object model, read [Work with worksheets using the Excel JavaScript
API](https://learn.microsoft.com/office/dev/add-ins/excel/excel-add-ins-worksheets)<!-- -->.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
type: class
properties:
- name: autoFilter
uid: 'excel!Excel.Worksheet#autoFilter:member'
package: excel!
fullName: autoFilter
summary: Represents the `AutoFilter` object of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-auto-filter.yaml
// This function adds a percentage AutoFilter to the active worksheet
// and applies the filter to a column of the used range.
await Excel.run(async (context) => {
// Retrieve the active worksheet and the used range on that worksheet.
const sheet = context.workbook.worksheets.getActiveWorksheet();
const farmData = sheet.getUsedRange();
// Add a filter that will only show the rows with the top 50% of values in column 3.
sheet.autoFilter.apply(farmData, 3, {
criterion1: "50",
filterOn: Excel.FilterOn.topPercent
});
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly autoFilter: Excel.AutoFilter;'
return:
type: '<xref uid="excel!Excel.AutoFilter:class" />'
- name: charts
uid: 'excel!Excel.Worksheet#charts:member'
package: excel!
fullName: charts
summary: Returns a collection of charts that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly charts: Excel.ChartCollection;'
return:
type: '<xref uid="excel!Excel.ChartCollection:class" />'
- name: comments
uid: 'excel!Excel.Worksheet#comments:member'
package: excel!
fullName: comments
summary: Returns a collection of all the Comments objects on the worksheet.
remarks: '\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly comments: Excel.CommentCollection;'
return:
type: '<xref uid="excel!Excel.CommentCollection:class" />'
- name: context
uid: 'excel!Excel.Worksheet#context:member'
package: excel!
fullName: context
summary: >-
The request context associated with the object. This connects the add-in's process to the Office host
application's process.
remarks: ''
isPreview: false
isDeprecated: false
syntax:
content: 'context: RequestContext;'
return:
type: '<xref uid="excel!Excel.RequestContext:class" />'
- name: customProperties
uid: 'excel!Excel.Worksheet#customProperties:member'
package: excel!
fullName: customProperties
summary: Gets a collection of worksheet-level custom properties.
remarks: >-
\[ [API set: ExcelApi 1.12](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml
await Excel.run(async (context) => {
// Load the keys and values of all custom properties in the current worksheet.
const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
customWorksheetProperties.load(["key", "value"]);
await context.sync();
// Log each custom property to the console.
// Note that your document may have more properties than those you have set using this snippet.
customWorksheetProperties.items.forEach((property) => {
console.log(`${property.key}:${property.value}`);
});
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly customProperties: Excel.WorksheetCustomPropertyCollection;'
return:
type: '<xref uid="excel!Excel.WorksheetCustomPropertyCollection:class" />'
- name: enableCalculation
uid: 'excel!Excel.Worksheet#enableCalculation:member'
package: excel!
fullName: enableCalculation
summary: >-
Determines if Excel should recalculate the worksheet when necessary. True if Excel recalculates the worksheet when
necessary. False if Excel doesn't recalculate the sheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'enableCalculation: boolean;'
return:
type: boolean
- name: freezePanes
uid: 'excel!Excel.Worksheet#freezePanes:member'
package: excel!
fullName: freezePanes
summary: Gets an object that can be used to manipulate frozen panes on the worksheet.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly freezePanes: Excel.WorksheetFreezePanes;'
return:
type: '<xref uid="excel!Excel.WorksheetFreezePanes:class" />'
- name: horizontalPageBreaks
uid: 'excel!Excel.Worksheet#horizontalPageBreaks:member'
package: excel!
fullName: horizontalPageBreaks
summary: Gets the horizontal page break collection for the worksheet. This collection only contains manual page breaks.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly horizontalPageBreaks: Excel.PageBreakCollection;'
return:
type: '<xref uid="excel!Excel.PageBreakCollection:class" />'
- name: id
uid: 'excel!Excel.Worksheet#id:member'
package: excel!
fullName: id
summary: >-
Returns a value that uniquely identifies the worksheet in a given workbook. The value of the identifier remains
the same even when the worksheet is renamed or moved.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly id: string;'
return:
type: string
- name: name
uid: 'excel!Excel.Worksheet#name:member'
package: excel!
fullName: name
summary: The display name of the worksheet. The name must be fewer than 32 characters.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'name: string;'
return:
type: string
- name: names
uid: 'excel!Excel.Worksheet#names:member'
package: excel!
fullName: names
summary: Collection of names scoped to the current worksheet.
remarks: '\[ [API set: ExcelApi 1.4](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly names: Excel.NamedItemCollection;'
return:
type: '<xref uid="excel!Excel.NamedItemCollection:class" />'
- name: pageLayout
uid: 'excel!Excel.Worksheet#pageLayout:member'
package: excel!
fullName: pageLayout
summary: Gets the `PageLayout` object of the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly pageLayout: Excel.PageLayout;'
return:
type: '<xref uid="excel!Excel.PageLayout:class" />'
- name: pivotTables
uid: 'excel!Excel.Worksheet#pivotTables:member'
package: excel!
fullName: pivotTables
summary: Collection of PivotTables that are part of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.3](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-get-pivottables.yaml
await Excel.run(async (context) => {
// Get the names of all the PivotTables in the current worksheet.
const pivotTables = context.workbook.worksheets.getActiveWorksheet().pivotTables;
pivotTables.load("name");
await context.sync();
// Display the names in the console.
console.log("PivotTables in the current worksheet:")
pivotTables.items.forEach((pivotTable) => {
console.log(`\t${pivotTable.name}`);
});
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly pivotTables: Excel.PivotTableCollection;'
return:
type: '<xref uid="excel!Excel.PivotTableCollection:class" />'
- name: position
uid: 'excel!Excel.Worksheet#position:member'
package: excel!
fullName: position
summary: The zero-based position of the worksheet within the workbook.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Set worksheet position.
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.position = 2;
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'position: number;'
return:
type: number
- name: protection
uid: 'excel!Excel.Worksheet#protection:member'
package: excel!
fullName: protection
summary: Returns the sheet protection object for a worksheet.
remarks: |-
\[ [API set: ExcelApi 1.2](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Unprotecting a worksheet with unprotect() will remove all
// WorksheetProtectionOptions options applied to a worksheet.
// To remove only a subset of WorksheetProtectionOptions use the
// protect() method and set the options you wish to remove to true.
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sheet1");
sheet.protection.protect({
allowInsertRows: false, // Protect row insertion
allowDeleteRows: true // Unprotect row deletion
});
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly protection: Excel.WorksheetProtection;'
return:
type: '<xref uid="excel!Excel.WorksheetProtection:class" />'
- name: shapes
uid: 'excel!Excel.Worksheet#shapes:member'
package: excel!
fullName: shapes
summary: Returns the collection of all the Shape objects on the worksheet.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly shapes: Excel.ShapeCollection;'
return:
type: '<xref uid="excel!Excel.ShapeCollection:class" />'
- name: showGridlines
uid: 'excel!Excel.Worksheet#showGridlines:member'
package: excel!
fullName: showGridlines
summary: Specifies if gridlines are visible to the user.
remarks: >-
\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/gridlines.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
sheet.showGridlines = true;
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'showGridlines: boolean;'
return:
type: boolean
- name: showHeadings
uid: 'excel!Excel.Worksheet#showHeadings:member'
package: excel!
fullName: showHeadings
summary: Specifies if headings are visible to the user.
remarks: '\[ [API set: ExcelApi 1.8](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'showHeadings: boolean;'
return:
type: boolean
- name: slicers
uid: 'excel!Excel.Worksheet#slicers:member'
package: excel!
fullName: slicers
summary: Returns a collection of slicers that are part of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.10](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/38-pivottable/pivottable-slicer.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Pivot");
const slicer = sheet.slicers.add(
"Farm Sales", /* The slicer data source. For PivotTables, this can be the PivotTable object reference or name. */
"Type" /* The field in the data source to filter by. For PivotTables, this can be a PivotField object reference or ID. */
);
slicer.name = "Fruit Slicer";
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'readonly slicers: Excel.SlicerCollection;'
return:
type: '<xref uid="excel!Excel.SlicerCollection:class" />'
- name: standardHeight
uid: 'excel!Excel.Worksheet#standardHeight:member'
package: excel!
fullName: standardHeight
summary: 'Returns the standard (default) height of all the rows in the worksheet, in points.'
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly standardHeight: number;'
return:
type: number
- name: standardWidth
uid: 'excel!Excel.Worksheet#standardWidth:member'
package: excel!
fullName: standardWidth
summary: >-
Specifies the standard (default) width of all the columns in the worksheet. One unit of column width is equal to
the width of one character in the Normal style. For proportional fonts, the width of the character 0 (zero) is
used.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'standardWidth: number;'
return:
type: number
- name: tabColor
uid: 'excel!Excel.Worksheet#tabColor:member'
package: excel!
fullName: tabColor
summary: >-
The tab color of the worksheet. When retrieving the tab color, if the worksheet is invisible, the value will be
`null`<!-- -->. If the worksheet is visible but the tab color is set to auto, an empty string will be returned.
Otherwise, the property will be set to a color, in the form \#RRGGBB (e.g., "FFA500"). When setting the color, use
an empty-string to set an "auto" color, or a real color otherwise.
remarks: >-
\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/tab-color.yaml
await Excel.run(async (context) => {
const activeSheet = context.workbook.worksheets.getActiveWorksheet();
activeSheet.tabColor = "#FF0000";
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'tabColor: string;'
return:
type: string
- name: tabId
uid: 'excel!Excel.Worksheet#tabId:member'
package: excel!
fullName: tabId
summary: >-
Returns a value representing this worksheet that can be read by Open Office XML. This is an integer value, which
is different from `worksheet.id` (which returns a globally unique identifier) and `worksheet.name` (which returns
a value such as "Sheet1").
remarks: '\[ [API set: ExcelApi 1.14](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly tabId: number;'
return:
type: number
- name: tables
uid: 'excel!Excel.Worksheet#tables:member'
package: excel!
fullName: tables
summary: Collection of tables that are part of the worksheet.
remarks: '\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly tables: Excel.TableCollection;'
return:
type: '<xref uid="excel!Excel.TableCollection:class" />'
- name: verticalPageBreaks
uid: 'excel!Excel.Worksheet#verticalPageBreaks:member'
package: excel!
fullName: verticalPageBreaks
summary: Gets the vertical page break collection for the worksheet. This collection only contains manual page breaks.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'readonly verticalPageBreaks: Excel.PageBreakCollection;'
return:
type: '<xref uid="excel!Excel.PageBreakCollection:class" />'
- name: visibility
uid: 'excel!Excel.Worksheet#visibility:member'
package: excel!
fullName: visibility
summary: The visibility of the worksheet.
remarks: >-
\[ [API set: ExcelApi 1.1 for reading visibility; 1.2 for setting
it.](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
isPreview: false
isDeprecated: false
syntax:
content: 'visibility: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";'
return:
type: '<xref uid="excel!Excel.SheetVisibility:enum" /> | "Visible" | "Hidden" | "VeryHidden"'
methods:
- name: activate()
uid: 'excel!Excel.Worksheet#activate:member(1)'
package: excel!
fullName: activate()
summary: Activate the worksheet in the Excel UI.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.activate();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'activate(): void;'
return:
type: void
description: ''
- name: calculate(markAllDirty)
uid: 'excel!Excel.Worksheet#calculate:member(1)'
package: excel!
fullName: calculate(markAllDirty)
summary: Calculates all cells on a worksheet.
remarks: '\[ [API set: ExcelApi 1.6](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'calculate(markAllDirty: boolean): void;'
parameters:
- id: markAllDirty
description: 'True, to mark all as dirty.'
type: boolean
return:
type: void
description: ''
- name: 'copy(positionType, relativeTo)'
uid: 'excel!Excel.Worksheet#copy:member(1)'
package: excel!
fullName: 'copy(positionType, relativeTo)'
summary: Copies a worksheet and places it at the specified position.
remarks: >-
\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-copy.yaml
await Excel.run(async (context) => {
let myWorkbook = context.workbook;
let sampleSheet = myWorkbook.worksheets.getActiveWorksheet();
let copiedSheet = sampleSheet.copy("End")
sampleSheet.load("name");
copiedSheet.load("name");
await context.sync();
console.log("'" + sampleSheet.name + "' was copied to '" + copiedSheet.name + "'")
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'copy(positionType?: Excel.WorksheetPositionType, relativeTo?: Excel.Worksheet): Excel.Worksheet;'
parameters:
- id: positionType
description: >-
The location in the workbook to place the newly created worksheet. The default value is "None", which
inserts the worksheet at the beginning of the worksheet.
type: '<xref uid="excel!Excel.WorksheetPositionType:enum" />'
- id: relativeTo
description: >-
The existing worksheet which determines the newly created worksheet's position. This is only needed if
`positionType` is "Before" or "After".
type: '<xref uid="excel!Excel.Worksheet:class" />'
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: The newly created worksheet.
- name: 'copy(positionTypeString, relativeTo)'
uid: 'excel!Excel.Worksheet#copy:member(2)'
package: excel!
fullName: 'copy(positionTypeString, relativeTo)'
summary: Copies a worksheet and places it at the specified position.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: >-
copy(positionTypeString?: "None" | "Before" | "After" | "Beginning" | "End", relativeTo?: Excel.Worksheet):
Excel.Worksheet;
parameters:
- id: positionTypeString
description: >-
The location in the workbook to place the newly created worksheet. The default value is "None", which
inserts the worksheet at the beginning of the worksheet.
type: '"None" | "Before" | "After" | "Beginning" | "End"'
- id: relativeTo
description: >-
The existing worksheet which determines the newly created worksheet's position. This is only needed if
`positionType` is "Before" or "After".
type: '<xref uid="excel!Excel.Worksheet:class" />'
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: The newly created worksheet.
- name: delete()
uid: 'excel!Excel.Worksheet#delete:member(1)'
package: excel!
fullName: delete()
summary: >-
Deletes the worksheet from the workbook. Note that if the worksheet's visibility is set to "VeryHidden", the
delete operation will fail with an `InvalidOperation` exception. You should first change its visibility to hidden
or visible before deleting it.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const wSheetName = 'Sheet1';
const worksheet = context.workbook.worksheets.getItem(wSheetName);
worksheet.delete();
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'delete(): void;'
return:
type: void
description: ''
- name: 'findAll(text, criteria)'
uid: 'excel!Excel.Worksheet#findAll:member(1)'
package: excel!
fullName: 'findAll(text, criteria)'
summary: >-
Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas`
object, comprising one or more rectangular ranges.
remarks: '\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'findAll(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;'
parameters:
- id: text
description: The string to find.
type: string
- id: criteria
description: >-
Additional search criteria, including whether the search needs to match the entire cell or be
case-sensitive.
type: '<xref uid="excel!Excel.WorksheetSearchCriteria:interface" />'
return:
type: '<xref uid="excel!Excel.RangeAreas:class" />'
description: >-
A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If no
cells meet this criteria, an `ItemNotFound` error will be thrown.
- name: 'findAllOrNullObject(text, criteria)'
uid: 'excel!Excel.Worksheet#findAllOrNullObject:member(1)'
package: excel!
fullName: 'findAllOrNullObject(text, criteria)'
summary: >-
Finds all occurrences of the given string based on the criteria specified and returns them as a `RangeAreas`
object, comprising one or more rectangular ranges.
remarks: >-
\[ [API set: ExcelApi 1.9](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/worksheet-find-all.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const foundRanges = sheet.findAllOrNullObject("Complete", {
completeMatch: true,
matchCase: false
});
await context.sync();
if (foundRanges.isNullObject) {
console.log("No complete projects");
} else {
foundRanges.format.fill.color = "green"
}
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'findAllOrNullObject(text: string, criteria: Excel.WorksheetSearchCriteria): Excel.RangeAreas;'
parameters:
- id: text
description: The string to find.
type: string
- id: criteria
description: >-
Additional search criteria, including whether the search needs to match the entire cell or be
case-sensitive.
type: '<xref uid="excel!Excel.WorksheetSearchCriteria:interface" />'
return:
type: '<xref uid="excel!Excel.RangeAreas:class" />'
description: >-
A `RangeAreas` object, comprising one or more rectangular ranges, that matches the search criteria. If there
are no matches, then this method returns an object with its `isNullObject` property set to `true`<!-- -->. For
further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
- name: 'getCell(row, column)'
uid: 'excel!Excel.Worksheet#getCell:member(1)'
package: excel!
fullName: 'getCell(row, column)'
summary: >-
Gets the `Range` object containing the single cell based on row and column numbers. The cell can be outside the
bounds of its parent range, so long as it stays within the worksheet grid.
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const cell = worksheet.getCell(0,0);
cell.load('address');
await context.sync();
console.log(cell.address);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getCell(row: number, column: number): Excel.Range;'
parameters:
- id: row
description: The row number of the cell to be retrieved. Zero-indexed.
type: number
- id: column
description: The column number of the cell to be retrieved. Zero-indexed.
type: number
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: getNext(visibleOnly)
uid: 'excel!Excel.Worksheet#getNext:member(1)'
package: excel!
fullName: getNext(visibleOnly)
summary: >-
Gets the worksheet that follows this one. If there are no worksheets following this one, this method will throw an
error.
remarks: >-
\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml
await Excel.run(async (context) => {
const sheets = context.workbook.worksheets;
// We don't want to include the default worksheet that was created
// when the workbook was created, so our "firstSheet" will be the one
// after the literal first. Note chaining of navigation methods.
const firstSheet = sheets.getFirst().getNext();
const lastSheet = sheets.getLast();
const firstTaxRateRange = firstSheet.getRange("B2");
const lastTaxRateRange = lastSheet.getRange("B2");
firstSheet.load("name");
lastSheet.load("name");
firstTaxRateRange.load("text");
lastTaxRateRange.load("text");
await context.sync();
let firstYear = firstSheet.name.substr(5, 4);
let lastYear = lastSheet.name.substr(5, 4);
console.log(`Tax Rate change from ${firstYear} to ${lastYear}`, `Tax rate for ${firstYear}: ${firstTaxRateRange.text[0][0]}\nTax rate for ${lastYear}: ${lastTaxRateRange.text[0][0]}`)
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getNext(visibleOnly?: boolean): Excel.Worksheet;'
parameters:
- id: visibleOnly
description: 'Optional. If `true`<!-- -->, considers only visible worksheets, skipping over any hidden ones.'
type: boolean
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: ''
- name: getNextOrNullObject(visibleOnly)
uid: 'excel!Excel.Worksheet#getNextOrNullObject:member(1)'
package: excel!
fullName: getNextOrNullObject(visibleOnly)
summary: >-
Gets the worksheet that follows this one. If there are no worksheets following this one, then this method returns
an object with its `isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject
methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getNextOrNullObject(visibleOnly?: boolean): Excel.Worksheet;'
parameters:
- id: visibleOnly
description: 'Optional. If `true`<!-- -->, considers only visible worksheets, skipping over any hidden ones.'
type: boolean
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: ''
- name: getPrevious(visibleOnly)
uid: 'excel!Excel.Worksheet#getPrevious:member(1)'
package: excel!
fullName: getPrevious(visibleOnly)
summary: 'Gets the worksheet that precedes this one. If there are no previous worksheets, this method will throw an error.'
remarks: >-
\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Link to full sample:
https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/reference-worksheets-by-relative-position.yaml
await Excel.run(async (context) => {
const sheets = context.workbook.worksheets;
const currentSheet = sheets.getActiveWorksheet();
const previousYearSheet = currentSheet.getPrevious();
const currentTaxDueRange = currentSheet.getRange("C2");
const previousTaxDueRange = previousYearSheet.getRange("C2");
currentSheet.load("name");
previousYearSheet.load("name");
currentTaxDueRange.load("text");
previousTaxDueRange.load("text");
await context.sync();
let currentYear = currentSheet.name.substr(5, 4);
let previousYear = previousYearSheet.name.substr(5, 4);
console.log("Two Year Tax Due Comparison", `Tax due for ${currentYear} was ${currentTaxDueRange.text[0][0]}\nTax due for ${previousYear} was ${previousTaxDueRange.text[0][0]}`)
await context.sync();
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getPrevious(visibleOnly?: boolean): Excel.Worksheet;'
parameters:
- id: visibleOnly
description: 'Optional. If `true`<!-- -->, considers only visible worksheets, skipping over any hidden ones.'
type: boolean
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: ''
- name: getPreviousOrNullObject(visibleOnly)
uid: 'excel!Excel.Worksheet#getPreviousOrNullObject:member(1)'
package: excel!
fullName: getPreviousOrNullObject(visibleOnly)
summary: >-
Gets the worksheet that precedes this one. If there are no previous worksheets, then this method returns an object
with its `isNullObject` property set to `true`<!-- -->. For further information, see [*OrNullObject methods and
properties](https://learn.microsoft.com/office/dev/add-ins/develop/application-specific-api-model#ornullobject-methods-and-properties)<!--
-->.
remarks: '\[ [API set: ExcelApi 1.5](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getPreviousOrNullObject(visibleOnly?: boolean): Excel.Worksheet;'
parameters:
- id: visibleOnly
description: 'Optional. If `true`<!-- -->, considers only visible worksheets, skipping over any hidden ones.'
type: boolean
return:
type: '<xref uid="excel!Excel.Worksheet:class" />'
description: ''
- name: getRange(address)
uid: 'excel!Excel.Worksheet#getRange:member(1)'
package: excel!
fullName: getRange(address)
summary: 'Gets the `Range` object, representing a single rectangular block of cells, specified by the address or name.'
remarks: |-
\[ [API set: ExcelApi 1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
#### Examples
```TypeScript
// Use the range address to get the range object.
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:F8";
const worksheet = context.workbook.worksheets.getItem(sheetName);
const range = worksheet.getRange(rangeAddress);
range.load('cellCount');
await context.sync();
console.log(range.cellCount);
});
```
isPreview: false
isDeprecated: false
syntax:
content: 'getRange(address?: string): Excel.Range;'
parameters:
- id: address
description: >-
Optional. The string representing the address or name of the range. For example, "A1:B2". If not specified,
the entire worksheet range is returned.
type: string
return:
type: '<xref uid="excel!Excel.Range:class" />'
description: ''
- name: 'getRangeByIndexes(startRow, startColumn, rowCount, columnCount)'
uid: 'excel!Excel.Worksheet#getRangeByIndexes:member(1)'
package: excel!
fullName: 'getRangeByIndexes(startRow, startColumn, rowCount, columnCount)'
summary: >-
Gets the `Range` object beginning at a particular row index and column index, and spanning a certain number of
rows and columns.
remarks: '\[ [API set: ExcelApi 1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]'
isPreview: false
isDeprecated: false
syntax:
content: 'getRangeByIndexes(startRow: number, startColumn: number, rowCount: number, columnCount: number): Excel.Range;'
parameters:
- id: startRow
description: Start row (zero-indexed).
type: number
- id: startColumn
description: Start column (zero-indexed).
type: number
- id: rowCount
description: Number of rows to include in the range.
type: number
- id: columnCount