-
Notifications
You must be signed in to change notification settings - Fork 0
/
ClosedXML.xml
4460 lines (4460 loc) · 211 KB
/
ClosedXML.xml
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
<?xml version="1.0"?>
<doc>
<assembly>
<name>ClosedXML</name>
</assembly>
<members>
<member name="T:ClosedXML.Excel.Caching.IXLRepository">
<summary>
Base interface for an abstract repository.
</summary>
</member>
<member name="M:ClosedXML.Excel.Caching.IXLRepository.Clear">
<summary>
Clear the repository;
</summary>
</member>
<member name="M:ClosedXML.Excel.Caching.IXLRepository`2.Store(`0,`1)">
<summary>
Put the <paramref name="value"/> into the repository under the specified <paramref name="key"/>
if there is no such key present.
</summary>
<param name="key">Key to identify the value.</param>
<param name="value">Value to put into the repository if key does not exist.</param>
<returns>Value stored in the repository under the specified <paramref name="key"/>. If key already existed
returned value may differ from the input one.</returns>
</member>
<member name="M:ClosedXML.Excel.Caching.XLRepositoryBase`2.ContainsKey(`0,`1@)">
<summary>
Check if the specified key is presented in the repository.
</summary>
<param name="key">Key to look for.</param>
<param name="value">Value from the repository stored under specified key or null if key does
not exist or the entry under this key has already bee GCed.</param>
<returns>True if entry exists and alive, false otherwise.</returns>
</member>
<member name="M:ClosedXML.Excel.Caching.XLRepositoryBase`2.Store(`0,`1)">
<summary>
Put the entity into the repository under the specified key if no other entity with
the same key is presented.
</summary>
<param name="key">Key to identify the entity.</param>
<param name="value">Entity to store.</param>
<returns>Entity that is stored in the repository under the specified key
(it can be either the <paramref name="value"/> or another entity that has been added to
the repository before.)</returns>
</member>
<member name="M:ClosedXML.Excel.Caching.XLRepositoryBase`2.GetEnumerator">
<summary>
Enumerate items in repository removing "dead" entries.
</summary>
</member>
<member name="T:ClosedXML.Excel.Caching.XLWorkbookElementRepositoryBase`2">
<summary>
Base repository for <see cref="T:ClosedXML.Excel.XLWorkbook"/> elements.
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.CalcEngine">
<summary>
CalcEngine parses strings and returns Expression objects that can
be evaluated.
</summary>
<remarks>
<para>This class has three extensibility points:</para>
<para>Use the <b>DataContext</b> property to add an object's properties to the engine scope.</para>
<para>Use the <b>RegisterFunction</b> method to define custom functions.</para>
<para>Override the <b>GetExternalObject</b> method to add arbitrary variables to the engine scope.</para>
</remarks>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.CalcEngine.Parse(System.String)">
<summary>
Parses a string into an <see cref="T:ClosedXML.Excel.CalcEngine.Expression"/>.
</summary>
<param name="expression">String to parse.</param>
<returns>An <see cref="T:ClosedXML.Excel.CalcEngine.Expression"/> object that can be evaluated.</returns>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.CalcEngine.Evaluate(System.String)">
<summary>
Evaluates a string.
</summary>
<param name="expression">Expression to evaluate.</param>
<returns>The value of the expression.</returns>
<remarks>
If you are going to evaluate the same expression several times,
it is more efficient to parse it only once using the <see cref="M:ClosedXML.Excel.CalcEngine.CalcEngine.Parse(System.String)"/>
method and then using the Expression.Evaluate method to evaluate
the parsed expression.
</remarks>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.CacheExpressions">
<summary>
Gets or sets whether the calc engine should keep a cache with parsed
expressions.
</summary>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.OptimizeExpressions">
<summary>
Gets or sets whether the calc engine should optimize expressions when
they are parsed.
</summary>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.IdentifierChars">
<summary>
Gets or sets a string that specifies special characters that are valid for identifiers.
</summary>
<remarks>
Identifiers must start with a letter or an underscore, which may be followed by
additional letters, underscores, or digits. This string allows you to specify
additional valid characters such as ':' or '!' (used in Excel range references
for example).
</remarks>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.CalcEngine.RegisterFunction(System.String,System.Int32,System.Int32,ClosedXML.Excel.CalcEngine.CalcEngineFunction)">
<summary>
Registers a function that can be evaluated by this <see cref="T:ClosedXML.Excel.CalcEngine.CalcEngine"/>.
</summary>
<param name="functionName">Function name.</param>
<param name="parmMin">Minimum parameter count.</param>
<param name="parmMax">Maximum parameter count.</param>
<param name="fn">Delegate that evaluates the function.</param>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.CalcEngine.RegisterFunction(System.String,System.Int32,ClosedXML.Excel.CalcEngine.CalcEngineFunction)">
<summary>
Registers a function that can be evaluated by this <see cref="T:ClosedXML.Excel.CalcEngine.CalcEngine"/>.
</summary>
<param name="functionName">Function name.</param>
<param name="parmCount">Parameter count.</param>
<param name="fn">Delegate that evaluates the function.</param>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.CalcEngine.GetExternalObject(System.String)">
<summary>
Gets an external object based on an identifier.
</summary>
<remarks>
This method is useful when the engine needs to create objects dynamically.
For example, a spreadsheet calc engine would use this method to dynamically create cell
range objects based on identifiers that cannot be enumerated at design time
(such as "AB12", "A1:AB12", etc.)
</remarks>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.DataContext">
<summary>
Gets or sets the DataContext for this <see cref="T:ClosedXML.Excel.CalcEngine.CalcEngine"/>.
</summary>
<remarks>
Once a DataContext is set, all public properties of the object become available
to the CalcEngine, including sub-properties such as "Address.Street". These may
be used with expressions just like any other constant.
</remarks>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.Functions">
<summary>
Gets the dictionary that contains function definitions.
</summary>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.Variables">
<summary>
Gets the dictionary that contains simple variables (not in the DataContext).
</summary>
</member>
<member name="P:ClosedXML.Excel.CalcEngine.CalcEngine.CultureInfo">
<summary>
Gets or sets the <see cref="P:ClosedXML.Excel.CalcEngine.CalcEngine.CultureInfo"/> to use when parsing numbers and dates.
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.CalcEngineFunction">
<summary>
Delegate that represents CalcEngine functions.
</summary>
<param name="parms">List of <see cref="T:ClosedXML.Excel.CalcEngine.Expression"/> objects that represent the
parameters to be used in the function call.</param>
<returns>The function result.</returns>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.CalcEngineHelpers.GetTotalCellsCount(ClosedXML.Excel.CalcEngine.XObjectExpression)">
<summary>
Get total count of cells in the specified range without initalizing them all
(which might cause serious performance issues on column-wide calculations).
</summary>
<param name="rangeExpression">Expression referring to the cell range.</param>
<returns>Total number of cells in the range.</returns>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.CellReferenceException">
<summary>
This error occurs when you delete a cell referred to in the
formula or if you paste cells over the ones referred to in the
formula.
Corresponds to the #REF! error in Excel
</summary>
<seealso cref="T:ClosedXML.Excel.CalcEngine.Exceptions.CalcEngineException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.CellValueException">
<summary>
This error is most often the result of specifying a
mathematical operation with one or more cells that contain
text.
Corresponds to the #VALUE! error in Excel
</summary>
<seealso cref="T:ClosedXML.Excel.CalcEngine.Exceptions.CalcEngineException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.DivisionByZeroException">
<summary>
The division operation in your formula refers to a cell that
contains the value 0 or is blank.
Corresponds to the #DIV/0! error in Excel
</summary>
<seealso cref="T:System.DivideByZeroException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.NameNotRecognizedException">
<summary>
This error value appears when you incorrectly type the range
name, refer to a deleted range name, or forget to put quotation
marks around a text string in a formula.
Corresponds to the #NAME? error in Excel
</summary>
<seealso cref="T:System.ApplicationException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.NoValueAvailableException">
<summary>
Technically, this is not an error value but a special value
that you can manually enter into a cell to indicate that you
don’t yet have a necessary value.
Corresponds to the #N/A error in Excel.
</summary>
<seealso cref="T:System.ApplicationException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.NullValueException">
<summary>
Because a space indicates an intersection, this error will
occur if you insert a space instead of a comma(the union operator)
between ranges used in function arguments.
Corresponds to the #NULL! error in Excel
</summary>
<seealso cref="T:ClosedXML.Excel.CalcEngine.Exceptions.CalcEngineException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Exceptions.NumberException">
<summary>
This error can be caused by an invalid argument in an Excel
function or a formula that produces a number too large or too small
to be represented in the worksheet.
Corresponds to the #NUM! error in Excel
</summary>
<seealso cref="T:ClosedXML.Excel.CalcEngine.Exceptions.CalcEngineException" />
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Expression">
<summary>
Base class that represents parsed expressions.
</summary>
<remarks>
For example:
<code>
Expression expr = scriptEngine.Parse(strExpression);
object val = expr.Evaluate();
</code>
</remarks>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.UnaryExpression">
<summary>
Unary expression, e.g. +123
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.BinaryExpression">
<summary>
Binary expression, e.g. 1+2
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.FunctionExpression">
<summary>
Function call expression, e.g. sin(0.5)
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.VariableExpression">
<summary>
Simple variable reference.
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.XObjectExpression">
<summary>
Expression that represents an external object.
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.EmptyValueExpression">
<summary>
Expression that represents an omitted parameter.
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.IValueObject">
<summary>
Interface supported by external objects that have to return a value
other than themselves (e.g. a cell range object should return the
cell content instead of the range itself).
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.ExpressionCache">
<summary>
Caches expressions based on their string representation.
This saves parsing time.
</summary>
<remarks>
Uses weak references to avoid accumulating unused expressions.
</remarks>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.ExpressionParseException">
<summary>
The exception that is thrown when the strings to be parsed to an expression is invalid.
</summary>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.ExpressionParseException.#ctor(System.String)">
<summary>
Initializes a new instance of the ExpressionParseException class with a
specified error message.
</summary>
<param name="message">The message that describes the error.</param>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.FunctionDefinition">
<summary>
Function definition class (keeps function name, parameter counts, and delegate).
</summary>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.Functions.DateAndTime.BusinessDaysUntil(System.DateTime,System.DateTime,System.Collections.Generic.IEnumerable{System.DateTime})">
<summary>
Calculates number of business days, taking into account:
- weekends (Saturdays and Sundays)
- bank holidays in the middle of the week
</summary>
<param name="firstDay">First day in the time interval</param>
<param name="lastDay">Last day in the time interval</param>
<param name="bankHolidays">List of bank holidays excluding weekends</param>
<returns>Number of business days during the 'span'</returns>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.Token">
<summary>
Represents a node in the expression tree.
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.TKTYPE">
<summary>
Token types (used when building expressions, sequence defines operator priority)
</summary>
</member>
<member name="T:ClosedXML.Excel.CalcEngine.TKID">
<summary>
Token ID (used when evaluating expressions)
</summary>
</member>
<member name="M:ClosedXML.Excel.CalcEngine.XLCalcEngine.GetPrecedentRanges(System.String)">
<summary>
Get a collection of cell ranges included into the expression. Order is not preserved.
</summary>
<param name="expression">Formula to parse.</param>
<returns>Collection of ranges included into the expression.</returns>
</member>
<member name="P:ClosedXML.Excel.IXLCell.Value">
<summary>
Gets or sets the cell's value. To get or set a strongly typed value, use the GetValue<T> and SetValue methods.
<para>ClosedXML will try to detect the data type through parsing. If it can't then the value will be left as a string.</para>
<para>If the object is an IEnumerable, ClosedXML will copy the collection's data into a table starting from this cell.</para>
<para>If the object is a range, ClosedXML will copy the range starting from this cell.</para>
<para>Setting the value to an object (not IEnumerable/range) will call the object's ToString() method.</para>
</summary>
<value>
The object containing the value(s) to set.
</value>
</member>
<member name="P:ClosedXML.Excel.IXLCell.Address">
<summary>Gets this cell's address, relative to the worksheet.</summary>
<value>The cell's address.</value>
</member>
<member name="P:ClosedXML.Excel.IXLCell.CurrentRegion">
<summary>
Returns the current region. The current region is a range bounded by any combination of blank rows and blank columns
</summary>
<value>
The current region.
</value>
</member>
<member name="P:ClosedXML.Excel.IXLCell.DataType">
<summary>
Gets or sets the type of this cell's data.
<para>Changing the data type will cause ClosedXML to covert the current value to the new data type.</para>
<para>An exception will be thrown if the current value cannot be converted to the new data type.</para>
</summary>
<value>
The type of the cell's data.
</value>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ClosedXML.Excel.IXLCell.SetDataType(ClosedXML.Excel.XLDataType)">
<summary>
Sets the type of this cell's data.
<para>Changing the data type will cause ClosedXML to covert the current value to the new data type.</para>
<para>An exception will be thrown if the current value cannot be converted to the new data type.</para>
</summary>
<param name="dataType">Type of the data.</param>
<returns></returns>
</member>
<member name="M:ClosedXML.Excel.IXLCell.SetValue``1(``0)">
<summary>
Sets the cell's value.
<para>If the object is an IEnumerable ClosedXML will copy the collection's data into a table starting from this cell.</para>
<para>If the object is a range ClosedXML will copy the range starting from this cell.</para>
<para>Setting the value to an object (not IEnumerable/range) will call the object's ToString() method.</para>
<para>ClosedXML will try to translate it to the corresponding type, if it can't then the value will be left as a string.</para>
</summary>
<value>
The object containing the value(s) to set.
</value>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetValue``1">
<summary>
Gets the cell's value converted to the T type.
<para>ClosedXML will try to covert the current value to the T type.</para>
<para>An exception will be thrown if the current value cannot be converted to the T type.</para>
</summary>
<typeparam name="T">The return type.</typeparam>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetString">
<summary>
Gets the cell's value converted to a String.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetFormattedString">
<summary>
Gets the cell's value formatted depending on the cell's data type and style.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetDouble">
<summary>
Gets the cell's value converted to Double.
<para>ClosedXML will try to covert the current value to Double.</para>
<para>An exception will be thrown if the current value cannot be converted to Double.</para>
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetBoolean">
<summary>
Gets the cell's value converted to Boolean.
<para>ClosedXML will try to covert the current value to Boolean.</para>
<para>An exception will be thrown if the current value cannot be converted to Boolean.</para>
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetDateTime">
<summary>
Gets the cell's value converted to DateTime.
<para>ClosedXML will try to covert the current value to DateTime.</para>
<para>An exception will be thrown if the current value cannot be converted to DateTime.</para>
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.GetTimeSpan">
<summary>
Gets the cell's value converted to TimeSpan.
<para>ClosedXML will try to covert the current value to TimeSpan.</para>
<para>An exception will be thrown if the current value cannot be converted to TimeSpan.</para>
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.Clear(ClosedXML.Excel.XLClearOptions)">
<summary>
Clears the contents of this cell.
</summary>
<param name="clearOptions">Specify what you want to clear.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.Delete(ClosedXML.Excel.XLShiftDeletedCells)">
<summary>
Deletes the current cell and shifts the surrounding cells according to the shiftDeleteCells parameter.
</summary>
<param name="shiftDeleteCells">How to shift the surrounding cells.</param>
</member>
<member name="P:ClosedXML.Excel.IXLCell.FormulaA1">
<summary>
Gets or sets the cell's formula with A1 references.
</summary>
<value>The formula with A1 references.</value>
</member>
<member name="P:ClosedXML.Excel.IXLCell.FormulaR1C1">
<summary>
Gets or sets the cell's formula with R1C1 references.
</summary>
<value>The formula with R1C1 references.</value>
</member>
<member name="M:ClosedXML.Excel.IXLCell.AsRange">
<summary>
Returns this cell as an IXLRange.
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCell.Style">
<summary>
Gets or sets the cell's style.
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCell.ShareString">
<summary>
Gets or sets a value indicating whether this cell's text should be shared or not.
</summary>
<value>
If false the cell's text will not be shared and stored as an inline value.
</value>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertData(System.Collections.IEnumerable)">
<summary>
Inserts the IEnumerable data elements and returns the range it occupies.
</summary>
<param name="data">The IEnumerable data.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertData(System.Collections.IEnumerable,System.Boolean)">
<summary>
Inserts the IEnumerable data elements and returns the range it occupies.
</summary>
<param name="data">The IEnumerable data.</param>
<param name="tranpose">if set to <c>true</c> the data will be transposed before inserting.</param>
<returns></returns>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertData(System.Data.DataTable)">
<summary>
Inserts the data of a data table.
</summary>
<param name="dataTable">The data table.</param>
<returns>The range occupied by the inserted data</returns>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable``1(System.Collections.Generic.IEnumerable{``0})">
<summary>
Inserts the IEnumerable data elements as a table and returns it.
<para>The new table will receive a generic name: Table#</para>
</summary>
<param name="data">The table data.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable``1(System.Collections.Generic.IEnumerable{``0},System.Boolean)">
<summary>
Inserts the IEnumerable data elements as a table and returns it.
<para>The new table will receive a generic name: Table#</para>
</summary>
<param name="data">The table data.</param>
<param name="createTable">
if set to <c>true</c> it will create an Excel table.
<para>if set to <c>false</c> the table will be created in memory.</para>
</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable``1(System.Collections.Generic.IEnumerable{``0},System.String)">
<summary>
Creates an Excel table from the given IEnumerable data elements.
</summary>
<param name="data">The table data.</param>
<param name="tableName">Name of the table.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable``1(System.Collections.Generic.IEnumerable{``0},System.String,System.Boolean)">
<summary>
Inserts the IEnumerable data elements as a table and returns it.
</summary>
<param name="data">The table data.</param>
<param name="tableName">Name of the table.</param>
<param name="createTable">
if set to <c>true</c> it will create an Excel table.
<para>if set to <c>false</c> the table will be created in memory.</para>
</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable(System.Data.DataTable)">
<summary>
Inserts the DataTable data elements as a table and returns it.
<para>The new table will receive a generic name: Table#</para>
</summary>
<param name="data">The table data.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable(System.Data.DataTable,System.Boolean)">
<summary>
Inserts the DataTable data elements as a table and returns it.
<para>The new table will receive a generic name: Table#</para>
</summary>
<param name="data">The table data.</param>
<param name="createTable">
if set to <c>true</c> it will create an Excel table.
<para>if set to <c>false</c> the table will be created in memory.</para>
</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable(System.Data.DataTable,System.String)">
<summary>
Creates an Excel table from the given DataTable data elements.
</summary>
<param name="data">The table data.</param>
<param name="tableName">Name of the table.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InsertTable(System.Data.DataTable,System.String,System.Boolean)">
<summary>
Inserts the DataTable data elements as a table and returns it.
</summary>
<param name="data">The table data.</param>
<param name="tableName">Name of the table.</param>
<param name="createTable">
if set to <c>true</c> it will create an Excel table.
<para>if set to <c>false</c> the table will be created in memory.</para>
</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.AddToNamed(System.String)">
<summary>
Creates a named range out of this cell.
<para>If the named range exists, it will add this range to that named range.</para>
<para>The default scope for the named range is Workbook.</para>
</summary>
<param name="rangeName">Name of the range.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCell.AddToNamed(System.String,ClosedXML.Excel.XLScope)">
<summary>
Creates a named range out of this cell.
<para>If the named range exists, it will add this range to that named range.</para>
<param name="rangeName">Name of the range.</param>
<param name="scope">The scope for the named range.</param>
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.AddToNamed(System.String,ClosedXML.Excel.XLScope,System.String)">
<summary>
Creates a named range out of this cell.
<para>If the named range exists, it will add this range to that named range.</para>
<param name="rangeName">Name of the range.</param>
<param name="scope">The scope for the named range.</param>
<param name="comment">The comments for the named range.</param>
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCell.ValueCached">
<summary>
Textual representation of cell calculated value (as it is saved to a workbook or read from it)
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCell.CachedValue">
<summary>
Calculated value of cell formula. Is used for decreasing number of computations perfromed.
May hold invalid value when <see cref="P:ClosedXML.Excel.IXLCell.NeedsRecalculation"/> flag is True.
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCell.NeedsRecalculation">
<summary>
Flag indicating that previously calculated cell value may be not valid anymore and has to be re-evaluated.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLCell.InvalidateFormula">
<summary>
Invalidate <see cref="P:ClosedXML.Excel.IXLCell.CachedValue"/> so the formula will be re-evaluated next time <see cref="P:ClosedXML.Excel.IXLCell.Value"/> is accessed.
If cell does not contain formula nothing happens.
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCells.Value">
<summary>
Sets the cells' value.
<para>If the object is an IEnumerable ClosedXML will copy the collection's data into a table starting from each cell.</para>
<para>If the object is a range ClosedXML will copy the range starting from each cell.</para>
<para>Setting the value to an object (not IEnumerable/range) will call the object's ToString() method.</para>
<para>ClosedXML will try to translate it to the corresponding type, if it can't then the value will be left as a string.</para>
</summary>
<value>
The object containing the value(s) to set.
</value>
</member>
<member name="P:ClosedXML.Excel.IXLCells.DataType">
<summary>
Sets the type of the cells' data.
<para>Changing the data type will cause ClosedXML to covert the current value to the new data type.</para>
<para>An exception will be thrown if the current value cannot be converted to the new data type.</para>
</summary>
<value>
The type of the cell's data.
</value>
<exception cref="T:System.ArgumentException"></exception>
</member>
<member name="M:ClosedXML.Excel.IXLCells.Clear(ClosedXML.Excel.XLClearOptions)">
<summary>
Clears the contents of these cells.
</summary>
<param name="clearOptions">Specify what you want to clear.</param>
</member>
<member name="M:ClosedXML.Excel.IXLCells.DeleteComments">
<summary>
Delete the comments of these cells.
</summary>
</member>
<member name="P:ClosedXML.Excel.IXLCells.FormulaA1">
<summary>
Sets the cells' formula with A1 references.
</summary>
<value>The formula with A1 references.</value>
</member>
<member name="P:ClosedXML.Excel.IXLCells.FormulaR1C1">
<summary>
Sets the cells' formula with R1C1 references.
</summary>
<value>The formula with R1C1 references.</value>
</member>
<member name="P:ClosedXML.Excel.XLCell.DataValidation">
<summary>
Get the data validation rule containing current cell or create a new one if no rule was defined for cell.
</summary>
</member>
<member name="P:ClosedXML.Excel.XLCell.IsEvaluating">
<summary>
Flag showing that the cell is in formula evaluation state.
</summary>
</member>
<member name="M:ClosedXML.Excel.XLCell.RecalculateFormula(System.String)">
<summary>
Calculate a value of the specified formula.
</summary>
<param name="fA1">Cell formula to evaluate.</param>
<returns>Null if formula is empty or null, calculated value otherwise.</returns>
</member>
<member name="M:ClosedXML.Excel.XLCell.Evaluate(System.Boolean)">
<summary>
Perform an evaluation of cell formula. If cell does not contain formula nothing happens, if cell does not need
recalculation (<see cref="P:ClosedXML.Excel.XLCell.NeedsRecalculation"/> is False) nothing happens either, unless <paramref name="force"/> flag is specified.
Otherwise recalculation is perfomed, result value is preserved in <see cref="P:ClosedXML.Excel.XLCell.CachedValue"/> and returned.
</summary>
<param name="force">Flag indicating whether a recalculation must be performed even is cell does not need it.</param>
<returns>Null if cell does not contain a formula. Calculated value otherwise.</returns>
</member>
<member name="P:ClosedXML.Excel.XLCell.NeedsRecalculation">
<summary>
Flag indicating that previously calculated cell value may be not valid anymore and has to be re-evaluated.
</summary>
</member>
<member name="P:ClosedXML.Excel.XLCell.ModifiedAtVersion">
<summary>
The value of <see cref="P:ClosedXML.Excel.XLWorkbook.RecalculationCounter"/> that workbook had at the moment of cell last modification.
If this value is greater than <see cref="P:ClosedXML.Excel.XLCell.EvaluatedAtVersion"/> then cell needs re-evaluation, as well as all dependent cells do.
</summary>
</member>
<member name="P:ClosedXML.Excel.XLCell.EvaluatedAtVersion">
<summary>
The value of <see cref="P:ClosedXML.Excel.XLWorkbook.RecalculationCounter"/> that workbook had at the moment of cell formula evaluation.
If this value equals to <see cref="P:ClosedXML.Excel.XLWorkbook.RecalculationCounter"/> it indicates that <see cref="P:ClosedXML.Excel.XLCell.CachedValue"/> stores
correct value and no re-evaluation has to be performed.
</summary>
</member>
<member name="P:ClosedXML.Excel.XLCell.NeedsRecalculationEvaluatedAtVersion">
<summary>
The value of <see cref="P:ClosedXML.Excel.XLWorkbook.RecalculationCounter"/> that workbook had at the moment of determining whether the cell
needs re-evaluation (due to it has been edited or some of the affecting cells has). If thie value equals to <see cref="P:ClosedXML.Excel.XLWorkbook.RecalculationCounter"/>
it indicates that <see cref="F:ClosedXML.Excel.XLCell._recalculationNeededLastValue"/> stores correct value and no check has to be performed.
</summary>
</member>
<member name="M:ClosedXML.Excel.XLCell.GetDataValidation">
<summary>
Get the data validation rule containing current cell.
</summary>
<returns>The data validation rule applying to the current cell or null if there is no such rule.</returns>
</member>
<member name="P:ClosedXML.Excel.IXLColumn.Width">
<summary>
Gets or sets the width of this column.
</summary>
<value>
The width of this column.
</value>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Delete">
<summary>
Deletes this column and shifts the columns at the right of this one accordingly.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.ColumnNumber">
<summary>
Gets this column's number
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.ColumnLetter">
<summary>
Gets this column's letter
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.InsertColumnsAfter(System.Int32)">
<summary>
Inserts X number of columns at the right of this one.
<para>All columns at the right will be shifted accordingly.</para>
</summary>
<param name="numberOfColumns">The number of columns to insert.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.InsertColumnsBefore(System.Int32)">
<summary>
Inserts X number of columns at the left of this one.
<para>This column and all at the right will be shifted accordingly.</para>
</summary>
<param name="numberOfColumns">The number of columns to insert.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Cell(System.Int32)">
<summary>
Gets the cell in the specified row.
</summary>
<param name="rowNumber">The cell's row.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Cells(System.String)">
<summary>
Returns the specified group of cells, separated by commas.
<para>e.g. Cells("1"), Cells("1:5"), Cells("1,3:5")</para>
</summary>
<param name="cellsInColumn">The column cells to return.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Cells(System.Int32,System.Int32)">
<summary>
Returns the specified group of cells.
</summary>
<param name="firstRow">The first row in the group of cells to return.</param>
<param name="lastRow">The last row in the group of cells to return.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.AdjustToContents">
<summary>
Adjusts the width of the column based on its contents.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.AdjustToContents(System.Int32)">
<summary>
Adjusts the width of the column based on its contents, starting from the startRow.
</summary>
<param name="startRow">The row to start calculating the column width.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.AdjustToContents(System.Int32,System.Int32)">
<summary>
Adjusts the width of the column based on its contents, starting from the startRow and ending at endRow.
</summary>
<param name="startRow">The row to start calculating the column width.</param>
<param name="endRow">The row to end calculating the column width.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Hide">
<summary>
Hides this column.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Unhide">
<summary>Unhides this column.</summary>
</member>
<member name="P:ClosedXML.Excel.IXLColumn.IsHidden">
<summary>
Gets a value indicating whether this column is hidden or not.
</summary>
<value>
<c>true</c> if this column is hidden; otherwise, <c>false</c>.
</value>
</member>
<member name="P:ClosedXML.Excel.IXLColumn.OutlineLevel">
<summary>
Gets or sets the outline level of this column.
</summary>
<value>
The outline level of this column.
</value>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Group">
<summary>
Adds this column to the next outline level (Increments the outline level for this column by 1).
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Group(System.Boolean)">
<summary>
Adds this column to the next outline level (Increments the outline level for this column by 1).
</summary>
<param name="collapse">If set to <c>true</c> the column will be shown collapsed.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Group(System.Int32)">
<summary>
Sets outline level for this column.
</summary>
<param name="outlineLevel">The outline level.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Group(System.Int32,System.Boolean)">
<summary>
Sets outline level for this column.
</summary>
<param name="outlineLevel">The outline level.</param>
<param name="collapse">If set to <c>true</c> the column will be shown collapsed.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Ungroup">
<summary>
Adds this column to the previous outline level (decrements the outline level for this column by 1).
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Ungroup(System.Boolean)">
<summary>
Adds this column to the previous outline level (decrements the outline level for this column by 1).
</summary>
<param name="fromAll">If set to <c>true</c> it will remove this column from all outline levels.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Collapse">
<summary>
Show this column as collapsed.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Expand">
<summary>Expands this column (if it's collapsed).</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.AddVerticalPageBreak">
<summary>
Adds a vertical page break after this column.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumn.Clear(ClosedXML.Excel.XLClearOptions)">
<summary>
Clears the contents of this column.
</summary>
<param name="clearOptions">Specify what you want to clear.</param>
</member>
<member name="P:ClosedXML.Excel.IXLColumns.Width">
<summary>
Sets the width of all columns.
</summary>
<value>
The width of all columns.
</value>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Delete">
<summary>
Deletes all columns and shifts the columns at the right of them accordingly.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.AdjustToContents">
<summary>
Adjusts the width of all columns based on its contents.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.AdjustToContents(System.Int32)">
<summary>
Adjusts the width of all columns based on its contents, starting from the startRow.
</summary>
<param name="startRow">The row to start calculating the column width.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.AdjustToContents(System.Int32,System.Int32)">
<summary>
Adjusts the width of all columns based on its contents, starting from the startRow and ending at endRow.
</summary>
<param name="startRow">The row to start calculating the column width.</param>
<param name="endRow">The row to end calculating the column width.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Hide">
<summary>
Hides all columns.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Unhide">
<summary>Unhides all columns.</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Group">
<summary>
Increments the outline level of all columns by 1.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Group(System.Boolean)">
<summary>
Increments the outline level of all columns by 1.
</summary>
<param name="collapse">If set to <c>true</c> the columns will be shown collapsed.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Group(System.Int32)">
<summary>
Sets outline level for all columns.
</summary>
<param name="outlineLevel">The outline level.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Group(System.Int32,System.Boolean)">
<summary>
Sets outline level for all columns.
</summary>
<param name="outlineLevel">The outline level.</param>
<param name="collapse">If set to <c>true</c> the columns will be shown collapsed.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Ungroup">
<summary>
Decrements the outline level of all columns by 1.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Ungroup(System.Boolean)">
<summary>
Decrements the outline level of all columns by 1.
</summary>
<param name="fromAll">If set to <c>true</c> it will remove the columns from all outline levels.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Collapse">
<summary>
Show all columns as collapsed.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Expand">
<summary>Expands all columns (if they're collapsed).</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Cells">
<summary>
Returns the collection of cells.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.CellsUsed">
<summary>
Returns the collection of cells that have a value.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.CellsUsed(System.Boolean)">
<summary>
Returns the collection of cells that have a value.
</summary>
<param name="includeFormats">if set to <c>true</c> will return all cells with a value or a style different than the default.</param>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.AddVerticalPageBreaks">
<summary>
Adds a vertical page break after these columns.
</summary>
</member>
<member name="M:ClosedXML.Excel.IXLColumns.Clear(ClosedXML.Excel.XLClearOptions)">
<summary>
Clears the contents of these columns.
</summary>
<param name="clearOptions">Specify what you want to clear.</param>
</member>