Fixed php examples and plugins so no warnings are given with the latest versions...
[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="T:Rico.sqlParse.sqlColumn">\r
10         <summary>\r
11  Represents a column in the select statement\r
12  </summary>\r
13 </member><member name="F:Rico.sqlParse.IsDistinct">\r
14         <summary>\r
15  True if the select statement contains the DISTINCT keyword\r
16  </summary>\r
17 </member><member name="F:Rico.sqlParse.SelectList">\r
18         <summary>\r
19  List of columns in the select statement\r
20  </summary>\r
21 </member><member name="F:Rico.sqlParse.GroupBy">\r
22         <summary>\r
23  List of "group by" items in the select statement\r
24  </summary>\r
25 </member><member name="F:Rico.sqlParse.OrderBy">\r
26         <summary>\r
27  List of "order by" items in the select statement\r
28  </summary>\r
29 </member><member name="F:Rico.sqlParse.FromClause">\r
30         <summary>\r
31  From clause of the select statement, including any joins\r
32  </summary>\r
33 </member><member name="F:Rico.sqlParse.WhereClause">\r
34         <summary>\r
35  Where clause of the select statement\r
36  </summary>\r
37 </member><member name="F:Rico.sqlParse.HavingClause">\r
38         <summary>\r
39  Having clause of the select statement\r
40  </summary>\r
41 </member><member name="F:Rico.sqlParse.Headings">\r
42         <summary>\r
43  List of column headings in the select list.\r
44  Set after an any unparse* call.\r
45  </summary>\r
46 </member><member name="M:Rico.sqlParse.Clone">\r
47         <summary>\r
48  Returns a cloned copy of this object\r
49  </summary>\r
50 </member><member name="M:Rico.sqlParse.UnparseSelect">\r
51         <summary>\r
52  Builds a SQL select statement string from its parsed components\r
53  </summary>\r
54 </member><member name="M:Rico.sqlParse.UnparseSelectDistinct">\r
55         <summary>\r
56  Rebuilds a SQL select statement that was parsed by ParseSelect, inserting the DISTINCT keyword\r
57  </summary>\r
58 </member><member name="M:Rico.sqlParse.UnparseDistinctColumnAccess(System.Int32)">\r
59         <summary>\r
60  Returns a SQL select statement that will return all of the values in a particular column.\r
61  This version is meant MS Access, as it does not support ordering by column name\r
62  </summary>\r
63         <param name="colnum"></param>\r
64 </member><member name="M:Rico.sqlParse.UnparseDistinctColumn(System.Int32)">\r
65         <summary>\r
66  Returns a SQL select statement that will return all of the values in a particular column.\r
67  The returned statement is not compatible MS Access, use UnparseDistinctColumnAccess() instead.\r
68  </summary>\r
69         <param name="colnum"></param>\r
70 </member><member name="M:Rico.sqlParse.UnparseColumnList">\r
71         <summary>\r
72  Returns the select list part of the statement as a string\r
73  </summary>\r
74         <returns></returns>\r
75 </member><member name="M:Rico.sqlParse.UnparseWithRowNumber(System.Int32,System.Int32,System.Boolean)">\r
76         <summary>\r
77  Returns a "windowed" select query.\r
78  </summary>\r
79         <param name="offset">The first row number to be returned</param>\r
80         <param name="numrows">The number of rows to return</param>\r
81         <param name="includeAS">use true for SQL Server 2005+ and false for Oracle</param>\r
82         <returns></returns>\r
83 </member><member name="M:Rico.sqlParse.Clear">\r
84         <summary>\r
85  Resets the object and prepares it to parse another select statement.\r
86  </summary>\r
87 </member><member name="M:Rico.sqlParse.ParseSelect(System.String)">\r
88         <summary>\r
89  Loads a select statement into the object.\r
90  Does not handle:\r
91  <list type="bullet">\r
92                         <item><description>union queries *</description></item>\r
93                         <item><description>select into</description></item>\r
94                         <item><description>select top</description></item>\r
95                         <item><description>more than one space between "group" and "by", or "order" and "by"</description></item>\r
96                         <item><description>stored procedures</description></item>\r
97                 </list>\r
98                 <para>* Put union queries in a view and then write your select statement against the view.</para>\r
99         </summary>\r
100         <param name="sqltext"></param>\r
101 </member><member name="M:Rico.sqlParse.SetSort(System.String)">\r
102         <summary>\r
103  Specifies the way the query results should be sorted.\r
104  Can specify multiple columns separated by commas. Cannot be used to specify a calculation that contains commas.\r
105  </summary>\r
106         <param name="SortSpecCSV"></param>\r
107 </member><member name="M:Rico.sqlParse.AddSort(System.String)">\r
108         <summary>\r
109  Add a single sort criteria to the beginning of the order by clause\r
110  </summary>\r
111         <param name="NewSort">A single column name or column index followed by the sort direction</param>\r
112 </member><member name="T:Rico.sqlParse">\r
113         <summary>\r
114  Holds a SQL select statement. Methods to load/parse a select statement from a string and to reassemble it in various ways.\r
115  Does not handle union queries.\r
116  </summary>\r
117 </member><member name="P:Rico.My.Resources.Resources.ResourceManager">\r
118         <summary>\r
119   Returns the cached ResourceManager instance used by this class.\r
120 </summary>\r
121 </member><member name="P:Rico.My.Resources.Resources.Culture">\r
122         <summary>\r
123   Overrides the current thread's CurrentUICulture property for all\r
124   resource lookups using this strongly typed resource class.\r
125 </summary>\r
126 </member><member name="T:Rico.My.Resources.Resources">\r
127         <summary>\r
128   A strongly-typed resource class, for looking up localized strings, etc.\r
129 </summary>\r
130 </member><member name="M:Rico.TableCollection.IndexOf(System.String)">\r
131         <summary>\r
132  Returns the index of the table with TblAlias or -1 if not found\r
133  </summary>\r
134         <param name="TblAlias"></param>\r
135 </member><member name="F:Rico.LiveGridBase.dbConnection">\r
136         <summary>\r
137  Database connection object (used when data source is a SQL query)\r
138  </summary>\r
139 </member><member name="P:Rico.LiveGridBase.canSortDefault">\r
140         <summary>\r
141  Controls whether columns can be sorted (default: true). \r
142  Sorting can be disabled for individual columns using the canSort property.\r
143  </summary>\r
144 </member><member name="P:Rico.LiveGridBase.canHideDefault">\r
145         <summary>\r
146  Controls whether columns can be hidden/shown (default: true). \r
147  Hide/show can be disabled for individual columns using the canHide property.\r
148  </summary>\r
149 </member><member name="P:Rico.LiveGridBase.canFilterDefault">\r
150         <summary>\r
151  Controls whether columns can be filtered (default: true). \r
152  Filtering can be disabled for individual columns using the canFilter property.\r
153  </summary>\r
154 </member><member name="P:Rico.LiveGridBase.highlightElem">\r
155         <summary>\r
156  A string that specifies what gets highlighted/selected in the grid\r
157  <list type="table">\r
158                         <item><term>cursorRow</term><description>the grid row under the cursor</description></item>\r
159                         <item><term>cursorCell</term><description>the grid cell under the cursor</description></item>\r
160                         <item><term>menuRow</term><description>the grid row where the menu is displayed (default)</description></item>\r
161                         <item><term>menuCell</term><description>the grid cell where the menu is displayed</description></item>\r
162                         <item><term>selection</term><description>allow the user to select cells</description></item>\r
163                         <item><term>none</term><description>never highlight</description></item>\r
164                 </list>\r
165         </summary>\r
166 </member><member name="P:Rico.LiveGridBase.highlightMethod">\r
167         <summary>\r
168  Method used to highlight cells and rows.\r
169  <list type="table">\r
170                         <item><term>outline</term><description>least CPU-intensive on client-side</description></item>\r
171                         <item><term>class</term><description>adds CSS class to highlighted cell/row (default)</description></item>\r
172                         <item><term>both</term><description>highlight using both outline and class</description></item>\r
173                 </list>\r
174         </summary>\r
175 </member><member name="P:Rico.LiveGridBase.prefetchBuffer">\r
176         <summary>\r
177  Load the buffer (and therefore the grid) on page load? (default: true)\r
178  </summary>\r
179 </member><member name="P:Rico.LiveGridBase.DisplayTimer">\r
180         <summary>\r
181  Display the session timer above the grid? (default: true)\r
182  </summary>\r
183 </member><member name="P:Rico.LiveGridBase.DisplayBookmark">\r
184         <summary>\r
185  Display the grid bookmark, ie. "Listing records X - Y of Z" (default: true)\r
186  </summary>\r
187 </member><member name="P:Rico.LiveGridBase.Caption">\r
188         <summary>\r
189  A caption for the grid, displayed next to the bookmark (default: nothing)\r
190  </summary>\r
191 </member><member name="P:Rico.LiveGridBase.click">\r
192         <summary>\r
193  Javascript event handler called when the user left-clicks on a cell\r
194  </summary>\r
195 </member><member name="P:Rico.LiveGridBase.dblclick">\r
196         <summary>\r
197  Javascript event handler called when the user double-clicks on a cell\r
198  </summary>\r
199 </member><member name="P:Rico.LiveGridBase.contextmenu">\r
200         <summary>\r
201  Javascript event handler called when the user right-clicks on a cell\r
202  </summary>\r
203 </member><member name="P:Rico.LiveGridBase.beforeInit">\r
204         <summary>\r
205  A Javascript function to be called right before the grid is initialized.\r
206  </summary>\r
207 </member><member name="P:Rico.LiveGridBase.afterInit">\r
208         <summary>\r
209  A Javascript function to be called right after the grid is initialized.\r
210  </summary>\r
211 </member><member name="P:Rico.LiveGridBase.TableFilter">\r
212         <summary>\r
213  For SQL data sources, this specifies a SQL condition clause to always be used when running the SQL query.\r
214  </summary>\r
215 </member><member name="P:Rico.LiveGridBase.saveColumnWidth">\r
216         <summary>\r
217  Whenever the user adjusts a column width, should the new width be saved to the grid's cookie? (default: true)\r
218  </summary>\r
219 </member><member name="P:Rico.LiveGridBase.saveColumnFilter">\r
220         <summary>\r
221  Whenever the user filters a column, should the new filter be saved to the grid's cookie? (default: false)\r
222  </summary>\r
223 </member><member name="P:Rico.LiveGridBase.saveColumnSort">\r
224         <summary>\r
225  Whenever the user sorts a column, should the new sort be saved to the grid's cookie? (default: false)\r
226  </summary>\r
227 </member><member name="P:Rico.LiveGridBase.cookieDays">\r
228         <summary>\r
229  Number of days before the grid's cookie expires. If you don't specify a value, \r
230  then the cookie is only maintained for the current session.\r
231  </summary>\r
232 </member><member name="P:Rico.LiveGridBase.DefaultSort">\r
233         <summary>\r
234  For SQL data sources, this specifies the default way the data should be sorted. (default: use primary key)\r
235  Can specify multiple columns separated by commas. Cannot be used to specify a calculation that contains commas.\r
236  </summary>\r
237 </member><member name="P:Rico.LiveGridBase.maxPrint">\r
238         <summary>\r
239  The maximum number of rows that the user is allowed to Print/Export. Set to 0 to disable print/export.\r
240  Default is to use the Rico client value (currently 5000).\r
241  </summary>\r
242 </member><member name="P:Rico.LiveGridBase.dndMgrIdx">\r
243         <summary>\r
244  Specifies which drag-and-drop management zone should be used for drag operations (default: 0). \r
245  This only needs to be specified if the web page uses multiple distinct zones.\r
246  </summary>\r
247 </member><member name="P:Rico.LiveGridBase.sessions">\r
248         <summary>\r
249  For SQL data sources, should the parsed query be stored in a session variable? This improves performance. (default: true)\r
250  </summary>\r
251 </member><member name="P:Rico.LiveGridBase.minPageRows">\r
252         <summary>\r
253  Minimum # of visible rows. Used only when visibleRows &lt; 0. (default: 2)\r
254  </summary>\r
255 </member><member name="P:Rico.LiveGridBase.maxPageRows">\r
256         <summary>\r
257  Maximum # of visible rows. Used only when visibleRows &lt; 0. (default: 50)\r
258  </summary>\r
259 </member><member name="P:Rico.LiveGridBase.ColGroupsOnTabHdr">\r
260         <summary>\r
261  Set to 'true' for ColumnGroup labels to be used as secondary headings. \r
262  In LiveGrid Edit, it may be set to 'false' so that ColumnGroup labels are only used on the input form.\r
263  Default: true.\r
264  </summary>\r
265 </member><member name="P:Rico.LiveGridBase.sendDebugMsgs">\r
266         <summary>\r
267  Send details of sql parsing/execution in ajax response? (true/false)\r
268  Default is to follow the debug value in web.config\r
269  </summary>\r
270 </member><member name="P:Rico.LiveGridBase.LogSqlOnError">\r
271         <summary>\r
272  Include sql statement in results if an error occurs (true/false)\r
273  Default is to follow the debug value in web.config\r
274  </summary>\r
275 </member><member name="P:Rico.LiveGridBase.fmt">\r
276         <summary>\r
277  Format of data returned by AJAX calls, either "xml" or "json" (defaul: xml).\r
278  </summary>\r
279 </member><member name="P:Rico.LiveGridBase.largeBufferSize">\r
280         <summary>\r
281  This property influences the size of the client buffer and AJAX fetch size.\r
282  Default value is -1, which means use the Rico client default value.\r
283  </summary>\r
284 </member><member name="P:Rico.LiveGridBase.requestParameters">\r
285         <summary>\r
286  Optional parameters to be passed along during the AJAX call\r
287  </summary>\r
288 </member><member name="P:Rico.LiveGridBase.formVar">\r
289         <summary>\r
290  Name of the Javascript variable containing the LiveGrid Edit object\r
291  </summary>\r
292 </member><member name="P:Rico.LiveGridBase.bufferVar">\r
293         <summary>\r
294  Name of the Javascript variable containing the LiveGrid buffer object\r
295  </summary>\r
296 </member><member name="P:Rico.LiveGridBase.bufferOptVar">\r
297         <summary>\r
298  Name of the Javascript variable containing the initial LiveGrid buffer options\r
299  </summary>\r
300 </member><member name="F:Rico.LiveGridBase.SqlCompat">\r
301         <summary>\r
302  Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.\r
303  </summary>\r
304 </member><member name="P:Rico.LiveGridBase.dbDialect">\r
305         <summary>\r
306  When connecting to SQL databases, this is the SQL dialect to use.\r
307  </summary>\r
308 </member><member name="P:Rico.LiveGridBase.dataProvider">\r
309         <summary>\r
310  When using a SQL data source there is no need to set this property, \r
311  as AJAX data fetches are sent back to the originating script by default.\r
312  When setting this property to a URL, make sure the URL is enclosed in single quotes.\r
313  If not enclosed in quotes, it is treated as the name of a Javascript function.\r
314  </summary>\r
315 </member><member name="P:Rico.LiveGridBase.rows">\r
316         <summary>\r
317  Number of visible rows in the grid.\r
318  Negative values have the following meanings:\r
319  <list type="bullet">\r
320                         <item><description>-1: size grid to client window</description></item>\r
321                         <item><description>-2: size grid to whichever is smaller: the client window or the data</description></item>\r
322                         <item><description>-3: size grid so that the page body does not have a scrollbar (default)</description></item>\r
323                         <item><description>-4: size grid to its parent node in the DOM</description></item>\r
324                 </list>\r
325         </summary>\r
326 </member><member name="P:Rico.LiveGridBase.action">\r
327         <summary>\r
328  Returns a string indicating the current action being taken by the grid control.\r
329  <list type="bullet">\r
330                         <item><description>table: default action. If no other grid on the page is processing an AJAX request, then this grid will be rendered to the client with a combination of html, css, and javascript.</description></item>\r
331                         <item><description>query: grid will process an AJAX query request during the prerender phase. This includes exports to Excel or HTML.</description></item>\r
332                         <item><description>ins: grid will process an AJAX insert record request during the prerender phase (LiveGridEdit only).</description></item>\r
333                         <item><description>upd: grid will process an AJAX update record request during the prerender phase (LiveGridEdit only).</description></item>\r
334                         <item><description>del: grid will process an AJAX delete record request during the prerender phase (LiveGridEdit only).</description></item>\r
335                 </list>\r
336         </summary>\r
337 </member><member name="P:Rico.LiveGridBase.IsAjaxRequest">\r
338         <summary>\r
339  Returns true if the grid is processing an AJAX request.\r
340  </summary>\r
341 </member><member name="P:Rico.LiveGridBase.CurrentField">\r
342         <summary>\r
343  Returns the column object for the last column in the grid.\r
344  </summary>\r
345 </member><member name="F:Rico.LiveGridBase.ColGroups">\r
346         <summary>\r
347  Collection of ColumnGroup objects, which define the headings used above each group of columns.\r
348  </summary>\r
349 </member><member name="F:Rico.LiveGridBase.Tables">\r
350         <summary>\r
351  Defines the tables used by the LiveGrid. The first table is the primary/main table.\r
352  </summary>\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 </member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">\r
359         <summary>\r
360  Adds a new column to grid, returns column index\r
361  </summary>\r
362         <param name="ColumnObj"></param>\r
363 </member><member name="M:Rico.LiveGridBase.AddCalculatedField(System.String,System.String,System.Int32,Rico.DataTypeValues)">\r
364         <summary>\r
365  Adds a new column to grid, returns Forumula object\r
366  </summary>\r
367         <param name="Heading"></param>\r
368         <param name="ColumnFormula"></param>\r
369         <param name="width"></param>\r
370         <param name="DataType"></param>\r
371         <returns></returns>\r
372 </member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">\r
373         <summary>\r
374  Takes a given string and makes it JSON valid (http://json.org/)\r
375  </summary>\r
376         <param name="val">value which should be escaped</param>\r
377         <returns>JSON valid string</returns>\r
378         <remarks>\r
379  AUTHOR: Michael Rebec\r
380  All characters which needs to be escaped are beeing replaced by their\r
381  unicode representation according to the\r
382  RFC4627#2.5 - http://www.ietf.org/rfc/rfc4627.txt?number=4627\r
383  </remarks>\r
384 </member><member name="T:Rico.LiveGridBase">\r
385         <summary>\r
386  Methods and properties common to LiveGrid and LiveGridEdit\r
387  </summary>\r
388 </member><member name="P:Rico.LiveGrid.BufferType">\r
389         <summary>\r
390  The type of buffer deployed on the client\r
391  <list type="table">\r
392                         <item><term>AjaxSQL</term><description>data source is a SQL database query</description></item>\r
393                         <item><term>AjaxLoadOnce</term><description>data is loaded all at one time from a remote source, such as an XML or JSON file</description></item>\r
394                         <item><term>Base</term><description>data is static, loaded from either an html table or javascript array</description></item>\r
395                 </list>\r
396         </summary>\r
397 </member><member name="P:Rico.LiveGrid.HtmlSourceId">\r
398         <summary>\r
399  If grid is populated from an html table, then set HtmlSourceId to the id of the source table\r
400  </summary>\r
401 </member><member name="P:Rico.LiveGrid.QueryDistinct">\r
402         <summary>\r
403  True if this should be a distinct sql query (default is false)\r
404  </summary>\r
405 </member><member name="T:Rico.LiveGrid">\r
406         <summary>\r
407  Class to define a LiveGrid\r
408  A LiveGrid buffers its data in a Javascript array and can retrieve that data via AJAX\r
409  </summary>\r
410 </member><member name="P:Rico.LoadClient.ImgHeading">\r
411         <summary>\r
412  Background image for grid headings and window titles.\r
413  Should be left unset, as it is used only for the grayedout theme (in which case it is set automatically).\r
414  </summary>\r
415 </member><member name="P:Rico.LoadClient.BaseLib">\r
416         <summary>\r
417  The base Javascript library to load from http://ajax.googleapis.com/ajax/libs/, possible values include:\r
418  <list type="bullet">\r
419                         <item><description>prototype/1.6/prototype.js</description></item>\r
420                         <item><description>prototype/1.7/prototype.js</description></item>\r
421                         <item><description>jquery/1.3/jquery.min.js</description></item>\r
422                         <item><description>jquery/1.4/jquery.min.js</description></item>\r
423                         <item><description>jquery/1.5/jquery.min.js</description></item>\r
424                         <item><description>jquery/1.6/jquery.min.js</description></item>\r
425                         <item><description>mootools/1.2/mootools-yui-compressed.js</description></item>\r
426                         <item><description>mootools/1.3/mootools-yui-compressed.js</description></item>\r
427                         <item><description>dojo/1.5/dojo/dojo.xd.js</description></item>\r
428                         <item><description>dojo/1.6/dojo/dojo.xd.js</description></item>\r
429                         <item><description>ext-core/3.0/ext-core.js</description></item>\r
430                         <item><description>ext-core/3.1/ext-core.js</description></item>\r
431                 </list>\r
432                 <para>Default value is "proto_min", which loads prototype 1.7 from the server control.</para>\r
433         </summary>\r
434 </member><member name="P:Rico.LoadClient.Logging">\r
435         <summary>\r
436  Enable Javascript console logging? Useful for debugging. Default is false.\r
437  </summary>\r
438 </member><member name="P:Rico.LoadClient.HTML5">\r
439         <summary>\r
440  Enable HTML5 web form elements in browsers that support them. \r
441  Default is false because the quality of the HTML5 web form elements is uneven across browsers.\r
442  </summary>\r
443 </member><member name="P:Rico.LoadClient.Language">\r
444         <summary>\r
445  Best left unset, in which case language will be set automatically based on request's HTTP_ACCEPT_LANGUAGE\r
446  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
447  </summary>\r
448 </member><member name="P:Rico.LoadClient.LoadBaseLib">\r
449         <summary>\r
450  Load base Javascript library (prototype, jQuery, etc)?\r
451  Default is true.\r
452  Set to false if library is being loaded another way. In this case, a BaseLib value is still required to indicate\r
453  which library Rico should connect to.\r
454  </summary>\r
455 </member><member name="P:Rico.LoadClient.Striping">\r
456         <summary>\r
457  Apply row striping to LiveGrids? Default is true. Applies only when themes are used.\r
458  </summary>\r
459 </member><member name="F:Rico.LoadClient.SupportedLangs">\r
460         <summary>\r
461  Comma separated list of 2 letter locales that Rico supports.\r
462  Do not set unless you have developed your own locale file.\r
463  </summary>\r
464 </member><member name="P:Rico.LoadClient.jQueryThemePath">\r
465         <summary>\r
466  URL to load jQuery themes from.\r
467  Default is http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/\r
468  Override this value if you have a jQuery theme on your own server.\r
469  </summary>\r
470 </member><member name="M:Rico.LoadClient.RegisterGrid(Rico.GridBase)">\r
471         <summary>\r
472  Called automatically from Rico grids on the page\r
473  </summary>\r
474         <param name="grid"></param>\r
475 </member><member name="P:Rico.LoadClient.LoadedLanguage">\r
476         <summary>\r
477  Returns the 2 character string representing the Rico locale file that was actually used on the client.\r
478  If there is no match between the requested languages and the available locale files, then english is used.\r
479  Only available during the render phase.\r
480  </summary>\r
481 </member><member name="P:Rico.LoadClient.checkQueryString">\r
482         <summary>\r
483  Load settings from QueryString?  true for demo, false for anything else. Default is false.\r
484  </summary>\r
485 </member><member name="P:Rico.LoadClient.checkWebConfig">\r
486         <summary>\r
487  Load settings from web.config file? Default is false.\r
488  If true, then the appSettings section of web.config will be checked for the following keys (which affect the similarly named properties):\r
489  <list type="bullet">\r
490                         <item><description>rico_BaseLib</description></item>\r
491                         <item><description>rico_Language</description></item>\r
492                         <item><description>rico_jTheme</description></item>\r
493                         <item><description>rico_rTheme</description></item>\r
494                         <item><description>rico_Logging</description></item>\r
495                         <item><description>rico_HTML5</description></item>\r
496                         <item><description>rico_LoadBaseLib</description></item>\r
497                         <item><description>rico_Striping</description></item>\r
498                 </list>\r
499                 <para>Boolean values in web.config should be the strings "true" or "1" for true, and "false" or "0" for false.</para>\r
500         </summary>\r
501 </member><member name="M:Rico.LoadClient.InitLiveGrids(System.Web.UI.HtmlTextWriter)">\r
502         <summary>\r
503  Initialize all LiveGrids on the page\r
504  Initialize grids with fixed # of rows first,\r
505  then initialize grids with variable # of rows\r
506  </summary>\r
507 </member><member name="P:Rico.LoadClient.jTheme">\r
508         <summary>\r
509  Set theme to one of the jQuery Themeroller themes. Default is no theme.\r
510  Valid values are:\r
511    black-tie, blitzer, cupertino, dark-hive, dot-luv, eggplant, excite-bike, flick, \r
512    hot-sneaks, humanity, le-frog, mint-choc, overcast, pepper-grinder, redmond, smoothness, \r
513    south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader\r
514  </summary>\r
515 </member><member name="P:Rico.LoadClient.rTheme">\r
516         <summary>\r
517  Set theme to one of the Rico themes. Default is no theme.\r
518  Valid values are:\r
519    coffee-with-milk, grayedout, greenHdg, seaglass, warmfall\r
520  </summary>\r
521 </member><member name="T:Rico.LoadClient">\r
522         <summary>\r
523  Loads the various Javascript, CSS, and image files required to make Rico function.\r
524  </summary>\r
525 </member><member name="P:Rico.SimpleCol.Width">\r
526         <summary>\r
527  Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.\r
528  </summary>\r
529 </member><member name="T:Rico.SimpleCol">\r
530         <summary>\r
531  Defines a column in a SimpleGrid\r
532  </summary>\r
533 </member><member name="P:Rico.Column.canSort">\r
534         <summary>\r
535  Is the user allowed to sort the column? Default is true.\r
536  </summary>\r
537 </member><member name="P:Rico.Column.canDrag">\r
538         <summary>\r
539  Is the user allowed to drag a column value? Default is false.\r
540  </summary>\r
541 </member><member name="P:Rico.Column.canFilter">\r
542         <summary>\r
543  Is the user allowed to filter the column? Default is true.\r
544  </summary>\r
545 </member><member name="P:Rico.Column.noResize">\r
546         <summary>\r
547  Prevent column from being resized? Default is false.\r
548  </summary>\r
549 </member><member name="P:Rico.Column.control">\r
550         <summary>\r
551  Javascript code to create a control object, which changes the way the column data is rendered.\r
552  The disadvantage of using this approach is that the altered rendering does not get reflected in exports.\r
553  A set of controls is defined in ricoLiveGridControls.js or the developer can create their own.\r
554  </summary>\r
555 </member><member name="P:Rico.Column.filterUI">\r
556         <summary>\r
557  If the AutoFilter option is enabled for the grid, then filterUI will control how each column is filtered. If filterUI is:\r
558  <list type="bullet">\r
559                         <item><description>null or omitted, then no filter is displayed for the column.</description></item>\r
560                         <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
561                         <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
562                         <item><description>'m' - will generate multi-select checklist filter, with a checkbox next to each item.</description></item>\r
563                         <item><description>'n' - will generate a select list filter. By default the list will contain "&lt; 0", "= 0", "&gt; 0". However, the list can be controlled by following "n" with any combination of "-", "0", or "+".</description></item>\r
564                 </list>\r
565         </summary>\r
566 </member><member name="P:Rico.Column.filterColId">\r
567         <summary>\r
568  This setting allows the filterUI to filter a different column than where it is displayed.\r
569  This is particularly useful for dates, where you can show a year selection on an OrderDate date column for example,\r
570  but actually have it filter a hidden column OrderYear=year(OrderDate).\r
571  </summary>\r
572 </member><member name="P:Rico.Column.ConfirmDeleteColumn">\r
573         <summary>\r
574  The text content of this column will be included in delete confirmation messages.\r
575  </summary>\r
576 </member><member name="P:Rico.Column.multiplier">\r
577         <summary>\r
578  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
579  Default is 1. Automatically set to 100 if DataType is percent.\r
580  </summary>\r
581 </member><member name="P:Rico.Column.decPlaces">\r
582         <summary>\r
583  If column is a number, this is the number of digits displayed to the right of the decimal point. Default is 0.\r
584  If DataType is dollar or euro, then decPlaces is automatically set to 2.\r
585  </summary>\r
586 </member><member name="P:Rico.Column.thouSep">\r
587         <summary>\r
588  If column is a number, display the value with a thousands separator? Default is true.\r
589  </summary>\r
590 </member><member name="P:Rico.Column.negSign">\r
591         <summary>\r
592  Specifies how negative numbers should be displayed. Possible values:\r
593  <list>\r
594                         <item><description>L=leading minus (default)</description></item>\r
595                         <item><description>T=trailing minus</description></item>\r
596                         <item><description>P=parentheses</description></item>\r
597                 </list>\r
598         </summary>\r
599 </member><member name="P:Rico.Column.prefix">\r
600         <summary>\r
601  If column is a number, this string is prepended to the number before display.\r
602  Useful for currency symbols.\r
603  </summary>\r
604 </member><member name="P:Rico.Column.suffix">\r
605         <summary>\r
606  If column is a number, this string is appended to the number before display.\r
607  Useful for percentages and temperature values. Automatically set to % if DataType is percent.\r
608  </summary>\r
609 </member><member name="P:Rico.Column.HdgStyleID">\r
610         <summary>\r
611  Used to give the column heading a specific style.\r
612  In most cases this is not necessary, as the heading will be styled according to the theme.\r
613  </summary>\r
614 </member><member name="P:Rico.Column.isNullable">\r
615         <summary>\r
616  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
617  </summary>\r
618 </member><member name="P:Rico.Column.Writeable">\r
619         <summary>\r
620  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
621  </summary>\r
622 </member><member name="P:Rico.Column.isKey">\r
623         <summary>\r
624  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
625  </summary>\r
626 </member><member name="P:Rico.Column.Length">\r
627         <summary>\r
628  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
629  </summary>\r
630 </member><member name="P:Rico.Column.TypeName">\r
631         <summary>\r
632  Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
633  </summary>\r
634 </member><member name="F:Rico.Column.ColGroupIdx">\r
635         <summary>\r
636  For internal use\r
637  </summary>\r
638 </member><member name="P:Rico.Column.Heading">\r
639         <summary>\r
640  Text displayed in the column heading.\r
641  </summary>\r
642 </member><member name="P:Rico.Column.Width">\r
643         <summary>\r
644  Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.\r
645  </summary>\r
646 </member><member name="M:Rico.Column.NumberFormat">\r
647         <summary>\r
648  Returns an Excel-type number format string based on decPlaces, thouSep, prefix.\r
649  </summary>\r
650 </member><member name="P:Rico.Column.DataType">\r
651         <summary>\r
652  Type of data stored in the column.\r
653  </summary>\r
654 </member><member name="M:Rico.Column.script">\r
655         <summary>\r
656  Internal function that returns the LiveGrid column options object, used to initialize the column on the client.\r
657  </summary>\r
658 </member><member name="T:Rico.Column">\r
659         <summary>\r
660  Base class for a LiveGrid column\r
661  </summary>\r
662 </member><member name="P:Rico.FormulaCol.Formula">\r
663         <summary>\r
664  SQL expression\r
665  </summary>\r
666 </member><member name="T:Rico.FormulaCol">\r
667         <summary>\r
668  Calculated Column\r
669  </summary>\r
670 </member><member name="P:Rico.TableCol.ColName">\r
671         <summary>\r
672  Column name in table or view\r
673  If not specified, use the control's ID instead\r
674  </summary>\r
675 </member><member name="P:Rico.TableCol.TblAlias">\r
676         <summary>\r
677  This should match the TblAlias of one of the Table objects specified for the grid.\r
678  If unspecified, the primary table or view is assumed.\r
679  </summary>\r
680 </member><member name="F:Rico.TableCol.TableIdx">\r
681         <summary>\r
682  Used internally\r
683  </summary>\r
684 </member><member name="T:Rico.TableCol">\r
685         <summary>\r
686  Column from table or view\r
687  </summary>\r
688 </member><member name="P:Rico.EditCol.pattern">\r
689         <summary>\r
690  Regular expression used to validate the user input. User entries will be checked to ensure they match the pattern specified. \r
691  There are a few special values:\r
692  <list type="table">\r
693                         <item><term>email</term><description>tests for a valid email address</description></item>\r
694                         <item><term>float-unsigned</term><description>tests for a valid unsigned floating point (real) number</description></item>\r
695                         <item><term>float-signed</term><description>tests for a valid signed floating point (real) number (this is the default when EntryType is "F")</description></item>\r
696                         <item><term>int-unsigned</term><description>tests for a valid unsigned integer number</description></item>\r
697                         <item><term>int-signed</term><description>tests for a valid signed integer number (this is the default when EntryType is "I")</description></item>\r
698                 </list>\r
699         </summary>\r
700 </member><member name="P:Rico.EditCol.min">\r
701         <summary>\r
702  Sets the minimum allowable value in a numeric or date field.\r
703  For dates, the value should be in ISO-8601 format.\r
704  </summary>\r
705 </member><member name="P:Rico.EditCol.max">\r
706         <summary>\r
707  Sets the maximum allowable value in a numeric or date field.\r
708  For dates, the value should be in ISO-8601 format.\r
709  </summary>\r
710 </member><member name="P:Rico.EditCol.Help">\r
711         <summary>\r
712  Provides information to help the user understand the meaning of the field.\r
713  Fields with help text will be display with a blue "i" icon next to the field name.\r
714  When the user hovers their cursor over the icon, the help text will be displayed.\r
715  </summary>\r
716 </member><member name="P:Rico.EditCol.TxtAreaRows">\r
717         <summary>\r
718  For columns with entry type "TA", this is # of rows to display in the textarea when in form view (default 4)\r
719  </summary>\r
720 </member><member name="P:Rico.EditCol.TxtAreaCols">\r
721         <summary>\r
722  For columns with entry type "TA", this is # of columns to display in the textarea when in form view (default 80)\r
723  </summary>\r
724 </member><member name="P:Rico.EditCol.ColData">\r
725         <summary>\r
726  column's default value in the form view\r
727  </summary>\r
728 </member><member name="P:Rico.EditCol.SelectSql">\r
729         <summary>\r
730  Specifies the SQL select statement to use for EntryTypes of SL, CL, and RL. \r
731  The select statement should return 2 columns: the first being the code and the second being the text value/description. \r
732  For example:\r
733  <code>\r
734  EntryType="SL" ColName="CustID" SelectSql="select ID,Name from Customers"\r
735  </code>\r
736         </summary>\r
737 </member><member name="P:Rico.EditCol.SelectCtl">\r
738         <summary>\r
739  For entry type "CL", this property specifies the id of the custom control.\r
740  </summary>\r
741 </member><member name="P:Rico.EditCol.SelectFilter">\r
742         <summary>\r
743  SelectSql serves 2 purposes. First, it is used to retrieve the appropriate data to display in the grid. \r
744  Second, it is used to populate the values in the select box (SL) or radio buttons (RL) on the pop-up form. \r
745  In some cases, you may want these to be different. In the SelectSql example above, we are retrieving customer name. \r
746  But let's say that our Customers table has a "CreditHold" field and we want to disable the selection of customers \r
747  on credit hold in the form view, but still display them in the grid. \r
748  This is where SelectFilter comes in:\r
749  <code>\r
750  SelectFilter="CreditHold='NO'"\r
751  </code>\r
752         </summary>\r
753 </member><member name="P:Rico.EditCol.SelectValues">\r
754         <summary>\r
755  Specifies the choices the user sees in form view for EntryTypes of N, S, and R. \r
756  If supplied, then this should be a string of comma-separated values. \r
757  For example:\r
758  <code>\r
759  SelectValues="Y,N"\r
760  </code>\r
761         </summary>\r
762 </member><member name="P:Rico.EditCol.SelectRows">\r
763         <summary>\r
764  Specifies the number of rows to display in drop down select boxes for entry types S and SL.\r
765  Default is to let the browser decide.\r
766  </summary>\r
767 </member><member name="P:Rico.EditCol.FilterFlag">\r
768         <summary>\r
769  If true, then the grid is filtered by the default value (ColData) for this column (default=false)\r
770  </summary>\r
771 </member><member name="P:Rico.EditCol.InsertOnly">\r
772         <summary>\r
773  If true, then only write this field to the database when peforming an insert (default=false).\r
774  </summary>\r
775 </member><member name="P:Rico.EditCol.UpdateOnly">\r
776         <summary>\r
777  If true, then only write this field to the database when peforming an update (default=false).\r
778  </summary>\r
779 </member><member name="P:Rico.EditCol.ReadOnly">\r
780         <summary>\r
781  If true, data is displayed on the entry form but cannot be changed AND IS NOT WRITTEN TO THE DATABASE.\r
782  If data must be written to the database, either use FormView="false" (if data should be displayed\r
783  in the grid), or EntryType="H" (if the grid column should be hidden).\r
784  Text is gray (default=false). \r
785  Does not apply to entry types of S, SL, N, R, RL.\r
786  </summary>\r
787 </member><member name="P:Rico.EditCol.FormView">\r
788         <summary>\r
789                 <list type="table">\r
790                         <item><term>True</term><description>Item is shown on the entry form (default)</description></item>\r
791                         <item><term>False</term><description>Item is not shown on the form</description></item>\r
792                 </list>\r
793         </summary>\r
794 </member><member name="P:Rico.EditCol.AddQuotes">\r
795         <summary>\r
796  When false, the column value will be left unquoted when inserting or updating the database. \r
797  Default is false for entry type TS, and true for all other entry types.\r
798  This makes it possible to populate columns with SQL function calls. \r
799  For example:\r
800  <code>\r
801  ColName="LastEditUser" EntryType="H" AddQuotes="false" ColData="suser_sname()"\r
802  </code>\r
803         </summary>\r
804 </member><member name="P:Rico.EditCol.MultiSelect">\r
805         <summary>\r
806  If true, the user is allowed to select multiple values.\r
807  For entry types R and RL, this changes the input from radio buttons to checkboxes.\r
808  Default is false.\r
809  </summary>\r
810 </member><member name="P:Rico.EditCol.DescriptionCol">\r
811         <summary>\r
812  Normally RL and SL columns are used for foreign keys, and only the key is stored in the table, not the foreign key's associated\r
813  name or description. However, by specifying a value for DescriptionCol, you can store the associated description as well.\r
814  <code>\r
815  EntryType="SL" ColName="CustID" DescriptionCol="CustName" SelectSql="select ID,Name from Customers"\r
816  </code>\r
817         </summary>\r
818 </member><member name="F:Rico.EditCol.DescriptionField">\r
819         <summary>\r
820  Used internally. Populates automatically based on DescriptionCol.\r
821  </summary>\r
822 </member><member name="P:Rico.EditCol.noFormBreak">\r
823         <summary>\r
824  Boolean value that when true, specifies that this entry field should placed on the same form row as the last field \r
825  (default: false - each form field is placed on a separate row).\r
826  </summary>\r
827 </member><member name="M:Rico.EditCol.isLookupField">\r
828         <summary>\r
829  Returns true if the column is a lookup field (entry type SL, RL, or CL)\r
830  </summary>\r
831 </member><member name="P:Rico.EditCol.EntryType">\r
832         <summary>\r
833  Code indicating the ui to be used for data entry\r
834  <list type="table">\r
835                         <item><term>TA</term><description>Text Area</description></item>\r
836                         <item><term>R</term><description>Radio button list</description></item>\r
837                         <item><term>RL</term><description>Radio buttons via lookup (field is a foreign key)</description></item>\r
838                         <item><term>S</term><description>Select list</description></item>\r
839                         <item><term>SL</term><description>Select list via lookup (field is a foreign key)</description></item>\r
840                         <item><term>CL</term><description>Custom widget via lookup (field is a foreign key)</description></item>\r
841                         <item><term>N</term><description>Select list of distinct column values, use allowed to add new values</description></item>\r
842                         <item><term>B</term><description>Text, non-blank</description></item>\r
843                         <item><term>T</term><description>Text</description></item>\r
844                         <item><term>I</term><description>Integer</description></item>\r
845                         <item><term>F</term><description>Floating point number</description></item>\r
846                         <item><term>tinyMCE</term><description>Rich text via tinyMCE</description></item>\r
847                         <item><term>D</term><description>Date</description></item>\r
848                         <item><term>TS</term><description>Time stamp</description></item>\r
849                         <item><term>H</term><description>Hidden</description></item>\r
850                 </list>\r
851         </summary>\r
852 </member><member name="T:Rico.EditCol">\r
853         <summary>\r
854  Defines an editable column in a LiveGridEdit object\r
855  </summary>\r
856 </member><member name="P:Rico.StyleBase.bold">\r
857         <summary>\r
858  True if the text should be displayed using a bold font\r
859  </summary>\r
860 </member><member name="P:Rico.StyleBase.italic">\r
861         <summary>\r
862  True if the text should be displayed in italics\r
863  </summary>\r
864 </member><member name="P:Rico.StyleBase.underline">\r
865         <summary>\r
866  True if the text should be underlined\r
867  </summary>\r
868 </member><member name="P:Rico.StyleBase.fontsize">\r
869         <summary>\r
870  Font size in points\r
871  </summary>\r
872 </member><member name="P:Rico.StyleBase.GridOnly">\r
873         <summary>\r
874  If true, then style is only applied to the grid, not to html or Excel exports\r
875  </summary>\r
876 </member><member name="P:Rico.StyleBase.BackColor">\r
877         <summary>\r
878  Specifies the background color. One of the 16 standard color names, or #rrggbb.\r
879  </summary>\r
880 </member><member name="P:Rico.StyleBase.ForeColor">\r
881         <summary>\r
882  Specifies the font color. One of the 16 standard color names, or #rrggbb.\r
883  </summary>\r
884 </member><member name="P:Rico.StyleBase.HorizontalAlign">\r
885         <summary>\r
886  Specifies horizontal alignment: Left, Right, Center, or NotSet (default)\r
887  </summary>\r
888 </member><member name="P:Rico.StyleBase.VerticalAlign">\r
889         <summary>\r
890  Specifies vertical alignment: Bottom, Middle, Top, or NotSet (default)\r
891  Only applies to Excel export\r
892  </summary>\r
893 </member><member name="P:Rico.StyleBase.Overflow">\r
894         <summary>\r
895  Normally, overflowed content is hidden, but setting this "auto" or "scroll" allows content in the cell to scroll.\r
896  Only applies to the grid, not to exports.\r
897  </summary>\r
898 </member><member name="P:Rico.StyleBase.CssStyle">\r
899         <summary>\r
900  Used internally. Returns the style properties as a css string.\r
901  </summary>\r
902 </member><member name="M:Rico.StyleBase.UnwrappedXlStyle">\r
903         <summary>\r
904  Used internally. Returns the style properties as an Excel XML string without the style tag.\r
905  </summary>\r
906 </member><member name="T:Rico.StyleBase">\r
907         <summary>\r
908  Base class for all style classes as well as the Column class.\r
909  </summary>\r
910 </member><member name="P:Rico.Style.StyleID">\r
911         <summary>\r
912  StyleID's should not contain spaces or other special characters.\r
913  <list type="bullet">\r
914                         <item><description>Use a StyleID of Default to style the entire grid</description></item>\r
915                         <item><description>Use a StyleID of DefaultHdg to style the grid heading</description></item>\r
916                         <item><description>Use a StyleID of ricoLG_evenRow and/or ricoLG_oddRow to stripe the grid (striping does not get exported).</description></item>\r
917                         <item><description>Use a StyleID of ricoLG_selection to set the styling for the selected row.</description></item>\r
918                 </list>\r
919         </summary>\r
920 </member><member name="M:Rico.Style.CssRule">\r
921         <summary>\r
922  Returns the style properties as a CSS rule\r
923  </summary>\r
924 </member><member name="M:Rico.Style.WrappedXlStyle">\r
925         <summary>\r
926  Returns the style properties as an Excel XML style, including the style tag\r
927  </summary>\r
928 </member><member name="P:Rico.Style.xlNumberFormat">\r
929         <summary>\r
930  For SimpleGrids only\r
931  </summary>\r
932 </member><member name="P:Rico.Style.NumberFormat">\r
933         <summary>\r
934  For SimpleGrids only\r
935  </summary>\r
936 </member><member name="M:Rico.Style.WrappedXlStyleNF">\r
937         <summary>\r
938  Returns the style properties plus number format as an Excel XML style, including the style tag\r
939  </summary>\r
940 </member><member name="T:Rico.Style">\r
941         <summary>\r
942  Defines a style that can be applied to a grid cell.\r
943  Using a StyleID of ricoLG_evenRow or ricoLG_oddRow will stripe the grid, however striping does not get exported.\r
944  Using a StyleID of ricoLG_selection will set the styling for the selected row.\r
945  </summary>\r
946 </member><member name="M:Rico.StyleDictionary.Add(Rico.Style)">\r
947         <summary>\r
948  Adds a Style object to the collection\r
949  </summary>\r
950         <param name="new_style"></param>\r
951 </member><member name="P:Rico.StyleDictionary.Item(System.String)">\r
952         <summary>\r
953  Returns a Style object from the collection based on the style's StyleID\r
954  </summary>\r
955         <param name="StyleId"></param>\r
956 </member><member name="P:Rico.StyleDictionary.Keys">\r
957         <summary>\r
958  Returns all of the StyleID's in the collection\r
959  </summary>\r
960 </member><member name="P:Rico.StyleDictionary.Values">\r
961         <summary>\r
962  Returns all of the Style objects in the collection\r
963  </summary>\r
964 </member><member name="M:Rico.StyleDictionary.Contains(System.String)">\r
965         <summary>\r
966  Returns true if the StyleID is in the collection\r
967  </summary>\r
968         <param name="StyleId"></param>\r
969 </member><member name="M:Rico.StyleDictionary.Remove(System.String)">\r
970         <summary>\r
971  Removes the Style object with the given StyleID from the collection\r
972  </summary>\r
973         <param name="StyleId"></param>\r
974 </member><member name="T:Rico.StyleDictionary">\r
975         <summary>\r
976  Container for a collection of Style objects\r
977  </summary>\r
978 </member><member name="P:Rico.LiveGridEdit.TableSelectNew">\r
979         <summary>\r
980  This is the value that Rico uses to identify when the user has selected "(new)" on fields with EntryType N.\r
981  </summary>\r
982 </member><member name="P:Rico.LiveGridEdit.TableSelectNone">\r
983         <summary>\r
984  This is the value that Rico uses to identify nulls in select lists\r
985  </summary>\r
986 </member><member name="P:Rico.LiveGridEdit.canAdd">\r
987         <summary>\r
988  True if the user is allowed to add records (default is true)\r
989  </summary>\r
990 </member><member name="P:Rico.LiveGridEdit.canEdit">\r
991         <summary>\r
992  True if the user is allowed to edit/update records (default is true)\r
993  </summary>\r
994 </member><member name="P:Rico.LiveGridEdit.canClone">\r
995         <summary>\r
996  True if the user is allowed to clone records (default is false)\r
997  </summary>\r
998 </member><member name="P:Rico.LiveGridEdit.canDelete">\r
999         <summary>\r
1000  True if the user is allowed to delete records (default is true)\r
1001  </summary>\r
1002 </member><member name="P:Rico.LiveGridEdit.ConfirmDelete">\r
1003         <summary>\r
1004  True if Rico should display a confirmation message when the user tries to delete a record\r
1005  </summary>\r
1006 </member><member name="P:Rico.LiveGridEdit.RecordName">\r
1007         <summary>\r
1008  Used in menus to refer to a record (default is "record")\r
1009  </summary>\r
1010 </member><member name="P:Rico.LiveGridEdit.showSaveMsg">\r
1011         <summary>\r
1012  Controls disposition of database update responses on the client\r
1013  <list type="bullet">\r
1014                         <item><description>full: show full response</description></item>\r
1015                         <item><description>errors: show full response for errors and short response otherwise (default)</description></item>\r
1016                 </list>\r
1017         </summary>\r
1018 </member><member name="P:Rico.LiveGridEdit.panelHeight">\r
1019         <summary>\r
1020  Height of tabbed panels on entry form (in pixels, default is 200).\r
1021  Tabbed panels are only created when ColumnGroup labels are present in the grid definition.\r
1022  </summary>\r
1023 </member><member name="P:Rico.LiveGridEdit.panelWidth">\r
1024         <summary>\r
1025  Width of tabbed panels on entry form (in pixels, default is 500).\r
1026  Tabbed panels are only created when ColumnGroup labels are present in the grid definition.\r
1027  </summary>\r
1028 </member><member name="P:Rico.LiveGridEdit.MaxInputLen">\r
1029         <summary>\r
1030  Maximum displayed text field length on entry form (default is 20)\r
1031  </summary>\r
1032 </member><member name="P:Rico.LiveGridEdit.IsAjaxUpdate">\r
1033         <summary>\r
1034  Returns true if the grid is processing an AJAX request that inserts, updates, or deletes a record.\r
1035  </summary>\r
1036 </member><member name="P:Rico.LiveGridEdit.onFormOpen">\r
1037         <summary>\r
1038  Javascript function to be called when the form opens to add or edit a record\r
1039  </summary>\r
1040 </member><member name="P:Rico.LiveGridEdit.onFormClose">\r
1041         <summary>\r
1042  Javascript function to be called when the add/edit form closes\r
1043  </summary>\r
1044 </member><member name="P:Rico.LiveGridEdit.onFormSubmit">\r
1045         <summary>\r
1046  Javascript function to be called when the add/edit form is submitted to the server\r
1047  </summary>\r
1048 </member><member name="P:Rico.LiveGridEdit.onSubmitResponse">\r
1049         <summary>\r
1050  Javascript function to be called when a response is received from the server after a form submittal\r
1051  </summary>\r
1052 </member><member name="E:Rico.LiveGridEdit.DbDelete">\r
1053         <summary>\r
1054  Event raised right before the database deletion takes place.\r
1055  </summary>\r
1056         <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
1057         <param name="WhereClause">Where clause that selects the record to be deleted.</param>\r
1058 </member><member name="E:Rico.LiveGridEdit.DbInsert">\r
1059         <summary>\r
1060  Event raised right before the database insertion takes place.\r
1061  </summary>\r
1062         <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
1063         <param name="Data">Hashtable containing the data to be inserted. Key is the column name. Value is the quoted data to be written. Changing the contents of the hash does NOT change what is written to the database.</param>\r
1064 </member><member name="E:Rico.LiveGridEdit.DbUpdate">\r
1065         <summary>\r
1066  Event raised right before the database update takes place.\r
1067  </summary>\r
1068         <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
1069         <param name="Data">Hashtable containing the data to be updated. Key is the column name. Value is the quoted data to be written. Changing the contents of the hash does NOT change what is written to the database.</param>\r
1070         <param name="WhereClause">Where clause that selects the record to be updated.</param>\r
1071 </member><member name="M:Rico.LiveGridEdit.TableKeyWhereClause(System.Int32)">\r
1072         <summary>\r
1073  Returns where clause based on table's primary key\r
1074  </summary>\r
1075         <param name="TabIdx"></param>\r
1076 </member><member name="P:Rico.GridBase.gridVar">\r
1077         <summary>\r
1078  Name of grid Javascript object\r
1079  </summary>\r
1080 </member><member name="P:Rico.GridBase.optionsVar">\r
1081         <summary>\r
1082  Name of grid options Javascript object\r
1083  </summary>\r
1084 </member><member name="P:Rico.GridBase.AutoFilter">\r
1085         <summary>\r
1086  If enabled, an additional row is added to the grid header where column filters are placed. \r
1087  See the EditCol.filterUI property to customize each column's filter.\r
1088  </summary>\r
1089 </member><member name="P:Rico.GridBase.FilterAllToken">\r
1090         <summary>\r
1091  The token in select filters used to indicate "show all values" (default: "___ALL___").\r
1092  </summary>\r
1093 </member><member name="P:Rico.GridBase.defaultWidth">\r
1094         <summary>\r
1095  if -1 (default), then use column heading width, otherwise this is the default width in pixels\r
1096  </summary>\r
1097 </member><member name="P:Rico.GridBase.allowColResize">\r
1098         <summary>\r
1099  Allow user to resize columns? Default is true.\r
1100  </summary>\r
1101 </member><member name="P:Rico.GridBase.frozenColumns">\r
1102         <summary>\r
1103  Number of frozen columns on the left (or right if direction=rtl). Default is 0.\r
1104  </summary>\r
1105 </member><member name="P:Rico.GridBase.RowLineHtEms">\r
1106         <summary>\r
1107  Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.\r
1108  </summary>\r
1109 </member><member name="P:Rico.GridBase.windowResize">\r
1110         <summary>\r
1111  Resize grid when browser window is resized? Default is true.\r
1112  </summary>\r
1113 </member><member name="P:Rico.GridBase.menuEvent">\r
1114         <summary>\r
1115  Specifies when the grid's popup menu should be invoked \r
1116  </summary>\r
1117 </member><member name="P:Rico.GridBase.DefaultHdgStyle">\r
1118         <summary>\r
1119  This holds the default style for headings. Use only if not using themes.\r
1120  </summary>\r
1121 </member><member name="P:Rico.GridBase.Styles">\r
1122         <summary>\r
1123  Collection of styles used for individual headings.\r
1124  </summary>\r
1125 </member><member name="P:Rico.GridBase.HdgRowLines">\r
1126         <summary>\r
1127  Lines of text displayed in each heading row\r
1128  </summary>\r
1129 </member><member name="P:Rico.GridBase.DefaultRowLines">\r
1130         <summary>\r
1131  Lines of text displayed in each data row\r
1132  </summary>\r
1133 </member><member name="P:Rico.GridBase.OuterDivId">\r
1134         <summary>\r
1135  Returns the id of the outermost grid container\r
1136  </summary>\r
1137 </member><member name="P:Rico.GridBase.InitCompleteFunction">\r
1138         <summary>\r
1139  Name of javascript function to call when grid initialization is complete (default is gridID_InitComplete)\r
1140  The grid object is passed as the single parameter to the function\r
1141  </summary>\r
1142 </member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">\r
1143         <summary>\r
1144  Returns the index of the column with the given id\r
1145  </summary>\r
1146 </member><member name="M:Rico.GridBase.GetColumn(System.String)">\r
1147         <summary>\r
1148  Returns the column object with the given id\r
1149  </summary>\r
1150 </member><member name="M:Rico.GridBase.GridRules">\r
1151         <summary>\r
1152  Returns the set of css rules that apply to this grid\r
1153  </summary>\r
1154 </member><member name="T:Rico.GridBase">\r
1155         <summary>\r
1156  This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.\r
1157  </summary>\r
1158 </member><member name="P:Rico.TreeResponse.ErrorMsg">\r
1159         <summary>\r
1160  May contain the text of an error message that occurred outside this control prior to rendering\r
1161  </summary>\r
1162 </member><member name="P:Rico.TreeResponse.dbConnection">\r
1163         <summary>\r
1164  Database connection object. Required only if sqlText is used.\r
1165  </summary>\r
1166 </member><member name="P:Rico.TreeResponse.SqlText">\r
1167         <summary>\r
1168  Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters \r
1169  </summary>\r
1170 </member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">\r
1171         <summary>\r
1172  Adds an entry that will be returned with the results. Often used to add the root node.\r
1173  </summary>\r
1174         <param name="parentID">id of parent, "" if this is the root</param>\r
1175         <param name="ID">id that uniquely identifies this node in the tree</param>\r
1176         <param name="description">description displayed to the user</param>\r
1177         <param name="containerORleaf">"L" or 0 = leaf, "C" or non-zero = container</param>\r
1178         <param name="selectable">0=not selectable, 1=selectable</param>\r
1179 </member><member name="T:Rico.TreeResponse">\r
1180         <summary>\r
1181  Use this class on a page that responds to AJAX requests from a Rico Tree Control\r
1182  This class automatically disables caching of the response and sets the response type to text/xml\r
1183  </summary>\r
1184 </member><member name="T:Rico.SimpleGrid.HtmlCell">\r
1185         <summary>\r
1186  Supports grid cells with html content.\r
1187  Note that when exporting to Excel, only these html tags are supported: B, Font, I, S, Span, Sub, Sup, U\r
1188  </summary>\r
1189 </member><member name="M:Rico.SimpleGrid.LinkCell.#ctor(System.String,System.String,System.String,System.String,System.String)">\r
1190         <summary>\r
1191  Creates a new LinkCell\r
1192  </summary>\r
1193         <param name="CellText">cell content</param>\r
1194         <param name="href">href portion of anchor tag</param>\r
1195         <param name="target">optional link target, e.g. _blank</param>\r
1196         <param name="CellStyleId">optional reference to a Rico:Style element</param>\r
1197 </member><member name="T:Rico.SimpleGrid.LinkCell">\r
1198         <summary>\r
1199  Supports grid cells with html links.\r
1200  When exporting, only the text is exported.\r
1201  </summary>\r
1202 </member><member name="T:Rico.SimpleGrid">\r
1203         <summary>\r
1204  Class to define a SimpleGrid\r
1205  </summary>\r
1206 </member>\r
1207 </members>\r
1208 </doc>