</name>\r
</assembly>\r
<members>\r
-<member name="P:Rico.TreeResponse.ErrorMsg">\r
- <summary>\r
- May contain the text of an error message that occurred outside this control prior to rendering\r
- </summary>\r
- <value></value>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.TreeResponse.dbConnection">\r
- <summary>\r
- Database connection object. Required only if sqlText is used.\r
- </summary>\r
- <value></value>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.TreeResponse.SqlText">\r
- <summary>\r
- Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters \r
- </summary>\r
- <value></value>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">\r
- <summary>\r
- Adds an entry that will be returned with the results. Often used to add the root node.\r
- </summary>\r
- <param name="parentID">id of parent, "" if this is the root</param>\r
- <param name="ID">id that uniquely identifies this node in the tree</param>\r
- <param name="description">description displayed to the user</param>\r
- <param name="containerORleaf">"L" or 0 = leaf, "C" or non-zero = container</param>\r
- <param name="selectable">0=not selectable, 1=selectable</param>\r
- <remarks></remarks>\r
-</member><member name="T:Rico.TreeResponse">\r
- <summary>\r
- Use this class on a page that responds to AJAX requests from a Rico Tree Control\r
- This class automatically disables caching of the response and sets the response type to text/xml\r
- </summary>\r
- <remarks></remarks>\r
-</member><member name="T:Rico.sqlParse.sqlColumn">\r
+<member name="T:Rico.sqlParse.sqlColumn">\r
<summary>\r
Represents a column in the select statement\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.IsDistinct">\r
<summary>\r
True if the select statement contains the DISTINCT keyword\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.SelectList">\r
<summary>\r
List of columns in the select statement\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.GroupBy">\r
<summary>\r
List of "group by" items in the select statement\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.OrderBy">\r
<summary>\r
List of "order by" items in the select statement\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.FromClause">\r
<summary>\r
From clause of the select statement, including any joins\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.WhereClause">\r
<summary>\r
Where clause of the select statement\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.HavingClause">\r
<summary>\r
Having clause of the select statement\r
</summary>\r
- <remarks></remarks>\r
</member><member name="F:Rico.sqlParse.Headings">\r
<summary>\r
List of column headings in the select list.\r
Set after an any unparse* call.\r
</summary>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.Clone">\r
<summary>\r
Returns a cloned copy of this object\r
</summary>\r
- <returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.UnparseSelect">\r
<summary>\r
Builds a SQL select statement string from its parsed components\r
</summary>\r
- <returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.UnparseSelectDistinct">\r
<summary>\r
Rebuilds a SQL select statement that was parsed by ParseSelect, inserting the DISTINCT keyword\r
</summary>\r
- <returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.UnparseDistinctColumnAccess(System.Int32)">\r
<summary>\r
Returns a SQL select statement that will return all of the values in a particular column.\r
This version is meant MS Access, as it does not support ordering by column name\r
</summary>\r
<param name="colnum"></param>\r
- <returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.UnparseDistinctColumn(System.Int32)">\r
<summary>\r
Returns a SQL select statement that will return all of the values in a particular column.\r
The returned statement is not compatible MS Access, use UnparseDistinctColumnAccess() instead.\r
</summary>\r
<param name="colnum"></param>\r
- <returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.UnparseColumnList">\r
<summary>\r
Returns the select list part of the statement as a string\r
</summary>\r
<returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.UnparseWithRowNumber(System.Int32,System.Int32,System.Boolean)">\r
<summary>\r
Returns a "windowed" select query.\r
<param name="numrows">The number of rows to return</param>\r
<param name="includeAS">use true for SQL Server 2005+ and false for Oracle</param>\r
<returns></returns>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.Clear">\r
<summary>\r
Resets the object and prepares it to parse another select statement.\r
</summary>\r
- <remarks></remarks>\r
</member><member name="M:Rico.sqlParse.ParseSelect(System.String)">\r
<summary>\r
Loads a select statement into the object.\r
<para>* Put union queries in a view and then write your select statement against the view.</para>\r
</summary>\r
<param name="sqltext"></param>\r
- <returns></returns>\r
- <remarks></remarks>\r
+</member><member name="M:Rico.sqlParse.SetSort(System.String)">\r
+ <summary>\r
+ Specifies the way the query results should be sorted.\r
+ Can specify multiple columns separated by commas. Cannot be used to specify a calculation that contains commas.\r
+ </summary>\r
+ <param name="SortSpecCSV"></param>\r
+</member><member name="M:Rico.sqlParse.AddSort(System.String)">\r
+ <summary>\r
+ Add a single sort criteria to the beginning of the order by clause\r
+ </summary>\r
+ <param name="NewSort">A single column name or column index followed by the sort direction</param>\r
</member><member name="T:Rico.sqlParse">\r
<summary>\r
Holds a SQL select statement. Methods to load/parse a select statement from a string and to reassemble it in various ways.\r
Does not handle union queries.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.SimpleCol.Width">\r
+</member><member name="P:Rico.My.Resources.Resources.ResourceManager">\r
<summary>\r
- Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.\r
+ Returns the cached ResourceManager instance used by this class.\r
+</summary>\r
+</member><member name="P:Rico.My.Resources.Resources.Culture">\r
+ <summary>\r
+ Overrides the current thread's CurrentUICulture property for all\r
+ resource lookups using this strongly typed resource class.\r
+</summary>\r
+</member><member name="T:Rico.My.Resources.Resources">\r
+ <summary>\r
+ A strongly-typed resource class, for looking up localized strings, etc.\r
+</summary>\r
+</member><member name="M:Rico.TableCollection.IndexOf(System.String)">\r
+ <summary>\r
+ Returns the index of the table with TblAlias or -1 if not found\r
</summary>\r
-</member><member name="F:Rico.Column.canSort">\r
+ <param name="TblAlias"></param>\r
+</member><member name="F:Rico.LiveGridBase.dbConnection">\r
<summary>\r
- Is the user allowed to sort the column? Default is true.\r
+ Database connection object (used when data source is a SQL query)\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.canDrag">\r
+</member><member name="P:Rico.LiveGridBase.canSortDefault">\r
<summary>\r
- Is the user allowed to drag a column value? Default is false.\r
+ Controls whether columns can be sorted (default: true). \r
+ Sorting can be disabled for individual columns using the canSort property.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.canFilter">\r
+</member><member name="P:Rico.LiveGridBase.canHideDefault">\r
<summary>\r
- Is the user allowed to filter the column? Default is true.\r
+ Controls whether columns can be hidden/shown (default: true). \r
+ Hide/show can be disabled for individual columns using the canHide property.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.control">\r
+</member><member name="P:Rico.LiveGridBase.canFilterDefault">\r
<summary>\r
- Javascript code to create a control object, which changes the way the column data is rendered.\r
- The disadvantage of using this approach is that the altered rendering does not get reflected in exports.\r
- A set of controls is defined in ricoLiveGridControls.js or the developer can create their own.\r
+ Controls whether columns can be filtered (default: true). \r
+ Filtering can be disabled for individual columns using the canFilter property.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.filterUI">\r
+</member><member name="P:Rico.LiveGridBase.highlightElem">\r
<summary>\r
- If the AutoFilter option is enabled for the grid, then filterUI will control how each column is filtered. If filterUI is:\r
- <list type="bullet">\r
- <item><description>null or omitted, then no filter is displayed for the column.</description></item>\r
- <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
- <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
- <item><description>'m' - will generate multi-select checklist filter, with a checkbox text to each item.</description></item>\r
+ A string that specifies what gets highlighted/selected in the grid\r
+ <list type="table">\r
+ <item><term>cursorRow</term><description>the grid row under the cursor</description></item>\r
+ <item><term>cursorCell</term><description>the grid cell under the cursor</description></item>\r
+ <item><term>menuRow</term><description>the grid row where the menu is displayed (default)</description></item>\r
+ <item><term>menuCell</term><description>the grid cell where the menu is displayed</description></item>\r
+ <item><term>selection</term><description>allow the user to select cells</description></item>\r
+ <item><term>none</term><description>never highlight</description></item>\r
</list>\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.filterColId">\r
+</member><member name="P:Rico.LiveGridBase.highlightMethod">\r
<summary>\r
- This setting allows the filterUI to filter a different column than where it is displayed.\r
- This is particularly useful for dates, where you can show a year selection on an OrderDate date column for example,\r
- but actually have it filter a hidden column OrderYear=year(OrderDate).\r
+ Method used to highlight cells and rows.\r
+ <list type="table">\r
+ <item><term>outline</term><description>least CPU-intensive on client-side</description></item>\r
+ <item><term>class</term><description>adds CSS class to highlighted cell/row (default)</description></item>\r
+ <item><term>both</term><description>highlight using both outline and class</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.prefetchBuffer">\r
+ <summary>\r
+ Load the buffer (and therefore the grid) on page load? (default: true)\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.ConfirmDeleteColumn">\r
+</member><member name="P:Rico.LiveGridBase.DisplayTimer">\r
<summary>\r
- The text content of this column will be included in delete confirmation messages.\r
+ Display the session timer above the grid? (default: true)\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.multiplier">\r
+</member><member name="P:Rico.LiveGridBase.DisplayBookmark">\r
<summary>\r
- 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
- Default is 1. Automatically set to 100 if DataType is percent.\r
+ Display the grid bookmark, ie. "Listing records X - Y of Z" (default: true)\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.decPlaces">\r
+</member><member name="P:Rico.LiveGridBase.Caption">\r
<summary>\r
- If column is a number, this is the number of digits displayed to the right of the decimal point. Default is 0.\r
- If DataType is dollar or euro, then decPlaces is automatically set to 2.\r
+ A caption for the grid, displayed next to the bookmark (default: nothing)\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.thouSep">\r
+</member><member name="P:Rico.LiveGridBase.click">\r
<summary>\r
- If column is a number, display the value with a thousands separator? Default is true.\r
+ Javascript event handler called when the user left-clicks on a cell\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.Column.negSign">\r
+</member><member name="P:Rico.LiveGridBase.dblclick">\r
<summary>\r
- Specifies how negative numbers should be displayed. Possible values:\r
- <list>\r
- <item><description>L=leading minus (default)</description></item>\r
- <item><description>T=trailing minus</description></item>\r
- <item><description>P=parentheses</description></item>\r
- </list>\r
- </summary>\r
-</member><member name="F:Rico.Column.prefix">\r
+ Javascript event handler called when the user double-clicks on a cell\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.contextmenu">\r
<summary>\r
- If column is a number, this string is prepended to the number before display.\r
- Useful for currency symbols.\r
+ Javascript event handler called when the user right-clicks on a cell\r
</summary>\r
-</member><member name="F:Rico.Column.suffix">\r
+</member><member name="P:Rico.LiveGridBase.beforeInit">\r
<summary>\r
- If column is a number, this string is appended to the number before display.\r
- Useful for percentages and temperature values. Automatically set to % if DataType is percent.\r
+ A Javascript function to be called right before the grid is initialized.\r
</summary>\r
-</member><member name="F:Rico.Column.HdgStyleID">\r
+</member><member name="P:Rico.LiveGridBase.afterInit">\r
<summary>\r
- Used to give the column heading a specific style.\r
- In most cases this is not necessary, as the heading will be styled according to the theme.\r
+ A Javascript function to be called right after the grid is initialized.\r
</summary>\r
-</member><member name="F:Rico.Column.isNullable">\r
+</member><member name="P:Rico.LiveGridBase.TableFilter">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ For SQL data sources, this specifies a SQL condition clause to always be used when running the SQL query.\r
</summary>\r
-</member><member name="F:Rico.Column.Writeable">\r
+</member><member name="P:Rico.LiveGridBase.saveColumnWidth">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Whenever the user adjusts a column width, should the new width be saved to the grid's cookie? (default: true)\r
</summary>\r
-</member><member name="F:Rico.Column.isKey">\r
+</member><member name="P:Rico.LiveGridBase.saveColumnFilter">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Whenever the user filters a column, should the new filter be saved to the grid's cookie? (default: false)\r
</summary>\r
-</member><member name="F:Rico.Column.Length">\r
+</member><member name="P:Rico.LiveGridBase.saveColumnSort">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Whenever the user sorts a column, should the new sort be saved to the grid's cookie? (default: false)\r
</summary>\r
-</member><member name="F:Rico.Column.TypeName">\r
+</member><member name="P:Rico.LiveGridBase.cookieDays">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Number of days before the grid's cookie expires. If you don't specify a value, \r
+ then the cookie is only maintained for the current session.\r
</summary>\r
-</member><member name="F:Rico.Column.ColGroupIdx">\r
+</member><member name="P:Rico.LiveGridBase.DefaultSort">\r
<summary>\r
- For internal use\r
+ For SQL data sources, this specifies the default way the data should be sorted. (default: use primary key)\r
+ Can specify multiple columns separated by commas. Cannot be used to specify a calculation that contains commas.\r
</summary>\r
-</member><member name="P:Rico.Column.Heading">\r
+</member><member name="P:Rico.LiveGridBase.maxPrint">\r
<summary>\r
- Text displayed in the column heading.\r
+ The maximum number of rows that the user is allowed to Print/Export. Set to 0 to disable print/export.\r
+ Default is to use the Rico client value (currently 5000).\r
</summary>\r
-</member><member name="P:Rico.Column.Width">\r
+</member><member name="P:Rico.LiveGridBase.dndMgrIdx">\r
<summary>\r
- Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.\r
+ Specifies which drag-and-drop management zone should be used for drag operations (default: 0). \r
+ This only needs to be specified if the web page uses multiple distinct zones.\r
</summary>\r
-</member><member name="M:Rico.Column.NumberFormat">\r
+</member><member name="P:Rico.LiveGridBase.sessions">\r
<summary>\r
- Returns an Excel-type number format string based on decPlaces, thouSep, prefix.\r
+ For SQL data sources, should the parsed query be stored in a session variable? This improves performance. (default: true)\r
</summary>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.Column.DataType">\r
+</member><member name="P:Rico.LiveGridBase.minPageRows">\r
<summary>\r
- Type of data stored in the column.\r
+ Minimum # of visible rows. Used only when visibleRows < 0. (default: 2)\r
</summary>\r
- <value></value>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="T:Rico.Column">\r
+</member><member name="P:Rico.LiveGridBase.maxPageRows">\r
<summary>\r
- Base class for a LiveGrid column\r
+ Maximum # of visible rows. Used only when visibleRows < 0. (default: 50)\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.ColGroupsOnTabHdr">\r
+ <summary>\r
+ Set to 'true' for ColumnGroup labels to be used as secondary headings. \r
+ In LiveGrid Edit, it may be set to 'false' so that ColumnGroup labels are only used on the input form.\r
+ Default: true.\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.sendDebugMsgs">\r
+ <summary>\r
+ Send details of sql parsing/execution in ajax response? (true/false)\r
+ Default is to follow the debug value in web.config\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.LogSqlOnError">\r
+ <summary>\r
+ Include sql statement in results if an error occurs (true/false)\r
+ Default is to follow the debug value in web.config\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.fmt">\r
+ <summary>\r
+ Format of data returned by AJAX calls, either "xml" or "json" (defaul: xml).\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.largeBufferSize">\r
+ <summary>\r
+ This property influences the size of the client buffer and AJAX fetch size.\r
+ Default value is -1, which means use the Rico client default value.\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.requestParameters">\r
+ <summary>\r
+ Optional parameters to be passed along during the AJAX call\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.formVar">\r
+</member><member name="P:Rico.LiveGridBase.formVar">\r
<summary>\r
- name of Javascript object containing LiveGrid Edit\r
+ Name of the Javascript variable containing the LiveGrid Edit object\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.bufferVar">\r
+</member><member name="P:Rico.LiveGridBase.bufferVar">\r
<summary>\r
- name of Javascript object containing LiveGrid buffer\r
+ Name of the Javascript variable containing the LiveGrid buffer object\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.bufferOptVar">\r
+</member><member name="P:Rico.LiveGridBase.bufferOptVar">\r
<summary>\r
- name of Javascript object containing initial LiveGrid buffer options\r
+ Name of the Javascript variable containing the initial LiveGrid buffer options\r
</summary>\r
-</member><member name="F:Rico.LiveGrid.SqlCompat">\r
+</member><member name="F:Rico.LiveGridBase.SqlCompat">\r
<summary>\r
Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.rows">\r
+</member><member name="P:Rico.LiveGridBase.dbDialect">\r
+ <summary>\r
+ When connecting to SQL databases, this is the SQL dialect to use.\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.dataProvider">\r
+ <summary>\r
+ When using a SQL data source there is no need to set this property, \r
+ as AJAX data fetches are sent back to the originating script by default.\r
+ When setting this property to a URL, make sure the URL is enclosed in single quotes.\r
+ If not enclosed in quotes, it is treated as the name of a Javascript function.\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.rows">\r
<summary>\r
Number of visible rows in the grid.\r
Negative values have the following meanings:\r
<item><description>-4: size grid to its parent node in the DOM</description></item>\r
</list>\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.HtmlSourceId">\r
+</member><member name="P:Rico.LiveGridBase.action">\r
<summary>\r
- If grid is populated from an html table, then set HtmlSourceId to the id of the source table\r
+ Returns a string indicating the current action being taken by the grid control.\r
+ <list type="bullet">\r
+ <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
+ <item><description>query: grid will process an AJAX query request during the prerender phase. This includes exports to Excel or HTML.</description></item>\r
+ <item><description>ins: grid will process an AJAX insert record request during the prerender phase (LiveGridEdit only).</description></item>\r
+ <item><description>upd: grid will process an AJAX update record request during the prerender phase (LiveGridEdit only).</description></item>\r
+ <item><description>del: grid will process an AJAX delete record request during the prerender phase (LiveGridEdit only).</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.IsAjaxRequest">\r
+ <summary>\r
+ Returns true if the grid is processing an AJAX request.\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridBase.CurrentField">\r
+ <summary>\r
+ Returns the column object for the last column in the grid.\r
</summary>\r
- <value></value>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LiveGrid.ColGroups">\r
+</member><member name="F:Rico.LiveGridBase.ColGroups">\r
<summary>\r
Collection of ColumnGroup objects, which define the headings used above each group of columns.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LiveGrid.Tables">\r
+</member><member name="F:Rico.LiveGridBase.Tables">\r
<summary>\r
- Defines the tables used by the LiveGrid. The first table is primary/main table.\r
+ Defines the tables used by the LiveGrid. The first table is the primary/main table.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="M:Rico.LiveGrid.ColClassName(System.Int32)">\r
+</member><member name="M:Rico.LiveGridBase.ColClassName(System.Int32)">\r
<summary>\r
Returns the class name of the specified grid column\r
</summary>\r
<param name="colnum"></param>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="M:Rico.LiveGrid.AddColumn(Rico.Column)">\r
+</member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">\r
<summary>\r
Adds a new column to grid, returns column index\r
</summary>\r
<param name="ColumnObj"></param>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="T:Rico.LiveGrid">\r
+</member><member name="M:Rico.LiveGridBase.AddCalculatedField(System.String,System.String,System.Int32,Rico.DataTypeValues)">\r
<summary>\r
- Class to define a LiveGrid\r
+ Adds a new column to grid, returns Forumula object\r
</summary>\r
-</member><member name="M:Rico.TableCollection.IndexOf(System.String)">\r
+ <param name="Heading"></param>\r
+ <param name="ColumnFormula"></param>\r
+ <param name="width"></param>\r
+ <param name="DataType"></param>\r
+ <returns></returns>\r
+</member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">\r
<summary>\r
- Returns the index of the table with TblName or -1 if not found\r
+ Takes a given string and makes it JSON valid (http://json.org/)\r
</summary>\r
- <param name="TblName"></param>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.GridBase.gridVar">\r
+ <param name="val">value which should be escaped</param>\r
+ <returns>JSON valid string</returns>\r
+ <remarks>\r
+ AUTHOR: Michael Rebec\r
+ All characters which needs to be escaped are beeing replaced by their\r
+ unicode representation according to the\r
+ RFC4627#2.5 - http://www.ietf.org/rfc/rfc4627.txt?number=4627\r
+ </remarks>\r
+</member><member name="T:Rico.LiveGridBase">\r
<summary>\r
- Name of grid Javascript object\r
+ Methods and properties common to LiveGrid and LiveGridEdit\r
</summary>\r
-</member><member name="P:Rico.GridBase.optionsVar">\r
+</member><member name="P:Rico.LiveGrid.BufferType">\r
<summary>\r
- Name of grid options Javascript object\r
+ The type of buffer deployed on the client\r
+ <list type="table">\r
+ <item><term>AjaxSQL</term><description>data source is a SQL database query</description></item>\r
+ <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
+ <item><term>Base</term><description>data is static, loaded from either an html table or javascript array</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.LiveGrid.HtmlSourceId">\r
+ <summary>\r
+ If grid is populated from an html table, then set HtmlSourceId to the id of the source table\r
</summary>\r
-</member><member name="F:Rico.GridBase.AutoFilter">\r
+</member><member name="P:Rico.LiveGrid.QueryDistinct">\r
<summary>\r
- If enabled, an additional row is added to the grid header where column filters are placed. \r
- See the EditCol.filterUI property to customize each column's filter.\r
+ True if this should be a distinct sql query (default is false)\r
</summary>\r
-</member><member name="F:Rico.GridBase.FilterAllToken">\r
+</member><member name="T:Rico.LiveGrid">\r
<summary>\r
- The token in select filters used to indicate "show all values" (default: "___ALL___").\r
+ Class to define a LiveGrid\r
+ A LiveGrid buffers its data in a Javascript array and can retrieve that data via AJAX\r
</summary>\r
-</member><member name="F:Rico.GridBase.defaultWidth">\r
+</member><member name="P:Rico.LoadClient.ImgHeading">\r
<summary>\r
- if -1 (default), then use column heading width, otherwise this is the default width in pixels\r
+ Background image for grid headings and window titles.\r
+ Should be left unset, as it is used only for the grayedout theme (in which case it is set automatically).\r
</summary>\r
-</member><member name="F:Rico.GridBase.allowColResize">\r
+</member><member name="P:Rico.LoadClient.BaseLib">\r
<summary>\r
- Allow user to resize columns? Default is true.\r
+ The base Javascript library to load from http://ajax.googleapis.com/ajax/libs/, possible values include:\r
+ <list type="bullet">\r
+ <item><description>prototype/1.6/prototype.js</description></item>\r
+ <item><description>prototype/1.7/prototype.js</description></item>\r
+ <item><description>jquery/1.3/jquery.min.js</description></item>\r
+ <item><description>jquery/1.4/jquery.min.js</description></item>\r
+ <item><description>jquery/1.5/jquery.min.js</description></item>\r
+ <item><description>jquery/1.6/jquery.min.js</description></item>\r
+ <item><description>mootools/1.2/mootools-yui-compressed.js</description></item>\r
+ <item><description>mootools/1.3/mootools-yui-compressed.js</description></item>\r
+ <item><description>dojo/1.5/dojo/dojo.xd.js</description></item>\r
+ <item><description>dojo/1.6/dojo/dojo.xd.js</description></item>\r
+ <item><description>ext-core/3.0/ext-core.js</description></item>\r
+ <item><description>ext-core/3.1/ext-core.js</description></item>\r
+ </list>\r
+ <para>Default value is "proto_min", which loads prototype 1.7 from the server control.</para>\r
+ </summary>\r
+</member><member name="P:Rico.LoadClient.Logging">\r
+ <summary>\r
+ Enable Javascript console logging? Useful for debugging. Default is false.\r
</summary>\r
-</member><member name="F:Rico.GridBase.frozenColumns">\r
+</member><member name="P:Rico.LoadClient.HTML5">\r
<summary>\r
- Number of frozen columns on the left (or right if direction=rtl). Default is 0.\r
+ Enable HTML5 web form elements in browsers that support them. \r
+ Default is false because the quality of the HTML5 web form elements is uneven across browsers.\r
</summary>\r
-</member><member name="F:Rico.GridBase.RowLineHtEms">\r
+</member><member name="P:Rico.LoadClient.Language">\r
<summary>\r
- Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.\r
+ Best left unset, in which case language will be set automatically based on request's HTTP_ACCEPT_LANGUAGE\r
+ 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
</summary>\r
-</member><member name="P:Rico.GridBase.menuEvent">\r
+</member><member name="P:Rico.LoadClient.LoadBaseLib">\r
<summary>\r
- Specifies when the grid's popup menu should be invoked \r
+ Load base Javascript library (prototype, jQuery, etc)?\r
+ Default is true.\r
+ Set to false if library is being loaded another way. In this case, a BaseLib value is still required to indicate\r
+ which library Rico should connect to.\r
</summary>\r
-</member><member name="P:Rico.GridBase.DefaultStyle">\r
+</member><member name="P:Rico.LoadClient.Striping">\r
<summary>\r
- Style used for the entire grid - headings and data.\r
+ Apply row striping to LiveGrids? Default is true. Applies only when themes are used.\r
</summary>\r
-</member><member name="P:Rico.GridBase.DefaultHdgStyle">\r
+</member><member name="F:Rico.LoadClient.SupportedLangs">\r
<summary>\r
- This holds the default style for headings. Use only if not using themes.\r
+ Comma separated list of 2 letter locales that Rico supports.\r
+ Do not set unless you have developed your own locale file.\r
</summary>\r
-</member><member name="F:Rico.GridBase.Styles">\r
+</member><member name="P:Rico.LoadClient.jQueryThemePath">\r
<summary>\r
- Collection of styles used for individual headings.\r
+ URL to load jQuery themes from.\r
+ Default is http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/\r
+ Override this value if you have a jQuery theme on your own server.\r
</summary>\r
-</member><member name="P:Rico.GridBase.HdgRowLines">\r
+</member><member name="M:Rico.LoadClient.RegisterGrid(Rico.GridBase)">\r
<summary>\r
- Lines of text displayed in each heading row\r
+ Called automatically from Rico grids on the page\r
</summary>\r
-</member><member name="P:Rico.GridBase.DefaultRowLines">\r
+ <param name="grid"></param>\r
+</member><member name="P:Rico.LoadClient.LoadedLanguage">\r
<summary>\r
- Lines of text displayed in each data row\r
+ Returns the 2 character string representing the Rico locale file that was actually used on the client.\r
+ If there is no match between the requested languages and the available locale files, then english is used.\r
+ Only available during the render phase.\r
</summary>\r
-</member><member name="P:Rico.GridBase.OuterDivId">\r
+</member><member name="P:Rico.LoadClient.checkQueryString">\r
<summary>\r
- Returns the id of the outermost grid container\r
+ Load settings from QueryString? true for demo, false for anything else. Default is false.\r
</summary>\r
-</member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">\r
+</member><member name="P:Rico.LoadClient.checkWebConfig">\r
<summary>\r
- Returns the index of the column with the given id\r
+ Load settings from web.config file? Default is false.\r
+ If true, then the appSettings section of web.config will be checked for the following keys (which affect the similarly named properties):\r
+ <list type="bullet">\r
+ <item><description>rico_BaseLib</description></item>\r
+ <item><description>rico_Language</description></item>\r
+ <item><description>rico_jTheme</description></item>\r
+ <item><description>rico_rTheme</description></item>\r
+ <item><description>rico_Logging</description></item>\r
+ <item><description>rico_HTML5</description></item>\r
+ <item><description>rico_LoadBaseLib</description></item>\r
+ <item><description>rico_Striping</description></item>\r
+ </list>\r
+ <para>Boolean values in web.config should be the strings "true" or "1" for true, and "false" or "0" for false.</para>\r
+ </summary>\r
+</member><member name="M:Rico.LoadClient.InitLiveGrids(System.Web.UI.HtmlTextWriter)">\r
+ <summary>\r
+ Initialize all LiveGrids on the page\r
+ Initialize grids with fixed # of rows first,\r
+ then initialize grids with variable # of rows\r
</summary>\r
-</member><member name="M:Rico.GridBase.GetColumn(System.String)">\r
+</member><member name="P:Rico.LoadClient.jTheme">\r
<summary>\r
- Returns the column object with the given id\r
+ Set theme to one of the jQuery Themeroller themes. Default is no theme.\r
+ Valid values are:\r
+ black-tie, blitzer, cupertino, dark-hive, dot-luv, eggplant, excite-bike, flick, \r
+ hot-sneaks, humanity, le-frog, mint-choc, overcast, pepper-grinder, redmond, smoothness, \r
+ south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader\r
</summary>\r
-</member><member name="M:Rico.GridBase.GridRules">\r
+</member><member name="P:Rico.LoadClient.rTheme">\r
<summary>\r
- Returns the set of css rules that apply to this grid\r
+ Set theme to one of the Rico themes. Default is no theme.\r
+ Valid values are:\r
+ coffee-with-milk, grayedout, greenHdg, seaglass, warmfall\r
</summary>\r
-</member><member name="T:Rico.GridBase">\r
+</member><member name="T:Rico.LoadClient">\r
<summary>\r
- This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.\r
+ Loads the various Javascript, CSS, and image files required to make Rico function.\r
</summary>\r
-</member><member name="P:Rico.StyleBase.bold">\r
+</member><member name="P:Rico.SimpleCol.Width">\r
<summary>\r
- True if the text should be displayed using a bold font\r
+ Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.\r
</summary>\r
-</member><member name="P:Rico.StyleBase.italic">\r
+</member><member name="T:Rico.SimpleCol">\r
<summary>\r
- True if the text should be displayed in italics\r
+ Defines a column in a SimpleGrid\r
</summary>\r
-</member><member name="P:Rico.StyleBase.underline">\r
+</member><member name="P:Rico.Column.canSort">\r
<summary>\r
- True if the text should be underlined\r
+ Is the user allowed to sort the column? Default is true.\r
</summary>\r
-</member><member name="P:Rico.StyleBase.fontsize">\r
+</member><member name="P:Rico.Column.canDrag">\r
+ <summary>\r
+ Is the user allowed to drag a column value? Default is false.\r
+ </summary>\r
+</member><member name="P:Rico.Column.canFilter">\r
+ <summary>\r
+ Is the user allowed to filter the column? Default is true.\r
+ </summary>\r
+</member><member name="P:Rico.Column.noResize">\r
+ <summary>\r
+ Prevent column from being resized? Default is false.\r
+ </summary>\r
+</member><member name="P:Rico.Column.control">\r
+ <summary>\r
+ Javascript code to create a control object, which changes the way the column data is rendered.\r
+ The disadvantage of using this approach is that the altered rendering does not get reflected in exports.\r
+ A set of controls is defined in ricoLiveGridControls.js or the developer can create their own.\r
+ </summary>\r
+</member><member name="P:Rico.Column.filterUI">\r
+ <summary>\r
+ If the AutoFilter option is enabled for the grid, then filterUI will control how each column is filtered. If filterUI is:\r
+ <list type="bullet">\r
+ <item><description>null or omitted, then no filter is displayed for the column.</description></item>\r
+ <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
+ <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
+ <item><description>'m' - will generate multi-select checklist filter, with a checkbox next to each item.</description></item>\r
+ <item><description>'n' - will generate a select list filter. By default the list will contain "< 0", "= 0", "> 0". However, the list can be controlled by following "n" with any combination of "-", "0", or "+".</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.Column.filterColId">\r
+ <summary>\r
+ This setting allows the filterUI to filter a different column than where it is displayed.\r
+ This is particularly useful for dates, where you can show a year selection on an OrderDate date column for example,\r
+ but actually have it filter a hidden column OrderYear=year(OrderDate).\r
+ </summary>\r
+</member><member name="P:Rico.Column.ConfirmDeleteColumn">\r
+ <summary>\r
+ The text content of this column will be included in delete confirmation messages.\r
+ </summary>\r
+</member><member name="P:Rico.Column.multiplier">\r
+ <summary>\r
+ 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
+ Default is 1. Automatically set to 100 if DataType is percent.\r
+ </summary>\r
+</member><member name="P:Rico.Column.decPlaces">\r
+ <summary>\r
+ If column is a number, this is the number of digits displayed to the right of the decimal point. Default is 0.\r
+ If DataType is dollar or euro, then decPlaces is automatically set to 2.\r
+ </summary>\r
+</member><member name="P:Rico.Column.thouSep">\r
+ <summary>\r
+ If column is a number, display the value with a thousands separator? Default is true.\r
+ </summary>\r
+</member><member name="P:Rico.Column.negSign">\r
+ <summary>\r
+ Specifies how negative numbers should be displayed. Possible values:\r
+ <list>\r
+ <item><description>L=leading minus (default)</description></item>\r
+ <item><description>T=trailing minus</description></item>\r
+ <item><description>P=parentheses</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.Column.prefix">\r
+ <summary>\r
+ If column is a number, this string is prepended to the number before display.\r
+ Useful for currency symbols.\r
+ </summary>\r
+</member><member name="P:Rico.Column.suffix">\r
+ <summary>\r
+ If column is a number, this string is appended to the number before display.\r
+ Useful for percentages and temperature values. Automatically set to % if DataType is percent.\r
+ </summary>\r
+</member><member name="P:Rico.Column.HdgStyleID">\r
+ <summary>\r
+ Used to give the column heading a specific style.\r
+ In most cases this is not necessary, as the heading will be styled according to the theme.\r
+ </summary>\r
+</member><member name="P:Rico.Column.isNullable">\r
+ <summary>\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ </summary>\r
+</member><member name="P:Rico.Column.Writeable">\r
+ <summary>\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ </summary>\r
+</member><member name="P:Rico.Column.isKey">\r
+ <summary>\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ </summary>\r
+</member><member name="P:Rico.Column.Length">\r
+ <summary>\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ </summary>\r
+</member><member name="P:Rico.Column.TypeName">\r
+ <summary>\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ </summary>\r
+</member><member name="F:Rico.Column.ColGroupIdx">\r
+ <summary>\r
+ For internal use\r
+ </summary>\r
+</member><member name="P:Rico.Column.Heading">\r
+ <summary>\r
+ Text displayed in the column heading.\r
+ </summary>\r
+</member><member name="P:Rico.Column.Width">\r
+ <summary>\r
+ Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.\r
+ </summary>\r
+</member><member name="M:Rico.Column.NumberFormat">\r
+ <summary>\r
+ Returns an Excel-type number format string based on decPlaces, thouSep, prefix.\r
+ </summary>\r
+</member><member name="P:Rico.Column.DataType">\r
+ <summary>\r
+ Type of data stored in the column.\r
+ </summary>\r
+</member><member name="M:Rico.Column.script">\r
+ <summary>\r
+ Internal function that returns the LiveGrid column options object, used to initialize the column on the client.\r
+ </summary>\r
+</member><member name="T:Rico.Column">\r
+ <summary>\r
+ Base class for a LiveGrid column\r
+ </summary>\r
+</member><member name="P:Rico.FormulaCol.Formula">\r
+ <summary>\r
+ SQL expression\r
+ </summary>\r
+</member><member name="T:Rico.FormulaCol">\r
+ <summary>\r
+ Calculated Column\r
+ </summary>\r
+</member><member name="P:Rico.TableCol.ColName">\r
+ <summary>\r
+ Column name in table or view\r
+ If not specified, use the control's ID instead\r
+ </summary>\r
+</member><member name="P:Rico.TableCol.TblAlias">\r
+ <summary>\r
+ This should match the TblAlias of one of the Table objects specified for the grid.\r
+ If unspecified, the primary table or view is assumed.\r
+ </summary>\r
+</member><member name="F:Rico.TableCol.TableIdx">\r
+ <summary>\r
+ Used internally\r
+ </summary>\r
+</member><member name="T:Rico.TableCol">\r
+ <summary>\r
+ Column from table or view\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.pattern">\r
+ <summary>\r
+ Regular expression used to validate the user input. User entries will be checked to ensure they match the pattern specified. \r
+ There are a few special values:\r
+ <list type="table">\r
+ <item><term>email</term><description>tests for a valid email address</description></item>\r
+ <item><term>float-unsigned</term><description>tests for a valid unsigned floating point (real) number</description></item>\r
+ <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
+ <item><term>int-unsigned</term><description>tests for a valid unsigned integer number</description></item>\r
+ <item><term>int-signed</term><description>tests for a valid signed integer number (this is the default when EntryType is "I")</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.min">\r
+ <summary>\r
+ Sets the minimum allowable value in a numeric or date field.\r
+ For dates, the value should be in ISO-8601 format.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.max">\r
+ <summary>\r
+ Sets the maximum allowable value in a numeric or date field.\r
+ For dates, the value should be in ISO-8601 format.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.Help">\r
+ <summary>\r
+ Provides information to help the user understand the meaning of the field.\r
+ Fields with help text will be display with a blue "i" icon next to the field name.\r
+ When the user hovers their cursor over the icon, the help text will be displayed.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.TxtAreaRows">\r
+ <summary>\r
+ For columns with entry type "TA", this is # of rows to display in the textarea when in form view (default 4)\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.TxtAreaCols">\r
+ <summary>\r
+ For columns with entry type "TA", this is # of columns to display in the textarea when in form view (default 80)\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.ColData">\r
+ <summary>\r
+ column's default value in the form view\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.SelectSql">\r
+ <summary>\r
+ Specifies the SQL select statement to use for EntryTypes of SL, CL, and RL. \r
+ The select statement should return 2 columns: the first being the code and the second being the text value/description. \r
+ For example:\r
+ <code>\r
+ EntryType="SL" ColName="CustID" SelectSql="select ID,Name from Customers"\r
+ </code>\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.SelectCtl">\r
+ <summary>\r
+ For entry type "CL", this property specifies the id of the custom control.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.SelectFilter">\r
+ <summary>\r
+ SelectSql serves 2 purposes. First, it is used to retrieve the appropriate data to display in the grid. \r
+ Second, it is used to populate the values in the select box (SL) or radio buttons (RL) on the pop-up form. \r
+ In some cases, you may want these to be different. In the SelectSql example above, we are retrieving customer name. \r
+ But let's say that our Customers table has a "CreditHold" field and we want to disable the selection of customers \r
+ on credit hold in the form view, but still display them in the grid. \r
+ This is where SelectFilter comes in:\r
+ <code>\r
+ SelectFilter="CreditHold='NO'"\r
+ </code>\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.SelectValues">\r
+ <summary>\r
+ Specifies the choices the user sees in form view for EntryTypes of N, S, and R. \r
+ If supplied, then this should be a string of comma-separated values. \r
+ For example:\r
+ <code>\r
+ SelectValues="Y,N"\r
+ </code>\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.SelectRows">\r
+ <summary>\r
+ Specifies the number of rows to display in drop down select boxes for entry types S and SL.\r
+ Default is to let the browser decide.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.FilterFlag">\r
+ <summary>\r
+ If true, then the grid is filtered by the default value (ColData) for this column (default=false)\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.InsertOnly">\r
+ <summary>\r
+ If true, then only write this field to the database when peforming an insert (default=false).\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.UpdateOnly">\r
+ <summary>\r
+ If true, then only write this field to the database when peforming an update (default=false).\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.ReadOnly">\r
+ <summary>\r
+ If true, data is displayed on the entry form but cannot be changed AND IS NOT WRITTEN TO THE DATABASE.\r
+ If data must be written to the database, either use FormView="false" (if data should be displayed\r
+ in the grid), or EntryType="H" (if the grid column should be hidden).\r
+ Text is gray (default=false). \r
+ Does not apply to entry types of S, SL, N, R, RL.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.FormView">\r
+ <summary>\r
+ <list type="table">\r
+ <item><term>True</term><description>Item is shown on the entry form (default)</description></item>\r
+ <item><term>False</term><description>Item is not shown on the form</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.AddQuotes">\r
+ <summary>\r
+ When false, the column value will be left unquoted when inserting or updating the database. \r
+ Default is false for entry type TS, and true for all other entry types.\r
+ This makes it possible to populate columns with SQL function calls. \r
+ For example:\r
+ <code>\r
+ ColName="LastEditUser" EntryType="H" AddQuotes="false" ColData="suser_sname()"\r
+ </code>\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.MultiSelect">\r
+ <summary>\r
+ If true, the user is allowed to select multiple values.\r
+ For entry types R and RL, this changes the input from radio buttons to checkboxes.\r
+ Default is false.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.DescriptionCol">\r
+ <summary>\r
+ 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
+ name or description. However, by specifying a value for DescriptionCol, you can store the associated description as well.\r
+ <code>\r
+ EntryType="SL" ColName="CustID" DescriptionCol="CustName" SelectSql="select ID,Name from Customers"\r
+ </code>\r
+ </summary>\r
+</member><member name="F:Rico.EditCol.DescriptionField">\r
+ <summary>\r
+ Used internally. Populates automatically based on DescriptionCol.\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.noFormBreak">\r
+ <summary>\r
+ Boolean value that when true, specifies that this entry field should placed on the same form row as the last field \r
+ (default: false - each form field is placed on a separate row).\r
+ </summary>\r
+</member><member name="M:Rico.EditCol.isLookupField">\r
+ <summary>\r
+ Returns true if the column is a lookup field (entry type SL, RL, or CL)\r
+ </summary>\r
+</member><member name="P:Rico.EditCol.EntryType">\r
+ <summary>\r
+ Code indicating the ui to be used for data entry\r
+ <list type="table">\r
+ <item><term>TA</term><description>Text Area</description></item>\r
+ <item><term>R</term><description>Radio button list</description></item>\r
+ <item><term>RL</term><description>Radio buttons via lookup (field is a foreign key)</description></item>\r
+ <item><term>S</term><description>Select list</description></item>\r
+ <item><term>SL</term><description>Select list via lookup (field is a foreign key)</description></item>\r
+ <item><term>CL</term><description>Custom widget via lookup (field is a foreign key)</description></item>\r
+ <item><term>N</term><description>Select list of distinct column values, use allowed to add new values</description></item>\r
+ <item><term>B</term><description>Text, non-blank</description></item>\r
+ <item><term>T</term><description>Text</description></item>\r
+ <item><term>I</term><description>Integer</description></item>\r
+ <item><term>F</term><description>Floating point number</description></item>\r
+ <item><term>tinyMCE</term><description>Rich text via tinyMCE</description></item>\r
+ <item><term>D</term><description>Date</description></item>\r
+ <item><term>TS</term><description>Time stamp</description></item>\r
+ <item><term>H</term><description>Hidden</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="T:Rico.EditCol">\r
+ <summary>\r
+ Defines an editable column in a LiveGridEdit object\r
+ </summary>\r
+</member><member name="P:Rico.StyleBase.bold">\r
+ <summary>\r
+ True if the text should be displayed using a bold font\r
+ </summary>\r
+</member><member name="P:Rico.StyleBase.italic">\r
+ <summary>\r
+ True if the text should be displayed in italics\r
+ </summary>\r
+</member><member name="P:Rico.StyleBase.underline">\r
+ <summary>\r
+ True if the text should be underlined\r
+ </summary>\r
+</member><member name="P:Rico.StyleBase.fontsize">\r
<summary>\r
Font size in points\r
</summary>\r
<summary>\r
Specifies horizontal alignment: Left, Right, Center, or NotSet (default)\r
</summary>\r
+</member><member name="P:Rico.StyleBase.VerticalAlign">\r
+ <summary>\r
+ Specifies vertical alignment: Bottom, Middle, Top, or NotSet (default)\r
+ Only applies to Excel export\r
+ </summary>\r
+</member><member name="P:Rico.StyleBase.Overflow">\r
+ <summary>\r
+ Normally, overflowed content is hidden, but setting this "auto" or "scroll" allows content in the cell to scroll.\r
+ Only applies to the grid, not to exports.\r
+ </summary>\r
</member><member name="P:Rico.StyleBase.CssStyle">\r
<summary>\r
Used internally. Returns the style properties as a css string.\r
<summary>\r
Container for a collection of Style objects\r
</summary>\r
-</member><member name="F:Rico.LoadClient.ImgHeading">\r
+</member><member name="P:Rico.LiveGridEdit.TableSelectNew">\r
<summary>\r
- Background image for grid headings and window titles.\r
- Should be left unset, as it is used only for the grayedout theme (in which case it is set automatically).\r
+ This is the value that Rico uses to identify when the user has selected "(new)" on fields with EntryType N.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.BaseLib">\r
+</member><member name="P:Rico.LiveGridEdit.TableSelectNone">\r
<summary>\r
- The base Javascript library to load from http://ajax.googleapis.com/ajax/libs/, possible values include:\r
+ This is the value that Rico uses to identify nulls in select lists\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.canAdd">\r
+ <summary>\r
+ True if the user is allowed to add records (default is true)\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.canEdit">\r
+ <summary>\r
+ True if the user is allowed to edit/update records (default is true)\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.canClone">\r
+ <summary>\r
+ True if the user is allowed to clone records (default is false)\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.canDelete">\r
+ <summary>\r
+ True if the user is allowed to delete records (default is true)\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.ConfirmDelete">\r
+ <summary>\r
+ True if Rico should display a confirmation message when the user tries to delete a record\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.RecordName">\r
+ <summary>\r
+ Used in menus to refer to a record (default is "record")\r
+ </summary>\r
+</member><member name="P:Rico.LiveGridEdit.showSaveMsg">\r
+ <summary>\r
+ Controls disposition of database update responses on the client\r
<list type="bullet">\r
- <item><description>prototype/1.6/prototype.js</description></item>\r
- <item><description>prototype/1.7/prototype.js</description></item>\r
- <item><description>jquery/1.3/jquery.min.js</description></item>\r
- <item><description>jquery/1.4/jquery.min.js</description></item>\r
- <item><description>jquery/1.5/jquery.min.js</description></item>\r
- <item><description>jquery/1.6/jquery.min.js</description></item>\r
- <item><description>mootools/1.2/mootools-yui-compressed.js</description></item>\r
- <item><description>mootools/1.3/mootools-yui-compressed.js</description></item>\r
- <item><description>dojo/1.4/dojo/dojo.xd.js</description></item>\r
- <item><description>dojo/1.5/dojo/dojo.xd.js</description></item>\r
- <item><description>dojo/1.6/dojo/dojo.xd.js</description></item>\r
- <item><description>ext-core/3.0/ext-core.js</description></item>\r
- <item><description>ext-core/3.1/ext-core.js</description></item>\r
+ <item><description>full: show full response</description></item>\r
+ <item><description>errors: show full response for errors and short response otherwise (default)</description></item>\r
</list>\r
- <para>Default value is "proto_min", which loads prototype 1.7 from the server control.</para>\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.Logging">\r
+</member><member name="P:Rico.LiveGridEdit.panelHeight">\r
<summary>\r
- Enable Javascript console logging? Useful for debugging. Default is false.\r
+ Height of tabbed panels on entry form (in pixels, default is 200).\r
+ Tabbed panels are only created when ColumnGroup labels are present in the grid definition.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.Language">\r
+</member><member name="P:Rico.LiveGridEdit.panelWidth">\r
<summary>\r
- Best left unset, in which case language will be set automatically based on request's HTTP_ACCEPT_LANGUAGE\r
- 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
+ Width of tabbed panels on entry form (in pixels, default is 500).\r
+ Tabbed panels are only created when ColumnGroup labels are present in the grid definition.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.LoadBaseLib">\r
+</member><member name="P:Rico.LiveGridEdit.MaxInputLen">\r
<summary>\r
- Load base Javascript library (prototype, jQuery, etc)?\r
- Default is true.\r
- Set to false if library is being loaded another way. In this case, a BaseLib value is still required to indicate\r
- which library Rico should connect to.\r
+ Maximum displayed text field length on entry form (default is 20)\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.Striping">\r
+</member><member name="P:Rico.LiveGridEdit.IsAjaxUpdate">\r
<summary>\r
- Apply row striping to LiveGrids? Default is true. Applies only when themes are used.\r
+ Returns true if the grid is processing an AJAX request that inserts, updates, or deletes a record.\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.SupportedLangs">\r
+</member><member name="P:Rico.LiveGridEdit.onFormOpen">\r
<summary>\r
- Comma separated list of 2 letter locales that Rico supports.\r
- Do not set unless you have developed your own locale file.\r
+ Javascript function to be called when the form opens to add or edit a record\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="F:Rico.LoadClient.jQueryThemePath">\r
+</member><member name="P:Rico.LiveGridEdit.onFormClose">\r
<summary>\r
- URL to load jQuery themes from.\r
- Default is http://ajax.googleapis.com/ajax/libs/jqueryui/1.8/themes/\r
- Override this value if you have a jQuery theme on your own server.\r
+ Javascript function to be called when the add/edit form closes\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.LoadClient.LoadedLanguage">\r
+</member><member name="P:Rico.LiveGridEdit.onFormSubmit">\r
<summary>\r
- Returns the 2 character string representing the Rico locale file that was actually used on the client.\r
- If there is no match between the requested languages and the available locale files, then english is used.\r
- Only available during the render phase.\r
+ Javascript function to be called when the add/edit form is submitted to the server\r
</summary>\r
- <value></value>\r
- <returns></returns>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.LoadClient.checkQueryString">\r
+</member><member name="P:Rico.LiveGridEdit.onSubmitResponse">\r
<summary>\r
- Load settings from QueryString? true for demo, false for anything else. Default is false.\r
+ Javascript function to be called when a response is received from the server after a form submittal\r
</summary>\r
-</member><member name="P:Rico.LoadClient.checkWebConfig">\r
+</member><member name="E:Rico.LiveGridEdit.DbDelete">\r
<summary>\r
- Load settings from web.config file? Default is false.\r
- If true, then the appSettings section of web.config will be checked for the following keys (which affect the similarly named properties):\r
- <list type="bullet">\r
- <item><description>rico_BaseLib</description></item>\r
- <item><description>rico_Language</description></item>\r
- <item><description>rico_jTheme</description></item>\r
- <item><description>rico_rTheme</description></item>\r
- <item><description>rico_Logging</description></item>\r
- <item><description>rico_LoadBaseLib</description></item>\r
- <item><description>rico_Striping</description></item>\r
- </list>\r
- <para>Boolean values in web.config should be the strings "true" or "1" for true, and "false" or "0" for false.</para>\r
- </summary>\r
-</member><member name="M:Rico.LoadClient.InitLiveGrids">\r
+ Event raised right before the database deletion takes place.\r
+ </summary>\r
+ <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
+ <param name="WhereClause">Where clause that selects the record to be deleted.</param>\r
+</member><member name="E:Rico.LiveGridEdit.DbInsert">\r
<summary>\r
- Initialize all grids on the page\r
- Initialize grids with fixed # of rows first,\r
- then initialize grids with variable # of rows\r
+ Event raised right before the database insertion takes place.\r
</summary>\r
- <returns>javascript to initialize grids</returns>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.LoadClient.jTheme">\r
+ <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
+ <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
+</member><member name="E:Rico.LiveGridEdit.DbUpdate">\r
<summary>\r
- Set theme to one of the jQuery Themeroller themes. Default is no theme.\r
- Valid values are:\r
- black-tie, blitzer, cupertino, dark-hive, dot-luv, eggplant, excite-bike, flick, \r
- hot-sneaks, humanity, le-frog, mint-choc, overcast, pepper-grinder, redmond, smoothness, \r
- south-street, start, sunny, swanky-purse, trontastic, ui-darkness, ui-lightness, vader\r
+ Event raised right before the database update takes place.\r
</summary>\r
- <value></value>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.LoadClient.rTheme">\r
+ <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
+ <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
+ <param name="WhereClause">Where clause that selects the record to be updated.</param>\r
+</member><member name="M:Rico.LiveGridEdit.TableKeyWhereClause(System.Int32)">\r
<summary>\r
- Set theme to one of the Rico themes. Default is no theme.\r
- Valid values are:\r
- coffee-with-milk, grayedout, greenHdg, seaglass, warmfall\r
+ Returns where clause based on table's primary key\r
</summary>\r
- <value></value>\r
- <remarks></remarks>\r
-</member><member name="T:Rico.LoadClient">\r
+ <param name="TabIdx"></param>\r
+</member><member name="P:Rico.GridBase.gridVar">\r
<summary>\r
- Loads the various Javascript, CSS, and image files required to make Rico function.\r
+ Name of grid Javascript object\r
</summary>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.My.Resources.Resources.ResourceManager">\r
+</member><member name="P:Rico.GridBase.optionsVar">\r
<summary>\r
- Returns the cached ResourceManager instance used by this class.\r
-</summary>\r
-</member><member name="P:Rico.My.Resources.Resources.Culture">\r
+ Name of grid options Javascript object\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.AutoFilter">\r
<summary>\r
- Overrides the current thread's CurrentUICulture property for all\r
- resource lookups using this strongly typed resource class.\r
-</summary>\r
-</member><member name="T:Rico.My.Resources.Resources">\r
+ If enabled, an additional row is added to the grid header where column filters are placed. \r
+ See the EditCol.filterUI property to customize each column's filter.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.FilterAllToken">\r
<summary>\r
- A strongly-typed resource class, for looking up localized strings, etc.\r
-</summary>\r
+ The token in select filters used to indicate "show all values" (default: "___ALL___").\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.defaultWidth">\r
+ <summary>\r
+ if -1 (default), then use column heading width, otherwise this is the default width in pixels\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.allowColResize">\r
+ <summary>\r
+ Allow user to resize columns? Default is true.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.frozenColumns">\r
+ <summary>\r
+ Number of frozen columns on the left (or right if direction=rtl). Default is 0.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.RowLineHtEms">\r
+ <summary>\r
+ Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.windowResize">\r
+ <summary>\r
+ Resize grid when browser window is resized? Default is true.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.menuEvent">\r
+ <summary>\r
+ Specifies when the grid's popup menu should be invoked \r
+ </summary>\r
+</member><member name="P:Rico.GridBase.DefaultHdgStyle">\r
+ <summary>\r
+ This holds the default style for headings. Use only if not using themes.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.Styles">\r
+ <summary>\r
+ Collection of styles used for individual headings.\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.HdgRowLines">\r
+ <summary>\r
+ Lines of text displayed in each heading row\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.DefaultRowLines">\r
+ <summary>\r
+ Lines of text displayed in each data row\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.OuterDivId">\r
+ <summary>\r
+ Returns the id of the outermost grid container\r
+ </summary>\r
+</member><member name="P:Rico.GridBase.InitCompleteFunction">\r
+ <summary>\r
+ Name of javascript function to call when grid initialization is complete (default is gridID_InitComplete)\r
+ The grid object is passed as the single parameter to the function\r
+ </summary>\r
+</member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">\r
+ <summary>\r
+ Returns the index of the column with the given id\r
+ </summary>\r
+</member><member name="M:Rico.GridBase.GetColumn(System.String)">\r
+ <summary>\r
+ Returns the column object with the given id\r
+ </summary>\r
+</member><member name="M:Rico.GridBase.GridRules">\r
+ <summary>\r
+ Returns the set of css rules that apply to this grid\r
+ </summary>\r
+</member><member name="T:Rico.GridBase">\r
+ <summary>\r
+ This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.\r
+ </summary>\r
+</member><member name="P:Rico.TreeResponse.ErrorMsg">\r
+ <summary>\r
+ May contain the text of an error message that occurred outside this control prior to rendering\r
+ </summary>\r
+</member><member name="P:Rico.TreeResponse.dbConnection">\r
+ <summary>\r
+ Database connection object. Required only if sqlText is used.\r
+ </summary>\r
+</member><member name="P:Rico.TreeResponse.SqlText">\r
+ <summary>\r
+ Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters \r
+ </summary>\r
+</member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">\r
+ <summary>\r
+ Adds an entry that will be returned with the results. Often used to add the root node.\r
+ </summary>\r
+ <param name="parentID">id of parent, "" if this is the root</param>\r
+ <param name="ID">id that uniquely identifies this node in the tree</param>\r
+ <param name="description">description displayed to the user</param>\r
+ <param name="containerORleaf">"L" or 0 = leaf, "C" or non-zero = container</param>\r
+ <param name="selectable">0=not selectable, 1=selectable</param>\r
+</member><member name="T:Rico.TreeResponse">\r
+ <summary>\r
+ Use this class on a page that responds to AJAX requests from a Rico Tree Control\r
+ This class automatically disables caching of the response and sets the response type to text/xml\r
+ </summary>\r
+</member><member name="T:Rico.SimpleGrid.HtmlCell">\r
+ <summary>\r
+ Supports grid cells with html content.\r
+ Note that when exporting to Excel, only these html tags are supported: B, Font, I, S, Span, Sub, Sup, U\r
+ </summary>\r
+</member><member name="M:Rico.SimpleGrid.LinkCell.#ctor(System.String,System.String,System.String,System.String,System.String)">\r
+ <summary>\r
+ Creates a new LinkCell\r
+ </summary>\r
+ <param name="CellText">cell content</param>\r
+ <param name="href">href portion of anchor tag</param>\r
+ <param name="target">optional link target, e.g. _blank</param>\r
+ <param name="CellStyleId">optional reference to a Rico:Style element</param>\r
+</member><member name="T:Rico.SimpleGrid.LinkCell">\r
+ <summary>\r
+ Supports grid cells with html links.\r
+ When exporting, only the text is exported.\r
+ </summary>\r
</member><member name="T:Rico.SimpleGrid">\r
<summary>\r
Class to define a SimpleGrid\r
projects / infodrom / rico3 / blobdiff