-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNumberDuck.html
More file actions
2840 lines (1849 loc) · 88.7 KB
/
NumberDuck.html
File metadata and controls
2840 lines (1849 loc) · 88.7 KB
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
<!DOCTYPE html>
<html>
<head>
<title>NumberDuck v3.2.0 [J237] API Reference</title>
<style type='text/css'>
body
{
font: 12px Helvetica, sans-serif;
color: #404040;
margin: auto; width: 800px;
}
h1, h2, h3, h4, h5
{
color: black;
font-family: Arial, sans-serif;
}
A:link {text-decoration: none}
A:visited {text-decoration: none}
A:active {text-decoration: none}
A:hover {text-decoration: none; color: red;}
.keyword
{
color: blue;
font-family: monospace;
}
.identifier
{
color: black;
font-family: monospace;
}
.functionBody
{
padding-left: 15px;
}
</style>
</head>
<body>
<h1>NumberDuck v3.2.0 [J237] API Reference</h1>
<!--Start-->
<div id='classlist'>
<a href='#Workbook'>Workbook</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Provides read/write access to Excel .xls files.</p>
<a href='#Workbook_Workbook'><span class='keyword'></span> <span class='identifier'>Workbook(Workbook.License eLicense)</span>
</a><br>
<a href='#Workbook_~Workbook'><span class='keyword'></span> <span class='identifier'>~Workbook()</span>
</a><br>
<a href='#Workbook_Clear'><span class='keyword'>void</span> <span class='identifier'>Clear()</span>
</a><br>
<a href='#Workbook_Load'><span class='keyword'>bool</span> <span class='identifier'>Load(string szFileName)</span>
</a><br>
<a href='#Workbook_Save'><span class='keyword'>bool</span> <span class='identifier'>Save(string szFileName, Workbook.FileType eFileType)</span>
</a><br>
<a href='#Workbook_GetNumWorksheet'><span class='keyword'>uint</span> <span class='identifier'>GetNumWorksheet()</span>
</a><br>
<a href='#Workbook_GetWorksheetByIndex'><span class='keyword'>Worksheet</span> <span class='identifier'>GetWorksheetByIndex(uint nIndex)</span>
</a><br>
<a href='#Workbook_CreateWorksheet'><span class='keyword'>Worksheet</span> <span class='identifier'>CreateWorksheet()</span>
</a><br>
<a href='#Workbook_PurgeWorksheet'><span class='keyword'>void</span> <span class='identifier'>PurgeWorksheet(uint nIndex)</span>
</a><br>
<a href='#Workbook_GetNumStyle'><span class='keyword'>uint</span> <span class='identifier'>GetNumStyle()</span>
</a><br>
<a href='#Workbook_GetStyleByIndex'><span class='keyword'>Style</span> <span class='identifier'>GetStyleByIndex(uint nIndex)</span>
</a><br>
<a href='#Workbook_GetDefaultStyle'><span class='keyword'>Style</span> <span class='identifier'>GetDefaultStyle()</span>
</a><br>
<a href='#Workbook_CreateStyle'><span class='keyword'>Style</span> <span class='identifier'>CreateStyle()</span>
</a><br>
</div>
<br><br>
<a href='#Worksheet'>Worksheet</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Provides access to cells and other stuff of a worksheet.</p>
<a href='#Worksheet_GetName'><span class='keyword'>string</span> <span class='identifier'>GetName()</span>
</a><br>
<a href='#Worksheet_SetName'><span class='keyword'>bool</span> <span class='identifier'>SetName(string szName)</span>
</a><br>
<a href='#Worksheet_GetOrientation'><span class='keyword'>Worksheet.Orientation</span> <span class='identifier'>GetOrientation()</span>
</a><br>
<a href='#Worksheet_SetOrientation'><span class='keyword'>void</span> <span class='identifier'>SetOrientation(Worksheet.Orientation eOrientation)</span>
</a><br>
<a href='#Worksheet_GetShowGridlines'><span class='keyword'>bool</span> <span class='identifier'>GetShowGridlines()</span>
</a><br>
<a href='#Worksheet_SetShowGridlines'><span class='keyword'>void</span> <span class='identifier'>SetShowGridlines(bool bShowGridlines)</span>
</a><br>
<a href='#Worksheet_GetPrintGridlines'><span class='keyword'>bool</span> <span class='identifier'>GetPrintGridlines()</span>
</a><br>
<a href='#Worksheet_SetPrintGridlines'><span class='keyword'>void</span> <span class='identifier'>SetPrintGridlines(bool bPrintGridlines)</span>
</a><br>
<a href='#Worksheet_GetColumnWidth'><span class='keyword'>ushort</span> <span class='identifier'>GetColumnWidth(ushort nColumn)</span>
</a><br>
<a href='#Worksheet_SetColumnWidth'><span class='keyword'>void</span> <span class='identifier'>SetColumnWidth(ushort nColumn, ushort nWidth)</span>
</a><br>
<a href='#Worksheet_GetColumnHidden'><span class='keyword'>bool</span> <span class='identifier'>GetColumnHidden(ushort nColumn)</span>
</a><br>
<a href='#Worksheet_SetColumnHidden'><span class='keyword'>void</span> <span class='identifier'>SetColumnHidden(ushort nColumn, bool bHidden)</span>
</a><br>
<a href='#Worksheet_InsertColumn'><span class='keyword'>void</span> <span class='identifier'>InsertColumn(ushort nColumn)</span>
</a><br>
<a href='#Worksheet_DeleteColumn'><span class='keyword'>void</span> <span class='identifier'>DeleteColumn(ushort nColumn)</span>
</a><br>
<a href='#Worksheet_GetRowHeight'><span class='keyword'>ushort</span> <span class='identifier'>GetRowHeight(ushort nRow)</span>
</a><br>
<a href='#Worksheet_SetRowHeight'><span class='keyword'>void</span> <span class='identifier'>SetRowHeight(ushort nRow, ushort nHeight)</span>
</a><br>
<a href='#Worksheet_InsertRow'><span class='keyword'>void</span> <span class='identifier'>InsertRow(ushort nRow)</span>
</a><br>
<a href='#Worksheet_DeleteRow'><span class='keyword'>void</span> <span class='identifier'>DeleteRow(ushort nRow)</span>
</a><br>
<a href='#Worksheet_GetCellByAddress'><span class='keyword'>Cell</span> <span class='identifier'>GetCellByAddress(string szAddress)</span>
</a><br>
<a href='#Worksheet_GetCell'><span class='keyword'>Cell</span> <span class='identifier'>GetCell(ushort nX, ushort nY)</span>
</a><br>
<a href='#Worksheet_GetCellByRC'><span class='keyword'>Cell</span> <span class='identifier'>GetCellByRC(ushort nRow, ushort nColumn)</span>
</a><br>
<a href='#Worksheet_GetNumPicture'><span class='keyword'>int</span> <span class='identifier'>GetNumPicture()</span>
</a><br>
<a href='#Worksheet_GetPictureByIndex'><span class='keyword'>Picture</span> <span class='identifier'>GetPictureByIndex(int nIndex)</span>
</a><br>
<a href='#Worksheet_CreatePicture'><span class='keyword'>Picture</span> <span class='identifier'>CreatePicture(string szFileName)</span>
</a><br>
<a href='#Worksheet_PurgePicture'><span class='keyword'>void</span> <span class='identifier'>PurgePicture(int nIndex)</span>
</a><br>
<a href='#Worksheet_GetNumChart'><span class='keyword'>int</span> <span class='identifier'>GetNumChart()</span>
</a><br>
<a href='#Worksheet_GetChartByIndex'><span class='keyword'>Chart</span> <span class='identifier'>GetChartByIndex(int nIndex)</span>
</a><br>
<a href='#Worksheet_CreateChart'><span class='keyword'>Chart</span> <span class='identifier'>CreateChart(Chart.Type eType)</span>
</a><br>
<a href='#Worksheet_PurgeChart'><span class='keyword'>void</span> <span class='identifier'>PurgeChart(int nIndex)</span>
</a><br>
<a href='#Worksheet_GetNumMergedCell'><span class='keyword'>int</span> <span class='identifier'>GetNumMergedCell()</span>
</a><br>
<a href='#Worksheet_GetMergedCellByIndex'><span class='keyword'>MergedCell</span> <span class='identifier'>GetMergedCellByIndex(int nIndex)</span>
</a><br>
<a href='#Worksheet_CreateMergedCell'><span class='keyword'>MergedCell</span> <span class='identifier'>CreateMergedCell(ushort nX, ushort nY, ushort nWidth, ushort nHeight)</span>
</a><br>
<a href='#Worksheet_PurgeMergedCell'><span class='keyword'>void</span> <span class='identifier'>PurgeMergedCell(int nIndex)</span>
</a><br>
</div>
<br><br>
<a href='#Cell'>Cell</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Cell objects give access to the properties of a single cell.</p>
<a href='#Cell_Equals'><span class='keyword'>bool</span> <span class='identifier'>Equals(Cell pCell)</span>
</a><br>
<a href='#Cell_GetValue'><span class='keyword'>Value</span> <span class='identifier'>GetValue()</span>
</a><br>
<a href='#Cell_GetType'><span class='keyword'>Value.Type</span> <span class='identifier'>GetType()</span>
</a><br>
<a href='#Cell_Clear'><span class='keyword'>void</span> <span class='identifier'>Clear()</span>
</a><br>
<a href='#Cell_SetString'><span class='keyword'>void</span> <span class='identifier'>SetString(string szString)</span>
</a><br>
<a href='#Cell_GetString'><span class='keyword'>string</span> <span class='identifier'>GetString()</span>
</a><br>
<a href='#Cell_SetFloat'><span class='keyword'>void</span> <span class='identifier'>SetFloat(double fFloat)</span>
</a><br>
<a href='#Cell_GetFloat'><span class='keyword'>double</span> <span class='identifier'>GetFloat()</span>
</a><br>
<a href='#Cell_SetBoolean'><span class='keyword'>void</span> <span class='identifier'>SetBoolean(bool bBoolean)</span>
</a><br>
<a href='#Cell_GetBoolean'><span class='keyword'>bool</span> <span class='identifier'>GetBoolean()</span>
</a><br>
<a href='#Cell_SetFormula'><span class='keyword'>void</span> <span class='identifier'>SetFormula(string szFormula)</span>
</a><br>
<a href='#Cell_GetFormula'><span class='keyword'>string</span> <span class='identifier'>GetFormula()</span>
</a><br>
<a href='#Cell_EvaulateFormula'><span class='keyword'>Value</span> <span class='identifier'>EvaulateFormula()</span>
</a><br>
<a href='#Cell_GetStyle'><span class='keyword'>Style</span> <span class='identifier'>GetStyle()</span>
</a><br>
<a href='#Cell_SetStyle'><span class='keyword'>bool</span> <span class='identifier'>SetStyle(Style pStyle)</span>
</a><br>
</div>
<br><br>
<a href='#Value'>Value</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>A Value is an object that can contain different types of values.</p>
<a href='#Value_~Value'><span class='keyword'></span> <span class='identifier'>~Value()</span>
</a><br>
<a href='#Value_Equals'><span class='keyword'>bool</span> <span class='identifier'>Equals(Value pValue)</span>
</a><br>
<a href='#Value_GetType'><span class='keyword'>Value.Type</span> <span class='identifier'>GetType()</span>
</a><br>
<a href='#Value_GetString'><span class='keyword'>string</span> <span class='identifier'>GetString()</span>
</a><br>
<a href='#Value_GetFloat'><span class='keyword'>double</span> <span class='identifier'>GetFloat()</span>
</a><br>
<a href='#Value_GetBoolean'><span class='keyword'>bool</span> <span class='identifier'>GetBoolean()</span>
</a><br>
<a href='#Value_GetFormula'><span class='keyword'>string</span> <span class='identifier'>GetFormula()</span>
</a><br>
<a href='#Value_EvaulateFormula'><span class='keyword'>Value</span> <span class='identifier'>EvaulateFormula()</span>
</a><br>
</div>
<br><br>
<a href='#Style'>Style</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Used for styling cells.</p>
<a href='#Style_GetFont'><span class='keyword'>Font</span> <span class='identifier'>GetFont()</span>
</a><br>
<a href='#Style_GetHorizontalAlign'><span class='keyword'>Style.HorizontalAlign</span> <span class='identifier'>GetHorizontalAlign()</span>
</a><br>
<a href='#Style_SetHorizontalAlign'><span class='keyword'>void</span> <span class='identifier'>SetHorizontalAlign(Style.HorizontalAlign eHorizontalAlign)</span>
</a><br>
<a href='#Style_GetVerticalAlign'><span class='keyword'>Style.VerticalAlign</span> <span class='identifier'>GetVerticalAlign()</span>
</a><br>
<a href='#Style_SetVerticalAlign'><span class='keyword'>void</span> <span class='identifier'>SetVerticalAlign(Style.VerticalAlign eVerticalAlign)</span>
</a><br>
<a href='#Style_GetWrapText'><span class='keyword'>bool</span> <span class='identifier'>GetWrapText()</span>
</a><br>
<a href='#Style_SetWrapText'><span class='keyword'>void</span> <span class='identifier'>SetWrapText(bool bWrapText)</span>
</a><br>
<a href='#Style_GetBackgroundColor'><span class='keyword'>Color</span> <span class='identifier'>GetBackgroundColor(bool bCreateIfMissing)</span>
</a><br>
<a href='#Style_ClearBackgroundColor'><span class='keyword'>void</span> <span class='identifier'>ClearBackgroundColor()</span>
</a><br>
<a href='#Style_GetFillPattern'><span class='keyword'>Style.FillPattern</span> <span class='identifier'>GetFillPattern()</span>
</a><br>
<a href='#Style_SetFillPattern'><span class='keyword'>void</span> <span class='identifier'>SetFillPattern(Style.FillPattern eFillPattern)</span>
</a><br>
<a href='#Style_GetFillPatternColor'><span class='keyword'>Color</span> <span class='identifier'>GetFillPatternColor(bool bCreateIfMissing)</span>
</a><br>
<a href='#Style_ClearFillPatternColor'><span class='keyword'>void</span> <span class='identifier'>ClearFillPatternColor()</span>
</a><br>
<a href='#Style_GetTopBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetTopBorderLine()</span>
</a><br>
<a href='#Style_GetRightBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetRightBorderLine()</span>
</a><br>
<a href='#Style_GetBottomBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetBottomBorderLine()</span>
</a><br>
<a href='#Style_GetLeftBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetLeftBorderLine()</span>
</a><br>
<a href='#Style_GetFormat'><span class='keyword'>string</span> <span class='identifier'>GetFormat()</span>
</a><br>
<a href='#Style_SetFormat'><span class='keyword'>void</span> <span class='identifier'>SetFormat(string szFormat)</span>
</a><br>
</div>
<br><br>
<a href='#Color'>Color</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>RGB color information. Used by the <em>Style</em> class.</p>
<a href='#Color_Color'><span class='keyword'></span> <span class='identifier'>Color(unsigned char nRed, unsigned char nGreen, unsigned char nBlue)</span>
</a><br>
<a href='#Color_~Color'><span class='keyword'></span> <span class='identifier'>~Color()</span>
</a><br>
<a href='#Color_Equals'><span class='keyword'>bool</span> <span class='identifier'>Equals(Color pColor)</span>
</a><br>
<a href='#Color_Set'><span class='keyword'>void</span> <span class='identifier'>Set(unsigned char nRed, unsigned char nGreen, unsigned char nBlue)</span>
</a><br>
<a href='#Color_SetFromRgba'><span class='keyword'>void</span> <span class='identifier'>SetFromRgba(uint nRgba)</span>
</a><br>
<a href='#Color_SetFromColor'><span class='keyword'>void</span> <span class='identifier'>SetFromColor(Color pColor)</span>
</a><br>
<a href='#Color_GetRed'><span class='keyword'>unsigned char</span> <span class='identifier'>GetRed()</span>
</a><br>
<a href='#Color_SetRed'><span class='keyword'>void</span> <span class='identifier'>SetRed(unsigned char nRed)</span>
</a><br>
<a href='#Color_GetGreen'><span class='keyword'>unsigned char</span> <span class='identifier'>GetGreen()</span>
</a><br>
<a href='#Color_SetGreen'><span class='keyword'>void</span> <span class='identifier'>SetGreen(unsigned char nGreen)</span>
</a><br>
<a href='#Color_GetBlue'><span class='keyword'>unsigned char</span> <span class='identifier'>GetBlue()</span>
</a><br>
<a href='#Color_SetBlue'><span class='keyword'>void</span> <span class='identifier'>SetBlue(unsigned char nBlue)</span>
</a><br>
<a href='#Color_GetRgba'><span class='keyword'>uint</span> <span class='identifier'>GetRgba()</span>
</a><br>
</div>
<br><br>
<a href='#Picture'>Picture</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Represents an embedded picture inside a worksheet.</p>
<a href='#Picture_GetX'><span class='keyword'>uint</span> <span class='identifier'>GetX()</span>
</a><br>
<a href='#Picture_SetX'><span class='keyword'>bool</span> <span class='identifier'>SetX(uint nX)</span>
</a><br>
<a href='#Picture_GetY'><span class='keyword'>uint</span> <span class='identifier'>GetY()</span>
</a><br>
<a href='#Picture_SetY'><span class='keyword'>bool</span> <span class='identifier'>SetY(uint nY)</span>
</a><br>
<a href='#Picture_GetSubX'><span class='keyword'>uint</span> <span class='identifier'>GetSubX()</span>
</a><br>
<a href='#Picture_SetSubX'><span class='keyword'>void</span> <span class='identifier'>SetSubX(uint nSubX)</span>
</a><br>
<a href='#Picture_GetSubY'><span class='keyword'>uint</span> <span class='identifier'>GetSubY()</span>
</a><br>
<a href='#Picture_SetSubY'><span class='keyword'>void</span> <span class='identifier'>SetSubY(uint nSubY)</span>
</a><br>
<a href='#Picture_GetWidth'><span class='keyword'>uint</span> <span class='identifier'>GetWidth()</span>
</a><br>
<a href='#Picture_SetWidth'><span class='keyword'>void</span> <span class='identifier'>SetWidth(uint nWidth)</span>
</a><br>
<a href='#Picture_GetHeight'><span class='keyword'>uint</span> <span class='identifier'>GetHeight()</span>
</a><br>
<a href='#Picture_SetHeight'><span class='keyword'>void</span> <span class='identifier'>SetHeight(uint nHeight)</span>
</a><br>
<a href='#Picture_GetUrl'><span class='keyword'>string</span> <span class='identifier'>GetUrl()</span>
</a><br>
<a href='#Picture_SetUrl'><span class='keyword'>void</span> <span class='identifier'>SetUrl(string szUrl)</span>
</a><br>
<a href='#Picture_GetBlob'><span class='keyword'>Blob</span> <span class='identifier'>GetBlob()</span>
</a><br>
<a href='#Picture_GetFormat'><span class='keyword'>Picture.Format</span> <span class='identifier'>GetFormat()</span>
</a><br>
</div>
<br><br>
<a href='#Chart'>Chart</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Represents an embedded chart inside a worksheet.</p>
<a href='#Chart_GetX'><span class='keyword'>uint</span> <span class='identifier'>GetX()</span>
</a><br>
<a href='#Chart_SetX'><span class='keyword'>bool</span> <span class='identifier'>SetX(uint nX)</span>
</a><br>
<a href='#Chart_GetY'><span class='keyword'>uint</span> <span class='identifier'>GetY()</span>
</a><br>
<a href='#Chart_SetY'><span class='keyword'>bool</span> <span class='identifier'>SetY(uint nY)</span>
</a><br>
<a href='#Chart_GetSubX'><span class='keyword'>uint</span> <span class='identifier'>GetSubX()</span>
</a><br>
<a href='#Chart_SetSubX'><span class='keyword'>void</span> <span class='identifier'>SetSubX(uint nSubX)</span>
</a><br>
<a href='#Chart_GetSubY'><span class='keyword'>uint</span> <span class='identifier'>GetSubY()</span>
</a><br>
<a href='#Chart_SetSubY'><span class='keyword'>void</span> <span class='identifier'>SetSubY(uint nSubY)</span>
</a><br>
<a href='#Chart_GetWidth'><span class='keyword'>uint</span> <span class='identifier'>GetWidth()</span>
</a><br>
<a href='#Chart_SetWidth'><span class='keyword'>void</span> <span class='identifier'>SetWidth(uint nWidth)</span>
</a><br>
<a href='#Chart_GetHeight'><span class='keyword'>uint</span> <span class='identifier'>GetHeight()</span>
</a><br>
<a href='#Chart_SetHeight'><span class='keyword'>void</span> <span class='identifier'>SetHeight(uint nHeight)</span>
</a><br>
<a href='#Chart_GetType'><span class='keyword'>Chart.Type</span> <span class='identifier'>GetType()</span>
</a><br>
<a href='#Chart_SetType'><span class='keyword'>void</span> <span class='identifier'>SetType(Chart.Type eType)</span>
</a><br>
<a href='#Chart_GetNumSeries'><span class='keyword'>uint</span> <span class='identifier'>GetNumSeries()</span>
</a><br>
<a href='#Chart_GetSeriesByIndex'><span class='keyword'>Series</span> <span class='identifier'>GetSeriesByIndex(uint nIndex)</span>
</a><br>
<a href='#Chart_CreateSeries'><span class='keyword'>Series</span> <span class='identifier'>CreateSeries(string szValues)</span>
</a><br>
<a href='#Chart_PurgeSeries'><span class='keyword'>void</span> <span class='identifier'>PurgeSeries(uint nIndex)</span>
</a><br>
<a href='#Chart_GetCategories'><span class='keyword'>string</span> <span class='identifier'>GetCategories()</span>
</a><br>
<a href='#Chart_SetCategories'><span class='keyword'>bool</span> <span class='identifier'>SetCategories(string szCategories)</span>
</a><br>
<a href='#Chart_GetTitle'><span class='keyword'>string</span> <span class='identifier'>GetTitle()</span>
</a><br>
<a href='#Chart_SetTitle'><span class='keyword'>void</span> <span class='identifier'>SetTitle(string szTitle)</span>
</a><br>
<a href='#Chart_GetHorizontalAxisLabel'><span class='keyword'>string</span> <span class='identifier'>GetHorizontalAxisLabel()</span>
</a><br>
<a href='#Chart_SetHorizontalAxisLabel'><span class='keyword'>void</span> <span class='identifier'>SetHorizontalAxisLabel(string szHorizontalAxisLabel)</span>
</a><br>
<a href='#Chart_GetVerticalAxisLabel'><span class='keyword'>string</span> <span class='identifier'>GetVerticalAxisLabel()</span>
</a><br>
<a href='#Chart_SetVerticalAxisLabel'><span class='keyword'>void</span> <span class='identifier'>SetVerticalAxisLabel(string szVerticalAxisLabel)</span>
</a><br>
<a href='#Chart_GetLegend'><span class='keyword'>Legend</span> <span class='identifier'>GetLegend()</span>
</a><br>
<a href='#Chart_GetFrameBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetFrameBorderLine()</span>
</a><br>
<a href='#Chart_GetFrameFill'><span class='keyword'>Fill</span> <span class='identifier'>GetFrameFill()</span>
</a><br>
<a href='#Chart_GetPlotBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetPlotBorderLine()</span>
</a><br>
<a href='#Chart_GetPlotFill'><span class='keyword'>Fill</span> <span class='identifier'>GetPlotFill()</span>
</a><br>
<a href='#Chart_GetHorizontalAxisLine'><span class='keyword'>Line</span> <span class='identifier'>GetHorizontalAxisLine()</span>
</a><br>
<a href='#Chart_GetHorizontalGridLine'><span class='keyword'>Line</span> <span class='identifier'>GetHorizontalGridLine()</span>
</a><br>
<a href='#Chart_GetVerticalAxisLine'><span class='keyword'>Line</span> <span class='identifier'>GetVerticalAxisLine()</span>
</a><br>
<a href='#Chart_GetVerticalGridLine'><span class='keyword'>Line</span> <span class='identifier'>GetVerticalGridLine()</span>
</a><br>
</div>
<br><br>
<a href='#Series'>Series</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Represents a data series inside this <em>Chart</em>.</p>
<a href='#Series_GetName'><span class='keyword'>string</span> <span class='identifier'>GetName()</span>
</a><br>
<a href='#Series_SetName'><span class='keyword'>bool</span> <span class='identifier'>SetName(string szName)</span>
</a><br>
<a href='#Series_GetValues'><span class='keyword'>string</span> <span class='identifier'>GetValues()</span>
</a><br>
<a href='#Series_SetValues'><span class='keyword'>bool</span> <span class='identifier'>SetValues(string szValues)</span>
</a><br>
<a href='#Series_GetLine'><span class='keyword'>Line</span> <span class='identifier'>GetLine()</span>
</a><br>
<a href='#Series_GetFill'><span class='keyword'>Fill</span> <span class='identifier'>GetFill()</span>
</a><br>
<a href='#Series_GetMarker'><span class='keyword'>Marker</span> <span class='identifier'>GetMarker()</span>
</a><br>
</div>
<br><br>
<a href='#Legend'>Legend</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Represents the legend inside of a <em>Chart</em>.</p>
<a href='#Legend_GetHidden'><span class='keyword'>bool</span> <span class='identifier'>GetHidden()</span>
</a><br>
<a href='#Legend_SetHidden'><span class='keyword'>void</span> <span class='identifier'>SetHidden(bool bHidden)</span>
</a><br>
<a href='#Legend_GetBorderLine'><span class='keyword'>Line</span> <span class='identifier'>GetBorderLine()</span>
</a><br>
<a href='#Legend_GetFill'><span class='keyword'>Fill</span> <span class='identifier'>GetFill()</span>
</a><br>
</div>
<br><br>
<a href='#Font'>Font</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Used in various places to style text.</p>
<a href='#Font_GetName'><span class='keyword'>string</span> <span class='identifier'>GetName()</span>
</a><br>
<a href='#Font_SetName'><span class='keyword'>void</span> <span class='identifier'>SetName(string szName)</span>
</a><br>
<a href='#Font_GetSize'><span class='keyword'>unsigned char</span> <span class='identifier'>GetSize()</span>
</a><br>
<a href='#Font_SetSize'><span class='keyword'>void</span> <span class='identifier'>SetSize(unsigned char nSize)</span>
</a><br>
<a href='#Font_GetColor'><span class='keyword'>Color</span> <span class='identifier'>GetColor(bool bCreateIfMissing)</span>
</a><br>
<a href='#Font_ClearColor'><span class='keyword'>void</span> <span class='identifier'>ClearColor()</span>
</a><br>
<a href='#Font_GetBold'><span class='keyword'>bool</span> <span class='identifier'>GetBold()</span>
</a><br>
<a href='#Font_SetBold'><span class='keyword'>void</span> <span class='identifier'>SetBold(bool bBold)</span>
</a><br>
<a href='#Font_GetItalic'><span class='keyword'>bool</span> <span class='identifier'>GetItalic()</span>
</a><br>
<a href='#Font_SetItalic'><span class='keyword'>void</span> <span class='identifier'>SetItalic(bool bItalic)</span>
</a><br>
<a href='#Font_GetUnderline'><span class='keyword'>Font.Underline</span> <span class='identifier'>GetUnderline()</span>
</a><br>
<a href='#Font_SetUnderline'><span class='keyword'>void</span> <span class='identifier'>SetUnderline(Font.Underline eUnderline)</span>
</a><br>
</div>
<br><br>
<a href='#Line'>Line</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Lines are used to style different sections of <em>Chart</em>s.</p>
<a href='#Line_Equals'><span class='keyword'>bool</span> <span class='identifier'>Equals(Line pLine)</span>
</a><br>
<a href='#Line_GetType'><span class='keyword'>Line.Type</span> <span class='identifier'>GetType()</span>
</a><br>
<a href='#Line_SetType'><span class='keyword'>void</span> <span class='identifier'>SetType(Line.Type eType)</span>
</a><br>
<a href='#Line_GetColor'><span class='keyword'>Color</span> <span class='identifier'>GetColor()</span>
</a><br>
</div>
<br><br>
<a href='#Fill'>Fill</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Used to modify the fill color of different sections of <em>Chart</em>s.</p>
<a href='#Fill_Equals'><span class='keyword'>bool</span> <span class='identifier'>Equals(Fill pFill)</span>
</a><br>
<a href='#Fill_GetType'><span class='keyword'>Fill.Type</span> <span class='identifier'>GetType()</span>
</a><br>
<a href='#Fill_SetType'><span class='keyword'>void</span> <span class='identifier'>SetType(Fill.Type eType)</span>
</a><br>
<a href='#Fill_GetForegroundColor'><span class='keyword'>Color</span> <span class='identifier'>GetForegroundColor()</span>
</a><br>
<a href='#Fill_GetBackgroundColor'><span class='keyword'>Color</span> <span class='identifier'>GetBackgroundColor()</span>
</a><br>
</div>
<br><br>
<a href='#Marker'>Marker</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Marker are used to style markers on Line <em>Chart</em>s.</p>
<a href='#Marker_Equals'><span class='keyword'>bool</span> <span class='identifier'>Equals(Marker pMarker)</span>
</a><br>
<a href='#Marker_GetType'><span class='keyword'>Marker.Type</span> <span class='identifier'>GetType()</span>
</a><br>
<a href='#Marker_SetType'><span class='keyword'>void</span> <span class='identifier'>SetType(Marker.Type eType)</span>
</a><br>
<a href='#Marker_GetFillColor'><span class='keyword'>Color</span> <span class='identifier'>GetFillColor(bool bCreateIfMissing)</span>
</a><br>
<a href='#Marker_SetFillColor'><span class='keyword'>void</span> <span class='identifier'>SetFillColor(Color pColor)</span>
</a><br>
<a href='#Marker_ClearFillColor'><span class='keyword'>void</span> <span class='identifier'>ClearFillColor()</span>
</a><br>
<a href='#Marker_GetBorderColor'><span class='keyword'>Color</span> <span class='identifier'>GetBorderColor(bool bCreateIfMissing)</span>
</a><br>
<a href='#Marker_SetBorderColor'><span class='keyword'>void</span> <span class='identifier'>SetBorderColor(Color pColor)</span>
</a><br>
<a href='#Marker_ClearBorderColor'><span class='keyword'>void</span> <span class='identifier'>ClearBorderColor()</span>
</a><br>
<a href='#Marker_GetSize'><span class='keyword'>int</span> <span class='identifier'>GetSize()</span>
</a><br>
<a href='#Marker_SetSize'><span class='keyword'>void</span> <span class='identifier'>SetSize(int nSize)</span>
</a><br>
</div>
<br><br>
<a href='#MergedCell'>MergedCell</a>
<div style='padding: 0px; padding-left: 20px;'>
<p>Allows you to modify merged cells that have been previously defined.</p>
<a href='#MergedCell_GetX'><span class='keyword'>uint</span> <span class='identifier'>GetX()</span>
</a><br>
<a href='#MergedCell_SetX'><span class='keyword'>void</span> <span class='identifier'>SetX(uint nX)</span>
</a><br>
<a href='#MergedCell_GetY'><span class='keyword'>uint</span> <span class='identifier'>GetY()</span>
</a><br>
<a href='#MergedCell_SetY'><span class='keyword'>void</span> <span class='identifier'>SetY(uint nY)</span>
</a><br>
<a href='#MergedCell_GetWidth'><span class='keyword'>uint</span> <span class='identifier'>GetWidth()</span>
</a><br>
<a href='#MergedCell_SetWidth'><span class='keyword'>void</span> <span class='identifier'>SetWidth(uint nWidth)</span>
</a><br>
<a href='#MergedCell_GetHeight'><span class='keyword'>uint</span> <span class='identifier'>GetHeight()</span>
</a><br>
<a href='#MergedCell_SetHeight'><span class='keyword'>void</span> <span class='identifier'>SetHeight(uint nHeight)</span>
</a><br>
</div>
<br><br>
</div>
<h2><a id='Workbook'>Workbook</a></h2>
<div><p>Provides read/write access to Excel .xls files.</p>
</div>
<h3><a id='Workbook_Workbook'><span class='keyword'></span> <span class='identifier'>Workbook(Workbook.License eLicense)</span>
</a></h3>
<div class='functionBody'>
<p>The main entry point for using Number Duck.</p>
<p>For the license, pass in Workbook::License::AGPL for AGPL v3, or Workbook::License::Commercial if you have purchased a commercial license.</p>
</div>
<h3><a id='Workbook_~Workbook'><span class='keyword'></span> <span class='identifier'>~Workbook()</span>
</a></h3>
<div class='functionBody'>
<p>Resolute destructor.</p>
</div>
<h3><a id='Workbook_Clear'><span class='keyword'>void</span> <span class='identifier'>Clear()</span>
</a></h3>
<div class='functionBody'>
<p>Clears this workbook back to defaults. The same result as deleting the object and constructing it again.</p>
</div>
<h3><a id='Workbook_Load'><span class='keyword'>bool</span> <span class='identifier'>Load(string szFileName)</span>
</a></h3>
<div class='functionBody'>
<p>Loads a .xls file from disk.</p>
<p>Currently only simple Excel .xls formatted files are supported.</p>
<p>Returns <em>false</em> on error.</p>
<p>A common error in loading is that the file is locked because it is already open in Excel.</p>
</div>
<h3><a id='Workbook_Save'><span class='keyword'>bool</span> <span class='identifier'>Save(string szFileName, Workbook.FileType eFileType)</span>
</a></h3>
<div class='functionBody'>
<p>Saves the current workbook to disk in Excel .xls format.</p>
<p>Possible file types are:</p>
<ul>
<li>Workbook::FileType::XLS</li>
<li>Workbook::FileType::XLSX</li>
</ul>
<p>Returns <em>false</em> on error.</p>
<p>Eg: pWorkbook->Save("BananaReport.xls", Workbook::FileType::XLS);</p>
</div>
<h3><a id='Workbook_GetNumWorksheet'><span class='keyword'>uint</span> <span class='identifier'>GetNumWorksheet()</span>
</a></h3>
<div class='functionBody'>
<p>Returns the number of worksheets available.</p>
</div>
<h3><a id='Workbook_GetWorksheetByIndex'><span class='keyword'>Worksheet</span> <span class='identifier'>GetWorksheetByIndex(uint nIndex)</span>
</a></h3>
<div class='functionBody'>
<p>Returns a pointer to the <em>Worksheet</em> from the given index.</p>
<p>Returns <em>NULL</em> if the given index is out of range.</p>
</div>
<h3><a id='Workbook_CreateWorksheet'><span class='keyword'>Worksheet</span> <span class='identifier'>CreateWorksheet()</span>
</a></h3>
<div class='functionBody'>
<p>Creates a new <em>Worksheet</em> and returns a pointer to it.</p>
<p>If the workbook already has the maximum allowed number of worksheets,
this function returns null.</p>
</div>
<h3><a id='Workbook_PurgeWorksheet'><span class='keyword'>void</span> <span class='identifier'>PurgeWorksheet(uint nIndex)</span>
</a></h3>
<div class='functionBody'>
<p>Deletes the <em>Worksheet</em> at the given index.</p>
</div>
<h3><a id='Workbook_GetNumStyle'><span class='keyword'>uint</span> <span class='identifier'>GetNumStyle()</span>
</a></h3>
<div class='functionBody'>
<p>Returns the number of existing <em>Styles</em> available in this <em>Workbook</em>.</p>
<p>More styles may be created with the <em>CreateStyle</em> function.</p>
</div>
<h3><a id='Workbook_GetStyleByIndex'><span class='keyword'>Style</span> <span class='identifier'>GetStyleByIndex(uint nIndex)</span>
</a></h3>
<div class='functionBody'>
<p>Returns the <em>Style</em> at the given index.</p>
<p>Returns <em>NULL</em> if you give an out of range index like a silly person.</p>
</div>
<h3><a id='Workbook_GetDefaultStyle'><span class='keyword'>Style</span> <span class='identifier'>GetDefaultStyle()</span>
</a></h3>
<div class='functionBody'>
<p>Returns the default <em>Style</em> for this <em>Workbook</em>.</p>
<p>This is a simple wrapper for GetStyleByIndex(0).</p>
</div>
<h3><a id='Workbook_CreateStyle'><span class='keyword'>Style</span> <span class='identifier'>CreateStyle()</span>
</a></h3>
<div class='functionBody'>
<p>Creates a new <em>Style</em> and returns a pointer to it.</p>
<p>Using this pointer you can set all the pretties for a <em>Cell</em>.</p>
</div>
<h2><a id='Worksheet'>Worksheet</a></h2>
<div><p>Provides access to cells and other stuff of a worksheet.</p>
</div>
<h3><a id='Worksheet_GetName'><span class='keyword'>string</span> <span class='identifier'>GetName()</span>
</a></h3>
<div class='functionBody'>
<p>Returns the name of the worksheet in UTF8.</p>
</div>
<h3><a id='Worksheet_SetName'><span class='keyword'>bool</span> <span class='identifier'>SetName(string szName)</span>
</a></h3>
<div class='functionBody'>
<p>Sets the name of the worksheet. Returns false if the name is already in use by another <em>Worksheet</em>.</p>
<p><em>szName</em> is a UTF8 string.</p>
</div>
<h3><a id='Worksheet_GetOrientation'><span class='keyword'>Worksheet.Orientation</span> <span class='identifier'>GetOrientation()</span>
</a></h3>
<div class='functionBody'>
<p>Returns the orientation of the worksheet for printing.</p>
<p>Possible orientations are:</p>
<ul>
<li>Worksheet::ORIENTATION_PORTRAIT</li>
<li>Worksheet::ORIENTATION_LANDSCAPE</li>
</ul>
</div>
<h3><a id='Worksheet_SetOrientation'><span class='keyword'>void</span> <span class='identifier'>SetOrientation(Worksheet.Orientation eOrientation)</span>
</a></h3>
<div class='functionBody'>
<p>Sets the page orientation for printing.</p>
<p>See Worksheet::SetOrientation for a list of possible orientations.</p>
</div>
<h3><a id='Worksheet_GetShowGridlines'><span class='keyword'>bool</span> <span class='identifier'>GetShowGridlines()</span>
</a></h3>
<div class='functionBody'>
<p>Returns true if grid lines are shown.</p>
</div>
<h3><a id='Worksheet_SetShowGridlines'><span class='keyword'>void</span> <span class='identifier'>SetShowGridlines(bool bShowGridlines)</span>
</a></h3>
<div class='functionBody'>
<p>Sets if grid lines will be shown.</p>
</div>
<h3><a id='Worksheet_GetPrintGridlines'><span class='keyword'>bool</span> <span class='identifier'>GetPrintGridlines()</span>
</a></h3>
<div class='functionBody'>
<p>Returns true if grid lines are printed.</p>
</div>
<h3><a id='Worksheet_SetPrintGridlines'><span class='keyword'>void</span> <span class='identifier'>SetPrintGridlines(bool bPrintGridlines)</span>
</a></h3>
<div class='functionBody'>
<p>Sets if grid lines will be printed.</p>
</div>
<h3><a id='Worksheet_GetColumnWidth'><span class='keyword'>ushort</span> <span class='identifier'>GetColumnWidth(ushort nColumn)</span>
</a></h3>
<div class='functionBody'>
<p>Returns the width of the given column in pixels.</p>
</div>
<h3><a id='Worksheet_SetColumnWidth'><span class='keyword'>void</span> <span class='identifier'>SetColumnWidth(ushort nColumn, ushort nWidth)</span>
</a></h3>
<div class='functionBody'>
<p>Sets the width of the column in pixels.</p>
</div>
<h3><a id='Worksheet_GetColumnHidden'><span class='keyword'>bool</span> <span class='identifier'>GetColumnHidden(ushort nColumn)</span>
</a></h3>
<div class='functionBody'>
<p>Returns true if the given column is hidden.</p>
</div>
<h3><a id='Worksheet_SetColumnHidden'><span class='keyword'>void</span> <span class='identifier'>SetColumnHidden(ushort nColumn, bool bHidden)</span>
</a></h3>
<div class='functionBody'>
<p>Allows you to show or hide the given column.</p>
</div>
<h3><a id='Worksheet_InsertColumn'><span class='keyword'>void</span> <span class='identifier'>InsertColumn(ushort nColumn)</span>
</a></h3>
<div class='functionBody'>
<p>Inserts a column before the given one.</p>