1 <?xml version="1.0"?>
\r
9 <member name="P:Rico.TreeResponse.ErrorMsg">
\r
11 May contain the text of an error message that occurred outside this control prior to rendering
\r
16 </member><member name="P:Rico.TreeResponse.dbConnection">
\r
18 Database connection object. Required only if sqlText is used.
\r
22 </member><member name="P:Rico.TreeResponse.SqlText">
\r
24 Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters
\r
29 </member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">
\r
31 Adds an entry that will be returned with the results. Often used to add the root node.
\r
33 <param name="parentID">id of parent, "" if this is the root</param>
\r
34 <param name="ID">id that uniquely identifies this node in the tree</param>
\r
35 <param name="description">description displayed to the user</param>
\r
36 <param name="containerORleaf">"L" or 0 = leaf, "C" or non-zero = container</param>
\r
37 <param name="selectable">0=not selectable, 1=selectable</param>
\r
39 </member><member name="T:Rico.TreeResponse">
\r
41 Use this class on a page that responds to AJAX requests from a Rico Tree Control
\r
42 This class automatically disables caching of the response and sets the response type to text/xml
\r
45 </member><member name="T:Rico.sqlParse.sqlColumn">
\r
47 Represents a column in the select statement
\r
49 </member><member name="F:Rico.sqlParse.IsDistinct">
\r
51 True if the select statement contains the DISTINCT keyword
\r
53 </member><member name="F:Rico.sqlParse.SelectList">
\r
55 List of columns in the select statement
\r
57 </member><member name="F:Rico.sqlParse.GroupBy">
\r
59 List of "group by" items in the select statement
\r
61 </member><member name="F:Rico.sqlParse.OrderBy">
\r
63 List of "order by" items in the select statement
\r
65 </member><member name="F:Rico.sqlParse.FromClause">
\r
67 From clause of the select statement, including any joins
\r
69 </member><member name="F:Rico.sqlParse.WhereClause">
\r
71 Where clause of the select statement
\r
73 </member><member name="F:Rico.sqlParse.HavingClause">
\r
75 Having clause of the select statement
\r
77 </member><member name="F:Rico.sqlParse.Headings">
\r
79 List of column headings in the select list.
\r
80 Set after an any unparse* call.
\r
82 </member><member name="M:Rico.sqlParse.Clone">
\r
84 Returns a cloned copy of this object
\r
86 </member><member name="M:Rico.sqlParse.UnparseSelect">
\r
88 Builds a SQL select statement string from its parsed components
\r
90 </member><member name="M:Rico.sqlParse.UnparseSelectDistinct">
\r
92 Rebuilds a SQL select statement that was parsed by ParseSelect, inserting the DISTINCT keyword
\r
94 </member><member name="M:Rico.sqlParse.UnparseDistinctColumnAccess(System.Int32)">
\r
96 Returns a SQL select statement that will return all of the values in a particular column.
\r
97 This version is meant MS Access, as it does not support ordering by column name
\r
99 <param name="colnum"></param>
\r
100 </member><member name="M:Rico.sqlParse.UnparseDistinctColumn(System.Int32)">
\r
102 Returns a SQL select statement that will return all of the values in a particular column.
\r
103 The returned statement is not compatible MS Access, use UnparseDistinctColumnAccess() instead.
\r
105 <param name="colnum"></param>
\r
106 </member><member name="M:Rico.sqlParse.UnparseColumnList">
\r
108 Returns the select list part of the statement as a string
\r
110 <returns></returns>
\r
111 <remarks></remarks>
\r
112 </member><member name="M:Rico.sqlParse.UnparseWithRowNumber(System.Int32,System.Int32,System.Boolean)">
\r
114 Returns a "windowed" select query.
\r
116 <param name="offset">The first row number to be returned</param>
\r
117 <param name="numrows">The number of rows to return</param>
\r
118 <param name="includeAS">use true for SQL Server 2005+ and false for Oracle</param>
\r
119 <returns></returns>
\r
120 <remarks></remarks>
\r
121 </member><member name="M:Rico.sqlParse.Clear">
\r
123 Resets the object and prepares it to parse another select statement.
\r
125 <remarks></remarks>
\r
126 </member><member name="M:Rico.sqlParse.ParseSelect(System.String)">
\r
128 Loads a select statement into the object.
\r
130 <list type="bullet">
\r
131 <item><description>union queries *</description></item>
\r
132 <item><description>select into</description></item>
\r
133 <item><description>select top</description></item>
\r
134 <item><description>more than one space between "group" and "by", or "order" and "by"</description></item>
\r
135 <item><description>stored procedures</description></item>
\r
137 <para>* Put union queries in a view and then write your select statement against the view.</para>
\r
139 <param name="sqltext"></param>
\r
140 </member><member name="T:Rico.sqlParse">
\r
142 Holds a SQL select statement. Methods to load/parse a select statement from a string and to reassemble it in various ways.
\r
143 Does not handle union queries.
\r
145 </member><member name="P:Rico.SimpleCol.Width">
\r
147 Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.
\r
149 </member><member name="T:Rico.SimpleCol">
\r
151 Defines a column in a SimpleGrid
\r
153 </member><member name="F:Rico.Column.canSort">
\r
155 Is the user allowed to sort the column? Default is true.
\r
157 </member><member name="F:Rico.Column.canDrag">
\r
159 Is the user allowed to drag a column value? Default is false.
\r
161 </member><member name="F:Rico.Column.canFilter">
\r
163 Is the user allowed to filter the column? Default is true.
\r
165 </member><member name="F:Rico.Column.control">
\r
167 Javascript code to create a control object, which changes the way the column data is rendered.
\r
168 The disadvantage of using this approach is that the altered rendering does not get reflected in exports.
\r
169 A set of controls is defined in ricoLiveGridControls.js or the developer can create their own.
\r
171 </member><member name="F:Rico.Column.filterUI">
\r
173 If the AutoFilter option is enabled for the grid, then filterUI will control how each column is filtered. If filterUI is:
\r
174 <list type="bullet">
\r
175 <item><description>null or omitted, then no filter is displayed for the column.</description></item>
\r
176 <item><description>'t' - will generate a text box filter and the records being displayed are filtered as the user types. May be followed by a number to indicate the size of the text box (default size is 10). </description></item>
\r
177 <item><description>'s' - will generate a select list filter with all possible column values contained in the list. Populated using a 'select distinct' query if the grid's source is a SQL query.</description></item>
\r
178 <item><description>'m' - will generate multi-select checklist filter, with a checkbox next to each item.</description></item>
\r
181 </member><member name="F:Rico.Column.filterColId">
\r
183 This setting allows the filterUI to filter a different column than where it is displayed.
\r
184 This is particularly useful for dates, where you can show a year selection on an OrderDate date column for example,
\r
185 but actually have it filter a hidden column OrderYear=year(OrderDate).
\r
187 </member><member name="F:Rico.Column.ConfirmDeleteColumn">
\r
189 The text content of this column will be included in delete confirmation messages.
\r
191 </member><member name="F:Rico.Column.multiplier">
\r
193 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
194 Default is 1. Automatically set to 100 if DataType is percent.
\r
196 </member><member name="F:Rico.Column.decPlaces">
\r
198 If column is a number, this is the number of digits displayed to the right of the decimal point. Default is 0.
\r
199 If DataType is dollar or euro, then decPlaces is automatically set to 2.
\r
201 </member><member name="F:Rico.Column.thouSep">
\r
203 If column is a number, display the value with a thousands separator? Default is true.
\r
205 </member><member name="F:Rico.Column.negSign">
\r
207 Specifies how negative numbers should be displayed. Possible values:
\r
209 <item><description>L=leading minus (default)</description></item>
\r
210 <item><description>T=trailing minus</description></item>
\r
211 <item><description>P=parentheses</description></item>
\r
214 </member><member name="F:Rico.Column.prefix">
\r
216 If column is a number, this string is prepended to the number before display.
\r
217 Useful for currency symbols.
\r
219 </member><member name="F:Rico.Column.suffix">
\r
221 If column is a number, this string is appended to the number before display.
\r
222 Useful for percentages and temperature values. Automatically set to % if DataType is percent.
\r
224 </member><member name="F:Rico.Column.HdgStyleID">
\r
226 Used to give the column heading a specific style.
\r
227 In most cases this is not necessary, as the heading will be styled according to the theme.
\r
229 </member><member name="F:Rico.Column.isNullable">
\r
231 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
233 </member><member name="F:Rico.Column.Writeable">
\r
235 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
237 </member><member name="F:Rico.Column.isKey">
\r
239 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
241 </member><member name="F:Rico.Column.Length">
\r
243 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
245 </member><member name="F:Rico.Column.TypeName">
\r
247 Database property - set automatically by LiveGrid.GetColumnInfoFromDb()
\r
249 </member><member name="F:Rico.Column.ColGroupIdx">
\r
253 </member><member name="P:Rico.Column.Heading">
\r
255 Text displayed in the column heading.
\r
257 </member><member name="P:Rico.Column.Width">
\r
259 Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.
\r
261 </member><member name="M:Rico.Column.NumberFormat">
\r
263 Returns an Excel-type number format string based on decPlaces, thouSep, prefix.
\r
265 </member><member name="P:Rico.Column.DataType">
\r
267 Type of data stored in the column.
\r
269 </member><member name="M:Rico.Column.script">
\r
271 Internal function that returns the LiveGrid column options object, used to initialize the column on the client.
\r
273 </member><member name="T:Rico.Column">
\r
275 Base class for a LiveGrid column
\r
277 </member><member name="F:Rico.FormulaCol.Formula">
\r
281 </member><member name="T:Rico.FormulaCol">
\r
285 </member><member name="F:Rico.TableCol.ColName">
\r
287 Column name in table or view
\r
289 </member><member name="F:Rico.TableCol.TblAlias">
\r
291 This should match the TblAlias of one of the Table objects specified for the grid.
\r
292 If unspecified, the primary table or view is assumed.
\r
294 </member><member name="F:Rico.TableCol.TableIdx">
\r
298 </member><member name="T:Rico.TableCol">
\r
300 Column from table or view
\r
302 </member><member name="F:Rico.EditCol.pattern">
\r
304 Regular expression used to validate the user input. User entries will be checked to ensure they match the pattern specified.
\r
305 There are a few special values:
\r
306 <list type="table">
\r
307 <item><term>email</term><description>tests for a valid email address</description></item>
\r
308 <item><term>float-unsigned</term><description>tests for a valid unsigned floating point (real) number</description></item>
\r
309 <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
310 <item><term>int-unsigned</term><description>tests for a valid unsigned integer number</description></item>
\r
311 <item><term>int-signed</term><description>tests for a valid signed integer number (this is the default when EntryType is "I")</description></item>
\r
314 </member><member name="F:Rico.EditCol.min">
\r
316 Sets the minimum allowable value in a numeric or date field.
\r
317 For dates, the value should be in ISO-8601 format.
\r
319 </member><member name="F:Rico.EditCol.max">
\r
321 Sets the maximum allowable value in a numeric or date field.
\r
322 For dates, the value should be in ISO-8601 format.
\r
324 </member><member name="F:Rico.EditCol.Help">
\r
326 Provides information to help the user understand the meaning of the field.
\r
327 Fields with help text will be display with a blue "i" icon next to the field name.
\r
328 When the user hovers their cursor over the icon, the help text will be displayed.
\r
330 </member><member name="F:Rico.EditCol.TxtAreaRows">
\r
332 For columns with entry type "TA", this is # of rows to display in the textarea when in form view (default 4)
\r
334 </member><member name="F:Rico.EditCol.TxtAreaCols">
\r
336 For columns with entry type "TA", this is # of columns to display in the textarea when in form view (default 80)
\r
338 </member><member name="F:Rico.EditCol.ColData">
\r
340 column's default value in the form view
\r
342 </member><member name="F:Rico.EditCol.SelectSql">
\r
344 Specifies the SQL select statement to use for EntryTypes of SL, CL, and RL.
\r
345 The select statement should return 2 columns: the first being the code and the second being the text value/description.
\r
348 EntryType="SL" ColName="CustID" SelectSql="select ID,Name from Customers"
\r
351 </member><member name="F:Rico.EditCol.SelectCtl">
\r
353 For entry type "CL", this property specifies the id of the custom control.
\r
355 </member><member name="F:Rico.EditCol.SelectFilter">
\r
357 SelectSql serves 2 purposes. First, it is used to retrieve the appropriate data to display in the grid.
\r
358 Second, it is used to populate the values in the select box (SL) or radio buttons (RL) on the pop-up form.
\r
359 In some cases, you may want these to be different. In the SelectSql example above, we are retrieving customer name.
\r
360 But let's say that our Customers table has a "CreditHold" field and we want to disable the selection of customers
\r
361 on credit hold in the form view, but still display them in the grid.
\r
362 This is where SelectFilter comes in:
\r
364 SelectFilter="CreditHold='NO'"
\r
367 </member><member name="F:Rico.EditCol.SelectValues">
\r
369 Specifies the choices the user sees in form view for EntryTypes of N, S, and R.
\r
370 If supplied, then this should be a string of comma-separated values.
\r
376 </member><member name="F:Rico.EditCol.SelectRows">
\r
378 Specifies the number of rows to display in drop down select boxes for entry types S and SL.
\r
379 Default is to let the browser decide.
\r
381 </member><member name="F:Rico.EditCol.FilterFlag">
\r
383 If true, then the grid is filtered by the default value (ColData) for this column (default=false)
\r
385 </member><member name="F:Rico.EditCol.InsertOnly">
\r
387 If true, then only write this field to the database when peforming an insert (default=false).
\r
389 </member><member name="F:Rico.EditCol.UpdateOnly">
\r
391 If true, then only write this field to the database when peforming an update (default=false).
\r
393 </member><member name="F:Rico.EditCol.ReadOnly">
\r
395 If true, data is displayed on the entry form but cannot be changed, text is gray (default=false).
\r
396 Does not apply to entry types of S, SL, N, R, RL -- use FormView="hidden" instead.
\r
398 </member><member name="F:Rico.EditCol.FormView">
\r
400 <list type="table">
\r
401 <item><term>True</term><description>Item is shown on the entry form (default)</description></item>
\r
402 <item><term>False</term><description>Item is not shown on the form</description></item>
\r
405 </member><member name="F:Rico.EditCol.AddQuotes">
\r
407 When false, the column value will be left unquoted when inserting or updating the database.
\r
408 Default is false for entry type TS, and true for all other entry types.
\r
409 This makes it possible to populate columns with SQL function calls.
\r
412 ColName="LastEditUser" EntryType="H" AddQuotes="false" ColData="suser_sname()"
\r
415 </member><member name="F:Rico.EditCol.MultiSelect">
\r
417 If true, the user is allowed to select multiple values.
\r
418 For entry types R and RL, this changes the input from radio buttons to checkboxes.
\r
421 </member><member name="F:Rico.EditCol.DescriptionCol">
\r
423 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
424 name or description. However, by specifying a value for DescriptionCol, you can store the associated description as well.
\r
426 EntryType="SL" ColName="CustID" DescriptionCol="CustName" SelectSql="select ID,Name from Customers"
\r
429 </member><member name="F:Rico.EditCol.DescriptionField">
\r
431 Used internally. Populates automatically based on DescriptionCol.
\r
433 </member><member name="F:Rico.EditCol.noFormBreak">
\r
435 Boolean value that when true, specifies that this entry field should placed on the same form row as the last field
\r
436 (default: false - each form field is placed on a separate row).
\r
438 </member><member name="M:Rico.EditCol.isLookupField">
\r
440 Returns true if the column is a lookup field (entry type SL, RL, or CL)
\r
442 </member><member name="P:Rico.EditCol.EntryType">
\r
444 Code indicating the ui to be used for data entry
\r
445 <list type="table">
\r
446 <item><term>TA</term><description>Text Area</description></item>
\r
447 <item><term>R</term><description>Radio button list</description></item>
\r
448 <item><term>RL</term><description>Radio buttons via lookup (field is a foreign key)</description></item>
\r
449 <item><term>S</term><description>Select list</description></item>
\r
450 <item><term>SL</term><description>Select list via lookup (field is a foreign key)</description></item>
\r
451 <item><term>CL</term><description>Custom widget via lookup (field is a foreign key)</description></item>
\r
452 <item><term>N</term><description>Select list of distinct column values, use allowed to add new values</description></item>
\r
453 <item><term>B</term><description>Text, non-blank</description></item>
\r
454 <item><term>T</term><description>Text</description></item>
\r
455 <item><term>I</term><description>Integer</description></item>
\r
456 <item><term>F</term><description>Floating point number</description></item>
\r
457 <item><term>tinyMCE</term><description>Rich text via tinyMCE</description></item>
\r
458 <item><term>D</term><description>Date</description></item>
\r
459 <item><term>TS</term><description>Time stamp</description></item>
\r
460 <item><term>H</term><description>Hidden</description></item>
\r
463 </member><member name="T:Rico.EditCol">
\r
465 Defines an editable column in a LiveGridEdit object
\r
467 </member><member name="F:Rico.LiveGridBase.dbConnection">
\r
469 Database connection object (used when data source is a SQL query)
\r
471 </member><member name="F:Rico.LiveGridBase.canSortDefault">
\r
473 Controls whether columns can be sorted (default: true).
\r
474 Sorting can be disabled for individual columns using the canSort property.
\r
476 </member><member name="F:Rico.LiveGridBase.canHideDefault">
\r
478 Controls whether columns can be hidden/shown (default: true).
\r
479 Hide/show can be disabled for individual columns using the canHide property.
\r
481 </member><member name="F:Rico.LiveGridBase.canFilterDefault">
\r
483 Controls whether columns can be filtered (default: true).
\r
484 Filtering can be disabled for individual columns using the canFilter property.
\r
486 </member><member name="F:Rico.LiveGridBase.highlightElem">
\r
488 A string that specifies what gets highlighted/selected in the grid
\r
489 <list type="table">
\r
490 <item><term>cursorRow</term><description>the grid row under the cursor</description></item>
\r
491 <item><term>cursorCell</term><description>the grid cell under the cursor</description></item>
\r
492 <item><term>menuRow</term><description>the grid row where the menu is displayed (default)</description></item>
\r
493 <item><term>menuCell</term><description>the grid cell where the menu is displayed</description></item>
\r
494 <item><term>selection</term><description>allow the user to select cells</description></item>
\r
495 <item><term>none</term><description>never highlight</description></item>
\r
498 </member><member name="F:Rico.LiveGridBase.highlightMethod">
\r
500 Method used to highlight cells and rows.
\r
501 <list type="table">
\r
502 <item><term>outline</term><description>least CPU-intensive on client-side</description></item>
\r
503 <item><term>class</term><description>adds CSS class to highlighted cell/row (default)</description></item>
\r
504 <item><term>both</term><description>highlight using both outline and class</description></item>
\r
507 </member><member name="F:Rico.LiveGridBase.prefetchBuffer">
\r
509 Load the buffer (and therefore the grid) on page load? (default: true)
\r
511 </member><member name="F:Rico.LiveGridBase.DisplayTimer">
\r
513 Display the session timer above the grid? (default: true)
\r
515 </member><member name="F:Rico.LiveGridBase.DisplayBookmark">
\r
517 Display the grid bookmark, ie. "Listing records X - Y of Z" (default: true)
\r
519 </member><member name="F:Rico.LiveGridBase.Caption">
\r
521 A caption for the grid, displayed next to the bookmark (default: nothing)
\r
523 </member><member name="F:Rico.LiveGridBase.click">
\r
525 Javascript event handler called when the user left-clicks on a cell
\r
527 </member><member name="F:Rico.LiveGridBase.dblclick">
\r
529 Javascript event handler called when the user double-clicks on a cell
\r
531 </member><member name="F:Rico.LiveGridBase.contextmenu">
\r
533 Javascript event handler called when the user right-clicks on a cell
\r
535 </member><member name="F:Rico.LiveGridBase.beforeInit">
\r
537 A Javascript function to be called right before the grid is initialized.
\r
539 </member><member name="F:Rico.LiveGridBase.afterInit">
\r
541 A Javascript function to be called right after the grid is initialized.
\r
543 </member><member name="F:Rico.LiveGridBase.TableFilter">
\r
545 For SQL data sources, this specifies a SQL condition clause to always be used when running the SQL query.
\r
547 </member><member name="F:Rico.LiveGridBase.saveColumnWidth">
\r
549 Whenever the user adjusts a column width, should the new width be saved to the grid's cookie? (default: true)
\r
551 </member><member name="F:Rico.LiveGridBase.saveColumnFilter">
\r
553 Whenever the user filters a column, should the new filter be saved to the grid's cookie? (default: false)
\r
555 </member><member name="F:Rico.LiveGridBase.saveColumnSort">
\r
557 Whenever the user sorts a column, should the new sort be saved to the grid's cookie? (default: false)
\r
559 </member><member name="F:Rico.LiveGridBase.cookieDays">
\r
561 Number of days before the grid's cookie expires. If you don't specify a value,
\r
562 then the cookie is only maintained for the current session.
\r
564 </member><member name="F:Rico.LiveGridBase.DefaultSort">
\r
566 For SQL data sources, this specifies the default way the data should be sorted. (default: use primary key)
\r
568 </member><member name="F:Rico.LiveGridBase.maxPrint">
\r
570 The maximum number of rows that the user is allowed to Print/Export. Set to 0 to disable print/export.
\r
571 Default is to use the Rico client value (currently 5000).
\r
573 </member><member name="F:Rico.LiveGridBase.dndMgrIdx">
\r
575 Specifies which drag-and-drop management zone should be used for drag operations (default: 0).
\r
576 This only needs to be specified if the web page uses multiple distinct zones.
\r
578 </member><member name="F:Rico.LiveGridBase.sessions">
\r
580 For SQL data sources, should the parsed query be stored in a session variable? This improves performance. (default: true)
\r
582 </member><member name="F:Rico.LiveGridBase.minPageRows">
\r
584 Minimum # of visible rows. Used only when visibleRows < 0. (default: 2)
\r
586 </member><member name="F:Rico.LiveGridBase.maxPageRows">
\r
588 Maximum # of visible rows. Used only when visibleRows < 0. (default: 50)
\r
590 </member><member name="F:Rico.LiveGridBase.ColGroupsOnTabHdr">
\r
592 Set to 'true' for ColumnGroup labels to be used as secondary headings.
\r
593 In LiveGrid Edit, it may be set to 'false' so that ColumnGroup labels are only used on the input form.
\r
596 </member><member name="F:Rico.LiveGridBase.sendDebugMsgs">
\r
598 Send details of sql parsing/execution in ajax response? (true/false)
\r
599 Default is to follow the debug value in web.config
\r
601 </member><member name="F:Rico.LiveGridBase.LogSqlOnError">
\r
603 Include sql statement in results if an error occurs (true/false)
\r
604 Default is to follow the debug value in web.config
\r
606 </member><member name="F:Rico.LiveGridBase.fmt">
\r
608 Format of data returned by AJAX calls, either "xml" or "json" (defaul: xml).
\r
610 </member><member name="F:Rico.LiveGridBase.largeBufferSize">
\r
612 This property influences the size of the client buffer and AJAX fetch size.
\r
613 Default value is -1, which means use the Rico client default value.
\r
615 </member><member name="F:Rico.LiveGridBase.requestParameters">
\r
617 Optional parameters to be passed along during the AJAX call
\r
619 </member><member name="P:Rico.LiveGridBase.formVar">
\r
621 Name of the Javascript variable containing the LiveGrid Edit object
\r
623 </member><member name="P:Rico.LiveGridBase.bufferVar">
\r
625 Name of the Javascript variable containing the LiveGrid buffer object
\r
627 </member><member name="P:Rico.LiveGridBase.bufferOptVar">
\r
629 Name of the Javascript variable containing the initial LiveGrid buffer options
\r
631 </member><member name="F:Rico.LiveGridBase.SqlCompat">
\r
633 Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.
\r
635 </member><member name="P:Rico.LiveGridBase.dbDialect">
\r
637 When connecting to SQL databases, this is the SQL dialect to use.
\r
639 </member><member name="P:Rico.LiveGridBase.dataProvider">
\r
641 When using a SQL data source there is no need to set this property,
\r
642 as AJAX data fetches are sent back to the originating script by default.
\r
643 When setting this property to a URL, make sure the URL is enclosed in single quotes.
\r
645 </member><member name="P:Rico.LiveGridBase.rows">
\r
647 Number of visible rows in the grid.
\r
648 Negative values have the following meanings:
\r
649 <list type="bullet">
\r
650 <item><description>-1: size grid to client window</description></item>
\r
651 <item><description>-2: size grid to whichever is smaller: the client window or the data</description></item>
\r
652 <item><description>-3: size grid so that the page body does not have a scrollbar (default)</description></item>
\r
653 <item><description>-4: size grid to its parent node in the DOM</description></item>
\r
656 </member><member name="F:Rico.LiveGridBase.ColGroups">
\r
658 Collection of ColumnGroup objects, which define the headings used above each group of columns.
\r
660 </member><member name="F:Rico.LiveGridBase.Tables">
\r
662 Defines the tables used by the LiveGrid. The first table is primary/main table.
\r
664 </member><member name="M:Rico.LiveGridBase.ColClassName(System.Int32)">
\r
666 Returns the class name of the specified grid column
\r
668 <param name="colnum"></param>
\r
669 </member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">
\r
671 Adds a new column to grid, returns column index
\r
673 <param name="ColumnObj"></param>
\r
674 </member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">
\r
676 Takes a given string and makes it JSON valid (http://json.org/)
\r
678 <param name="val">value which should be escaped</param>
\r
679 <returns>JSON valid string</returns>
\r
681 AUTHOR: Michael Rebec
\r
682 All characters which needs to be escaped are beeing replaced by their
\r
683 unicode representation according to the
\r
684 RFC4627#2.5 - http://www.ietf.org/rfc/rfc4627.txt?number=4627
\r
686 </member><member name="T:Rico.LiveGridBase">
\r
688 Methods and properties common to LiveGrid and LiveGridEdit
\r
690 </member><member name="P:Rico.LiveGrid.BufferType">
\r
692 The type of buffer deployed on the client
\r
693 <list type="table">
\r
694 <item><term>AjaxSQL</term><description>data source is a SQL database query</description></item>
\r
695 <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
696 <item><term>Base</term><description>data is static, loaded from either an html table or javascript array</description></item>
\r
699 </member><member name="P:Rico.LiveGrid.HtmlSourceId">
\r
701 If grid is populated from an html table, then set HtmlSourceId to the id of the source table
\r
703 </member><member name="P:Rico.LiveGrid.QueryDistinct">
\r
705 True if this should be a distinct sql query (default is false)
\r
707 </member><member name="T:Rico.LiveGrid">
\r
709 Class to define a LiveGrid
\r
710 A LiveGrid buffers its data in a Javascript array and can retrieve that data via AJAX
\r
712 </member><member name="M:Rico.TableCollection.IndexOf(System.String)">
\r
714 Returns the index of the table with TblAlias or -1 if not found
\r
716 <param name="TblAlias"></param>
\r
717 </member><member name="P:Rico.GridBase.gridVar">
\r
719 Name of grid Javascript object
\r
721 </member><member name="P:Rico.GridBase.optionsVar">
\r
723 Name of grid options Javascript object
\r
725 </member><member name="F:Rico.GridBase.AutoFilter">
\r
727 If enabled, an additional row is added to the grid header where column filters are placed.
\r
728 See the EditCol.filterUI property to customize each column's filter.
\r
730 </member><member name="F:Rico.GridBase.FilterAllToken">
\r
732 The token in select filters used to indicate "show all values" (default: "___ALL___").
\r
734 </member><member name="F:Rico.GridBase.defaultWidth">
\r
736 if -1 (default), then use column heading width, otherwise this is the default width in pixels
\r
738 </member><member name="F:Rico.GridBase.allowColResize">
\r
740 Allow user to resize columns? Default is true.
\r
742 </member><member name="F:Rico.GridBase.frozenColumns">
\r
744 Number of frozen columns on the left (or right if direction=rtl). Default is 0.
\r
746 </member><member name="F:Rico.GridBase.RowLineHtEms">
\r
748 Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.
\r
750 </member><member name="F:Rico.GridBase.windowResize">
\r
752 Resize grid when browser window is resized? Default is true.
\r
754 </member><member name="P:Rico.GridBase.menuEvent">
\r
756 Specifies when the grid's popup menu should be invoked
\r
758 </member><member name="P:Rico.GridBase.DefaultStyle">
\r
760 Style used for the entire grid - headings and data.
\r
762 </member><member name="P:Rico.GridBase.DefaultHdgStyle">
\r
764 This holds the default style for headings. Use only if not using themes.
\r
766 </member><member name="F:Rico.GridBase.Styles">
\r
768 Collection of styles used for individual headings.
\r
770 </member><member name="P:Rico.GridBase.HdgRowLines">
\r
772 Lines of text displayed in each heading row
\r
774 </member><member name="P:Rico.GridBase.DefaultRowLines">
\r
776 Lines of text displayed in each data row
\r
778 </member><member name="P:Rico.GridBase.OuterDivId">
\r
780 Returns the id of the outermost grid container
\r
782 </member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">
\r
784 Returns the index of the column with the given id
\r
786 </member><member name="M:Rico.GridBase.GetColumn(System.String)">
\r
788 Returns the column object with the given id
\r
790 </member><member name="M:Rico.GridBase.GridRules">
\r
792 Returns the set of css rules that apply to this grid
\r
794 </member><member name="T:Rico.GridBase">
\r
796 This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.
\r
798 </member><member name="P:Rico.StyleBase.bold">
\r
800 True if the text should be displayed using a bold font
\r
802 </member><member name="P:Rico.StyleBase.italic">
\r
804 True if the text should be displayed in italics
\r
806 </member><member name="P:Rico.StyleBase.underline">
\r
808 True if the text should be underlined
\r
810 </member><member name="P:Rico.StyleBase.fontsize">
\r
812 Font size in points
\r
814 </member><member name="P:Rico.StyleBase.GridOnly">
\r
816 If true, then style is only applied to the grid, not to html or Excel exports
\r
818 </member><member name="P:Rico.StyleBase.BackColor">
\r
820 Specifies the background color. One of the 16 standard color names, or #rrggbb.
\r
822 </member><member name="P:Rico.StyleBase.ForeColor">
\r
824 Specifies the font color. One of the 16 standard color names, or #rrggbb.
\r
826 </member><member name="P:Rico.StyleBase.HorizontalAlign">
\r
828 Specifies horizontal alignment: Left, Right, Center, or NotSet (default)
\r
830 </member><member name="P:Rico.StyleBase.Overflow">
\r
832 Normally, overflowed content is hidden, but this allows content in the cell to scroll.
\r
833 Only applies to the grid, not to exports.
\r
835 </member><member name="P:Rico.StyleBase.CssStyle">
\r
837 Used internally. Returns the style properties as a css string.
\r
839 </member><member name="M:Rico.StyleBase.UnwrappedXlStyle">
\r
841 Used internally. Returns the style properties as an Excel XML string without the style tag.
\r
843 </member><member name="T:Rico.StyleBase">
\r
845 Base class for all style classes as well as the Column class.
\r
847 </member><member name="P:Rico.Style.StyleID">
\r
849 StyleID's should not contain spaces or other special characters.
\r
850 <list type="bullet">
\r
851 <item><description>Use a StyleID of Default to style the entire grid</description></item>
\r
852 <item><description>Use a StyleID of DefaultHdg to style the grid heading</description></item>
\r
853 <item><description>Use a StyleID of ricoLG_evenRow and/or ricoLG_oddRow to stripe the grid (striping does not get exported).</description></item>
\r
854 <item><description>Use a StyleID of ricoLG_selection to set the styling for the selected row.</description></item>
\r
857 </member><member name="M:Rico.Style.CssRule">
\r
859 Returns the style properties as a CSS rule
\r
861 </member><member name="M:Rico.Style.WrappedXlStyle">
\r
863 Returns the style properties as an Excel XML style, including the style tag
\r
865 </member><member name="P:Rico.Style.xlNumberFormat">
\r
867 For SimpleGrids only
\r
869 </member><member name="P:Rico.Style.NumberFormat">
\r
871 For SimpleGrids only
\r
873 </member><member name="M:Rico.Style.WrappedXlStyleNF">
\r
875 Returns the style properties plus number format as an Excel XML style, including the style tag
\r
877 </member><member name="T:Rico.Style">
\r
879 Defines a style that can be applied to a grid cell.
\r
880 Using a StyleID of ricoLG_evenRow or ricoLG_oddRow will stripe the grid, however striping does not get exported.
\r
881 Using a StyleID of ricoLG_selection will set the styling for the selected row.
\r
883 </member><member name="M:Rico.StyleDictionary.Add(Rico.Style)">
\r
885 Adds a Style object to the collection
\r
887 <param name="new_style"></param>
\r
888 </member><member name="P:Rico.StyleDictionary.Item(System.String)">
\r
890 Returns a Style object from the collection based on the style's StyleID
\r
892 <param name="StyleId"></param>
\r
893 </member><member name="P:Rico.StyleDictionary.Keys">
\r
895 Returns all of the StyleID's in the collection
\r
897 </member><member name="P:Rico.StyleDictionary.Values">
\r
899 Returns all of the Style objects in the collection
\r
901 </member><member name="M:Rico.StyleDictionary.Contains(System.String)">
\r
903 Returns true if the StyleID is in the collection
\r
905 <param name="StyleId"></param>
\r
906 </member><member name="M:Rico.StyleDictionary.Remove(System.String)">
\r
908 Removes the Style object with the given StyleID from the collection
\r
910 <param name="StyleId"></param>
\r
911 </member><member name="T:Rico.StyleDictionary">
\r
913 Container for a collection of Style objects
\r
915 </member><member name="F:Rico.LoadClient.ImgHeading">
\r
917 Background image for grid headings and window titles.
\r
918 Should be left unset, as it is used only for the grayedout theme (in which case it is set automatically).
\r
920 </member><member name="F:Rico.LoadClient.BaseLib">
\r
922 The base Javascript library to load from http://ajax.googleapis.com/ajax/libs/, possible values include:
\r
923 <list type="bullet">
\r
924 <item><description>prototype/1.6/prototype.js</description></item>
\r
925 <item><description>prototype/1.7/prototype.js</description></item>
\r
926 <item><description>jquery/1.3/jquery.min.js</description></item>
\r
927 <item><description>jquery/1.4/jquery.min.js</description></item>
\r
928 <item><description>jquery/1.5/jquery.min.js</description></item>
\r
929 <item><description>jquery/1.6/jquery.min.js</description></item>
\r
930 <item><description>mootools/1.2/mootools-yui-compressed.js</description></item>
\r
931 <item><description>mootools/1.3/mootools-yui-compressed.js</description></item>
\r
932 <item><description>dojo/1.5/dojo/dojo.xd.js</description></item>
\r
933 <item><description>dojo/1.6/dojo/dojo.xd.js</description></item>
\r
934 <item><description>ext-core/3.0/ext-core.js</description></item>
\r
935 <item><description>ext-core/3.1/ext-core.js</description></item>
\r
937 <para>Default value is "proto_min", which loads prototype 1.7 from the server control.</para>
\r
939 </member><member name="F:Rico.LoadClient.Logging">
\r
941 Enable Javascript console logging? Useful for debugging. Default is false.
\r
943 </member><member name="F:Rico.LoadClient.HTML5">
\r
945 Enable HTML5 web form elements in browsers that support them.
\r
946 Default is false because the quality of the HTML5 web form elements is uneven across browsers.
\r
948 </member><member name="F:Rico.LoadClient.Language">
\r
950 Best left unset, in which case language will be set automatically based on request's HTTP_ACCEPT_LANGUAGE
\r
951 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
953 </member><member name="F:Rico.LoadClient.LoadBaseLib">
\r
955 Load base Javascript library (prototype, jQuery, etc)?
\r
957 Set to false if library is being loaded another way. In this case, a BaseLib value is still required to indicate
\r
958 which library Rico should connect to.
\r
960 </member><member name="F:Rico.LoadClient.Striping">
\r
962 Apply row striping to LiveGrids? Default is true. Applies only when themes are used.
\r
964 </member><member name="F:Rico.LoadClient.SupportedLangs">
\r
966 Comma separated list of 2 letter locales that Rico supports.
\r
967 Do not set unless you have developed your own locale file.
\r
969 </member><member name="F:Rico.LoadClient.jQueryThemePath">
\r
971 URL to load jQuery themes from.
\r
972 Default is http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/
\r
973 Override this value if you have a jQuery theme on your own server.
\r
975 </member><member name="P:Rico.LoadClient.LoadedLanguage">
\r
977 Returns the 2 character string representing the Rico locale file that was actually used on the client.
\r
978 If there is no match between the requested languages and the available locale files, then english is used.
\r
979 Only available during the render phase.
\r
981 </member><member name="P:Rico.LoadClient.checkQueryString">
\r
983 Load settings from QueryString? true for demo, false for anything else. Default is false.
\r
985 </member><member name="P:Rico.LoadClient.checkWebConfig">
\r
987 Load settings from web.config file? Default is false.
\r
988 If true, then the appSettings section of web.config will be checked for the following keys (which affect the similarly named properties):
\r
989 <list type="bullet">
\r
990 <item><description>rico_BaseLib</description></item>
\r
991 <item><description>rico_Language</description></item>
\r
992 <item><description>rico_jTheme</description></item>
\r
993 <item><description>rico_rTheme</description></item>
\r
994 <item><description>rico_Logging</description></item>
\r
995 <item><description>rico_HTML5</description></item>
\r
996 <item><description>rico_LoadBaseLib</description></item>
\r
997 <item><description>rico_Striping</description></item>
\r
999 <para>Boolean values in web.config should be the strings "true" or "1" for true, and "false" or "0" for false.</para>
\r
1001 </member><member name="M:Rico.LoadClient.InitLiveGrids(System.Web.UI.HtmlTextWriter)">
\r
1003 Initialize all grids on the page
\r
1004 Initialize grids with fixed # of rows first,
\r
1005 then initialize grids with variable # of rows
\r
1007 </member><member name="P:Rico.LoadClient.jTheme">
\r
1009 Set theme to one of the jQuery Themeroller themes. Default is no theme.
\r
1011 black-tie, blitzer, cupertino, dark-hive, dot-luv, eggplant, excite-bike, flick,
\r
1012 hot-sneaks, humanity, le-frog, mint-choc, overcast, pepper-grinder, redmond, smoothness,
\r
1013 south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader
\r
1015 </member><member name="P:Rico.LoadClient.rTheme">
\r
1017 Set theme to one of the Rico themes. Default is no theme.
\r
1019 coffee-with-milk, grayedout, greenHdg, seaglass, warmfall
\r
1021 </member><member name="T:Rico.LoadClient">
\r
1023 Loads the various Javascript, CSS, and image files required to make Rico function.
\r
1025 </member><member name="P:Rico.My.Resources.Resources.ResourceManager">
\r
1027 Returns the cached ResourceManager instance used by this class.
\r
1029 </member><member name="P:Rico.My.Resources.Resources.Culture">
\r
1031 Overrides the current thread's CurrentUICulture property for all
\r
1032 resource lookups using this strongly typed resource class.
\r
1034 </member><member name="T:Rico.My.Resources.Resources">
\r
1036 A strongly-typed resource class, for looking up localized strings, etc.
\r
1038 </member><member name="T:Rico.SimpleGrid">
\r
1040 Class to define a SimpleGrid
\r
1042 </member><member name="F:Rico.LiveGridEdit.onFormOpen">
\r
1044 Javascript function to be called when the form opens to add or edit a record
\r
1046 </member><member name="F:Rico.LiveGridEdit.onFormClose">
\r
1048 Javascript function to be called when the add/edit form closes
\r
1050 </member><member name="F:Rico.LiveGridEdit.onFormSubmit">
\r
1052 Javascript function to be called when the add/edit form is submitted to the server
\r
1054 </member><member name="F:Rico.LiveGridEdit.onSubmitResponse">
\r
1056 Javascript function to be called when a response is received from the server after a form submittal
\r
1058 </member><member name="E:Rico.LiveGridEdit.DbDelete">
\r
1060 Event raised right before the database deletion takes place.
\r
1062 <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>
\r
1063 </member><member name="E:Rico.LiveGridEdit.DbInsert">
\r
1065 Event raised right before the database insertion takes place.
\r
1067 <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>
\r
1068 <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
1069 </member><member name="E:Rico.LiveGridEdit.DbUpdate">
\r
1071 Event raised right before the database update takes place.
\r
1073 <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>
\r
1074 <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
1075 <param name="WhereClause">Where clause that selects the record to be updated.</param>
\r
1076 </member><member name="M:Rico.LiveGridEdit.TableKeyWhereClause(System.Int32)">
\r
1078 Returns where clause based on table's primary key
\r
1080 <param name="TabIdx"></param>
\r