개정판 99558071
ISSUE #000 Use SVG 추가.
HYTOS/HYTOS/MainWindow.py | ||
---|---|---|
162 | 162 |
DEFAULT_SIZE = QSizeF(1188, 841) |
163 | 163 |
PAPER_SIZE = QSizeF(1500, 950) # 엑셀에서 이미지 영역의 크기(픽셀 단위) |
164 | 164 |
USE_IMAGE = 'Use Image' |
165 |
USE_SVG = 'Use SVG' |
|
165 | 166 |
addMessage = pyqtSignal(Enum, str) |
166 | 167 | |
167 | 168 |
def __init__(self): |
... | ... | |
1593 | 1594 |
self.showImageSelectionMessageBox() |
1594 | 1595 |
return |
1595 | 1596 | |
1596 |
report_drawing = MainWindow.USE_IMAGE |
|
1597 | 1597 |
configs = app_doc_data.getAppConfigs('option', 'ReportDrawing') |
1598 | 1598 |
if configs and configs[0].value: |
1599 | 1599 |
report_drawing = configs[0].value |
1600 |
report_drawing = MainWindow.USE_IMAGE #TODO: force to set report drawing to USE_IMAGE
|
|
1600 |
report_drawing = MainWindow.USE_SVG #TODO: force to set report drawing to USE_IMAGE
|
|
1601 | 1601 | |
1602 | 1602 |
report_drawing_path = None |
1603 | 1603 |
with NamedTemporaryFile() as f: |
... | ... | |
1640 | 1640 |
cal_image = openpyxl.drawing.image.Image(report_drawing_path) |
1641 | 1641 |
x_scale = MainWindow.PAPER_SIZE.width() / cal_image.width |
1642 | 1642 |
y_scale = MainWindow.PAPER_SIZE.height() / cal_image.height |
1643 |
cal_image.width *= x_scale |
|
1644 |
cal_image.height *= y_scale |
|
1643 |
#cal_image.width *= x_scale
|
|
1644 |
#cal_image.height *= y_scale
|
|
1645 | 1645 |
ws.add_image(cal_image, 'A1') |
1646 | 1646 | |
1647 | 1647 |
company_image = openpyxl.drawing.image.Image(company_image_path) |
... | ... | |
2303 | 2303 |
wb.save(filename=save_file_name) |
2304 | 2304 | |
2305 | 2305 |
if report_drawing == 'Use SVG': |
2306 |
report_app_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'ReportApp', |
|
2307 |
'ReportApp.exe') |
|
2306 |
report_app_path = os.path.join(os.path.dirname(os.path.realpath(__file__)), 'ReportApp', 'ReportApp.exe') |
|
2308 | 2307 | |
2309 | 2308 |
arguments = [report_app_path, save_file_name, report_drawing_path] |
2310 | 2309 |
res = subprocess.call(arguments) |
HYTOS/HYTOS/ReportApp/GemBox.Spreadsheet.xml | ||
---|---|---|
1 |
<?xml version="1.0"?> |
|
2 |
<doc> |
|
3 |
<assembly> |
|
4 |
<name>GemBox.Spreadsheet</name> |
|
5 |
</assembly> |
|
6 |
<members> |
|
7 |
<member name="T:GemBox.Spreadsheet.AbstractRange"> |
|
8 |
<summary> |
|
9 |
Base class for classes representing one or more excel cells. |
|
10 |
</summary> |
|
11 |
<seealso href="https://www.gemboxsoftware.com/spreadsheet/examples/c-sharp-excel-range/204">Referencing ExcelCell and CellRange in C# and VB.NET</seealso> |
|
12 |
</member> |
|
13 |
<member name="M:GemBox.Spreadsheet.AbstractRange.#ctor(GemBox.Spreadsheet.ExcelWorksheet)"> |
|
14 |
<summary> |
|
15 |
Internal. |
|
16 |
</summary> |
|
17 |
<param name="parent"></param> |
|
18 |
<exclude/> |
|
19 |
</member> |
|
20 |
<member name="P:GemBox.Spreadsheet.AbstractRange.Name"> |
|
21 |
<summary> |
|
22 |
Gets the name of <see cref="T:GemBox.Spreadsheet.AbstractRange"/> instance. |
|
23 |
</summary> |
|
24 |
<remarks> |
|
25 |
A cell name includes its column letter and row number. For example, the name of a cell in row 0 and column 0 is "A1". |
|
26 |
A cell range name includes the column letter and row number of first (top-left) and last (bottom-right) cell. |
|
27 |
For example, the name of range [0, 0]...[4, 4] is "A1:E5", of range [0, 0]...[4, MaxColumns-1] is "1:5", |
|
28 |
of range [0, 0]...[MaxRows-1, 4] is "A:E", of single cell range [4, 4]...[4, 4] is "E5". |
|
29 |
</remarks> |
|
30 |
</member> |
|
31 |
<member name="P:GemBox.Spreadsheet.AbstractRange.Comment"> |
|
32 |
<summary> |
|
33 |
Gets or sets comment. |
|
34 |
</summary> |
|
35 |
</member> |
|
36 |
<member name="P:GemBox.Spreadsheet.AbstractRange.Hyperlink"> |
|
37 |
<summary> |
|
38 |
Gets or sets hyperlink. |
|
39 |
</summary> |
|
40 |
</member> |
|
41 |
<member name="P:GemBox.Spreadsheet.AbstractRange.Formula"> |
|
42 |
<summary> |
|
43 |
Gets or sets formula string. |
|
44 |
</summary> |
|
45 |
</member> |
|
46 |
<member name="P:GemBox.Spreadsheet.AbstractRange.FormulaR1C1"> |
|
47 |
<summary> |
|
48 |
Gets or sets a formula string in R1C1 notation. |
|
49 |
</summary> |
|
50 |
</member> |
|
51 |
<member name="P:GemBox.Spreadsheet.AbstractRange.Value"> |
|
52 |
<summary> |
|
53 |
Gets or sets cell value on one or more excel cells. |
|
54 |
</summary> |
|
55 |
</member> |
|
56 |
<member name="M:GemBox.Spreadsheet.AbstractRange.Calculate"> |
|
57 |
<summary> |
|
58 |
Calculates formula for one or more excel cells. |
|
59 |
</summary> |
|
60 |
</member> |
|
61 |
<member name="M:GemBox.Spreadsheet.AbstractRange.Insert(GemBox.Spreadsheet.InsertShiftDirection)"> |
|
62 |
<summary> |
|
63 |
Inserts a range by shifting cells in the specified direction. |
|
64 |
</summary> |
|
65 |
<param name="direction">The shift direction.</param> |
|
66 |
</member> |
|
67 |
<member name="M:GemBox.Spreadsheet.AbstractRange.Remove(GemBox.Spreadsheet.RemoveShiftDirection)"> |
|
68 |
<summary> |
|
69 |
Removes a range by shifting cells in the specified direction. |
|
70 |
</summary> |
|
71 |
<param name="direction">The shift direction.</param> |
|
72 |
</member> |
|
73 |
<member name="P:GemBox.Spreadsheet.AbstractRange.Style"> |
|
74 |
<summary> |
|
75 |
Gets or sets the cell formatting of one or more cells. |
|
76 |
</summary> |
|
77 |
<value> |
|
78 |
The cell formatting of one or more cells. |
|
79 |
</value> |
|
80 |
<remarks> |
|
81 |
<para>Conceptually, cell formatting is divided into following groups:</para><list type="bullet"> |
|
82 |
<item> |
|
83 |
<description> |
|
84 |
<b>Number</b> - indicates how to format and render the numeric value of a cell. Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.NumberFormat" />. |
|
85 |
</description> |
|
86 |
</item> |
|
87 |
<item> |
|
88 |
<description> |
|
89 |
<b>Alignment</b> - formatting information pertaining to text alignment in cells. Associated properties are <see cref="P:GemBox.Spreadsheet.CellStyle.HorizontalAlignment" />, <see cref="P:GemBox.Spreadsheet.CellStyle.VerticalAlignment" />, <see cref="P:GemBox.Spreadsheet.CellStyle.Indent" />, <see cref="P:GemBox.Spreadsheet.CellStyle.Rotation" />, <see cref="P:GemBox.Spreadsheet.CellStyle.IsTextVertical" />, <see cref="P:GemBox.Spreadsheet.CellStyle.WrapText" /> and <see cref="P:GemBox.Spreadsheet.CellStyle.ShrinkToFit" />. |
|
90 |
</description> |
|
91 |
</item> |
|
92 |
<item> |
|
93 |
<description> |
|
94 |
<b>Font</b> - defines the properties for the used font. Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.Font" />. |
|
95 |
</description> |
|
96 |
</item> |
|
97 |
<item> |
|
98 |
<description> |
|
99 |
<b>Border</b> - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.Borders" />. |
|
100 |
</description> |
|
101 |
</item> |
|
102 |
<item> |
|
103 |
<description> |
|
104 |
<b>Fill</b> - specifies fill formatting (pattern or gradient). Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.FillPattern" />. |
|
105 |
</description> |
|
106 |
</item> |
|
107 |
<item> |
|
108 |
<description> |
|
109 |
<b>Protection</b> - contains protection properties associated with the cell. Associated properties are <see cref="P:GemBox.Spreadsheet.CellStyle.Locked" /> and <see cref="P:GemBox.Spreadsheet.CellStyle.FormulaHidden" />. |
|
110 |
</description> |
|
111 |
</item> |
|
112 |
</list><para> |
|
113 |
Additional <see cref="T:GemBox.Spreadsheet.CellStyle" /> properties not associated with any formatting group are: |
|
114 |
</para><list type="bullet"> |
|
115 |
<item> |
|
116 |
<description> |
|
117 |
<see cref="P:GemBox.Spreadsheet.CellStyle.Name" /> - name of the referenced <see cref="P:GemBox.Spreadsheet.AbstractRange.Style">workbook style</see>. |
|
118 |
</description> |
|
119 |
</item> |
|
120 |
<item> |
|
121 |
<description> |
|
122 |
<see cref="P:GemBox.Spreadsheet.CellStyle.QuotePrefix" /> - <see langword="true" /> to store numeric value of a cell as text; otherwise, <see langword="false" />. |
|
123 |
</description> |
|
124 |
</item> |
|
125 |
<item> |
|
126 |
<description> |
|
127 |
<see cref="P:GemBox.Spreadsheet.CellStyle.IsDefault" /> - <see langword="true" /> if <see cref="P:GemBox.Spreadsheet.CellStyle.Name">referenced</see> <see cref="P:GemBox.Spreadsheet.AbstractRange.Style">workbook style</see> is default (<b> |
|
128 |
<see cref="P:GemBox.Spreadsheet.CellStyleCollection.Normal" /> |
|
129 |
</b>) and there are no additional modifications of cell formatting; otherwise, <see langword="false" />. |
|
130 |
</description> |
|
131 |
</item> |
|
132 |
</list><para> |
|
133 |
<see cref="T:GemBox.Spreadsheet.ExcelFile">Workbook</see> contains a set of <see cref="P:GemBox.Spreadsheet.ExcelFile.Styles">master styles</see> which can be referenced by multiple cells. |
|
134 |
</para><para> |
|
135 |
<see cref="T:GemBox.Spreadsheet.ExcelFile">Workbook</see> must always contain at least one <see cref="P:GemBox.Spreadsheet.AbstractRange.Style">master style</see> which cannot be removed and is, by default, referenced by all cells. This default style is <b> |
|
136 |
<see cref="P:GemBox.Spreadsheet.CellStyleCollection.Normal" /> |
|
137 |
</b>. |
|
138 |
</para><para> |
|
139 |
<see cref="P:GemBox.Spreadsheet.AbstractRange.Style">Workbook style</see> can either be built-in or user-defined. Built-in style is accessible from <see cref="P:GemBox.Spreadsheet.ExcelFile.Styles">workbook styles</see> via <see cref="T:GemBox.Spreadsheet.BuiltInCellStyleName" /> enumeration. |
|
140 |
</para><para> |
|
141 |
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from <see cref="P:GemBox.Spreadsheet.CellStyle.Name">referenced</see> <see cref="P:GemBox.Spreadsheet.AbstractRange.Style">workbook (master) style</see>, unless cell formatting group or its associated property is modified. |
|
142 |
</para><para> |
|
143 |
Cell formatting is available for one or more cells through <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property which is available on <see cref="T:GemBox.Spreadsheet.ExcelCell" /> and <see cref="T:GemBox.Spreadsheet.CellRange" /> types. |
|
144 |
Cell formatting specified on <see cref="T:GemBox.Spreadsheet.ExcelColumn" /> and <see cref="T:GemBox.Spreadsheet.ExcelRow" /> types through <see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Style" /> property is simply propagated to cell formatting of its <see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Cells" />. |
|
145 |
</para><note type="note"> |
|
146 |
<para> |
|
147 |
For performance reasons, cell formatting on <see cref="T:GemBox.Spreadsheet.CellRange" /> is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side. |
|
148 |
</para> |
|
149 |
<para> |
|
150 |
Setting cell formatting property on <see cref="T:GemBox.Spreadsheet.CellRange" /> is propagated to each cell in a range. |
|
151 |
</para> |
|
152 |
</note><para> |
|
153 |
To set <see cref="P:GemBox.Spreadsheet.AbstractRange.Style">workbook (master) style</see> to one or more cells, simply assign it to <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property. |
|
154 |
</para><note type="tip"> |
|
155 |
<para> |
|
156 |
Preferable way to modify formatting property of multiple cells is to get <see cref="T:GemBox.Spreadsheet.CellRange" /> to which all those cells belong, and use <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property of that range to make the modification. |
|
157 |
</para><para> |
|
158 |
If modifying multiple formatting properties of a <see cref="T:GemBox.Spreadsheet.CellRange" />, without preserving unmodified formatting properties, preferable way is to create new instance of <see cref="T:GemBox.Spreadsheet.CellStyle" />, make modifications on it, and assign it to <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property of that range. |
|
159 |
</para> |
|
160 |
</note><para> |
|
161 |
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting <see cref="P:GemBox.Spreadsheet.ExcelWorksheet.Cells">all worksheet cells</see>) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint. |
|
162 |
</para> |
|
163 |
</remarks> |
|
164 |
</member> |
|
165 |
<member name="P:GemBox.Spreadsheet.AbstractRange.CharacterRanges"> |
|
166 |
<summary> |
|
167 |
Returns all <see cref="T:GemBox.Spreadsheet.FormattedCharacterRange"/> objects that represents a range of characters within the cell text. |
|
168 |
</summary> |
|
169 |
<value> |
|
170 |
All <see cref="T:GemBox.Spreadsheet.FormattedCharacterRange"/> objects that represents a range of characters within the cell text. |
|
171 |
</value> |
|
172 |
</member> |
|
173 |
<member name="M:GemBox.Spreadsheet.AbstractRange.GetCharacters(System.Int32)"> |
|
174 |
<summary> |
|
175 |
Returns a <see cref="T:GemBox.Spreadsheet.FormattedCharacterRange"/> object that represents a range of characters within the cell text. |
|
176 |
The range starts at a specified character position. |
|
177 |
</summary> |
|
178 |
<param name="startIndex">The zero-based starting character position.</param> |
|
179 |
<returns>New <see cref="T:GemBox.Spreadsheet.FormattedCharacterRange"/> object.</returns> |
|
180 |
<remarks>This method only works on cell with string value.</remarks> |
|
181 |
<exception cref="T:System.ArgumentOutOfRangeException">Argument <paramref name="startIndex"/> is less than zero or is equal to or greater than 32767.</exception> |
|
182 |
<seealso href="https://www.gemboxsoftware.com/spreadsheet/examples/excel-cell-inline-formatting/203">In-line Text Formatting example</seealso> |
|
183 |
</member> |
|
184 |
<member name="M:GemBox.Spreadsheet.AbstractRange.GetCharacters(System.Int32,System.Int32)"> |
|
185 |
<summary> |
|
186 |
Returns a <see cref="T:GemBox.Spreadsheet.FormattedCharacterRange"/> object that represents a range of characters within the cell text. |
|
187 |
The range starts at a specified character position and has a specified length. |
|
188 |
</summary> |
|
189 |
<param name="startIndex">The zero-based starting character position.</param> |
|
190 |
<param name="length">The number of characters.</param> |
|
191 |
<returns>New <see cref="T:GemBox.Spreadsheet.FormattedCharacterRange"/> object.</returns> |
|
192 |
<remarks>This method only works on cell with string value.</remarks> |
|
193 |
<exception cref="T:System.ArgumentOutOfRangeException">Argument <paramref name="startIndex"/> is less than zero or is equal to or greater than 32767.</exception> |
|
194 |
<exception cref="T:System.ArgumentOutOfRangeException">Argument <paramref name="length"/> is equal to or less than zero or is greater than 32767.</exception> |
|
195 |
<seealso href="https://www.gemboxsoftware.com/spreadsheet/examples/excel-cell-inline-formatting/203">In-line Text Formatting example</seealso> |
|
196 |
</member> |
|
197 |
<member name="M:GemBox.Spreadsheet.AbstractRange.ReplaceText(System.String,System.String)"> |
|
198 |
<summary> |
|
199 |
Replaces all occurrences of the specified text with another text in the current <see cref="T:GemBox.Spreadsheet.AbstractRange"/>. |
|
200 |
</summary> |
|
201 |
<param name="oldValue">The text to be replaced.</param> |
|
202 |
<param name="newValue">The text to replace all occurrences of <paramref name="oldValue"/>.</param> |
|
203 |
<returns><see langword="true"/> if text is found, <see langword="false"/> otherwise.</returns> |
|
204 |
</member> |
|
205 |
<member name="M:GemBox.Spreadsheet.AbstractRange.ReplaceText(System.String,System.String,System.Boolean)"> |
|
206 |
<summary> |
|
207 |
Replaces all occurrences of the specified text with another text in the current <see cref="T:GemBox.Spreadsheet.AbstractRange"/>. |
|
208 |
</summary> |
|
209 |
<param name="oldValue">The text to be replaced.</param> |
|
210 |
<param name="newValue">The text to replace all occurrences of <paramref name="oldValue"/>.</param> |
|
211 |
<param name="matchCase"><see langword="true"/> to match exact case, <see langword="false"/> otherwise.</param> |
|
212 |
<returns><see langword="true"/> if text is found, <see langword="false"/> otherwise.</returns> |
|
213 |
</member> |
|
214 |
<member name="M:GemBox.Spreadsheet.AbstractRange.ReplaceText(System.String,System.String,System.Boolean,System.Boolean)"> |
|
215 |
<summary> |
|
216 |
Replaces all occurrences of the specified text with another text in the current <see cref="T:GemBox.Spreadsheet.AbstractRange"/>. |
|
217 |
</summary> |
|
218 |
<param name="oldValue">The text to be replaced.</param> |
|
219 |
<param name="newValue">The text to replace all occurrences of <paramref name="oldValue"/>.</param> |
|
220 |
<param name="matchCase"><see langword="true"/> to match exact case, <see langword="false"/> otherwise.</param> |
|
221 |
<param name="matchEntireCellContents"><see langword="true"/> to match entire cell contents, <see langword="false"/> otherwise.</param> |
|
222 |
<returns><see langword="true"/> if text is found, <see langword="false"/> otherwise.</returns> |
|
223 |
</member> |
|
224 |
<member name="M:GemBox.Spreadsheet.AbstractRange.ReplaceText(System.Text.RegularExpressions.Regex,System.String)"> |
|
225 |
<summary> |
|
226 |
Replaces all matches of the specified <see cref="T:System.Text.RegularExpressions.Regex"/> with specified text in the current <see cref="T:GemBox.Spreadsheet.AbstractRange"/>. |
|
227 |
</summary> |
|
228 |
<param name="regex">The Regex which should be matched.</param> |
|
229 |
<param name="replacement">The text which should replace all matches of searched <see cref="T:System.Text.RegularExpressions.Regex"/>.</param> |
|
230 |
<returns><see langword="true"/> if text is found, <see langword="false"/> otherwise.</returns> |
|
231 |
</member> |
|
232 |
<member name="M:GemBox.Spreadsheet.AbstractRange.ClearFormat"> |
|
233 |
<summary> |
|
234 |
Clears the range format. |
|
235 |
</summary> |
|
236 |
</member> |
|
237 |
<member name="M:GemBox.Spreadsheet.AbstractRange.Clear(GemBox.Spreadsheet.ClearOptions)"> |
|
238 |
<summary> |
|
239 |
Clears the range (content, formatting, comment, hyperlink or all). |
|
240 |
</summary> |
|
241 |
<param name="options">The clear options.</param> |
|
242 |
</member> |
|
243 |
<member name="M:GemBox.Spreadsheet.AbstractRange.ToString"> |
|
244 |
<summary> |
|
245 |
Returns a <see cref="T:System.String"/> that represents this <see cref="T:GemBox.Spreadsheet.AbstractRange"/> instance. |
|
246 |
</summary> |
|
247 |
<returns> |
|
248 |
A <see cref="T:System.String"/> that represents this <see cref="T:GemBox.Spreadsheet.AbstractRange"/> instance. |
|
249 |
</returns> |
|
250 |
<remarks>This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).</remarks> |
|
251 |
</member> |
|
252 |
<member name="P:GemBox.Spreadsheet.AbstractRange.IsStyleDefault"> |
|
253 |
<summary> |
|
254 |
Returns <see langword="true"/> if all cells in <see cref="T:GemBox.Spreadsheet.AbstractRange"/> have default cell style; otherwise, <see langword="false"/>. |
|
255 |
</summary> |
|
256 |
</member> |
|
257 |
<member name="M:GemBox.Spreadsheet.AbstractRange.SetBorders(GemBox.Spreadsheet.MultipleBorders,System.Drawing.Color,GemBox.Spreadsheet.LineStyle)"> |
|
258 |
<summary> |
|
259 |
Sets borders on one or more excel cells, taking cell position into account. |
|
260 |
</summary> |
|
261 |
<param name="multipleBorders">Borders to set.</param> |
|
262 |
<param name="lineColor">Line color.</param> |
|
263 |
<param name="lineStyle">Line style.</param> |
|
264 |
</member> |
|
265 |
<member name="T:GemBox.Spreadsheet.AnchorCell"> |
|
266 |
<summary> |
|
267 |
Represents an anchor cell object used in <see cref="T:GemBox.Spreadsheet.ExcelDrawingPosition"/> type to specify from which cell and to which cell drawing (picture, chart, etc.) spans. |
|
268 |
</summary> |
|
269 |
</member> |
|
270 |
<member name="M:GemBox.Spreadsheet.AnchorCell.#ctor(GemBox.Spreadsheet.ExcelColumn,GemBox.Spreadsheet.ExcelRow,System.Int64,System.Int64)"> |
|
271 |
<summary> |
|
272 |
Initializes a new instance of the <see cref="T:GemBox.Spreadsheet.AnchorCell"/> class by using offset values in EMU units (1 point = 12 700 EMU). |
|
273 |
</summary> |
|
274 |
<param name="column">The column where the anchor is placed.</param> |
|
275 |
<param name="row">The row where the anchor is placed.</param> |
|
276 |
<param name="columnOffset">The column offset for the anchor.</param> |
|
277 |
<param name="rowOffset">The row offset for the anchor.</param> |
|
278 |
<exception cref="T:System.ArgumentNullException"><paramref name="column"/> or <paramref name="row"/> is <see langword="null"/>.</exception> |
|
279 |
<exception cref="T:System.ArgumentException"><paramref name="column"/> and <paramref name="row"/> do not belong to the same worksheet.</exception> |
|
280 |
</member> |
|
281 |
<member name="M:GemBox.Spreadsheet.AnchorCell.#ctor(GemBox.Spreadsheet.ExcelColumn,GemBox.Spreadsheet.ExcelRow,System.Double,System.Double,GemBox.Spreadsheet.LengthUnit)"> |
|
282 |
<summary> |
|
283 |
Initializes a new instance of the <see cref="T:GemBox.Spreadsheet.AnchorCell"/> class by using offset values in arbitrary length unit. |
|
284 |
</summary> |
|
285 |
<param name="column">The column where the anchor is placed.</param> |
|
286 |
<param name="row">The row where the anchor is placed.</param> |
|
287 |
<param name="columnOffset">The column offset for the anchor in arbitrary length unit.</param> |
|
288 |
<param name="rowOffset">The row offset for the anchor in arbitrary length unit.</param> |
|
289 |
<param name="unit">The length unit in which <paramref name="columnOffset"/> and <paramref name="rowOffset"/> are specified.</param> |
|
290 |
<exception cref="T:System.ArgumentNullException"><paramref name="column"/> or <paramref name="row"/> is <see langword="null"/>.</exception> |
|
291 |
<exception cref="T:System.ArgumentException"><paramref name="column"/> and <paramref name="row"/> do not belong to the same worksheet.</exception> |
|
292 |
</member> |
|
293 |
<member name="M:GemBox.Spreadsheet.AnchorCell.#ctor(GemBox.Spreadsheet.ExcelColumn,GemBox.Spreadsheet.ExcelRow,System.Boolean)"> |
|
294 |
<summary> |
|
295 |
Initializes a new instance of the <see cref="T:GemBox.Spreadsheet.AnchorCell"/> class. |
|
296 |
</summary> |
|
297 |
<param name="column">The column where the anchor is placed.</param> |
|
298 |
<param name="row">The row where the anchor is placed.</param> |
|
299 |
<param name="topLeft">If set to <see langword="true" />, anchor will be placed in the top left corner of the cell in current column and current row; otherwise, anchor will be placed in the top-left corner of the cell in next column and next row.</param> |
|
300 |
</member> |
|
301 |
<member name="M:GemBox.Spreadsheet.AnchorCell.#ctor(GemBox.Spreadsheet.ExcelCell,System.Boolean)"> |
|
302 |
<summary> |
|
303 |
Initializes a new instance of the <see cref="T:GemBox.Spreadsheet.AnchorCell"/> class. |
|
304 |
</summary> |
|
305 |
<param name="cell">The cell where the anchor is placed.</param> |
|
306 |
<param name="topLeft">If set to <see langword="true" />, anchor will be placed in the top left corner of the cell in current column and current row; otherwise, anchor will be placed in the top-left corner of the cell in next column and next row.</param> |
|
307 |
</member> |
|
308 |
<member name="M:GemBox.Spreadsheet.AnchorCell.#ctor(GemBox.Spreadsheet.AnchorCell)"> |
|
309 |
<summary> |
|
310 |
Initializes a new instance of the <see cref="T:GemBox.Spreadsheet.AnchorCell"/> class by using another anchor cell. |
|
311 |
</summary> |
|
312 |
<param name="anchorCell">Anchor cell to copy from.</param> |
|
313 |
<exception cref="T:System.ArgumentNullException"><paramref name="anchorCell"/> is <see langword="null"/>.</exception> |
|
314 |
</member> |
|
315 |
<member name="P:GemBox.Spreadsheet.AnchorCell.Column"> |
|
316 |
<summary> |
|
317 |
Gets or sets the column for the anchor cell. |
|
318 |
</summary> |
|
319 |
<value> |
|
320 |
The column for the anchor cell. |
|
321 |
</value> |
|
322 |
<exception cref="T:System.ArgumentNullException">Value is <see langword="null"/>.</exception> |
|
323 |
<exception cref="T:System.ArgumentException">Column doesn't belong to the same worksheet as anchor cell row.</exception> |
|
324 |
</member> |
|
325 |
<member name="P:GemBox.Spreadsheet.AnchorCell.Row"> |
|
326 |
<summary> |
|
327 |
Gets or sets the row for the anchor cell. |
|
328 |
</summary> |
|
329 |
<value> |
|
330 |
The row for the anchor cell. |
|
331 |
</value> |
|
332 |
<exception cref="T:System.ArgumentNullException">Value is <see langword="null"/>.</exception> |
|
333 |
<exception cref="T:System.ArgumentException">Row doesn't belong to the same worksheet as anchor cell column.</exception> |
|
334 |
</member> |
|
335 |
<member name="P:GemBox.Spreadsheet.AnchorCell.ColumnOffset"> |
|
336 |
<summary> |
|
337 |
Gets or sets the column offset for the anchor cell in EMU units (1 point = 12 700 EMU). |
|
338 |
</summary> |
|
339 |
<value> |
|
340 |
The column offset for the anchor cell in EMU units (1 point = 12 700 EMU). |
|
341 |
</value> |
|
342 |
<remarks> |
|
343 |
<para><see cref="T:GemBox.Spreadsheet.LengthUnit">Length unit</see> for this property is <see cref="F:GemBox.Spreadsheet.LengthUnit.Emu">EMU</see> (English Metric Unit) (1 point = 12 700 EMU) for historical reasons.</para> |
|
344 |
<para>Use <see cref="M:GemBox.Spreadsheet.AnchorCell.GetColumnOffset(GemBox.Spreadsheet.LengthUnit)"/> and <see cref="M:GemBox.Spreadsheet.AnchorCell.SetColumnOffset(System.Double,GemBox.Spreadsheet.LengthUnit)"/> methods to get or set the <see cref="P:GemBox.Spreadsheet.AnchorCell.ColumnOffset"/> using arbitrary <see cref="T:GemBox.Spreadsheet.LengthUnit">length unit</see>.</para> |
|
345 |
<para><see cref="P:GemBox.Spreadsheet.AnchorCell.ColumnOffset"/> is constrained to <see cref="P:GemBox.Spreadsheet.AnchorCell.Column"/>.<see cref="P:GemBox.Spreadsheet.ExcelColumn.Width"/>.</para> |
|
346 |
</remarks> |
|
347 |
</member> |
|
348 |
<member name="P:GemBox.Spreadsheet.AnchorCell.RowOffset"> |
|
349 |
<summary> |
|
350 |
Gets or sets row offset for the anchor cell in EMU units (1 point = 12 700 EMU). |
|
351 |
</summary> |
|
352 |
<value> |
|
353 |
The row offset for the anchor cell in EMU units (1 point = 12 700 EMU). |
|
354 |
</value> |
|
355 |
<remarks> |
|
356 |
<para><see cref="T:GemBox.Spreadsheet.LengthUnit">Length unit</see> for this property is <see cref="F:GemBox.Spreadsheet.LengthUnit.Emu">EMU</see> (English Metric Unit) (1 point = 12 700 EMU) for historical reasons.</para> |
|
357 |
<para>Use <see cref="M:GemBox.Spreadsheet.AnchorCell.GetRowOffset(GemBox.Spreadsheet.LengthUnit)"/> and <see cref="M:GemBox.Spreadsheet.AnchorCell.SetRowOffset(System.Double,GemBox.Spreadsheet.LengthUnit)"/> methods to get or set the <see cref="P:GemBox.Spreadsheet.AnchorCell.RowOffset"/> using arbitrary <see cref="T:GemBox.Spreadsheet.LengthUnit">length unit</see>.</para> |
|
358 |
<para><see cref="P:GemBox.Spreadsheet.AnchorCell.RowOffset"/> is constrained to <see cref="P:GemBox.Spreadsheet.AnchorCell.Row"/>.<see cref="P:GemBox.Spreadsheet.ExcelRow.Height"/>.</para> |
|
359 |
</remarks> |
|
360 |
</member> |
|
361 |
<member name="M:GemBox.Spreadsheet.AnchorCell.GetColumnOffset(GemBox.Spreadsheet.LengthUnit)"> |
|
362 |
<summary> |
|
363 |
Gets the column offset for the anchor cell in arbitrary length unit. |
|
364 |
</summary> |
|
365 |
<param name="unit">The length unit in which to return column offset.</param> |
|
366 |
<returns>The column offset for the anchor cell in arbitrary length unit.</returns> |
|
367 |
<remarks><see cref="P:GemBox.Spreadsheet.AnchorCell.ColumnOffset"/> is constrained to <see cref="P:GemBox.Spreadsheet.AnchorCell.Column"/>.<see cref="P:GemBox.Spreadsheet.ExcelColumn.Width"/>.</remarks> |
|
368 |
</member> |
|
369 |
<member name="M:GemBox.Spreadsheet.AnchorCell.SetColumnOffset(System.Double,GemBox.Spreadsheet.LengthUnit)"> |
|
370 |
<summary> |
|
371 |
Sets the column offset for the anchor cell in arbitrary length unit. |
|
372 |
</summary> |
|
373 |
<param name="value">The column offset value.</param> |
|
374 |
<param name="unit">The length unit in which <paramref name="value"/> is specified.</param> |
|
375 |
</member> |
|
376 |
<member name="M:GemBox.Spreadsheet.AnchorCell.GetRowOffset(GemBox.Spreadsheet.LengthUnit)"> |
|
377 |
<summary> |
|
378 |
Gets the row offset for the anchor cell in arbitrary length unit. |
|
379 |
</summary> |
|
380 |
<param name="unit">The length unit in which to return row offset.</param> |
|
381 |
<returns>The row offset for the anchor cell in arbitrary length unit.</returns> |
|
382 |
<remarks><see cref="P:GemBox.Spreadsheet.AnchorCell.RowOffset"/> is constrained to <see cref="P:GemBox.Spreadsheet.AnchorCell.Row"/>.<see cref="P:GemBox.Spreadsheet.ExcelRow.Height"/>.</remarks> |
|
383 |
</member> |
|
384 |
<member name="M:GemBox.Spreadsheet.AnchorCell.SetRowOffset(System.Double,GemBox.Spreadsheet.LengthUnit)"> |
|
385 |
<summary> |
|
386 |
Sets the row offset for the anchor cell in arbitrary length unit. |
|
387 |
</summary> |
|
388 |
<param name="value">The row offset value.</param> |
|
389 |
<param name="unit">The length unit in which <paramref name="value"/> is specified.</param> |
|
390 |
</member> |
|
391 |
<member name="M:GemBox.Spreadsheet.AnchorCell.Equals(GemBox.Spreadsheet.AnchorCell)"> |
|
392 |
<summary> |
|
393 |
Determines whether the <paramref name="other"/> <see cref="T:GemBox.Spreadsheet.AnchorCell"/> is equal to this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance. |
|
394 |
</summary> |
|
395 |
<param name="other">The other anchor cell to compare with this anchor cell instance.</param> |
|
396 |
<returns><see langword="true"/> if the <paramref name="other"/> <see cref="T:GemBox.Spreadsheet.AnchorCell"/> is equal to this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance; otherwise, <see langword="false"/>.</returns> |
|
397 |
</member> |
|
398 |
<member name="M:GemBox.Spreadsheet.AnchorCell.Equals(System.Object)"> |
|
399 |
<summary> |
|
400 |
Determines whether the specified <see cref="T:System.Object"/> is equal to this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance. |
|
401 |
</summary> |
|
402 |
<param name="obj">The <see cref="T:System.Object"/> to compare with this anchor cell instance.</param> |
|
403 |
<returns> |
|
404 |
<see langword="true"/> if the specified <see cref="T:System.Object"/> is an <see cref="T:GemBox.Spreadsheet.AnchorCell"/> and is equal to this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance; otherwise, <see langword="false"/>. |
|
405 |
</returns> |
|
406 |
</member> |
|
407 |
<member name="M:GemBox.Spreadsheet.AnchorCell.GetHashCode"> |
|
408 |
<summary> |
|
409 |
Returns a hash code for this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance. |
|
410 |
</summary> |
|
411 |
<returns> |
|
412 |
An integer value that specifies a hash value for this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance. |
|
413 |
</returns> |
|
414 |
</member> |
|
415 |
<member name="M:GemBox.Spreadsheet.AnchorCell.ToString"> |
|
416 |
<summary> |
|
417 |
Returns a <see cref="T:System.String"/> that represents this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance. |
|
418 |
</summary> |
|
419 |
<returns> |
|
420 |
A <see cref="T:System.String"/> that represents this <see cref="T:GemBox.Spreadsheet.AnchorCell"/> instance. |
|
421 |
</returns> |
|
422 |
<remarks>This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).</remarks> |
|
423 |
</member> |
|
424 |
<member name="T:GemBox.Spreadsheet.AutoFilter"> |
|
425 |
<summary> |
|
426 |
Represents filter settings and provides filter functionality. |
|
427 |
</summary> |
|
428 |
<remarks> |
|
429 |
<para>Use <see cref="M:GemBox.Spreadsheet.CellRange.Filter"/> methods to create or get an <see cref="T:GemBox.Spreadsheet.AutoFilter"/> instance.</para> |
|
430 |
<para>Active <see cref="T:GemBox.Spreadsheet.AutoFilter"/> is stored in the parent worksheet (<see cref="P:GemBox.Spreadsheet.ExcelWorksheet.Filter"/>) and is loaded from and saved to XLSX file.</para> |
|
431 |
</remarks> |
|
432 |
<seealso href="https://www.gemboxsoftware.com/spreadsheet/examples/c-sharp-vb-net-excel-autofilter/112">Excel AutoFiltering example</seealso> |
|
433 |
</member> |
|
434 |
<member name="P:GemBox.Spreadsheet.AutoFilter.Range"> |
|
435 |
<summary> |
|
436 |
Gets the range to filter. |
|
437 |
</summary> |
|
438 |
<value> |
|
439 |
The range to filter. |
|
440 |
</value> |
|
441 |
</member> |
|
442 |
<member name="P:GemBox.Spreadsheet.AutoFilter.Columns"> |
|
443 |
<summary> |
|
444 |
Gets the filter columns. |
|
445 |
</summary> |
|
446 |
<value> |
|
447 |
The filter columns. |
|
448 |
</value> |
|
449 |
</member> |
|
450 |
<member name="P:GemBox.Spreadsheet.AutoFilter.Sort"> |
|
451 |
<summary> |
|
452 |
Gets the <see cref="T:GemBox.Spreadsheet.AutoFilter"/> sort state. |
|
453 |
</summary> |
|
454 |
<value> |
|
455 |
The <see cref="T:GemBox.Spreadsheet.AutoFilter"/> sort state. |
|
456 |
</value> |
|
457 |
</member> |
|
458 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByValues(System.Int32,System.Collections.IEnumerable)"> |
|
459 |
<summary> |
|
460 |
<para>Sets a <see cref="T:GemBox.Spreadsheet.ValuesFilter"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
461 |
<para><see cref="T:GemBox.Spreadsheet.ValuesFilter"/> filters by a list of values.</para> |
|
462 |
<para>The list can contain <see langword="null"/>, <see cref="T:System.String"/> and <see cref="T:GemBox.Spreadsheet.DateTimeGroup"/> values.</para> |
|
463 |
</summary> |
|
464 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set <see cref="T:GemBox.Spreadsheet.ValuesFilter"/> applies to.</param> |
|
465 |
<param name="values">The list of values to filter by.</param> |
|
466 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
467 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
468 |
<exception cref="T:System.NotSupportedException"><paramref name="values"/> contains an item which is not <see langword="null"/>, <see cref="T:System.String"/> or <see cref="T:GemBox.Spreadsheet.DateTimeGroup"/>.</exception> |
|
469 |
<remarks> |
|
470 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it will be overridden. |
|
471 |
</remarks> |
|
472 |
</member> |
|
473 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByValues(System.Int32,System.Object[])"> |
|
474 |
<summary> |
|
475 |
<para>Sets a <see cref="T:GemBox.Spreadsheet.ValuesFilter"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
476 |
<para><see cref="T:GemBox.Spreadsheet.ValuesFilter"/> filters by a list of values.</para> |
|
477 |
<para>The list can contain <see langword="null"/>, <see cref="T:System.String"/> and <see cref="T:GemBox.Spreadsheet.DateTimeGroup"/> values.</para> |
|
478 |
</summary> |
|
479 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set <see cref="T:GemBox.Spreadsheet.ValuesFilter"/> applies to.</param> |
|
480 |
<param name="values">The list of values to filter by.</param> |
|
481 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
482 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
483 |
<exception cref="T:System.NotSupportedException"><paramref name="values"/> contains an item which is not <see langword="null"/>, <see cref="T:System.String"/> or <see cref="T:GemBox.Spreadsheet.DateTimeGroup"/>.</exception> |
|
484 |
<remarks> |
|
485 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it will be overridden. |
|
486 |
</remarks> |
|
487 |
</member> |
|
488 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByTop10(System.Int32,System.Boolean,System.Boolean,System.Double)"> |
|
489 |
<summary> |
|
490 |
<para>Sets a <see cref="T:GemBox.Spreadsheet.Top10Filter"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
491 |
<para><see cref="T:GemBox.Spreadsheet.Top10Filter"/> filters by a top N (percent or number of items).</para> |
|
492 |
</summary> |
|
493 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set <see cref="T:GemBox.Spreadsheet.Top10Filter"/> applies to.</param> |
|
494 |
<param name="top">a value indicating whether or not to filter by top order. A <see langword="false" /> value filters by bottom order.</param> |
|
495 |
<param name="percent">A value indicating whether or not to filter by percent value of the column. A <see langword="false" /> value filters by number of items.</param> |
|
496 |
<param name="value">The top or bottom value to use as the filter criteria. For example "Filter by Top 10 Percent" or "Filter by Top 5 Items".</param> |
|
497 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
498 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
499 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="value"/> must be greater than zero.</exception> |
|
500 |
<remarks> |
|
501 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it will be overridden. |
|
502 |
</remarks> |
|
503 |
</member> |
|
504 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByCustom(System.Int32,GemBox.Spreadsheet.FilterOperator,System.Object)"> |
|
505 |
<summary> |
|
506 |
<para>Sets a <see cref="T:GemBox.Spreadsheet.CustomFilter"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
507 |
<para><see cref="T:GemBox.Spreadsheet.CustomFilter"/> filters by a one or two conditions (operators and values).</para> |
|
508 |
</summary> |
|
509 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set <see cref="T:GemBox.Spreadsheet.Top10Filter"/> applies to.</param> |
|
510 |
<param name="operator">The operator used by the filter condition.</param> |
|
511 |
<param name="value">The value used by the filter condition.</param> |
|
512 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
513 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
514 |
<exception cref="T:System.NotSupportedException">Value's type is not supported.</exception> |
|
515 |
<remarks> |
|
516 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it will be overridden. |
|
517 |
</remarks> |
|
518 |
</member> |
|
519 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByCustom(System.Int32,GemBox.Spreadsheet.FilterOperator,System.Object,System.Boolean,GemBox.Spreadsheet.FilterOperator,System.Object)"> |
|
520 |
<summary> |
|
521 |
<para>Sets a <see cref="T:GemBox.Spreadsheet.CustomFilter"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
522 |
<para><see cref="T:GemBox.Spreadsheet.CustomFilter"/> filters by a one or two conditions (operators and values).</para> |
|
523 |
</summary> |
|
524 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set <see cref="T:GemBox.Spreadsheet.CustomFilter"/> applies to.</param> |
|
525 |
<param name="operator">The operator used by the (first) filter condition.</param> |
|
526 |
<param name="value">The value used by the (first) filter condition.</param> |
|
527 |
<param name="and">The value indicating whether the two conditions have an "and" relationship. <see langword="true"/> indicates "and" and <see langword="false"/> indicates "or".</param> |
|
528 |
<param name="operator2">The operator used by the second filter condition.</param> |
|
529 |
<param name="value2">The value used by the second filter condition.</param> |
|
530 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
531 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
532 |
<exception cref="T:System.NotSupportedException">Value's type is not supported.</exception> |
|
533 |
<remarks> |
|
534 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it will be overridden. |
|
535 |
</remarks> |
|
536 |
</member> |
|
537 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByDynamic(System.Int32,GemBox.Spreadsheet.DynamicFilterType)"> |
|
538 |
<summary> |
|
539 |
<para>Sets a <see cref="T:GemBox.Spreadsheet.DynamicFilter"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
540 |
<para><see cref="T:GemBox.Spreadsheet.DynamicFilter"/> filters by a dynamic criteria that can change, either with the data itself (e.g., "above average") or with the current system date (e.g., show values for "today").</para> |
|
541 |
</summary> |
|
542 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set <see cref="T:GemBox.Spreadsheet.DynamicFilter"/> applies to.</param> |
|
543 |
<param name="dynamicFilterType">The dynamic filter type.</param> |
|
544 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
545 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
546 |
<remarks> |
|
547 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it will be overridden. |
|
548 |
</remarks> |
|
549 |
</member> |
|
550 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ByPredicate(System.Int32,System.Predicate{GemBox.Spreadsheet.ExcelCell})"> |
|
551 |
<summary> |
|
552 |
<para>Sets a custom filter method to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>).</para> |
|
553 |
<para>Use this method to specify a custom filter behavior which is not provided by any of the <see cref="T:GemBox.Spreadsheet.FilterType"/>s.</para> |
|
554 |
</summary> |
|
555 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that a set custom filter predicate applies to.</param> |
|
556 |
<param name="match">A custom filter method.</param> |
|
557 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters or to apply filter.</returns> |
|
558 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
559 |
<remarks> |
|
560 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a filter (<see cref="P:GemBox.Spreadsheet.FilterColumn.Filter"/> is not equal to <see langword="null"/>), it won't be removed. |
|
561 |
</remarks> |
|
562 |
</member> |
|
563 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32)"> |
|
564 |
<summary> |
|
565 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>). |
|
566 |
</summary> |
|
567 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
568 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
569 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
570 |
<remarks> |
|
571 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
572 |
</remarks> |
|
573 |
</member> |
|
574 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,System.Collections.Generic.IEnumerable{System.String})"> |
|
575 |
<summary> |
|
576 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified custom list by which order of items to sort by. |
|
577 |
</summary> |
|
578 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
579 |
<param name="customList">The custom list by which order of items to sort by.</param> |
|
580 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
581 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
582 |
<remarks> |
|
583 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
584 |
</remarks> |
|
585 |
</member> |
|
586 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,System.String[])"> |
|
587 |
<summary> |
|
588 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified custom list by which order of items to sort by. |
|
589 |
</summary> |
|
590 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
591 |
<param name="customList">The custom list by which order of items to sort by.</param> |
|
592 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
593 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
594 |
<remarks> |
|
595 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
596 |
</remarks> |
|
597 |
</member> |
|
598 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,System.Boolean)"> |
|
599 |
<summary> |
|
600 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified order to sort by. |
|
601 |
</summary> |
|
602 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
603 |
<param name="descending"><see langword="true" /> to sort the values in the descending order; otherwise, <see langword="false" />.</param> |
|
604 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
605 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
606 |
<remarks> |
|
607 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
608 |
</remarks> |
|
609 |
</member> |
|
610 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,System.Boolean,System.Collections.Generic.IEnumerable{System.String})"> |
|
611 |
<summary> |
|
612 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified order and custom list by which order of items to sort by. |
|
613 |
</summary> |
|
614 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
615 |
<param name="descending"><see langword="true" /> to sort the values in the descending order; otherwise, <see langword="false" />.</param> |
|
616 |
<param name="customList">The custom list by which order of items to sort by.</param> |
|
617 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
618 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
619 |
<remarks> |
|
620 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
621 |
</remarks> |
|
622 |
</member> |
|
623 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,System.Boolean,System.String[])"> |
|
624 |
<summary> |
|
625 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified order and custom list by which order of items to sort by. |
|
626 |
</summary> |
|
627 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
628 |
<param name="descending"><see langword="true" /> to sort the values in the descending order; otherwise, <see langword="false" />.</param> |
|
629 |
<param name="customList">The custom list by which order of items to sort by.</param> |
|
630 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
631 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
632 |
<remarks> |
|
633 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
634 |
</remarks> |
|
635 |
</member> |
|
636 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,System.Comparison{GemBox.Spreadsheet.ExcelCell})"> |
|
637 |
<summary> |
|
638 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified comparison method to sort by. |
|
639 |
</summary> |
|
640 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
641 |
<param name="comparison">The comparison method to sort by.</param> |
|
642 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
643 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
644 |
<remarks> |
|
645 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
646 |
</remarks> |
|
647 |
</member> |
|
648 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,GemBox.Spreadsheet.SpreadsheetColor)"> |
|
649 |
<summary> |
|
650 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified font color to sort by. |
|
651 |
</summary> |
|
652 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
653 |
<param name="fontColor">The font color to sort by.</param> |
|
654 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
655 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
656 |
<remarks> |
|
657 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
658 |
</remarks> |
|
659 |
</member> |
|
660 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,GemBox.Spreadsheet.SpreadsheetColor,System.Boolean)"> |
|
661 |
<summary> |
|
662 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified font color and order to sort by. |
|
663 |
</summary> |
|
664 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
665 |
<param name="fontColor">The font color to sort by.</param> |
|
666 |
<param name="descending"><see langword="true" /> to sort cells with the specified font color at the end of a range; otherwise, <see langword="false" /> to sort cells with the specified font color at the beginning of a range.</param> |
|
667 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
668 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
669 |
<remarks> |
|
670 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
671 |
</remarks> |
|
672 |
</member> |
|
673 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,GemBox.Spreadsheet.ExcelFillPattern)"> |
|
674 |
<summary> |
|
675 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified fill pattern to sort by. |
|
676 |
</summary> |
|
677 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
678 |
<param name="fillPattern">The fill pattern to sort by.</param> |
|
679 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
680 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
681 |
<remarks> |
|
682 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
683 |
</remarks> |
|
684 |
</member> |
|
685 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,GemBox.Spreadsheet.ExcelFillPattern,System.Boolean)"> |
|
686 |
<summary> |
|
687 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified fill pattern and order to sort by. |
|
688 |
</summary> |
|
689 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
690 |
<param name="fillPattern">The fill pattern to sort by.</param> |
|
691 |
<param name="descending"><see langword="true" /> to sort cells with the specified fill pattern at the end of a range; otherwise, <see langword="false" /> to sort cells with the specified fill pattern at the beginning of a range.</param> |
|
692 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
693 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
694 |
<remarks> |
|
695 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
696 |
</remarks> |
|
697 |
</member> |
|
698 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,GemBox.Spreadsheet.SpreadsheetIcon)"> |
|
699 |
<summary> |
|
700 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified icon to sort by. |
|
701 |
</summary> |
|
702 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
703 |
<param name="icon">The icon to sort by.</param> |
|
704 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
705 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
706 |
<remarks> |
|
707 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
708 |
</remarks> |
|
709 |
</member> |
|
710 |
<member name="M:GemBox.Spreadsheet.AutoFilter.SortBy(System.Int32,GemBox.Spreadsheet.SpreadsheetIcon,System.Boolean)"> |
|
711 |
<summary> |
|
712 |
Adds a <see cref="T:GemBox.Spreadsheet.SortLevel"/> to a column with the specified index (relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/>) and with the specified icon and order to sort by. |
|
713 |
</summary> |
|
714 |
<param name="columnIndex">The index of a column relative to the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> that an added <see cref="T:GemBox.Spreadsheet.SortLevel"/> applies to.</param> |
|
715 |
<param name="icon">The icon to sort by.</param> |
|
716 |
<param name="descending"><see langword="true" /> to sort cells with the specified icon at the end of a range; otherwise, <see langword="false" /> to sort cells with the specified icon at the beginning of a range.</param> |
|
717 |
<returns>This <see cref="T:GemBox.Spreadsheet.AutoFilter"/> to specify additional filters / sort levels or to apply filter / sort.</returns> |
|
718 |
<exception cref="T:System.ArgumentOutOfRangeException"><paramref name="columnIndex"/> is less than zero or is equal to or greater than <see cref="P:GemBox.Spreadsheet.CellRange.Width"/> of the <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" />.</exception> |
|
719 |
<remarks> |
|
720 |
If <see cref="T:GemBox.Spreadsheet.FilterColumn"/> already specifies a sort level (<see cref="P:GemBox.Spreadsheet.FilterColumn.Sort"/> is not equal to <see langword="null"/>), it will be overridden. |
|
721 |
</remarks> |
|
722 |
</member> |
|
723 |
<member name="M:GemBox.Spreadsheet.AutoFilter.Apply"> |
|
724 |
<summary> |
|
725 |
<para>Performs the filtering and sorting of this <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> based on this <see cref="T:GemBox.Spreadsheet.AutoFilter"/> settings.</para> |
|
726 |
<para>Rows which cells contained in <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" /> do not satisfy filtering conditions will be hidden (<see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Hidden"/> will be set to <see langword="true"/>).</para> |
|
727 |
</summary> |
|
728 |
<exception cref="T:System.InvalidOperationException">Sort range contains merged cells.</exception> |
|
729 |
<remarks> |
|
730 |
This method has the same affect as <see cref="M:GemBox.Spreadsheet.AutoFilter.Apply(System.Boolean)"/> with parameter set to <see langword="true"/>. |
|
731 |
</remarks> |
|
732 |
</member> |
|
733 |
<member name="M:GemBox.Spreadsheet.AutoFilter.Apply(System.Boolean)"> |
|
734 |
<summary> |
|
735 |
<para>Performs the filtering and (optionally) sorting of this <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" /> based on this <see cref="T:GemBox.Spreadsheet.AutoFilter" /> settings.</para> |
|
736 |
<para>Rows which cells contained in <see cref="P:GemBox.Spreadsheet.AutoFilter.Range" /> do not satisfy filtering conditions will be hidden (<see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Hidden"/> will be set to <see langword="true"/>).</para> |
|
737 |
</summary> |
|
738 |
<exception cref="T:System.InvalidOperationException">Sort range contains merged cells.</exception> |
|
739 |
<param name="applySort">if set to <see langword="true" /> perform sorting in addition to filtering.</param> |
|
740 |
</member> |
|
741 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ShowAll"> |
|
742 |
<summary> |
|
743 |
Shows all rows (sets <see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Hidden"/> to <see langword="false"/>) to which <see cref="P:GemBox.Spreadsheet.AutoFilter.Range"/> belongs. |
|
744 |
</summary> |
|
745 |
</member> |
|
746 |
<member name="M:GemBox.Spreadsheet.AutoFilter.ToString"> |
|
747 |
<summary> |
|
748 |
Returns a <see cref="T:System.String"/> that represents this <see cref="T:GemBox.Spreadsheet.AutoFilter"/> instance. |
|
749 |
</summary> |
|
750 |
<returns> |
|
751 |
A <see cref="T:System.String"/> that represents this <see cref="T:GemBox.Spreadsheet.AutoFilter"/> instance. |
|
752 |
</returns> |
|
753 |
<remarks>This method should be used primarily for debugging purposes and should be considered volatile (format of its return value might change in future versions).</remarks> |
|
754 |
</member> |
|
755 |
<member name="T:GemBox.Spreadsheet.BuiltInCellStyleName"> |
|
756 |
<summary> |
|
757 |
Represents a built-in style name. |
|
758 |
</summary> |
|
759 |
<remarks> |
|
760 |
<para>Conceptually, cell formatting is divided into following groups:</para><list type="bullet"> |
|
761 |
<item> |
|
762 |
<description> |
|
763 |
<b>Number</b> - indicates how to format and render the numeric value of a cell. Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.NumberFormat" />. |
|
764 |
</description> |
|
765 |
</item> |
|
766 |
<item> |
|
767 |
<description> |
|
768 |
<b>Alignment</b> - formatting information pertaining to text alignment in cells. Associated properties are <see cref="P:GemBox.Spreadsheet.CellStyle.HorizontalAlignment" />, <see cref="P:GemBox.Spreadsheet.CellStyle.VerticalAlignment" />, <see cref="P:GemBox.Spreadsheet.CellStyle.Indent" />, <see cref="P:GemBox.Spreadsheet.CellStyle.Rotation" />, <see cref="P:GemBox.Spreadsheet.CellStyle.IsTextVertical" />, <see cref="P:GemBox.Spreadsheet.CellStyle.WrapText" /> and <see cref="P:GemBox.Spreadsheet.CellStyle.ShrinkToFit" />. |
|
769 |
</description> |
|
770 |
</item> |
|
771 |
<item> |
|
772 |
<description> |
|
773 |
<b>Font</b> - defines the properties for the used font. Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.Font" />. |
|
774 |
</description> |
|
775 |
</item> |
|
776 |
<item> |
|
777 |
<description> |
|
778 |
<b>Border</b> - expresses a single set of cell border formats (left, right, top, bottom and diagonal). Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.Borders" />. |
|
779 |
</description> |
|
780 |
</item> |
|
781 |
<item> |
|
782 |
<description> |
|
783 |
<b>Fill</b> - specifies fill formatting (pattern or gradient). Associated property is <see cref="P:GemBox.Spreadsheet.CellStyle.FillPattern" />. |
|
784 |
</description> |
|
785 |
</item> |
|
786 |
<item> |
|
787 |
<description> |
|
788 |
<b>Protection</b> - contains protection properties associated with the cell. Associated properties are <see cref="P:GemBox.Spreadsheet.CellStyle.Locked" /> and <see cref="P:GemBox.Spreadsheet.CellStyle.FormulaHidden" />. |
|
789 |
</description> |
|
790 |
</item> |
|
791 |
</list><para> |
|
792 |
Additional <see cref="T:GemBox.Spreadsheet.CellStyle" /> properties not associated with any formatting group are: |
|
793 |
</para><list type="bullet"> |
|
794 |
<item> |
|
795 |
<description> |
|
796 |
<see cref="P:GemBox.Spreadsheet.CellStyle.Name" /> - name of the referenced <see cref="T:GemBox.Spreadsheet.Style">workbook style</see>. |
|
797 |
</description> |
|
798 |
</item> |
|
799 |
<item> |
|
800 |
<description> |
|
801 |
<see cref="P:GemBox.Spreadsheet.CellStyle.QuotePrefix" /> - <see langword="true" /> to store numeric value of a cell as text; otherwise, <see langword="false" />. |
|
802 |
</description> |
|
803 |
</item> |
|
804 |
<item> |
|
805 |
<description> |
|
806 |
<see cref="P:GemBox.Spreadsheet.CellStyle.IsDefault" /> - <see langword="true" /> if <see cref="P:GemBox.Spreadsheet.CellStyle.Name">referenced</see> <see cref="T:GemBox.Spreadsheet.Style">workbook style</see> is default (<b> |
|
807 |
<see cref="P:GemBox.Spreadsheet.CellStyleCollection.Normal" /> |
|
808 |
</b>) and there are no additional modifications of cell formatting; otherwise, <see langword="false" />. |
|
809 |
</description> |
|
810 |
</item> |
|
811 |
</list><para> |
|
812 |
<see cref="T:GemBox.Spreadsheet.ExcelFile">Workbook</see> contains a set of <see cref="P:GemBox.Spreadsheet.ExcelFile.Styles">master styles</see> which can be referenced by multiple cells. |
|
813 |
</para><para> |
|
814 |
<see cref="T:GemBox.Spreadsheet.ExcelFile">Workbook</see> must always contain at least one <see cref="T:GemBox.Spreadsheet.Style">master style</see> which cannot be removed and is, by default, referenced by all cells. This default style is <b> |
|
815 |
<see cref="P:GemBox.Spreadsheet.CellStyleCollection.Normal" /> |
|
816 |
</b>. |
|
817 |
</para><para> |
|
818 |
<see cref="T:GemBox.Spreadsheet.Style">Workbook style</see> can either be built-in or user-defined. Built-in style is accessible from <see cref="P:GemBox.Spreadsheet.ExcelFile.Styles">workbook styles</see> via <see cref="T:GemBox.Spreadsheet.BuiltInCellStyleName" /> enumeration. |
|
819 |
</para><para> |
|
820 |
Cell formatting group (Number, Alignment, Font, Border, Fill or Protection) (and its associated properties) is resolved from <see cref="P:GemBox.Spreadsheet.CellStyle.Name">referenced</see> <see cref="T:GemBox.Spreadsheet.Style">workbook (master) style</see>, unless cell formatting group or its associated property is modified. |
|
821 |
</para><para> |
|
822 |
Cell formatting is available for one or more cells through <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property which is available on <see cref="T:GemBox.Spreadsheet.ExcelCell" /> and <see cref="T:GemBox.Spreadsheet.CellRange" /> types. |
|
823 |
Cell formatting specified on <see cref="T:GemBox.Spreadsheet.ExcelColumn" /> and <see cref="T:GemBox.Spreadsheet.ExcelRow" /> types through <see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Style" /> property is simply propagated to cell formatting of its <see cref="P:GemBox.Spreadsheet.ExcelColumnRowBase.Cells" />. |
|
824 |
</para><note type="note"> |
|
825 |
<para> |
|
826 |
For performance reasons, cell formatting on <see cref="T:GemBox.Spreadsheet.CellRange" /> is resolved based just on its top-left cell formatting, except borders which are resolved based on corner cells depending on border side. |
|
827 |
</para> |
|
828 |
<para> |
|
829 |
Setting cell formatting property on <see cref="T:GemBox.Spreadsheet.CellRange" /> is propagated to each cell in a range. |
|
830 |
</para> |
|
831 |
</note><para> |
|
832 |
To set <see cref="T:GemBox.Spreadsheet.Style">workbook (master) style</see> to one or more cells, simply assign it to <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property. |
|
833 |
</para><note type="tip"> |
|
834 |
<para> |
|
835 |
Preferable way to modify formatting property of multiple cells is to get <see cref="T:GemBox.Spreadsheet.CellRange" /> to which all those cells belong, and use <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property of that range to make the modification. |
|
836 |
</para><para> |
|
837 |
If modifying multiple formatting properties of a <see cref="T:GemBox.Spreadsheet.CellRange" />, without preserving unmodified formatting properties, preferable way is to create new instance of <see cref="T:GemBox.Spreadsheet.CellStyle" />, make modifications on it, and assign it to <see cref="P:GemBox.Spreadsheet.AbstractRange.Style" /> property of that range. |
|
838 |
</para> |
|
839 |
</note><para> |
|
840 |
GemBox.Spreadsheet internally takes care not to allocate unnecessary cells when formatting a range of cells (for example, when formatting <see cref="P:GemBox.Spreadsheet.ExcelWorksheet.Cells">all worksheet cells</see>) and to cache formatting information of equally formatted cells, at the appropriate time, to reduce memory footprint. |
|
841 |
</para> |
|
842 |
</remarks> |
|
843 |
<seealso cref="T:GemBox.Spreadsheet.CellStyleCollection" /> |
|
844 |
</member> |
|
845 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Normal"> |
|
846 |
<summary> |
|
847 |
'<b><see cref="P:GemBox.Spreadsheet.CellStyleCollection.Normal"/></b>' built-in style. |
|
848 |
</summary> |
|
849 |
</member> |
|
850 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel1"> |
|
851 |
<summary> |
|
852 |
'<b>RowLevel_1</b>' built-in style. |
|
853 |
</summary> |
|
854 |
</member> |
|
855 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel2"> |
|
856 |
<summary> |
|
857 |
'<b>RowLevel_2</b>' built-in style. |
|
858 |
</summary> |
|
859 |
</member> |
|
860 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel3"> |
|
861 |
<summary> |
|
862 |
'<b>RowLevel_3</b>' built-in style. |
|
863 |
</summary> |
|
864 |
</member> |
|
865 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel4"> |
|
866 |
<summary> |
|
867 |
'<b>RowLevel_4</b>' built-in style. |
|
868 |
</summary> |
|
869 |
</member> |
|
870 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel5"> |
|
871 |
<summary> |
|
872 |
'<b>RowLevel_5</b>' built-in style. |
|
873 |
</summary> |
|
874 |
</member> |
|
875 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel6"> |
|
876 |
<summary> |
|
877 |
'<b>RowLevel_6</b>' built-in style. |
|
878 |
</summary> |
|
879 |
</member> |
|
880 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.RowLevel7"> |
|
881 |
<summary> |
|
882 |
'<b>RowLevel_7</b>' built-in style. |
|
883 |
</summary> |
|
884 |
</member> |
|
885 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel1"> |
|
886 |
<summary> |
|
887 |
'<b>ColLevel_1</b>' built-in style. |
|
888 |
</summary> |
|
889 |
</member> |
|
890 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel2"> |
|
891 |
<summary> |
|
892 |
'<b>ColLevel_2</b>' built-in style. |
|
893 |
</summary> |
|
894 |
</member> |
|
895 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel3"> |
|
896 |
<summary> |
|
897 |
'<b>ColLevel_3</b>' built-in style. |
|
898 |
</summary> |
|
899 |
</member> |
|
900 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel4"> |
|
901 |
<summary> |
|
902 |
'<b>ColLevel_4</b>' built-in style. |
|
903 |
</summary> |
|
904 |
</member> |
|
905 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel5"> |
|
906 |
<summary> |
|
907 |
'<b>ColLevel_5</b>' built-in style. |
|
908 |
</summary> |
|
909 |
</member> |
|
910 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel6"> |
|
911 |
<summary> |
|
912 |
'<b>ColLevel_6</b>' built-in style. |
|
913 |
</summary> |
|
914 |
</member> |
|
915 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ColLevel7"> |
|
916 |
<summary> |
|
917 |
'<b>ColLevel_7</b>' built-in style. |
|
918 |
</summary> |
|
919 |
</member> |
|
920 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Comma"> |
|
921 |
<summary> |
|
922 |
'<b>Comma</b>' built-in style. |
|
923 |
</summary> |
|
924 |
</member> |
|
925 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Currency"> |
|
926 |
<summary> |
|
927 |
'<b>Currency</b>' built-in style. |
|
928 |
</summary> |
|
929 |
</member> |
|
930 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Percent"> |
|
931 |
<summary> |
|
932 |
'<b>Percent</b>' built-in style. |
|
933 |
</summary> |
|
934 |
</member> |
|
935 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Comma0"> |
|
936 |
<summary> |
|
937 |
'<b>Comma [0]</b>' built-in style. |
|
938 |
</summary> |
|
939 |
</member> |
|
940 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Currency0"> |
|
941 |
<summary> |
|
942 |
'<b>Currency [0]</b>' built-in style. |
|
943 |
</summary> |
|
944 |
</member> |
|
945 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Hyperlink"> |
|
946 |
<summary> |
|
947 |
<b>Hyperlink</b> built-in style. |
|
948 |
</summary> |
|
949 |
</member> |
|
950 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.FollowedHyperlink"> |
|
951 |
<summary> |
|
952 |
<b>Followed Hyperlink</b> built-in style. |
|
953 |
</summary> |
|
954 |
</member> |
|
955 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Note"> |
|
956 |
<summary> |
|
957 |
<b>Note</b> built-in style. |
|
958 |
</summary> |
|
959 |
</member> |
|
960 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.WarningText"> |
|
961 |
<summary> |
|
962 |
'<b>Warning Text</b>' built-in style. |
|
963 |
</summary> |
|
964 |
</member> |
|
965 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Title"> |
|
966 |
<summary> |
|
967 |
'<b>Title</b>' built-in style. |
|
968 |
</summary> |
|
969 |
</member> |
|
970 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Heading1"> |
|
971 |
<summary> |
|
972 |
'<b>Heading 1</b>' built-in style. |
|
973 |
</summary> |
|
974 |
</member> |
|
975 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Heading2"> |
|
976 |
<summary> |
|
977 |
'<b>Heading 2</b>' built-in style. |
|
978 |
</summary> |
|
979 |
</member> |
|
980 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Heading3"> |
|
981 |
<summary> |
|
982 |
'<b>Heading 3</b>' built-in style. |
|
983 |
</summary> |
|
984 |
</member> |
|
985 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Heading4"> |
|
986 |
<summary> |
|
987 |
'<b>Heading 4</b>' built-in style. |
|
988 |
</summary> |
|
989 |
</member> |
|
990 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Input"> |
|
991 |
<summary> |
|
992 |
'<b>Input</b>' built-in style. |
|
993 |
</summary> |
|
994 |
</member> |
|
995 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Output"> |
|
996 |
<summary> |
|
997 |
'<b>Output</b>' built-in style. |
|
998 |
</summary> |
|
999 |
</member> |
|
1000 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Calculation"> |
|
1001 |
<summary> |
|
1002 |
'<b>Calculation</b>' built-in style. |
|
1003 |
</summary> |
|
1004 |
</member> |
|
1005 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.CheckCell"> |
|
1006 |
<summary> |
|
1007 |
'<b>Check Cell</b>' built-in style. |
|
1008 |
</summary> |
|
1009 |
</member> |
|
1010 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.LinkedCell"> |
|
1011 |
<summary> |
|
1012 |
'<b>Linked Cell</b>' built-in style. |
|
1013 |
</summary> |
|
1014 |
</member> |
|
1015 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Total"> |
|
1016 |
<summary> |
|
1017 |
'<b>Total</b>' built-in style. |
|
1018 |
</summary> |
|
1019 |
</member> |
|
1020 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Good"> |
|
1021 |
<summary> |
|
1022 |
'<b>Good</b>' built-in style. |
|
1023 |
</summary> |
|
1024 |
</member> |
|
1025 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Bad"> |
|
1026 |
<summary> |
|
1027 |
'<b>Bad</b>' built-in style. |
|
1028 |
</summary> |
|
1029 |
</member> |
|
1030 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Neutral"> |
|
1031 |
<summary> |
|
1032 |
'<b>Neutral</b>' built-in style. |
|
1033 |
</summary> |
|
1034 |
</member> |
|
1035 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent1"> |
|
1036 |
<summary> |
|
1037 |
'<b>Accent1</b>' built-in style. |
|
1038 |
</summary> |
|
1039 |
</member> |
|
1040 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent1Pct20"> |
|
1041 |
<summary> |
|
1042 |
'<b>20% - Accent1</b>' built-in style. |
|
1043 |
</summary> |
|
1044 |
</member> |
|
1045 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent1Pct40"> |
|
1046 |
<summary> |
|
1047 |
'<b>40% - Accent1</b>' built-in style. |
|
1048 |
</summary> |
|
1049 |
</member> |
|
1050 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent1Pct60"> |
|
1051 |
<summary> |
|
1052 |
'<b>60% - Accent1</b>' built-in style. |
|
1053 |
</summary> |
|
1054 |
</member> |
|
1055 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent2"> |
|
1056 |
<summary> |
|
1057 |
'<b>Accent2</b>' built-in style. |
|
1058 |
</summary> |
|
1059 |
</member> |
|
1060 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent2Pct20"> |
|
1061 |
<summary> |
|
1062 |
'<b>20% - Accent2</b>' built-in style. |
|
1063 |
</summary> |
|
1064 |
</member> |
|
1065 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent2Pct40"> |
|
1066 |
<summary> |
|
1067 |
'<b>40% - Accent2</b>' built-in style. |
|
1068 |
</summary> |
|
1069 |
</member> |
|
1070 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent2Pct60"> |
|
1071 |
<summary> |
|
1072 |
'<b>60% - Accent2</b>' built-in style. |
|
1073 |
</summary> |
|
1074 |
</member> |
|
1075 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent3"> |
|
1076 |
<summary> |
|
1077 |
'<b>Accent3</b>' built-in style. |
|
1078 |
</summary> |
|
1079 |
</member> |
|
1080 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent3Pct20"> |
|
1081 |
<summary> |
|
1082 |
'<b>20% - Accent3</b>' built-in style. |
|
1083 |
</summary> |
|
1084 |
</member> |
|
1085 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent3Pct40"> |
|
1086 |
<summary> |
|
1087 |
'<b>40% - Accent3</b>' built-in style. |
|
1088 |
</summary> |
|
1089 |
</member> |
|
1090 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent3Pct60"> |
|
1091 |
<summary> |
|
1092 |
'<b>60% - Accent3</b>' built-in style. |
|
1093 |
</summary> |
|
1094 |
</member> |
|
1095 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent4"> |
|
1096 |
<summary> |
|
1097 |
'<b>Accent4</b>' built-in style. |
|
1098 |
</summary> |
|
1099 |
</member> |
|
1100 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent4Pct20"> |
|
1101 |
<summary> |
|
1102 |
'<b>20% - Accent4</b>' built-in style. |
|
1103 |
</summary> |
|
1104 |
</member> |
|
1105 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent4Pct40"> |
|
1106 |
<summary> |
|
1107 |
'<b>40% - Accent4</b>' built-in style. |
|
1108 |
</summary> |
|
1109 |
</member> |
|
1110 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent4Pct60"> |
|
1111 |
<summary> |
|
1112 |
'<b>60% - Accent4</b>' built-in style. |
|
1113 |
</summary> |
|
1114 |
</member> |
|
1115 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent5"> |
|
1116 |
<summary> |
|
1117 |
'<b>Accent5</b>' built-in style. |
|
1118 |
</summary> |
|
1119 |
</member> |
|
1120 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent5Pct20"> |
|
1121 |
<summary> |
|
1122 |
'<b>20% - Accent5</b>' built-in style. |
|
1123 |
</summary> |
|
1124 |
</member> |
|
1125 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent5Pct40"> |
|
1126 |
<summary> |
|
1127 |
'<b>40% - Accent5</b>' built-in style. |
|
1128 |
</summary> |
|
1129 |
</member> |
|
1130 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent5Pct60"> |
|
1131 |
<summary> |
|
1132 |
'<b>60% - Accent5</b>' built-in style. |
|
1133 |
</summary> |
|
1134 |
</member> |
|
1135 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent6"> |
|
1136 |
<summary> |
|
1137 |
'<b>Accent6</b>' built-in style. |
|
1138 |
</summary> |
|
1139 |
</member> |
|
1140 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent6Pct20"> |
|
1141 |
<summary> |
|
1142 |
'<b>20% - Accent6</b>' built-in style. |
|
1143 |
</summary> |
|
1144 |
</member> |
|
1145 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent6Pct40"> |
|
1146 |
<summary> |
|
1147 |
'<b>40% - Accent6</b>' built-in style. |
|
1148 |
</summary> |
|
1149 |
</member> |
|
1150 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.Accent6Pct60"> |
|
1151 |
<summary> |
|
1152 |
'<b>60% - Accent6</b>' built-in style. |
|
1153 |
</summary> |
|
1154 |
</member> |
|
1155 |
<member name="F:GemBox.Spreadsheet.BuiltInCellStyleName.ExplanatoryText"> |
|
1156 |
<summary> |
|
1157 |
'<b>Explanatory Text</b>' built-in style. |
|
1158 |
</summary> |
|
1159 |
</member> |
|
1160 |
<member name="T:GemBox.Spreadsheet.BuiltInDocumentProperties"> |
|
1161 |
<summary> |
|
1162 |
Enumeration of available built-in document properties. |
|
1163 |
</summary> |
|
1164 |
</member> |
|
1165 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Title"> |
|
1166 |
<summary> |
|
1167 |
Title of the document. |
|
1168 |
</summary> |
|
1169 |
</member> |
|
1170 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Author"> |
|
1171 |
<summary> |
|
1172 |
Name of the document's author. |
|
1173 |
</summary> |
|
1174 |
</member> |
|
1175 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Subject"> |
|
1176 |
<summary> |
|
1177 |
Subject of the document. |
|
1178 |
</summary> |
|
1179 |
</member> |
|
1180 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Comments"> |
|
1181 |
<summary> |
|
1182 |
Document comments. |
|
1183 |
</summary> |
|
1184 |
</member> |
|
1185 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Category"> |
|
1186 |
<summary> |
|
1187 |
Category of the document. |
|
1188 |
</summary> |
|
1189 |
</member> |
|
1190 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Status"> |
|
1191 |
<summary> |
|
1192 |
Status of the document. |
|
1193 |
</summary> |
|
1194 |
</member> |
|
1195 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Keywords"> |
|
1196 |
<summary> |
|
1197 |
Document keywords. |
|
1198 |
</summary> |
|
1199 |
</member> |
|
1200 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.LastSavedBy"> |
|
1201 |
<summary> |
|
1202 |
Name of the last author. |
|
1203 |
</summary> |
|
1204 |
</member> |
|
1205 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Manager"> |
|
1206 |
<summary> |
|
1207 |
Manager. |
|
1208 |
</summary> |
|
1209 |
</member> |
|
1210 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Company"> |
|
1211 |
<summary> |
|
1212 |
Company. |
|
1213 |
</summary> |
|
1214 |
</member> |
|
1215 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.HyperlinkBase"> |
|
1216 |
<summary> |
|
1217 |
Base hyperlink. |
|
1218 |
</summary> |
|
1219 |
</member> |
|
1220 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.Application"> |
|
1221 |
<summary> |
|
1222 |
Application. |
|
1223 |
</summary> |
|
1224 |
</member> |
|
1225 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.DateContentCreated"> |
|
1226 |
<summary> |
|
1227 |
UTC time of creation of the document. |
|
1228 |
</summary> |
|
1229 |
</member> |
|
1230 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.DateLastSaved"> |
|
1231 |
<summary> |
|
1232 |
UTC time on which the document was last modified/saved. |
|
1233 |
</summary> |
|
1234 |
</member> |
|
1235 |
<member name="F:GemBox.Spreadsheet.BuiltInDocumentProperties.DateLastPrinted"> |
|
1236 |
<summary> |
|
1237 |
UTC time on which the document was last printed. |
|
1238 |
</summary> |
|
1239 |
</member> |
|
1240 |
<member name="T:GemBox.Spreadsheet.CalculationEngine.CalculationOptions"> |
|
1241 |
<summary> |
|
1242 |
Class represents various calculation engine options. |
|
1243 |
</summary> |
|
1244 |
</member> |
|
1245 |
<member name="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.EnableIterativeCalculation"> |
|
1246 |
<summary> |
|
1247 |
Gets or sets a value indicating whether iterative calculation is enabled. |
|
1248 |
</summary> |
|
1249 |
<value> |
|
1250 |
<c>True</c> if iterative calculation is enabled; otherwise, <c>false</c>. |
|
1251 |
</value> |
|
1252 |
<remarks> |
|
1253 |
A circular reference is when a formula refers to itself directly or indirectly. |
|
1254 |
Setting this property to <c>true</c> will allow circular references in cell formulas; |
|
1255 |
otherwise a <see cref="T:GemBox.Spreadsheet.CalculationEngine.SpreadsheetParserException" /> will be thrown for every circular reference in the calculation process. |
|
1256 |
</remarks> |
|
1257 |
</member> |
|
1258 |
<member name="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.MaximumIterations"> |
|
1259 |
<summary> |
|
1260 |
Gets or sets the maximum calculation iterations. |
|
1261 |
</summary> |
|
1262 |
<value> |
|
1263 |
The maximum calculation iterations. |
|
1264 |
</value> |
|
1265 |
<remarks> |
|
1266 |
This property defines the maximum number of formula recalculations for a circular reference. |
|
1267 |
</remarks> |
|
1268 |
</member> |
|
1269 |
<member name="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.MaximumChange"> |
|
1270 |
<summary> |
|
1271 |
Gets or sets the maximum calculation change. |
|
1272 |
</summary> |
|
1273 |
<value> |
|
1274 |
The maximum calculation change. |
|
1275 |
</value> |
|
1276 |
<remarks> |
|
1277 |
This property defines the maximum value change in circular reference iterations after which the calculation process is stopped. |
|
1278 |
</remarks> |
|
1279 |
</member> |
|
1280 |
<member name="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.EnableCaching"> |
|
1281 |
<summary> |
|
1282 |
Gets or sets the value indicating whether the intermediate results of formulas should be cached. |
|
1283 |
For some files, caching can decrease the time necessary to calculate formulas. |
|
1284 |
</summary> |
|
1285 |
<value> |
|
1286 |
The value indicates whether the intermediate results of formulas should be cached. |
|
1287 |
The default value is false. |
|
1288 |
</value> |
|
1289 |
<remarks> |
|
1290 |
Use this property with caution, however. For most files, caching will not improve performance, but hurt it. |
|
1291 |
Caching is useful only when there are repeated formulas (or expressions) that are always evaluated to the |
|
1292 |
same result. So, even though some formulas can look the same, their results will be different; |
|
1293 |
Thus, they are inapplicable for caching. An example of such a formula is <code>=MAX(ROW(), COLUMN())</code>, whose result |
|
1294 |
will not be cached, because the result depends on the cell where the formula is placed. |
|
1295 |
</remarks> |
|
1296 |
</member> |
|
1297 |
<member name="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.CultureInfo"> |
|
1298 |
<summary> |
|
1299 |
<para>Gets or sets the culture used during the calculation.</para> |
|
1300 |
<para>The default value is <see cref="P:System.Globalization.CultureInfo.CurrentCulture" />.</para> |
|
1301 |
</summary> |
|
1302 |
<value> |
|
1303 |
The culture used during the calculation. |
|
1304 |
</value> |
|
1305 |
<remarks> |
|
1306 |
<note type="important"> |
|
1307 |
<para>.NET 5.0 and later versions use <see href="http://site.icu-project.org/home">International Components for Unicode (ICU)</see> libraries for globalization functionality when running on Windows 10 May 2019 Update or later.</para> |
|
1308 |
<para>When running your application on .NET 5.0, you might see changes in calculation of some formulas, for example, when formatting currency (if <see cref="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.CultureInfo" /> is <see href="https://docs.microsoft.com/en-us/dotnet/core/compatibility/globalization/5.0/icu-globalization-api#currency-symbol">specified without country or region</see>) or negative currency (because <see cref="P:System.Globalization.NumberFormatInfo.CurrencyNegativePattern" /> might differ between ICU and <see href="https://docs.microsoft.com/en-us/windows/win32/intl/national-language-support">NLS</see> which is used on .NET Framework and .NET Core 3.1 and lower).</para> |
|
1309 |
<para>For more information about this .NET 5.0 breaking change and how to revert to using NLS globalization APIs, see the <see href="https://docs.microsoft.com/en-us/dotnet/core/compatibility/globalization/5.0/icu-globalization-api">Globalization APIs use ICU libraries on Windows</see> page.</para> |
|
1310 |
</note> |
|
1311 |
</remarks> |
|
1312 |
</member> |
|
1313 |
<member name="P:GemBox.Spreadsheet.CalculationEngine.CalculationOptions.PrioritizeR1C1ReferencingNotation"> |
|
1314 |
<summary> |
|
1315 |
Gets or sets the value indicating whether to prioritize R1C1 notation over A1 notation when evaluating formulas. |
|
1316 |
</summary> |
|
1317 |
<value> |
|
1318 |
The value indicating whether to prioritize R1C1 notation over A1 notation when evaluating formulas. |
|
1319 |
The default value is false (A1 notation is prioritized). |
|
1320 |
</value> |
|
1321 |
<remarks> |
|
1322 |
This property is necessary because some references can be ambiguous. For example "RC1" references |
|
1323 |
the RC column and first row in A1 notation and the current row and first column in R1C1 notation. |
|
1324 |
</remarks> |
|
1325 |
</member> |
|
1326 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.Covar(System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double})"> |
|
1327 |
<summary> |
|
1328 |
Returns covariance, the average of the products of deviations |
|
1329 |
for each data point pair. Use covariance to determine the |
|
1330 |
relationship between two data sets. For example, you can |
|
1331 |
examine whether greater income accompanies greater |
|
1332 |
levels of education. |
|
1333 |
</summary> |
|
1334 |
<param name="arrayX">First data set from X random variable.</param> |
|
1335 |
<param name="arrayY">Second data set from Y random variable.</param> |
|
1336 |
<returns>Returns covariance</returns> |
|
1337 |
</member> |
|
1338 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.GammLn(System.Double)"> |
|
1339 |
<summary> |
|
1340 |
Returns the natural logarithm of the gamma function, G(x). |
|
1341 |
</summary> |
|
1342 |
<param name="n">The value for which you want to calculate gamma function.</param> |
|
1343 |
<returns>Returns the natural logarithm of the gamma function.</returns> |
|
1344 |
</member> |
|
1345 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.Log1p(System.Double)"> |
|
1346 |
<summary> |
|
1347 |
Computes log(1+x) without losing precision for small values of x. |
|
1348 |
</summary> |
|
1349 |
</member> |
|
1350 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.BetaFunction(System.Double,System.Double)"> |
|
1351 |
<summary> |
|
1352 |
Calculates Beta function |
|
1353 |
</summary> |
|
1354 |
<param name="m">First parameter for beta function</param> |
|
1355 |
<param name="n">Second parameter for beta function</param> |
|
1356 |
<returns>returns beta function</returns> |
|
1357 |
</member> |
|
1358 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.BetaCF(System.Double,System.Double,System.Double)"> |
|
1359 |
<summary> |
|
1360 |
Used by betai: Evaluates continued fraction for |
|
1361 |
incomplete beta function by modified Lentz’s |
|
1362 |
</summary> |
|
1363 |
<param name="a">Beta incomplete parameter</param> |
|
1364 |
<param name="b">Beta incomplete parameter</param> |
|
1365 |
<param name="x">Beta incomplete parameter</param> |
|
1366 |
<returns>Value used for Beta incomplete function</returns> |
|
1367 |
</member> |
|
1368 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.StandardNormalDistributionFunction(System.Double)"> |
|
1369 |
<summary> |
|
1370 |
Standard normal density function |
|
1371 |
</summary> |
|
1372 |
<param name="t">T Value</param> |
|
1373 |
<returns>Standard normal density</returns> |
|
1374 |
</member> |
|
1375 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.BetaIncomplete(System.Double,System.Double,System.Double)"> |
|
1376 |
<summary> |
|
1377 |
Returns the incomplete beta function Ix(a, b). |
|
1378 |
</summary> |
|
1379 |
<param name="a">Beta incomplete parameter</param> |
|
1380 |
<param name="b">Beta incomplete parameter</param> |
|
1381 |
<param name="x">Beta incomplete parameter</param> |
|
1382 |
<returns>Beta Incomplete value</returns> |
|
1383 |
</member> |
|
1384 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.Sort(System.Collections.Generic.IList{System.Double}@)"> |
|
1385 |
<summary> |
|
1386 |
Sort array of double values. |
|
1387 |
</summary> |
|
1388 |
<param name="values">Array of doubles which should be sorted.</param> |
|
1389 |
</member> |
|
1390 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.Median(System.Collections.Generic.IList{System.Double})"> |
|
1391 |
<summary> |
|
1392 |
Returns the median of the given numbers |
|
1393 |
</summary> |
|
1394 |
<param name="values">Array of double numbers</param> |
|
1395 |
<returns>Median</returns> |
|
1396 |
</member> |
|
1397 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.Mean(System.Collections.Generic.IList{System.Double})"> |
|
1398 |
<summary> |
|
1399 |
Calculates a Mean for a series of numbers. |
|
1400 |
</summary> |
|
1401 |
<param name="values">series with double numbers</param> |
|
1402 |
<returns>Returns Mean</returns> |
|
1403 |
</member> |
|
1404 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.Variance(System.Collections.Generic.IList{System.Double},System.Boolean)"> |
|
1405 |
<summary> |
|
1406 |
Calculates a Variance for a series of numbers. |
|
1407 |
</summary> |
|
1408 |
<param name="values">double values</param> |
|
1409 |
<param name="sampleVariance">If variance is calculated from sample sum has to be divided by n-1.</param> |
|
1410 |
<returns>Variance</returns> |
|
1411 |
</member> |
|
1412 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.StudentsDistribution(System.Double,System.Int32,System.Boolean)"> |
|
1413 |
<summary> |
|
1414 |
Calculates the Percentage Points (probability) for the Student |
|
1415 |
t-distribution. The t-distribution is used in the hypothesis |
|
1416 |
testing of small sample data sets. Use this function in place |
|
1417 |
of a table of critical values for the t-distribution. |
|
1418 |
</summary> |
|
1419 |
<param name="x">The numeric value at which to evaluate the distribution.</param> |
|
1420 |
<param name="n">An integer indicating the number of degrees of freedom.</param> |
|
1421 |
<param name="oneTailed">Specifies the number of distribution tails to return.</param> |
|
1422 |
<returns>Returns the Percentage Points (probability) for the Student t-distribution.</returns> |
|
1423 |
</member> |
|
1424 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.StandardNormalDistribution(System.Double)"> |
|
1425 |
<summary> |
|
1426 |
Returns the standard normal cumulative distribution |
|
1427 |
function. The distribution has a mean of 0 (zero) and |
|
1428 |
a standard deviation of one. Use this function in place |
|
1429 |
of a table of standard normal curve areas. |
|
1430 |
</summary> |
|
1431 |
<param name="zValue">The value for which you want the distribution.</param> |
|
1432 |
<returns>Returns the standard normal cumulative distribution.</returns> |
|
1433 |
</member> |
|
1434 |
<member name="M:GemBox.Spreadsheet.CalculationEngine.Functions.Calculators.StatisticalCalculator.StudentsDistributionInverse(System.Double,System.Int32)"> |
|
1435 |
<summary> |
내보내기 Unified diff