Updated LoadRicoClient for asp and php, so all asp and php examples are working again...
[infodrom/rico3] / bin / Rico.xml
1 <?xml version="1.0"?>\r
2 <doc>\r
3 <assembly>\r
4 <name>\r
5 Rico\r
6 </name>\r
7 </assembly>\r
8 <members>\r
9 <member name="P:Rico.TreeResponse.ErrorMsg">\r
10         <summary>\r
11  May contain the text of an error message that occurred outside this control prior to rendering\r
12  </summary>\r
13         <value></value>\r
14         <returns></returns>\r
15         <remarks></remarks>\r
16 </member><member name="P:Rico.TreeResponse.dbConnection">\r
17         <summary>\r
18  Database connection object. Required only if sqlText is used.\r
19  </summary>\r
20         <value></value>\r
21         <remarks></remarks>\r
22 </member><member name="P:Rico.TreeResponse.SqlText">\r
23         <summary>\r
24  Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters \r
25  </summary>\r
26         <value></value>\r
27         <returns></returns>\r
28         <remarks></remarks>\r
29 </member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">\r
30         <summary>\r
31  Adds an entry that will be returned with the results. Often used to add the root node.\r
32  </summary>\r
33         <param name="parentID">id of parent, "" if this is the root</param>\r
34         <param name="ID">id that uniquely identifies this node in the tree</param>\r
35         <param name="description">description displayed to the user</param>\r
36         <param name="containerORleaf">"L" or 0 = leaf, "C" or non-zero = container</param>\r
37         <param name="selectable">0=not selectable, 1=selectable</param>\r
38         <remarks></remarks>\r
39 </member><member name="T:Rico.TreeResponse">\r
40         <summary>\r
41  Use this class on a page that responds to AJAX requests from a Rico Tree Control\r
42  This class automatically disables caching of the response and sets the response type to text/xml\r
43  </summary>\r
44         <remarks></remarks>\r
45 </member><member name="T:Rico.sqlParse.sqlColumn">\r
46         <summary>\r
47  Represents a column in the select statement\r
48  </summary>\r
49 </member><member name="F:Rico.sqlParse.IsDistinct">\r
50         <summary>\r
51  True if the select statement contains the DISTINCT keyword\r
52  </summary>\r
53 </member><member name="F:Rico.sqlParse.SelectList">\r
54         <summary>\r
55  List of columns in the select statement\r
56  </summary>\r
57 </member><member name="F:Rico.sqlParse.GroupBy">\r
58         <summary>\r
59  List of "group by" items in the select statement\r
60  </summary>\r
61 </member><member name="F:Rico.sqlParse.OrderBy">\r
62         <summary>\r
63  List of "order by" items in the select statement\r
64  </summary>\r
65 </member><member name="F:Rico.sqlParse.FromClause">\r
66         <summary>\r
67  From clause of the select statement, including any joins\r
68  </summary>\r
69 </member><member name="F:Rico.sqlParse.WhereClause">\r
70         <summary>\r
71  Where clause of the select statement\r
72  </summary>\r
73 </member><member name="F:Rico.sqlParse.HavingClause">\r
74         <summary>\r
75  Having clause of the select statement\r
76  </summary>\r
77 </member><member name="F:Rico.sqlParse.Headings">\r
78         <summary>\r
79  List of column headings in the select list.\r
80  Set after an any unparse* call.\r
81  </summary>\r
82 </member><member name="M:Rico.sqlParse.Clone">\r
83         <summary>\r
84  Returns a cloned copy of this object\r
85  </summary>\r
86 </member><member name="M:Rico.sqlParse.UnparseSelect">\r
87         <summary>\r
88  Builds a SQL select statement string from its parsed components\r
89  </summary>\r
90 </member><member name="M:Rico.sqlParse.UnparseSelectDistinct">\r
91         <summary>\r
92  Rebuilds a SQL select statement that was parsed by ParseSelect, inserting the DISTINCT keyword\r
93  </summary>\r
94 </member><member name="M:Rico.sqlParse.UnparseDistinctColumnAccess(System.Int32)">\r
95         <summary>\r
96  Returns a SQL select statement that will return all of the values in a particular column.\r
97  This version is meant MS Access, as it does not support ordering by column name\r
98  </summary>\r
99         <param name="colnum"></param>\r
100 </member><member name="M:Rico.sqlParse.UnparseDistinctColumn(System.Int32)">\r
101         <summary>\r
102  Returns a SQL select statement that will return all of the values in a particular column.\r
103  The returned statement is not compatible MS Access, use UnparseDistinctColumnAccess() instead.\r
104  </summary>\r
105         <param name="colnum"></param>\r
106 </member><member name="M:Rico.sqlParse.UnparseColumnList">\r
107         <summary>\r
108  Returns the select list part of the statement as a string\r
109  </summary>\r
110         <returns></returns>\r
111         <remarks></remarks>\r
112 </member><member name="M:Rico.sqlParse.UnparseWithRowNumber(System.Int32,System.Int32,System.Boolean)">\r
113         <summary>\r
114  Returns a "windowed" select query.\r
115  </summary>\r
116         <param name="offset">The first row number to be returned</param>\r
117         <param name="numrows">The number of rows to return</param>\r
118         <param name="includeAS">use true for SQL Server 2005+ and false for Oracle</param>\r
119         <returns></returns>\r
120         <remarks></remarks>\r
121 </member><member name="M:Rico.sqlParse.Clear">\r
122         <summary>\r
123  Resets the object and prepares it to parse another select statement.\r
124  </summary>\r
125         <remarks></remarks>\r
126 </member><member name="M:Rico.sqlParse.ParseSelect(System.String)">\r
127         <summary>\r
128  Loads a select statement into the object.\r
129  Does not handle:\r
130  <list type="bullet">\r
131                         <item><description>union queries *</description></item>\r
132                         <item><description>select into</description></item>\r
133                         <item><description>select top</description></item>\r
134                         <item><description>more than one space between "group" and "by", or "order" and "by"</description></item>\r
135                         <item><description>stored procedures</description></item>\r
136                 </list>\r
137                 <para>* Put union queries in a view and then write your select statement against the view.</para>\r
138         </summary>\r
139         <param name="sqltext"></param>\r
140 </member><member name="T:Rico.sqlParse">\r
141         <summary>\r
142  Holds a SQL select statement. Methods to load/parse a select statement from a string and to reassemble it in various ways.\r
143  Does not handle union queries.\r
144  </summary>\r
145 </member><member name="P:Rico.SimpleCol.Width">\r
146         <summary>\r
147  Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.\r
148  </summary>\r
149 </member><member name="F:Rico.Column.canSort">\r
150         <summary>\r
151  Is the user allowed to sort the column? Default is true.\r
152  </summary>\r
153         <remarks></remarks>\r
154 </member><member name="F:Rico.Column.canDrag">\r
155         <summary>\r
156  Is the user allowed to drag a column value? Default is false.\r
157  </summary>\r
158         <remarks></remarks>\r
159 </member><member name="F:Rico.Column.canFilter">\r
160         <summary>\r
161  Is the user allowed to filter the column? Default is true.\r
162  </summary>\r
163         <remarks></remarks>\r
164 </member><member name="F:Rico.Column.control">\r
165         <summary>\r
166  Javascript code to create a control object, which changes the way the column data is rendered.\r
167  The disadvantage of using this approach is that the altered rendering does not get reflected in exports.\r
168  A set of controls is defined in ricoLiveGridControls.js or the developer can create their own.\r
169  </summary>\r
170         <remarks></remarks>\r
171 </member><member name="F:Rico.Column.filterUI">\r
172         <summary>\r
173  If the AutoFilter option is enabled for the grid, then filterUI will control how each column is filtered. If filterUI is:\r
174  <list type="bullet">\r
175                         <item><description>null or omitted, then no filter is displayed for the column.</description></item>\r
176                         <item><description>'t' - will generate a text box filter and the records being displayed are filtered as the user types. May be followed by a number to indicate the size of the text box (default size is 10). </description></item>\r
177                         <item><description>'s' - will generate a select list filter with all possible column values contained in the list. Populated using a 'select distinct' query if the grid's source is a SQL query.</description></item>\r
178                         <item><description>'m' - will generate multi-select checklist filter, with a checkbox text to each item.</description></item>\r
179                 </list>\r
180         </summary>\r
181         <remarks></remarks>\r
182 </member><member name="F:Rico.Column.filterColId">\r
183         <summary>\r
184  This setting allows the filterUI to filter a different column than where it is displayed.\r
185  This is particularly useful for dates, where you can show a year selection on an OrderDate date column for example,\r
186  but actually have it filter a hidden column OrderYear=year(OrderDate).\r
187  </summary>\r
188         <remarks></remarks>\r
189 </member><member name="F:Rico.Column.ConfirmDeleteColumn">\r
190         <summary>\r
191  The text content of this column will be included in delete confirmation messages.\r
192  </summary>\r
193         <remarks></remarks>\r
194 </member><member name="F:Rico.Column.multiplier">\r
195         <summary>\r
196  If column is a number, this value can be used to multiply the database value by a factor before displaying it in the grid.\r
197  Default is 1. Automatically set to 100 if DataType is percent.\r
198  </summary>\r
199         <remarks></remarks>\r
200 </member><member name="F:Rico.Column.decPlaces">\r
201         <summary>\r
202  If column is a number, this is the number of digits displayed to the right of the decimal point. Default is 0.\r
203  If DataType is dollar or euro, then decPlaces is automatically set to 2.\r
204  </summary>\r
205         <remarks></remarks>\r
206 </member><member name="F:Rico.Column.thouSep">\r
207         <summary>\r
208  If column is a number, display the value with a thousands separator? Default is true.\r
209  </summary>\r
210         <remarks></remarks>\r
211 </member><member name="F:Rico.Column.negSign">\r
212         <summary>\r
213  Specifies how negative numbers should be displayed. Possible values:\r
214  <list>\r
215                         <item><description>L=leading minus (default)</description></item>\r
216                         <item><description>T=trailing minus</description></item>\r
217                         <item><description>P=parentheses</description></item>\r
218                 </list>\r
219         </summary>\r
220 </member><member name="F:Rico.Column.prefix">\r
221         <summary>\r
222  If column is a number, this string is prepended to the number before display.\r
223  Useful for currency symbols.\r
224  </summary>\r
225 </member><member name="F:Rico.Column.suffix">\r
226         <summary>\r
227  If column is a number, this string is appended to the number before display.\r
228  Useful for percentages and temperature values. Automatically set to % if DataType is percent.\r
229  </summary>\r
230 </member><member name="F:Rico.Column.HdgStyleID">\r
231         <summary>\r
232  Used to give the column heading a specific style.\r
233  In most cases this is not necessary, as the heading will be styled according to the theme.\r
234  </summary>\r
235 </member><member name="F:Rico.Column.isNullable">\r
236         <summary>\r
237  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
238  </summary>\r
239 </member><member name="F:Rico.Column.Writeable">\r
240         <summary>\r
241  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
242  </summary>\r
243 </member><member name="F:Rico.Column.isKey">\r
244         <summary>\r
245  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
246  </summary>\r
247 </member><member name="F:Rico.Column.Length">\r
248         <summary>\r
249  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
250  </summary>\r
251 </member><member name="F:Rico.Column.TypeName">\r
252         <summary>\r
253  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
254  </summary>\r
255 </member><member name="F:Rico.Column.ColGroupIdx">\r
256         <summary>\r
257  For internal use\r
258  </summary>\r
259 </member><member name="P:Rico.Column.Heading">\r
260         <summary>\r
261  Text displayed in the column heading.\r
262  </summary>\r
263 </member><member name="P:Rico.Column.Width">\r
264         <summary>\r
265  Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.\r
266  </summary>\r
267 </member><member name="M:Rico.Column.NumberFormat">\r
268         <summary>\r
269  Returns an Excel-type number format string based on decPlaces, thouSep, prefix.\r
270  </summary>\r
271         <returns></returns>\r
272         <remarks></remarks>\r
273 </member><member name="P:Rico.Column.DataType">\r
274         <summary>\r
275  Type of data stored in the column.\r
276  </summary>\r
277         <value></value>\r
278         <returns></returns>\r
279         <remarks></remarks>\r
280 </member><member name="T:Rico.Column">\r
281         <summary>\r
282  Base class for a LiveGrid column\r
283  </summary>\r
284 </member><member name="F:Rico.EditCol.FormView">\r
285         <summary>\r
286                 <list type="table">\r
287                         <item><term>True</term><description>Item is shown on the entry form (default)</description></item>\r
288                         <item><term>False</term><description>Item is not shown on the form</description></item>\r
289                 </list>\r
290         </summary>\r
291 </member><member name="P:Rico.EditCol.EntryType">\r
292         <summary>\r
293  Code indicating the ui to be used for data entry\r
294  <list type="table">\r
295                         <item><term>TA</term><description>Text Area</description></item>\r
296                         <item><term>R</term><description>Radio button list</description></item>\r
297                         <item><term>RL</term><description>Radio buttons via lookup (field is a foreign key)</description></item>\r
298                         <item><term>S</term><description>Select list</description></item>\r
299                         <item><term>SL</term><description>Select list via lookup (field is a foreign key)</description></item>\r
300                         <item><term>CL</term><description>Custom widget via lookup (field is a foreign key)</description></item>\r
301                         <item><term>N</term><description>Select list of distinct column values, use allowed to add new values</description></item>\r
302                         <item><term>B</term><description>Text, non-blank</description></item>\r
303                         <item><term>T</term><description>Text</description></item>\r
304                         <item><term>I</term><description>Integer</description></item>\r
305                         <item><term>F</term><description>Floating point number</description></item>\r
306                         <item><term>tinyMCE</term><description>Rich text via tinyMCE</description></item>\r
307                         <item><term>D</term><description>Date</description></item>\r
308                         <item><term>TS</term><description>Time stamp</description></item>\r
309                         <item><term>H</term><description>Hidden</description></item>\r
310                 </list>\r
311         </summary>\r
312 </member><member name="F:Rico.LiveGridBase.largeBufferSize">\r
313         <summary>\r
314  controls size of client buffer and AJAX fetch size\r
315  </summary>\r
316 </member><member name="P:Rico.LiveGridBase.formVar">\r
317         <summary>\r
318  name of Javascript object containing LiveGrid Edit\r
319  </summary>\r
320 </member><member name="P:Rico.LiveGridBase.bufferVar">\r
321         <summary>\r
322  name of Javascript object containing LiveGrid buffer\r
323  </summary>\r
324 </member><member name="P:Rico.LiveGridBase.bufferOptVar">\r
325         <summary>\r
326  name of Javascript object containing initial LiveGrid buffer options\r
327  </summary>\r
328 </member><member name="F:Rico.LiveGridBase.SqlCompat">\r
329         <summary>\r
330  Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.\r
331  </summary>\r
332 </member><member name="P:Rico.LiveGridBase.rows">\r
333         <summary>\r
334  Number of visible rows in the grid.\r
335  Negative values have the following meanings:\r
336  <list type="bullet">\r
337                         <item><description>-1: size grid to client window</description></item>\r
338                         <item><description>-2: size grid to whichever is smaller: the client window or the data</description></item>\r
339                         <item><description>-3: size grid so that the page body does not have a scrollbar (default)</description></item>\r
340                         <item><description>-4: size grid to its parent node in the DOM</description></item>\r
341                 </list>\r
342         </summary>\r
343 </member><member name="F:Rico.LiveGridBase.ColGroups">\r
344         <summary>\r
345  Collection of ColumnGroup objects, which define the headings used above each group of columns.\r
346  </summary>\r
347         <remarks></remarks>\r
348 </member><member name="F:Rico.LiveGridBase.Tables">\r
349         <summary>\r
350  Defines the tables used by the LiveGrid. The first table is primary/main table.\r
351  </summary>\r
352         <remarks></remarks>\r
353 </member><member name="M:Rico.LiveGridBase.ColClassName(System.Int32)">\r
354         <summary>\r
355  Returns the class name of the specified grid column\r
356  </summary>\r
357         <param name="colnum"></param>\r
358         <returns></returns>\r
359         <remarks></remarks>\r
360 </member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">\r
361         <summary>\r
362  Adds a new column to grid, returns column index\r
363  </summary>\r
364         <param name="ColumnObj"></param>\r
365 </member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">\r
366         <summary>\r
367  Takes a given string and makes it JSON valid (http://json.org/)\r
368  </summary>\r
369         <param name="val">value which should be escaped</param>\r
370         <returns>JSON valid string</returns>\r
371         <remarks>\r
372  AUTHOR: Michael Rebec\r
373  All characters which needs to be escaped are beeing replaced by their\r
374  unicode representation according to the\r
375  RFC4627#2.5 - http://www.ietf.org/rfc/rfc4627.txt?number=4627\r
376  </remarks>\r
377 </member><member name="T:Rico.LiveGridBase">\r
378         <summary>\r
379  Methods and properties common to LiveGrid and LiveGridEdit\r
380  </summary>\r
381 </member><member name="P:Rico.LiveGrid.BufferType">\r
382         <summary>\r
383  The type of buffer deployed on the client\r
384  <list type="table">\r
385                         <item><term>AjaxSQL</term><description>data source is a SQL database query</description></item>\r
386                         <item><term>AjaxLoadOnce</term><description>data is loaded once from a remote source, such as an XML file</description></item>\r
387                         <item><term>Base</term><description>data is static, loaded from either an html table or javascript array</description></item>\r
388                 </list>\r
389         </summary>\r
390 </member><member name="P:Rico.LiveGrid.HtmlSourceId">\r
391         <summary>\r
392  If grid is populated from an html table, then set HtmlSourceId to the id of the source table\r
393  </summary>\r
394 </member><member name="P:Rico.LiveGrid.QueryDistinct">\r
395         <summary>\r
396  True if this should be a distinct sql query (default is false)\r
397  </summary>\r
398 </member><member name="T:Rico.LiveGrid">\r
399         <summary>\r
400  Class to define a LiveGrid\r
401  </summary>\r
402 </member><member name="M:Rico.TableCollection.IndexOf(System.String)">\r
403         <summary>\r
404  Returns the index of the table with TblAlias or -1 if not found\r
405  </summary>\r
406         <param name="TblAlias"></param>\r
407 </member><member name="P:Rico.GridBase.gridVar">\r
408         <summary>\r
409  Name of grid Javascript object\r
410  </summary>\r
411 </member><member name="P:Rico.GridBase.optionsVar">\r
412         <summary>\r
413  Name of grid options Javascript object\r
414  </summary>\r
415 </member><member name="F:Rico.GridBase.AutoFilter">\r
416         <summary>\r
417  If enabled, an additional row is added to the grid header where column filters are placed. \r
418  See the EditCol.filterUI property to customize each column's filter.\r
419  </summary>\r
420 </member><member name="F:Rico.GridBase.FilterAllToken">\r
421         <summary>\r
422  The token in select filters used to indicate "show all values" (default: "___ALL___").\r
423  </summary>\r
424 </member><member name="F:Rico.GridBase.defaultWidth">\r
425         <summary>\r
426  if -1 (default), then use column heading width, otherwise this is the default width in pixels\r
427  </summary>\r
428 </member><member name="F:Rico.GridBase.allowColResize">\r
429         <summary>\r
430  Allow user to resize columns? Default is true.\r
431  </summary>\r
432 </member><member name="F:Rico.GridBase.frozenColumns">\r
433         <summary>\r
434  Number of frozen columns on the left (or right if direction=rtl). Default is 0.\r
435  </summary>\r
436 </member><member name="F:Rico.GridBase.RowLineHtEms">\r
437         <summary>\r
438  Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.\r
439  </summary>\r
440 </member><member name="F:Rico.GridBase.windowResize">\r
441         <summary>\r
442  Resize grid when browser window is resized? Default is true.\r
443  </summary>\r
444 </member><member name="P:Rico.GridBase.menuEvent">\r
445         <summary>\r
446  Specifies when the grid's popup menu should be invoked \r
447  </summary>\r
448 </member><member name="P:Rico.GridBase.DefaultStyle">\r
449         <summary>\r
450  Style used for the entire grid - headings and data.\r
451  </summary>\r
452 </member><member name="P:Rico.GridBase.DefaultHdgStyle">\r
453         <summary>\r
454  This holds the default style for headings. Use only if not using themes.\r
455  </summary>\r
456 </member><member name="F:Rico.GridBase.Styles">\r
457         <summary>\r
458  Collection of styles used for individual headings.\r
459  </summary>\r
460 </member><member name="P:Rico.GridBase.HdgRowLines">\r
461         <summary>\r
462  Lines of text displayed in each heading row\r
463  </summary>\r
464 </member><member name="P:Rico.GridBase.DefaultRowLines">\r
465         <summary>\r
466  Lines of text displayed in each data row\r
467  </summary>\r
468 </member><member name="P:Rico.GridBase.OuterDivId">\r
469         <summary>\r
470  Returns the id of the outermost grid container\r
471  </summary>\r
472 </member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">\r
473         <summary>\r
474  Returns the index of the column with the given id\r
475  </summary>\r
476 </member><member name="M:Rico.GridBase.GetColumn(System.String)">\r
477         <summary>\r
478  Returns the column object with the given id\r
479  </summary>\r
480 </member><member name="M:Rico.GridBase.GridRules">\r
481         <summary>\r
482  Returns the set of css rules that apply to this grid\r
483  </summary>\r
484 </member><member name="T:Rico.GridBase">\r
485         <summary>\r
486  This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.\r
487  </summary>\r
488 </member><member name="P:Rico.StyleBase.bold">\r
489         <summary>\r
490  True if the text should be displayed using a bold font\r
491  </summary>\r
492 </member><member name="P:Rico.StyleBase.italic">\r
493         <summary>\r
494  True if the text should be displayed in italics\r
495  </summary>\r
496 </member><member name="P:Rico.StyleBase.underline">\r
497         <summary>\r
498  True if the text should be underlined\r
499  </summary>\r
500 </member><member name="P:Rico.StyleBase.fontsize">\r
501         <summary>\r
502  Font size in points\r
503  </summary>\r
504 </member><member name="P:Rico.StyleBase.GridOnly">\r
505         <summary>\r
506  If true, then style is only applied to the grid, not to html or Excel exports\r
507  </summary>\r
508 </member><member name="P:Rico.StyleBase.BackColor">\r
509         <summary>\r
510  Specifies the background color. One of the 16 standard color names, or #rrggbb.\r
511  </summary>\r
512 </member><member name="P:Rico.StyleBase.ForeColor">\r
513         <summary>\r
514  Specifies the font color. One of the 16 standard color names, or #rrggbb.\r
515  </summary>\r
516 </member><member name="P:Rico.StyleBase.HorizontalAlign">\r
517         <summary>\r
518  Specifies horizontal alignment: Left, Right, Center, or NotSet (default)\r
519  </summary>\r
520 </member><member name="P:Rico.StyleBase.Overflow">\r
521         <summary>\r
522  Normally, overflowed content is hidden, but this allows content in the cell to scroll.\r
523  Only applies to the grid, not to exports.\r
524  </summary>\r
525 </member><member name="P:Rico.StyleBase.CssStyle">\r
526         <summary>\r
527  Used internally. Returns the style properties as a css string.\r
528  </summary>\r
529 </member><member name="M:Rico.StyleBase.UnwrappedXlStyle">\r
530         <summary>\r
531  Used internally. Returns the style properties as an Excel XML string without the style tag.\r
532  </summary>\r
533 </member><member name="T:Rico.StyleBase">\r
534         <summary>\r
535  Base class for all style classes as well as the Column class.\r
536  </summary>\r
537 </member><member name="P:Rico.Style.StyleID">\r
538         <summary>\r
539  StyleID's should not contain spaces or other special characters.\r
540  <list type="bullet">\r
541                         <item><description>Use a StyleID of Default to style the entire grid</description></item>\r
542                         <item><description>Use a StyleID of DefaultHdg to style the grid heading</description></item>\r
543                         <item><description>Use a StyleID of ricoLG_evenRow and/or ricoLG_oddRow to stripe the grid (striping does not get exported).</description></item>\r
544                         <item><description>Use a StyleID of ricoLG_selection to set the styling for the selected row.</description></item>\r
545                 </list>\r
546         </summary>\r
547 </member><member name="M:Rico.Style.CssRule">\r
548         <summary>\r
549  Returns the style properties as a CSS rule\r
550  </summary>\r
551 </member><member name="M:Rico.Style.WrappedXlStyle">\r
552         <summary>\r
553  Returns the style properties as an Excel XML style, including the style tag\r
554  </summary>\r
555 </member><member name="P:Rico.Style.xlNumberFormat">\r
556         <summary>\r
557  For SimpleGrids only\r
558  </summary>\r
559 </member><member name="P:Rico.Style.NumberFormat">\r
560         <summary>\r
561  For SimpleGrids only\r
562  </summary>\r
563 </member><member name="M:Rico.Style.WrappedXlStyleNF">\r
564         <summary>\r
565  Returns the style properties plus number format as an Excel XML style, including the style tag\r
566  </summary>\r
567 </member><member name="T:Rico.Style">\r
568         <summary>\r
569  Defines a style that can be applied to a grid cell.\r
570  Using a StyleID of ricoLG_evenRow or ricoLG_oddRow will stripe the grid, however striping does not get exported.\r
571  Using a StyleID of ricoLG_selection will set the styling for the selected row.\r
572  </summary>\r
573 </member><member name="M:Rico.StyleDictionary.Add(Rico.Style)">\r
574         <summary>\r
575  Adds a Style object to the collection\r
576  </summary>\r
577         <param name="new_style"></param>\r
578 </member><member name="P:Rico.StyleDictionary.Item(System.String)">\r
579         <summary>\r
580  Returns a Style object from the collection based on the style's StyleID\r
581  </summary>\r
582         <param name="StyleId"></param>\r
583 </member><member name="P:Rico.StyleDictionary.Keys">\r
584         <summary>\r
585  Returns all of the StyleID's in the collection\r
586  </summary>\r
587 </member><member name="P:Rico.StyleDictionary.Values">\r
588         <summary>\r
589  Returns all of the Style objects in the collection\r
590  </summary>\r
591 </member><member name="M:Rico.StyleDictionary.Contains(System.String)">\r
592         <summary>\r
593  Returns true if the StyleID is in the collection\r
594  </summary>\r
595         <param name="StyleId"></param>\r
596 </member><member name="M:Rico.StyleDictionary.Remove(System.String)">\r
597         <summary>\r
598  Removes the Style object with the given StyleID from the collection\r
599  </summary>\r
600         <param name="StyleId"></param>\r
601 </member><member name="T:Rico.StyleDictionary">\r
602         <summary>\r
603  Container for a collection of Style objects\r
604  </summary>\r
605 </member><member name="F:Rico.LoadClient.ImgHeading">\r
606         <summary>\r
607  Background image for grid headings and window titles.\r
608  Should be left unset, as it is used only for the grayedout theme (in which case it is set automatically).\r
609  </summary>\r
610 </member><member name="F:Rico.LoadClient.BaseLib">\r
611         <summary>\r
612  The base Javascript library to load from http://ajax.googleapis.com/ajax/libs/, possible values include:\r
613  <list type="bullet">\r
614                         <item><description>prototype/1.6/prototype.js</description></item>\r
615                         <item><description>prototype/1.7/prototype.js</description></item>\r
616                         <item><description>jquery/1.3/jquery.min.js</description></item>\r
617                         <item><description>jquery/1.4/jquery.min.js</description></item>\r
618                         <item><description>jquery/1.5/jquery.min.js</description></item>\r
619                         <item><description>jquery/1.6/jquery.min.js</description></item>\r
620                         <item><description>mootools/1.2/mootools-yui-compressed.js</description></item>\r
621                         <item><description>mootools/1.3/mootools-yui-compressed.js</description></item>\r
622                         <item><description>dojo/1.5/dojo/dojo.xd.js</description></item>\r
623                         <item><description>dojo/1.6/dojo/dojo.xd.js</description></item>\r
624                         <item><description>ext-core/3.0/ext-core.js</description></item>\r
625                         <item><description>ext-core/3.1/ext-core.js</description></item>\r
626                 </list>\r
627                 <para>Default value is "proto_min", which loads prototype 1.7 from the server control.</para>\r
628         </summary>\r
629 </member><member name="F:Rico.LoadClient.Logging">\r
630         <summary>\r
631  Enable Javascript console logging? Useful for debugging. Default is false.\r
632  </summary>\r
633 </member><member name="F:Rico.LoadClient.HTML5">\r
634         <summary>\r
635  Enable HTML5 web form elements in browsers that support them. \r
636  Default is false because the quality of the HTML5 web form elements is uneven across browsers.\r
637  </summary>\r
638 </member><member name="F:Rico.LoadClient.Language">\r
639         <summary>\r
640  Best left unset, in which case language will be set automatically based on request's HTTP_ACCEPT_LANGUAGE\r
641  However, if you want to present the same locale settings to all users, then you can set this value to force the desired locale.\r
642  </summary>\r
643 </member><member name="F:Rico.LoadClient.LoadBaseLib">\r
644         <summary>\r
645  Load base Javascript library (prototype, jQuery, etc)?\r
646  Default is true.\r
647  Set to false if library is being loaded another way. In this case, a BaseLib value is still required to indicate\r
648  which library Rico should connect to.\r
649  </summary>\r
650 </member><member name="F:Rico.LoadClient.Striping">\r
651         <summary>\r
652  Apply row striping to LiveGrids? Default is true. Applies only when themes are used.\r
653  </summary>\r
654 </member><member name="F:Rico.LoadClient.SupportedLangs">\r
655         <summary>\r
656  Comma separated list of 2 letter locales that Rico supports.\r
657  Do not set unless you have developed your own locale file.\r
658  </summary>\r
659 </member><member name="F:Rico.LoadClient.jQueryThemePath">\r
660         <summary>\r
661  URL to load jQuery themes from.\r
662  Default is http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/\r
663  Override this value if you have a jQuery theme on your own server.\r
664  </summary>\r
665 </member><member name="P:Rico.LoadClient.LoadedLanguage">\r
666         <summary>\r
667  Returns the 2 character string representing the Rico locale file that was actually used on the client.\r
668  If there is no match between the requested languages and the available locale files, then english is used.\r
669  Only available during the render phase.\r
670  </summary>\r
671 </member><member name="P:Rico.LoadClient.checkQueryString">\r
672         <summary>\r
673  Load settings from QueryString?  true for demo, false for anything else. Default is false.\r
674  </summary>\r
675 </member><member name="P:Rico.LoadClient.checkWebConfig">\r
676         <summary>\r
677  Load settings from web.config file? Default is false.\r
678  If true, then the appSettings section of web.config will be checked for the following keys (which affect the similarly named properties):\r
679  <list type="bullet">\r
680                         <item><description>rico_BaseLib</description></item>\r
681                         <item><description>rico_Language</description></item>\r
682                         <item><description>rico_jTheme</description></item>\r
683                         <item><description>rico_rTheme</description></item>\r
684                         <item><description>rico_Logging</description></item>\r
685                         <item><description>rico_HTML5</description></item>\r
686                         <item><description>rico_LoadBaseLib</description></item>\r
687                         <item><description>rico_Striping</description></item>\r
688                 </list>\r
689                 <para>Boolean values in web.config should be the strings "true" or "1" for true, and "false" or "0" for false.</para>\r
690         </summary>\r
691 </member><member name="M:Rico.LoadClient.InitLiveGrids(System.Web.UI.HtmlTextWriter)">\r
692         <summary>\r
693  Initialize all grids on the page\r
694  Initialize grids with fixed # of rows first,\r
695  then initialize grids with variable # of rows\r
696  </summary>\r
697 </member><member name="P:Rico.LoadClient.jTheme">\r
698         <summary>\r
699  Set theme to one of the jQuery Themeroller themes. Default is no theme.\r
700  Valid values are:\r
701    black-tie, blitzer, cupertino, dark-hive, dot-luv, eggplant, excite-bike, flick, \r
702    hot-sneaks, humanity, le-frog, mint-choc, overcast, pepper-grinder, redmond, smoothness, \r
703    south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader\r
704  </summary>\r
705 </member><member name="P:Rico.LoadClient.rTheme">\r
706         <summary>\r
707  Set theme to one of the Rico themes. Default is no theme.\r
708  Valid values are:\r
709    coffee-with-milk, grayedout, greenHdg, seaglass, warmfall\r
710  </summary>\r
711 </member><member name="T:Rico.LoadClient">\r
712         <summary>\r
713  Loads the various Javascript, CSS, and image files required to make Rico function.\r
714  </summary>\r
715 </member><member name="P:Rico.My.Resources.Resources.ResourceManager">\r
716         <summary>\r
717   Returns the cached ResourceManager instance used by this class.\r
718 </summary>\r
719 </member><member name="P:Rico.My.Resources.Resources.Culture">\r
720         <summary>\r
721   Overrides the current thread's CurrentUICulture property for all\r
722   resource lookups using this strongly typed resource class.\r
723 </summary>\r
724 </member><member name="T:Rico.My.Resources.Resources">\r
725         <summary>\r
726   A strongly-typed resource class, for looking up localized strings, etc.\r
727 </summary>\r
728 </member><member name="T:Rico.SimpleGrid">\r
729         <summary>\r
730  Class to define a SimpleGrid\r
731  </summary>\r
732 </member>\r
733 </members>\r
734 </doc>