1 <?xml version="1.0"?>
\r
9 <member name="M:Rico.TableCollection.IndexOf(System.String)">
\r
11 Returns the index of the table with TblAlias or -1 if not found
\r
13 <param name="TblAlias"></param>
\r
14 </member><member name="P:Rico.My.Resources.Resources.ResourceManager">
\r
16 Returns the cached ResourceManager instance used by this class.
\r
18 </member><member name="P:Rico.My.Resources.Resources.Culture">
\r
20 Overrides the current thread's CurrentUICulture property for all
\r
21 resource lookups using this strongly typed resource class.
\r
23 </member><member name="T:Rico.My.Resources.Resources">
\r
25 A strongly-typed resource class, for looking up localized strings, etc.
\r
27 </member><member name="T:Rico.sqlParse.sqlColumn">
\r
29 Represents a column in the select statement
\r
31 </member><member name="F:Rico.sqlParse.IsDistinct">
\r
33 True if the select statement contains the DISTINCT keyword
\r
35 </member><member name="F:Rico.sqlParse.SelectList">
\r
37 List of columns in the select statement
\r
39 </member><member name="F:Rico.sqlParse.GroupBy">
\r
41 List of "group by" items in the select statement
\r
43 </member><member name="F:Rico.sqlParse.OrderBy">
\r
45 List of "order by" items in the select statement
\r
47 </member><member name="F:Rico.sqlParse.FromClause">
\r
49 From clause of the select statement, including any joins
\r
51 </member><member name="F:Rico.sqlParse.WhereClause">
\r
53 Where clause of the select statement
\r
55 </member><member name="F:Rico.sqlParse.HavingClause">
\r
57 Having clause of the select statement
\r
59 </member><member name="F:Rico.sqlParse.Headings">
\r
61 List of column headings in the select list.
\r
62 Set after an any unparse* call.
\r
64 </member><member name="M:Rico.sqlParse.Clone">
\r
66 Returns a cloned copy of this object
\r
68 </member><member name="M:Rico.sqlParse.UnparseSelect">
\r
70 Builds a SQL select statement string from its parsed components
\r
72 </member><member name="M:Rico.sqlParse.UnparseSelectDistinct">
\r
74 Rebuilds a SQL select statement that was parsed by ParseSelect, inserting the DISTINCT keyword
\r
76 </member><member name="M:Rico.sqlParse.UnparseDistinctColumnAccess(System.Int32)">
\r
78 Returns a SQL select statement that will return all of the values in a particular column.
\r
79 This version is meant MS Access, as it does not support ordering by column name
\r
81 <param name="colnum"></param>
\r
82 </member><member name="M:Rico.sqlParse.UnparseDistinctColumn(System.Int32)">
\r
84 Returns a SQL select statement that will return all of the values in a particular column.
\r
85 The returned statement is not compatible MS Access, use UnparseDistinctColumnAccess() instead.
\r
87 <param name="colnum"></param>
\r
88 </member><member name="M:Rico.sqlParse.UnparseColumnList">
\r
90 Returns the select list part of the statement as a string
\r
94 </member><member name="M:Rico.sqlParse.UnparseWithRowNumber(System.Int32,System.Int32,System.Boolean)">
\r
96 Returns a "windowed" select query.
\r
98 <param name="offset">The first row number to be returned</param>
\r
99 <param name="numrows">The number of rows to return</param>
\r
100 <param name="includeAS">use true for SQL Server 2005+ and false for Oracle</param>
\r
101 <returns></returns>
\r
102 <remarks></remarks>
\r
103 </member><member name="M:Rico.sqlParse.Clear">
\r
105 Resets the object and prepares it to parse another select statement.
\r
107 <remarks></remarks>
\r
108 </member><member name="M:Rico.sqlParse.ParseSelect(System.String)">
\r
110 Loads a select statement into the object.
\r
112 <list type="bullet">
\r
113 <item><description>union queries *</description></item>
\r
114 <item><description>select into</description></item>
\r
115 <item><description>select top</description></item>
\r
116 <item><description>more than one space between "group" and "by", or "order" and "by"</description></item>
\r
117 <item><description>stored procedures</description></item>
\r
119 <para>* Put union queries in a view and then write your select statement against the view.</para>
\r
121 <param name="sqltext"></param>
\r
122 </member><member name="T:Rico.sqlParse">
\r
124 Holds a SQL select statement. Methods to load/parse a select statement from a string and to reassemble it in various ways.
\r
125 Does not handle union queries.
\r
127 </member><member name="F:Rico.LiveGridEdit.onFormOpen">
\r
129 Javascript function to be called when the form opens to add or edit a record
\r
131 </member><member name="F:Rico.LiveGridEdit.onFormClose">
\r
133 Javascript function to be called when the add/edit form closes
\r
135 </member><member name="F:Rico.LiveGridEdit.onFormSubmit">
\r
137 Javascript function to be called when the add/edit form is submitted to the server
\r
139 </member><member name="F:Rico.LiveGridEdit.onSubmitResponse">
\r
141 Javascript function to be called when a response is received from the server after a form submittal
\r
143 </member><member name="E:Rico.LiveGridEdit.DbDelete">
\r
145 Event raised right before the database deletion takes place.
\r
147 <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>
\r
148 <param name="WhereClause">Where clause that selects the record to be deleted.</param>
\r
149 </member><member name="E:Rico.LiveGridEdit.DbInsert">
\r
151 Event raised right before the database insertion takes place.
\r
153 <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>
\r
154 <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
155 </member><member name="E:Rico.LiveGridEdit.DbUpdate">
\r
157 Event raised right before the database update takes place.
\r
159 <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>
\r
160 <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
161 <param name="WhereClause">Where clause that selects the record to be updated.</param>
\r
162 </member><member name="M:Rico.LiveGridEdit.TableKeyWhereClause(System.Int32)">
\r
164 Returns where clause based on table's primary key
\r
166 <param name="TabIdx"></param>
\r
167 </member><member name="F:Rico.LiveGridBase.dbConnection">
\r
169 Database connection object (used when data source is a SQL query)
\r
171 </member><member name="F:Rico.LiveGridBase.canSortDefault">
\r
173 Controls whether columns can be sorted (default: true).
\r
174 Sorting can be disabled for individual columns using the canSort property.
\r
176 </member><member name="F:Rico.LiveGridBase.canHideDefault">
\r
178 Controls whether columns can be hidden/shown (default: true).
\r
179 Hide/show can be disabled for individual columns using the canHide property.
\r
181 </member><member name="F:Rico.LiveGridBase.canFilterDefault">
\r
183 Controls whether columns can be filtered (default: true).
\r
184 Filtering can be disabled for individual columns using the canFilter property.
\r
186 </member><member name="F:Rico.LiveGridBase.highlightElem">
\r
188 A string that specifies what gets highlighted/selected in the grid
\r
189 <list type="table">
\r
190 <item><term>cursorRow</term><description>the grid row under the cursor</description></item>
\r
191 <item><term>cursorCell</term><description>the grid cell under the cursor</description></item>
\r
192 <item><term>menuRow</term><description>the grid row where the menu is displayed (default)</description></item>
\r
193 <item><term>menuCell</term><description>the grid cell where the menu is displayed</description></item>
\r
194 <item><term>selection</term><description>allow the user to select cells</description></item>
\r
195 <item><term>none</term><description>never highlight</description></item>
\r
198 </member><member name="F:Rico.LiveGridBase.highlightMethod">
\r
200 Method used to highlight cells and rows.
\r
201 <list type="table">
\r
202 <item><term>outline</term><description>least CPU-intensive on client-side</description></item>
\r
203 <item><term>class</term><description>adds CSS class to highlighted cell/row (default)</description></item>
\r
204 <item><term>both</term><description>highlight using both outline and class</description></item>
\r
207 </member><member name="F:Rico.LiveGridBase.prefetchBuffer">
\r
209 Load the buffer (and therefore the grid) on page load? (default: true)
\r
211 </member><member name="F:Rico.LiveGridBase.DisplayTimer">
\r
213 Display the session timer above the grid? (default: true)
\r
215 </member><member name="F:Rico.LiveGridBase.DisplayBookmark">
\r
217 Display the grid bookmark, ie. "Listing records X - Y of Z" (default: true)
\r
219 </member><member name="F:Rico.LiveGridBase.Caption">
\r
221 A caption for the grid, displayed next to the bookmark (default: nothing)
\r
223 </member><member name="F:Rico.LiveGridBase.click">
\r
225 Javascript event handler called when the user left-clicks on a cell
\r
227 </member><member name="F:Rico.LiveGridBase.dblclick">
\r
229 Javascript event handler called when the user double-clicks on a cell
\r
231 </member><member name="F:Rico.LiveGridBase.contextmenu">
\r
233 Javascript event handler called when the user right-clicks on a cell
\r
235 </member><member name="F:Rico.LiveGridBase.beforeInit">
\r
237 A Javascript function to be called right before the grid is initialized.
\r
239 </member><member name="F:Rico.LiveGridBase.afterInit">
\r
241 A Javascript function to be called right after the grid is initialized.
\r
243 </member><member name="F:Rico.LiveGridBase.TableFilter">
\r
245 For SQL data sources, this specifies a SQL condition clause to always be used when running the SQL query.
\r
247 </member><member name="F:Rico.LiveGridBase.saveColumnWidth">
\r
249 Whenever the user adjusts a column width, should the new width be saved to the grid's cookie? (default: true)
\r
251 </member><member name="F:Rico.LiveGridBase.saveColumnFilter">
\r
253 Whenever the user filters a column, should the new filter be saved to the grid's cookie? (default: false)
\r
255 </member><member name="F:Rico.LiveGridBase.saveColumnSort">
\r
257 Whenever the user sorts a column, should the new sort be saved to the grid's cookie? (default: false)
\r
259 </member><member name="F:Rico.LiveGridBase.cookieDays">
\r
261 Number of days before the grid's cookie expires. If you don't specify a value,
\r
262 then the cookie is only maintained for the current session.
\r
264 </member><member name="F:Rico.LiveGridBase.DefaultSort">
\r
266 For SQL data sources, this specifies the default way the data should be sorted. (default: use primary key)
\r
268 </member><member name="F:Rico.LiveGridBase.maxPrint">
\r
270 The maximum number of rows that the user is allowed to Print/Export. Set to 0 to disable print/export.
\r
271 Default is to use the Rico client value (currently 5000).
\r
273 </member><member name="F:Rico.LiveGridBase.dndMgrIdx">
\r
275 Specifies which drag-and-drop management zone should be used for drag operations (default: 0).
\r
276 This only needs to be specified if the web page uses multiple distinct zones.
\r
278 </member><member name="F:Rico.LiveGridBase.sessions">
\r
280 For SQL data sources, should the parsed query be stored in a session variable? This improves performance. (default: true)
\r
282 </member><member name="F:Rico.LiveGridBase.minPageRows">
\r
284 Minimum # of visible rows. Used only when visibleRows < 0. (default: 2)
\r
286 </member><member name="F:Rico.LiveGridBase.maxPageRows">
\r
288 Maximum # of visible rows. Used only when visibleRows < 0. (default: 50)
\r
290 </member><member name="F:Rico.LiveGridBase.ColGroupsOnTabHdr">
\r
292 Set to 'true' for ColumnGroup labels to be used as secondary headings.
\r
293 In LiveGrid Edit, it may be set to 'false' so that ColumnGroup labels are only used on the input form.
\r
296 </member><member name="F:Rico.LiveGridBase.sendDebugMsgs">
\r
298 Send details of sql parsing/execution in ajax response? (true/false)
\r
299 Default is to follow the debug value in web.config
\r
301 </member><member name="F:Rico.LiveGridBase.LogSqlOnError">
\r
303 Include sql statement in results if an error occurs (true/false)
\r
304 Default is to follow the debug value in web.config
\r
306 </member><member name="F:Rico.LiveGridBase.fmt">
\r
308 Format of data returned by AJAX calls, either "xml" or "json" (defaul: xml).
\r
310 </member><member name="F:Rico.LiveGridBase.largeBufferSize">
\r
312 This property influences the size of the client buffer and AJAX fetch size.
\r
313 Default value is -1, which means use the Rico client default value.
\r
315 </member><member name="F:Rico.LiveGridBase.requestParameters">
\r
317 Optional parameters to be passed along during the AJAX call
\r
319 </member><member name="P:Rico.LiveGridBase.formVar">
\r
321 Name of the Javascript variable containing the LiveGrid Edit object
\r
323 </member><member name="P:Rico.LiveGridBase.bufferVar">
\r
325 Name of the Javascript variable containing the LiveGrid buffer object
\r
327 </member><member name="P:Rico.LiveGridBase.bufferOptVar">
\r
329 Name of the Javascript variable containing the initial LiveGrid buffer options
\r
331 </member><member name="F:Rico.LiveGridBase.SqlCompat">
\r
333 Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.
\r
335 </member><member name="P:Rico.LiveGridBase.dbDialect">
\r
337 When connecting to SQL databases, this is the SQL dialect to use.
\r
339 </member><member name="P:Rico.LiveGridBase.dataProvider">
\r
341 When using a SQL data source there is no need to set this property,
\r
342 as AJAX data fetches are sent back to the originating script by default.
\r
343 When setting this property to a URL, make sure the URL is enclosed in single quotes.
\r
345 </member><member name="P:Rico.LiveGridBase.rows">
\r
347 Number of visible rows in the grid.
\r
348 Negative values have the following meanings:
\r
349 <list type="bullet">
\r
350 <item><description>-1: size grid to client window</description></item>
\r
351 <item><description>-2: size grid to whichever is smaller: the client window or the data</description></item>
\r
352 <item><description>-3: size grid so that the page body does not have a scrollbar (default)</description></item>
\r
353 <item><description>-4: size grid to its parent node in the DOM</description></item>
\r
356 </member><member name="F:Rico.LiveGridBase.ColGroups">
\r
358 Collection of ColumnGroup objects, which define the headings used above each group of columns.
\r
360 </member><member name="F:Rico.LiveGridBase.Tables">
\r
362 Defines the tables used by the LiveGrid. The first table is primary/main table.
\r
364 </member><member name="M:Rico.LiveGridBase.ColClassName(System.Int32)">
\r
366 Returns the class name of the specified grid column
\r
368 <param name="colnum"></param>
\r
369 </member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">
\r
371 Adds a new column to grid, returns column index
\r
373 <param name="ColumnObj"></param>
\r
374 </member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">
\r
376 Takes a given string and makes it JSON valid (http://json.org/)
\r
378 <param name="val">value which should be escaped</param>
\r
379 <returns>JSON valid string</returns>
\r
381 AUTHOR: Michael Rebec
\r
382 All characters which needs to be escaped are beeing replaced by their
\r
383 unicode representation according to the
\r
384 RFC4627#2.5 - http://www.ietf.org/rfc/rfc4627.txt?number=4627
\r
386 </member><member name="T:Rico.LiveGridBase">
\r
388 Methods and properties common to LiveGrid and LiveGridEdit
\r
390 </member><member name="P:Rico.LiveGrid.BufferType">
\r
392 The type of buffer deployed on the client
\r
393 <list type="table">
\r
394 <item><term>AjaxSQL</term><description>data source is a SQL database query</description></item>
\r
395 <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
396 <item><term>Base</term><description>data is static, loaded from either an html table or javascript array</description></item>
\r
399 </member><member name="P:Rico.LiveGrid.HtmlSourceId">
\r
401 If grid is populated from an html table, then set HtmlSourceId to the id of the source table
\r
403 </member><member name="P:Rico.LiveGrid.QueryDistinct">
\r
405 True if this should be a distinct sql query (default is false)
\r
407 </member><member name="T:Rico.LiveGrid">
\r
409 Class to define a LiveGrid
\r
410 A LiveGrid buffers its data in a Javascript array and can retrieve that data via AJAX
\r
412 </member><member name="P:Rico.TreeResponse.ErrorMsg">
\r
414 May contain the text of an error message that occurred outside this control prior to rendering
\r
416 </member><member name="P:Rico.TreeResponse.dbConnection">
\r
418 Database connection object. Required only if sqlText is used.
\r
420 </member><member name="P:Rico.TreeResponse.SqlText">
\r
422 Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters
\r
424 </member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">
\r
426 Adds an entry that will be returned with the results. Often used to add the root node.
\r
428 <param name="parentID">id of parent, "" if this is the root</param>
\r
429 <param name="ID">id that uniquely identifies this node in the tree</param>
\r
430 <param name="description">description displayed to the user</param>
\r
431 <param name="containerORleaf">"L" or 0 = leaf, "C" or non-zero = container</param>
\r
432 <param name="selectable">0=not selectable, 1=selectable</param>
\r
433 </member><member name="T:Rico.TreeResponse">
\r
435 Use this class on a page that responds to AJAX requests from a Rico Tree Control
\r
436 This class automatically disables caching of the response and sets the response type to text/xml
\r
438 </member><member name="P:Rico.GridBase.gridVar">
\r
440 Name of grid Javascript object
\r
442 </member><member name="P:Rico.GridBase.optionsVar">
\r
444 Name of grid options Javascript object
\r
446 </member><member name="F:Rico.GridBase.AutoFilter">
\r
448 If enabled, an additional row is added to the grid header where column filters are placed.
\r
449 See the EditCol.filterUI property to customize each column's filter.
\r
451 </member><member name="F:Rico.GridBase.FilterAllToken">
\r
453 The token in select filters used to indicate "show all values" (default: "___ALL___").
\r
455 </member><member name="F:Rico.GridBase.defaultWidth">
\r
457 if -1 (default), then use column heading width, otherwise this is the default width in pixels
\r
459 </member><member name="F:Rico.GridBase.allowColResize">
\r
461 Allow user to resize columns? Default is true.
\r
463 </member><member name="F:Rico.GridBase.frozenColumns">
\r
465 Number of frozen columns on the left (or right if direction=rtl). Default is 0.
\r
467 </member><member name="F:Rico.GridBase.RowLineHtEms">
\r
469 Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.
\r
471 </member><member name="F:Rico.GridBase.windowResize">
\r
473 Resize grid when browser window is resized? Default is true.
\r
475 </member><member name="P:Rico.GridBase.menuEvent">
\r
477 Specifies when the grid's popup menu should be invoked
\r
479 </member><member name="P:Rico.GridBase.DefaultHdgStyle">
\r
481 This holds the default style for headings. Use only if not using themes.
\r
483 </member><member name="F:Rico.GridBase.Styles">
\r
485 Collection of styles used for individual headings.
\r
487 </member><member name="P:Rico.GridBase.HdgRowLines">
\r
489 Lines of text displayed in each heading row
\r
491 </member><member name="P:Rico.GridBase.DefaultRowLines">
\r
493 Lines of text displayed in each data row
\r
495 </member><member name="P:Rico.GridBase.OuterDivId">
\r
497 Returns the id of the outermost grid container
\r
499 </member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">
\r
501 Returns the index of the column with the given id
\r
503 </member><member name="M:Rico.GridBase.GetColumn(System.String)">
\r
505 Returns the column object with the given id
\r
507 </member><member name="M:Rico.GridBase.GridRules">
\r
509 Returns the set of css rules that apply to this grid
\r
511 </member><member name="T:Rico.GridBase">
\r
513 This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.
\r
515 </member><member name="F:Rico.LoadClient.ImgHeading">
\r
517 Background image for grid headings and window titles.
\r
518 Should be left unset, as it is used only for the grayedout theme (in which case it is set automatically).
\r
520 </member><member name="F:Rico.LoadClient.BaseLib">
\r
522 The base Javascript library to load from http://ajax.googleapis.com/ajax/libs/, possible values include:
\r
523 <list type="bullet">
\r
524 <item><description>prototype/1.6/prototype.js</description></item>
\r
525 <item><description>prototype/1.7/prototype.js</description></item>
\r
526 <item><description>jquery/1.3/jquery.min.js</description></item>
\r
527 <item><description>jquery/1.4/jquery.min.js</description></item>
\r
528 <item><description>jquery/1.5/jquery.min.js</description></item>
\r
529 <item><description>jquery/1.6/jquery.min.js</description></item>
\r
530 <item><description>mootools/1.2/mootools-yui-compressed.js</description></item>
\r
531 <item><description>mootools/1.3/mootools-yui-compressed.js</description></item>
\r
532 <item><description>dojo/1.5/dojo/dojo.xd.js</description></item>
\r
533 <item><description>dojo/1.6/dojo/dojo.xd.js</description></item>
\r
534 <item><description>ext-core/3.0/ext-core.js</description></item>
\r
535 <item><description>ext-core/3.1/ext-core.js</description></item>
\r
537 <para>Default value is "proto_min", which loads prototype 1.7 from the server control.</para>
\r
539 </member><member name="F:Rico.LoadClient.Logging">
\r
541 Enable Javascript console logging? Useful for debugging. Default is false.
\r
543 </member><member name="F:Rico.LoadClient.HTML5">
\r
545 Enable HTML5 web form elements in browsers that support them.
\r
546 Default is false because the quality of the HTML5 web form elements is uneven across browsers.
\r
548 </member><member name="F:Rico.LoadClient.Language">
\r
550 Best left unset, in which case language will be set automatically based on request's HTTP_ACCEPT_LANGUAGE
\r
551 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
553 </member><member name="F:Rico.LoadClient.LoadBaseLib">
\r
555 Load base Javascript library (prototype, jQuery, etc)?
\r
557 Set to false if library is being loaded another way. In this case, a BaseLib value is still required to indicate
\r
558 which library Rico should connect to.
\r
560 </member><member name="F:Rico.LoadClient.Striping">
\r
562 Apply row striping to LiveGrids? Default is true. Applies only when themes are used.
\r
564 </member><member name="F:Rico.LoadClient.SupportedLangs">
\r
566 Comma separated list of 2 letter locales that Rico supports.
\r
567 Do not set unless you have developed your own locale file.
\r
569 </member><member name="F:Rico.LoadClient.jQueryThemePath">
\r
571 URL to load jQuery themes from.
\r
572 Default is http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/
\r
573 Override this value if you have a jQuery theme on your own server.
\r
575 </member><member name="P:Rico.LoadClient.LoadedLanguage">
\r
577 Returns the 2 character string representing the Rico locale file that was actually used on the client.
\r
578 If there is no match between the requested languages and the available locale files, then english is used.
\r
579 Only available during the render phase.
\r
581 </member><member name="P:Rico.LoadClient.checkQueryString">
\r
583 Load settings from QueryString? true for demo, false for anything else. Default is false.
\r
585 </member><member name="P:Rico.LoadClient.checkWebConfig">
\r
587 Load settings from web.config file? Default is false.
\r
588 If true, then the appSettings section of web.config will be checked for the following keys (which affect the similarly named properties):
\r
589 <list type="bullet">
\r
590 <item><description>rico_BaseLib</description></item>
\r
591 <item><description>rico_Language</description></item>
\r
592 <item><description>rico_jTheme</description></item>
\r
593 <item><description>rico_rTheme</description></item>
\r
594 <item><description>rico_Logging</description></item>
\r
595 <item><description>rico_HTML5</description></item>
\r
596 <item><description>rico_LoadBaseLib</description></item>
\r
597 <item><description>rico_Striping</description></item>
\r
599 <para>Boolean values in web.config should be the strings "true" or "1" for true, and "false" or "0" for false.</para>
\r
601 </member><member name="M:Rico.LoadClient.InitLiveGrids(System.Web.UI.HtmlTextWriter)">
\r
603 Initialize all grids on the page
\r
604 Initialize grids with fixed # of rows first,
\r
605 then initialize grids with variable # of rows
\r
607 </member><member name="P:Rico.LoadClient.jTheme">
\r
609 Set theme to one of the jQuery Themeroller themes. Default is no theme.
\r
611 black-tie, blitzer, cupertino, dark-hive, dot-luv, eggplant, excite-bike, flick,
\r
612 hot-sneaks, humanity, le-frog, mint-choc, overcast, pepper-grinder, redmond, smoothness,
\r
613 south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader
\r
615 </member><member name="P:Rico.LoadClient.rTheme">
\r
617 Set theme to one of the Rico themes. Default is no theme.
\r
619 coffee-with-milk, grayedout, greenHdg, seaglass, warmfall
\r
621 </member><member name="T:Rico.LoadClient">
\r
623 Loads the various Javascript, CSS, and image files required to make Rico function.
\r
625 </member><member name="P:Rico.StyleBase.bold">
\r
627 True if the text should be displayed using a bold font
\r
629 </member><member name="P:Rico.StyleBase.italic">
\r
631 True if the text should be displayed in italics
\r
633 </member><member name="P:Rico.StyleBase.underline">
\r
635 True if the text should be underlined
\r
637 </member><member name="P:Rico.StyleBase.fontsize">
\r
639 Font size in points
\r
641 </member><member name="P:Rico.StyleBase.GridOnly">
\r
643 If true, then style is only applied to the grid, not to html or Excel exports
\r
645 </member><member name="P:Rico.StyleBase.BackColor">
\r
647 Specifies the background color. One of the 16 standard color names, or #rrggbb.
\r
649 </member><member name="P:Rico.StyleBase.ForeColor">
\r
651 Specifies the font color. One of the 16 standard color names, or #rrggbb.
\r
653 </member><member name="P:Rico.StyleBase.HorizontalAlign">
\r
655 Specifies horizontal alignment: Left, Right, Center, or NotSet (default)
\r
657 </member><member name="P:Rico.StyleBase.Overflow">
\r
659 Normally, overflowed content is hidden, but this allows content in the cell to scroll.
\r
660 Only applies to the grid, not to exports.
\r
662 </member><member name="P:Rico.StyleBase.CssStyle">
\r
664 Used internally. Returns the style properties as a css string.
\r
666 </member><member name="M:Rico.StyleBase.UnwrappedXlStyle">
\r
668 Used internally. Returns the style properties as an Excel XML string without the style tag.
\r
670 </member><member name="T:Rico.StyleBase">
\r
672 Base class for all style classes as well as the Column class.
\r
674 </member><member name="P:Rico.Style.StyleID">
\r
676 StyleID's should not contain spaces or other special characters.
\r
677 <list type="bullet">
\r
678 <item><description>Use a StyleID of Default to style the entire grid</description></item>
\r
679 <item><description>Use a StyleID of DefaultHdg to style the grid heading</description></item>
\r
680 <item><description>Use a StyleID of ricoLG_evenRow and/or ricoLG_oddRow to stripe the grid (striping does not get exported).</description></item>
\r
681 <item><description>Use a StyleID of ricoLG_selection to set the styling for the selected row.</description></item>
\r
684 </member><member name="M:Rico.Style.CssRule">
\r
686 Returns the style properties as a CSS rule
\r
688 </member><member name="M:Rico.Style.WrappedXlStyle">
\r
690 Returns the style properties as an Excel XML style, including the style tag
\r
692 </member><member name="P:Rico.Style.xlNumberFormat">
\r
694 For SimpleGrids only
\r
696 </member><member name="P:Rico.Style.NumberFormat">
\r
698 For SimpleGrids only
\r
700 </member><member name="M:Rico.Style.WrappedXlStyleNF">
\r
702 Returns the style properties plus number format as an Excel XML style, including the style tag
\r
704 </member><member name="T:Rico.Style">
\r
706 Defines a style that can be applied to a grid cell.
\r
707 Using a StyleID of ricoLG_evenRow or ricoLG_oddRow will stripe the grid, however striping does not get exported.
\r
708 Using a StyleID of ricoLG_selection will set the styling for the selected row.
\r
710 </member><member name="M:Rico.StyleDictionary.Add(Rico.Style)">
\r
712 Adds a Style object to the collection
\r
714 <param name="new_style"></param>
\r
715 </member><member name="P:Rico.StyleDictionary.Item(System.String)">
\r
717 Returns a Style object from the collection based on the style's StyleID
\r
719 <param name="StyleId"></param>
\r
720 </member><member name="P:Rico.StyleDictionary.Keys">
\r
722 Returns all of the StyleID's in the collection
\r
724 </member><member name="P:Rico.StyleDictionary.Values">
\r
726 Returns all of the Style objects in the collection
\r
728 </member><member name="M:Rico.StyleDictionary.Contains(System.String)">
\r
730 Returns true if the StyleID is in the collection
\r
732 <param name="StyleId"></param>
\r
733 </member><member name="M:Rico.StyleDictionary.Remove(System.String)">
\r
735 Removes the Style object with the given StyleID from the collection
\r
737 <param name="StyleId"></param>
\r
738 </member><member name="T:Rico.StyleDictionary">
\r
740 Container for a collection of Style objects
\r
742 </member><member name="P:Rico.SimpleCol.Width">
\r
744 Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.
\r
746 </member><member name="T:Rico.SimpleCol">
\r
748 Defines a column in a SimpleGrid
\r
750 </member><member name="F:Rico.Column.canSort">
\r
752 Is the user allowed to sort the column? Default is true.
\r
754 </member><member name="F:Rico.Column.canDrag">
\r
756 Is the user allowed to drag a column value? Default is false.
\r
758 </member><member name="F:Rico.Column.canFilter">
\r
760 Is the user allowed to filter the column? Default is true.
\r
762 </member><member name="F:Rico.Column.control">
\r
764 Javascript code to create a control object, which changes the way the column data is rendered.
\r
765 The disadvantage of using this approach is that the altered rendering does not get reflected in exports.
\r
766 A set of controls is defined in ricoLiveGridControls.js or the developer can create their own.
\r
768 </member><member name="F:Rico.Column.filterUI">
\r
770 If the AutoFilter option is enabled for the grid, then filterUI will control how each column is filtered. If filterUI is:
\r
771 <list type="bullet">
\r
772 <item><description>null or omitted, then no filter is displayed for the column.</description></item>
\r
773 <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
774 <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
775 <item><description>'m' - will generate multi-select checklist filter, with a checkbox next to each item.</description></item>
\r
778 </member><member name="F:Rico.Column.filterColId">
\r
780 This setting allows the filterUI to filter a different column than where it is displayed.
\r
781 This is particularly useful for dates, where you can show a year selection on an OrderDate date column for example,
\r
782 but actually have it filter a hidden column OrderYear=year(OrderDate).
\r
784 </member><member name="F:Rico.Column.ConfirmDeleteColumn">
\r
786 The text content of this column will be included in delete confirmation messages.
\r
788 </member><member name="F:Rico.Column.multiplier">
\r
790 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
791 Default is 1. Automatically set to 100 if DataType is percent.
\r
793 </member><member name="F:Rico.Column.decPlaces">
\r
795 If column is a number, this is the number of digits displayed to the right of the decimal point. Default is 0.
\r
796 If DataType is dollar or euro, then decPlaces is automatically set to 2.
\r
798 </member><member name="F:Rico.Column.thouSep">
\r
800 If column is a number, display the value with a thousands separator? Default is true.
\r
802 </member><member name="F:Rico.Column.negSign">
\r
804 Specifies how negative numbers should be displayed. Possible values:
\r
806 <item><description>L=leading minus (default)</description></item>
\r
807 <item><description>T=trailing minus</description></item>
\r
808 <item><description>P=parentheses</description></item>
\r
811 </member><member name="F:Rico.Column.prefix">
\r
813 If column is a number, this string is prepended to the number before display.
\r
814 Useful for currency symbols.
\r
816 </member><member name="F:Rico.Column.suffix">
\r
818 If column is a number, this string is appended to the number before display.
\r
819 Useful for percentages and temperature values. Automatically set to % if DataType is percent.
\r
821 </member><member name="F:Rico.Column.HdgStyleID">
\r
823 Used to give the column heading a specific style.
\r
824 In most cases this is not necessary, as the heading will be styled according to the theme.
\r
826 </member><member name="F:Rico.Column.isNullable">
\r
828 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
830 </member><member name="F:Rico.Column.Writeable">
\r
832 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
834 </member><member name="F:Rico.Column.isKey">
\r
836 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
838 </member><member name="F:Rico.Column.Length">
\r
840 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
842 </member><member name="F:Rico.Column.TypeName">
\r
844 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
846 </member><member name="F:Rico.Column.ColGroupIdx">
\r
850 </member><member name="P:Rico.Column.Heading">
\r
852 Text displayed in the column heading.
\r
854 </member><member name="P:Rico.Column.Width">
\r
856 Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.
\r
858 </member><member name="M:Rico.Column.NumberFormat">
\r
860 Returns an Excel-type number format string based on decPlaces, thouSep, prefix.
\r
862 </member><member name="P:Rico.Column.DataType">
\r
864 Type of data stored in the column.
\r
866 </member><member name="M:Rico.Column.script">
\r
868 Internal function that returns the LiveGrid column options object, used to initialize the column on the client.
\r
870 </member><member name="T:Rico.Column">
\r
872 Base class for a LiveGrid column
\r
874 </member><member name="F:Rico.FormulaCol.Formula">
\r
878 </member><member name="T:Rico.FormulaCol">
\r
882 </member><member name="F:Rico.TableCol.ColName">
\r
884 Column name in table or view
\r
886 </member><member name="F:Rico.TableCol.TblAlias">
\r
888 This should match the TblAlias of one of the Table objects specified for the grid.
\r
889 If unspecified, the primary table or view is assumed.
\r
891 </member><member name="F:Rico.TableCol.TableIdx">
\r
895 </member><member name="T:Rico.TableCol">
\r
897 Column from table or view
\r
899 </member><member name="F:Rico.EditCol.pattern">
\r
901 Regular expression used to validate the user input. User entries will be checked to ensure they match the pattern specified.
\r
902 There are a few special values:
\r
903 <list type="table">
\r
904 <item><term>email</term><description>tests for a valid email address</description></item>
\r
905 <item><term>float-unsigned</term><description>tests for a valid unsigned floating point (real) number</description></item>
\r
906 <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
907 <item><term>int-unsigned</term><description>tests for a valid unsigned integer number</description></item>
\r
908 <item><term>int-signed</term><description>tests for a valid signed integer number (this is the default when EntryType is "I")</description></item>
\r
911 </member><member name="F:Rico.EditCol.min">
\r
913 Sets the minimum allowable value in a numeric or date field.
\r
914 For dates, the value should be in ISO-8601 format.
\r
916 </member><member name="F:Rico.EditCol.max">
\r
918 Sets the maximum allowable value in a numeric or date field.
\r
919 For dates, the value should be in ISO-8601 format.
\r
921 </member><member name="F:Rico.EditCol.Help">
\r
923 Provides information to help the user understand the meaning of the field.
\r
924 Fields with help text will be display with a blue "i" icon next to the field name.
\r
925 When the user hovers their cursor over the icon, the help text will be displayed.
\r
927 </member><member name="F:Rico.EditCol.TxtAreaRows">
\r
929 For columns with entry type "TA", this is # of rows to display in the textarea when in form view (default 4)
\r
931 </member><member name="F:Rico.EditCol.TxtAreaCols">
\r
933 For columns with entry type "TA", this is # of columns to display in the textarea when in form view (default 80)
\r
935 </member><member name="F:Rico.EditCol.ColData">
\r
937 column's default value in the form view
\r
939 </member><member name="F:Rico.EditCol.SelectSql">
\r
941 Specifies the SQL select statement to use for EntryTypes of SL, CL, and RL.
\r
942 The select statement should return 2 columns: the first being the code and the second being the text value/description.
\r
945 EntryType="SL" ColName="CustID" SelectSql="select ID,Name from Customers"
\r
948 </member><member name="F:Rico.EditCol.SelectCtl">
\r
950 For entry type "CL", this property specifies the id of the custom control.
\r
952 </member><member name="F:Rico.EditCol.SelectFilter">
\r
954 SelectSql serves 2 purposes. First, it is used to retrieve the appropriate data to display in the grid.
\r
955 Second, it is used to populate the values in the select box (SL) or radio buttons (RL) on the pop-up form.
\r
956 In some cases, you may want these to be different. In the SelectSql example above, we are retrieving customer name.
\r
957 But let's say that our Customers table has a "CreditHold" field and we want to disable the selection of customers
\r
958 on credit hold in the form view, but still display them in the grid.
\r
959 This is where SelectFilter comes in:
\r
961 SelectFilter="CreditHold='NO'"
\r
964 </member><member name="F:Rico.EditCol.SelectValues">
\r
966 Specifies the choices the user sees in form view for EntryTypes of N, S, and R.
\r
967 If supplied, then this should be a string of comma-separated values.
\r
973 </member><member name="F:Rico.EditCol.SelectRows">
\r
975 Specifies the number of rows to display in drop down select boxes for entry types S and SL.
\r
976 Default is to let the browser decide.
\r
978 </member><member name="F:Rico.EditCol.FilterFlag">
\r
980 If true, then the grid is filtered by the default value (ColData) for this column (default=false)
\r
982 </member><member name="F:Rico.EditCol.InsertOnly">
\r
984 If true, then only write this field to the database when peforming an insert (default=false).
\r
986 </member><member name="F:Rico.EditCol.UpdateOnly">
\r
988 If true, then only write this field to the database when peforming an update (default=false).
\r
990 </member><member name="F:Rico.EditCol.ReadOnly">
\r
992 If true, data is displayed on the entry form but cannot be changed, text is gray (default=false).
\r
993 Does not apply to entry types of S, SL, N, R, RL -- use FormView="hidden" instead.
\r
995 </member><member name="F:Rico.EditCol.FormView">
\r
997 <list type="table">
\r
998 <item><term>True</term><description>Item is shown on the entry form (default)</description></item>
\r
999 <item><term>False</term><description>Item is not shown on the form</description></item>
\r
1002 </member><member name="F:Rico.EditCol.AddQuotes">
\r
1004 When false, the column value will be left unquoted when inserting or updating the database.
\r
1005 Default is false for entry type TS, and true for all other entry types.
\r
1006 This makes it possible to populate columns with SQL function calls.
\r
1009 ColName="LastEditUser" EntryType="H" AddQuotes="false" ColData="suser_sname()"
\r
1012 </member><member name="F:Rico.EditCol.MultiSelect">
\r
1014 If true, the user is allowed to select multiple values.
\r
1015 For entry types R and RL, this changes the input from radio buttons to checkboxes.
\r
1018 </member><member name="F:Rico.EditCol.DescriptionCol">
\r
1020 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
1021 name or description. However, by specifying a value for DescriptionCol, you can store the associated description as well.
\r
1023 EntryType="SL" ColName="CustID" DescriptionCol="CustName" SelectSql="select ID,Name from Customers"
\r
1026 </member><member name="F:Rico.EditCol.DescriptionField">
\r
1028 Used internally. Populates automatically based on DescriptionCol.
\r
1030 </member><member name="F:Rico.EditCol.noFormBreak">
\r
1032 Boolean value that when true, specifies that this entry field should placed on the same form row as the last field
\r
1033 (default: false - each form field is placed on a separate row).
\r
1035 </member><member name="M:Rico.EditCol.isLookupField">
\r
1037 Returns true if the column is a lookup field (entry type SL, RL, or CL)
\r
1039 </member><member name="P:Rico.EditCol.EntryType">
\r
1041 Code indicating the ui to be used for data entry
\r
1042 <list type="table">
\r
1043 <item><term>TA</term><description>Text Area</description></item>
\r
1044 <item><term>R</term><description>Radio button list</description></item>
\r
1045 <item><term>RL</term><description>Radio buttons via lookup (field is a foreign key)</description></item>
\r
1046 <item><term>S</term><description>Select list</description></item>
\r
1047 <item><term>SL</term><description>Select list via lookup (field is a foreign key)</description></item>
\r
1048 <item><term>CL</term><description>Custom widget via lookup (field is a foreign key)</description></item>
\r
1049 <item><term>N</term><description>Select list of distinct column values, use allowed to add new values</description></item>
\r
1050 <item><term>B</term><description>Text, non-blank</description></item>
\r
1051 <item><term>T</term><description>Text</description></item>
\r
1052 <item><term>I</term><description>Integer</description></item>
\r
1053 <item><term>F</term><description>Floating point number</description></item>
\r
1054 <item><term>tinyMCE</term><description>Rich text via tinyMCE</description></item>
\r
1055 <item><term>D</term><description>Date</description></item>
\r
1056 <item><term>TS</term><description>Time stamp</description></item>
\r
1057 <item><term>H</term><description>Hidden</description></item>
\r
1060 </member><member name="T:Rico.EditCol">
\r
1062 Defines an editable column in a LiveGridEdit object
\r
1064 </member><member name="T:Rico.SimpleGrid">
\r
1066 Class to define a SimpleGrid
\r