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