</name>\r
</assembly>\r
<members>\r
-<member name="P:Rico.TreeResponse.ErrorMsg">\r
+<member name="M:Rico.TableCollection.IndexOf(System.String)">\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
+ Returns the index of the table with TblAlias or -1 if not found\r
</summary>\r
- <value></value>\r
- <remarks></remarks>\r
-</member><member name="P:Rico.TreeResponse.SqlText">\r
+ <param name="TblAlias"></param>\r
+</member><member name="P:Rico.My.Resources.Resources.ResourceManager">\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
+ Returns the cached ResourceManager instance used by this class.\r
+</summary>\r
+</member><member name="P:Rico.My.Resources.Resources.Culture">\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
+ 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
- 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
+ A strongly-typed resource class, for looking up localized strings, etc.\r
+</summary>\r
</member><member name="T:Rico.sqlParse.sqlColumn">\r
<summary>\r
Represents a column in the select statement\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
-</member><member name="P:Rico.SimpleCol.Width">\r
+</member><member name="F:Rico.LiveGridEdit.onFormOpen">\r
<summary>\r
- Initial width of the column in pixels. Default is to use SimpleGrid.defaultWidth.\r
+ Javascript function to be called when the form opens to add or edit a record\r
</summary>\r
-</member><member name="T:Rico.SimpleCol">\r
+</member><member name="F:Rico.LiveGridEdit.onFormClose">\r
<summary>\r
- Defines a column in a SimpleGrid\r
+ Javascript function to be called when the add/edit form closes\r
</summary>\r
-</member><member name="F:Rico.Column.canSort">\r
+</member><member name="F:Rico.LiveGridEdit.onFormSubmit">\r
<summary>\r
- Is the user allowed to sort the column? Default is true.\r
+ Javascript function to be called when the add/edit form is submitted to the server\r
</summary>\r
-</member><member name="F:Rico.Column.canDrag">\r
+</member><member name="F:Rico.LiveGridEdit.onSubmitResponse">\r
<summary>\r
- Is the user allowed to drag a column value? 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="F:Rico.Column.canFilter">\r
+</member><member name="E:Rico.LiveGridEdit.DbDelete">\r
<summary>\r
- Is the user allowed to filter the column? Default is true.\r
+ Event raised right before the database deletion takes place.\r
</summary>\r
-</member><member name="F:Rico.Column.control">\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
- 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
+ Event raised right before the database insertion takes place.\r
</summary>\r
-</member><member name="F:Rico.Column.filterUI">\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
- 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
- </list>\r
- </summary>\r
-</member><member name="F:Rico.Column.filterColId">\r
+ Event raised right before the database update takes place.\r
+ </summary>\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
- 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
+ Returns where clause based on table's primary key\r
</summary>\r
-</member><member name="F:Rico.Column.ConfirmDeleteColumn">\r
+ <param name="TabIdx"></param>\r
+</member><member name="F:Rico.LiveGridBase.dbConnection">\r
<summary>\r
- The text content of this column will be included in delete confirmation messages.\r
+ Database connection object (used when data source is a SQL query)\r
</summary>\r
-</member><member name="F:Rico.Column.multiplier">\r
+</member><member name="F:Rico.LiveGridBase.canSortDefault">\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
+ Controls whether columns can be sorted (default: true). \r
+ Sorting can be disabled for individual columns using the canSort property.\r
</summary>\r
-</member><member name="F:Rico.Column.decPlaces">\r
+</member><member name="F:Rico.LiveGridBase.canHideDefault">\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
+ 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
-</member><member name="F:Rico.Column.thouSep">\r
+</member><member name="F:Rico.LiveGridBase.canFilterDefault">\r
<summary>\r
- If column is a number, display the value with a thousands separator? Default is true.\r
+ Controls whether columns can be filtered (default: true). \r
+ Filtering can be disabled for individual columns using the canFilter property.\r
</summary>\r
-</member><member name="F:Rico.Column.negSign">\r
+</member><member name="F:Rico.LiveGridBase.highlightElem">\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
+ 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
-</member><member name="F:Rico.Column.prefix">\r
+</member><member name="F:Rico.LiveGridBase.highlightMethod">\r
<summary>\r
- If column is a number, this string is prepended to the number before display.\r
- Useful for currency symbols.\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="F:Rico.LiveGridBase.prefetchBuffer">\r
+ <summary>\r
+ Load the buffer (and therefore the grid) on page load? (default: true)\r
</summary>\r
-</member><member name="F:Rico.Column.suffix">\r
+</member><member name="F:Rico.LiveGridBase.DisplayTimer">\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
+ Display the session timer above the grid? (default: true)\r
</summary>\r
-</member><member name="F:Rico.Column.HdgStyleID">\r
+</member><member name="F:Rico.LiveGridBase.DisplayBookmark">\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
+ Display the grid bookmark, ie. "Listing records X - Y of Z" (default: true)\r
</summary>\r
-</member><member name="F:Rico.Column.isNullable">\r
+</member><member name="F:Rico.LiveGridBase.Caption">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ A caption for the grid, displayed next to the bookmark (default: nothing)\r
</summary>\r
-</member><member name="F:Rico.Column.Writeable">\r
+</member><member name="F:Rico.LiveGridBase.click">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Javascript event handler called when the user left-clicks on a cell\r
</summary>\r
-</member><member name="F:Rico.Column.isKey">\r
+</member><member name="F:Rico.LiveGridBase.dblclick">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Javascript event handler called when the user double-clicks on a cell\r
</summary>\r
-</member><member name="F:Rico.Column.Length">\r
+</member><member name="F:Rico.LiveGridBase.contextmenu">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ Javascript event handler called when the user right-clicks on a cell\r
</summary>\r
-</member><member name="F:Rico.Column.TypeName">\r
+</member><member name="F:Rico.LiveGridBase.beforeInit">\r
<summary>\r
- Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
+ A Javascript function to be called right before the grid is initialized.\r
</summary>\r
-</member><member name="F:Rico.Column.ColGroupIdx">\r
+</member><member name="F:Rico.LiveGridBase.afterInit">\r
<summary>\r
- For internal use\r
+ A Javascript function to be called right after the grid is initialized.\r
</summary>\r
-</member><member name="P:Rico.Column.Heading">\r
+</member><member name="F:Rico.LiveGridBase.TableFilter">\r
<summary>\r
- Text displayed in the column heading.\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="P:Rico.Column.Width">\r
+</member><member name="F:Rico.LiveGridBase.saveColumnWidth">\r
<summary>\r
- Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.\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="M:Rico.Column.NumberFormat">\r
+</member><member name="F:Rico.LiveGridBase.saveColumnFilter">\r
<summary>\r
- Returns an Excel-type number format string based on decPlaces, thouSep, prefix.\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="P:Rico.Column.DataType">\r
+</member><member name="F:Rico.LiveGridBase.saveColumnSort">\r
<summary>\r
- Type of data stored in the column.\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="M:Rico.Column.script">\r
+</member><member name="F:Rico.LiveGridBase.cookieDays">\r
<summary>\r
- Internal function that returns the LiveGrid column options object, used to initialize the column on the client.\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="T:Rico.Column">\r
+</member><member name="F:Rico.LiveGridBase.DefaultSort">\r
<summary>\r
- Base class for a LiveGrid column\r
+ For SQL data sources, this specifies the default way the data should be sorted. (default: use primary key)\r
</summary>\r
-</member><member name="F:Rico.FormulaCol.Formula">\r
+</member><member name="F:Rico.LiveGridBase.maxPrint">\r
<summary>\r
- SQL expression\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="T:Rico.FormulaCol">\r
+</member><member name="F:Rico.LiveGridBase.dndMgrIdx">\r
<summary>\r
- Calculated Column\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="F:Rico.TableCol.ColName">\r
+</member><member name="F:Rico.LiveGridBase.sessions">\r
<summary>\r
- Column name in table or view\r
+ For SQL data sources, should the parsed query be stored in a session variable? This improves performance. (default: true)\r
</summary>\r
-</member><member name="F:Rico.TableCol.TblAlias">\r
+</member><member name="F:Rico.LiveGridBase.minPageRows">\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
+ Minimum # of visible rows. Used only when visibleRows < 0. (default: 2)\r
</summary>\r
-</member><member name="F:Rico.TableCol.TableIdx">\r
+</member><member name="F:Rico.LiveGridBase.maxPageRows">\r
<summary>\r
- Used internally\r
+ Maximum # of visible rows. Used only when visibleRows < 0. (default: 50)\r
</summary>\r
-</member><member name="T:Rico.TableCol">\r
+</member><member name="F:Rico.LiveGridBase.ColGroupsOnTabHdr">\r
<summary>\r
- Column from table or view\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="F:Rico.EditCol.pattern">\r
+</member><member name="F:Rico.LiveGridBase.sendDebugMsgs">\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="F:Rico.EditCol.min">\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="F:Rico.LiveGridBase.LogSqlOnError">\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
+ 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="F:Rico.EditCol.max">\r
+</member><member name="F:Rico.LiveGridBase.fmt">\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
+ Format of data returned by AJAX calls, either "xml" or "json" (defaul: xml).\r
</summary>\r
-</member><member name="F:Rico.EditCol.Help">\r
+</member><member name="F:Rico.LiveGridBase.largeBufferSize">\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="F: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="F: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
+ 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="F:Rico.EditCol.ColData">\r
+</member><member name="F:Rico.LiveGridBase.requestParameters">\r
<summary>\r
- column's default value in the form view\r
+ Optional parameters to be passed along during the AJAX call\r
</summary>\r
-</member><member name="F: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="F:Rico.EditCol.SelectCtl">\r
+</member><member name="P:Rico.LiveGridBase.formVar">\r
<summary>\r
- For entry type "CL", this property specifies the id of the custom control.\r
+ Name of the Javascript variable containing the LiveGrid Edit object\r
</summary>\r
-</member><member name="F: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="F: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="F:Rico.EditCol.SelectRows">\r
+</member><member name="P:Rico.LiveGridBase.bufferVar">\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
+ Name of the Javascript variable containing the LiveGrid buffer object\r
</summary>\r
-</member><member name="F:Rico.EditCol.FilterFlag">\r
+</member><member name="P:Rico.LiveGridBase.bufferOptVar">\r
<summary>\r
- If true, then the grid is filtered by the default value (ColData) for this column (default=false)\r
+ Name of the Javascript variable containing the initial LiveGrid buffer options\r
</summary>\r
-</member><member name="F:Rico.EditCol.InsertOnly">\r
+</member><member name="F:Rico.LiveGridBase.SqlCompat">\r
<summary>\r
- If true, then only write this field to the database when peforming an insert (default=false).\r
+ Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.\r
</summary>\r
-</member><member name="F:Rico.EditCol.UpdateOnly">\r
+</member><member name="P:Rico.LiveGridBase.dbDialect">\r
<summary>\r
- If true, then only write this field to the database when peforming an update (default=false).\r
+ When connecting to SQL databases, this is the SQL dialect to use.\r
</summary>\r
-</member><member name="F:Rico.EditCol.ReadOnly">\r
+</member><member name="P:Rico.LiveGridBase.dataProvider">\r
<summary>\r
- If true, data is displayed on the entry form but cannot be changed, text is gray (default=false). \r
- Does not apply to entry types of S, SL, N, R, RL -- use FormView="hidden" instead.\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
</summary>\r
-</member><member name="F:Rico.EditCol.FormView">\r
+</member><member name="P:Rico.LiveGridBase.rows">\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
+ Number of visible rows in the grid.\r
+ Negative values have the following meanings:\r
+ <list type="bullet">\r
+ <item><description>-1: size grid to client window</description></item>\r
+ <item><description>-2: size grid to whichever is smaller: the client window or the data</description></item>\r
+ <item><description>-3: size grid so that the page body does not have a scrollbar (default)</description></item>\r
+ <item><description>-4: size grid to its parent node in the DOM</description></item>\r
</list>\r
</summary>\r
-</member><member name="F:Rico.EditCol.AddQuotes">\r
+</member><member name="F:Rico.LiveGridBase.ColGroups">\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="F:Rico.EditCol.MultiSelect">\r
+ Collection of ColumnGroup objects, which define the headings used above each group of columns.\r
+ </summary>\r
+</member><member name="F:Rico.LiveGridBase.Tables">\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
+ Defines the tables used by the LiveGrid. The first table is primary/main table.\r
</summary>\r
-</member><member name="F:Rico.EditCol.DescriptionCol">\r
+</member><member name="M:Rico.LiveGridBase.ColClassName(System.Int32)">\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
+ Returns the class name of the specified grid column\r
+ </summary>\r
+ <param name="colnum"></param>\r
+</member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">\r
<summary>\r
- Used internally. Populates automatically based on DescriptionCol.\r
+ Adds a new column to grid, returns column index\r
</summary>\r
-</member><member name="F:Rico.EditCol.noFormBreak">\r
+ <param name="ColumnObj"></param>\r
+</member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">\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
+ Takes a given string and makes it JSON valid (http://json.org/)\r
</summary>\r
-</member><member name="M:Rico.EditCol.isLookupField">\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
- Returns true if the column is a lookup field (entry type SL, RL, or CL)\r
+ Methods and properties common to LiveGrid and LiveGridEdit\r
</summary>\r
-</member><member name="P:Rico.EditCol.EntryType">\r
+</member><member name="P:Rico.LiveGrid.BufferType">\r
<summary>\r
- Code indicating the ui to be used for data entry\r
+ The type of buffer deployed on the client\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
+ <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="T:Rico.EditCol">\r
+</member><member name="P:Rico.LiveGrid.HtmlSourceId">\r
<summary>\r
- Defines an editable column in a LiveGridEdit object\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.LiveGridBase.dbConnection">\r
+</member><member name="P:Rico.LiveGrid.QueryDistinct">\r
<summary>\r
- Database connection object (used when data source is a SQL query)\r
+ True if this should be a distinct sql query (default is false)\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.canSortDefault">\r
+</member><member name="T:Rico.LiveGrid">\r
<summary>\r
- Controls whether columns can be sorted (default: true). \r
- Sorting can be disabled for individual columns using the canSort property.\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.LiveGridBase.canHideDefault">\r
+</member><member name="P:Rico.TreeResponse.ErrorMsg">\r
<summary>\r
- Controls whether columns can be hidden/shown (default: true). \r
- Hide/show can be disabled for individual columns using the canHide property.\r
+ May contain the text of an error message that occurred outside this control prior to rendering\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.canFilterDefault">\r
+</member><member name="P:Rico.TreeResponse.dbConnection">\r
<summary>\r
- Controls whether columns can be filtered (default: true). \r
- Filtering can be disabled for individual columns using the canFilter property.\r
+ Database connection object. Required only if sqlText is used.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.highlightElem">\r
- <summary>\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
-</member><member name="F:Rico.LiveGridBase.highlightMethod">\r
- <summary>\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="F:Rico.LiveGridBase.prefetchBuffer">\r
+</member><member name="P:Rico.TreeResponse.SqlText">\r
<summary>\r
- Load the buffer (and therefore the grid) on page load? (default: true)\r
+ Optional sql query to execute, must return 5 columns matching WriteTreeRow parameters \r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.DisplayTimer">\r
+</member><member name="M:Rico.TreeResponse.WriteTreeRow(System.Object,System.Object,System.Object,System.Object,System.Object)">\r
<summary>\r
- Display the session timer above the grid? (default: true)\r
+ Adds an entry that will be returned with the results. Often used to add the root node.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.DisplayBookmark">\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
- Display the grid bookmark, ie. "Listing records X - Y of Z" (default: true)\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="F:Rico.LiveGridBase.Caption">\r
+</member><member name="P:Rico.GridBase.gridVar">\r
<summary>\r
- A caption for the grid, displayed next to the bookmark (default: nothing)\r
+ Name of grid Javascript object\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.click">\r
+</member><member name="P:Rico.GridBase.optionsVar">\r
<summary>\r
- Javascript event handler called when the user left-clicks on a cell\r
+ Name of grid options Javascript object\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.dblclick">\r
+</member><member name="F:Rico.GridBase.AutoFilter">\r
<summary>\r
- Javascript event handler called when the user double-clicks on a cell\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="F:Rico.LiveGridBase.contextmenu">\r
+</member><member name="F:Rico.GridBase.FilterAllToken">\r
<summary>\r
- Javascript event handler called when the user right-clicks on a cell\r
+ The token in select filters used to indicate "show all values" (default: "___ALL___").\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.beforeInit">\r
+</member><member name="F:Rico.GridBase.defaultWidth">\r
<summary>\r
- A Javascript function to be called right before the grid is initialized.\r
+ if -1 (default), then use column heading width, otherwise this is the default width in pixels\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.afterInit">\r
+</member><member name="F:Rico.GridBase.allowColResize">\r
<summary>\r
- A Javascript function to be called right after the grid is initialized.\r
+ Allow user to resize columns? Default is true.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.TableFilter">\r
+</member><member name="F:Rico.GridBase.frozenColumns">\r
<summary>\r
- For SQL data sources, this specifies a SQL condition clause to always be used when running the SQL query.\r
+ Number of frozen columns on the left (or right if direction=rtl). Default is 0.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.saveColumnWidth">\r
+</member><member name="F:Rico.GridBase.RowLineHtEms">\r
<summary>\r
- Whenever the user adjusts a column width, should the new width be saved to the grid's cookie? (default: true)\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="F:Rico.LiveGridBase.saveColumnFilter">\r
+</member><member name="F:Rico.GridBase.windowResize">\r
<summary>\r
- Whenever the user filters a column, should the new filter be saved to the grid's cookie? (default: false)\r
+ Resize grid when browser window is resized? Default is true.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.saveColumnSort">\r
+</member><member name="P:Rico.GridBase.menuEvent">\r
<summary>\r
- Whenever the user sorts a column, should the new sort be saved to the grid's cookie? (default: false)\r
+ Specifies when the grid's popup menu should be invoked \r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.cookieDays">\r
+</member><member name="P:Rico.GridBase.DefaultHdgStyle">\r
<summary>\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
+ This holds the default style for headings. Use only if not using themes.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.DefaultSort">\r
+</member><member name="F:Rico.GridBase.Styles">\r
<summary>\r
- For SQL data sources, this specifies the default way the data should be sorted. (default: use primary key)\r
+ Collection of styles used for individual headings.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.maxPrint">\r
+</member><member name="P:Rico.GridBase.HdgRowLines">\r
<summary>\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
+ Lines of text displayed in each heading row\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.dndMgrIdx">\r
+</member><member name="P:Rico.GridBase.DefaultRowLines">\r
<summary>\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
+ Lines of text displayed in each data row\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.sessions">\r
+</member><member name="P:Rico.GridBase.OuterDivId">\r
<summary>\r
- For SQL data sources, should the parsed query be stored in a session variable? This improves performance. (default: true)\r
+ Returns the id of the outermost grid container\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.minPageRows">\r
+</member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">\r
<summary>\r
- Minimum # of visible rows. Used only when visibleRows < 0. (default: 2)\r
+ Returns the index of the column with the given id\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.maxPageRows">\r
+</member><member name="M:Rico.GridBase.GetColumn(System.String)">\r
<summary>\r
- Maximum # of visible rows. Used only when visibleRows < 0. (default: 50)\r
+ Returns the column object with the given id\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.ColGroupsOnTabHdr">\r
+</member><member name="M:Rico.GridBase.GridRules">\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
+ Returns the set of css rules that apply to this grid\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.sendDebugMsgs">\r
+</member><member name="T:Rico.GridBase">\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
+ This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.LogSqlOnError">\r
+</member><member name="F:Rico.LoadClient.ImgHeading">\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
+ 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.LiveGridBase.fmt">\r
+</member><member name="F:Rico.LoadClient.BaseLib">\r
<summary>\r
- Format of data returned by AJAX calls, either "xml" or "json" (defaul: xml).\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="F:Rico.LoadClient.Logging">\r
+ <summary>\r
+ Enable Javascript console logging? Useful for debugging. Default is false.\r
</summary>\r
-</member><member name="F:Rico.LiveGridBase.largeBufferSize">\r
+</member><member name="F:Rico.LoadClient.HTML5">\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
+ 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.LiveGridBase.requestParameters">\r
+</member><member name="F:Rico.LoadClient.Language">\r
<summary>\r
- Optional parameters to be passed along during the AJAX call\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.LiveGridBase.formVar">\r
+</member><member name="F:Rico.LoadClient.LoadBaseLib">\r
<summary>\r
- Name of the Javascript variable containing the LiveGrid Edit object\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.LiveGridBase.bufferVar">\r
+</member><member name="F:Rico.LoadClient.Striping">\r
<summary>\r
- Name of the Javascript variable containing the LiveGrid buffer object\r
+ Apply row striping to LiveGrids? Default is true. Applies only when themes are used.\r
</summary>\r
-</member><member name="P:Rico.LiveGridBase.bufferOptVar">\r
+</member><member name="F:Rico.LoadClient.SupportedLangs">\r
<summary>\r
- Name of the Javascript variable containing the initial LiveGrid buffer options\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.LiveGridBase.SqlCompat">\r
+</member><member name="F:Rico.LoadClient.jQueryThemePath">\r
<summary>\r
- Provides a set of functions that mask differences across various SQL dialects. Available once dbDialect is set.\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.LiveGridBase.dbDialect">\r
+</member><member name="P:Rico.LoadClient.LoadedLanguage">\r
<summary>\r
- When connecting to SQL databases, this is the SQL dialect to use.\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.LiveGridBase.dataProvider">\r
+</member><member name="P:Rico.LoadClient.checkQueryString">\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
+ Load settings from QueryString? true for demo, false for anything else. Default is false.\r
</summary>\r
-</member><member name="P:Rico.LiveGridBase.rows">\r
+</member><member name="P:Rico.LoadClient.checkWebConfig">\r
<summary>\r
- Number of visible rows in the grid.\r
- Negative values have the following meanings:\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>-1: size grid to client window</description></item>\r
- <item><description>-2: size grid to whichever is smaller: the client window or the data</description></item>\r
- <item><description>-3: size grid so that the page body does not have a scrollbar (default)</description></item>\r
- <item><description>-4: size grid to its parent node in the DOM</description></item>\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="F:Rico.LiveGridBase.ColGroups">\r
+</member><member name="M:Rico.LoadClient.InitLiveGrids(System.Web.UI.HtmlTextWriter)">\r
<summary>\r
- Collection of ColumnGroup objects, which define the headings used above each group of columns.\r
+ Initialize all grids 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="F:Rico.LiveGridBase.Tables">\r
+</member><member name="P:Rico.LoadClient.jTheme">\r
<summary>\r
- Defines the tables used by the LiveGrid. The first table is primary/main table.\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.LiveGridBase.ColClassName(System.Int32)">\r
+</member><member name="P:Rico.LoadClient.rTheme">\r
<summary>\r
- Returns the class name of the specified grid column\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
- <param name="colnum"></param>\r
-</member><member name="M:Rico.LiveGridBase.AddColumn(Rico.Column)">\r
+</member><member name="T:Rico.LoadClient">\r
<summary>\r
- Adds a new column to grid, returns column index\r
+ Loads the various Javascript, CSS, and image files required to make Rico function.\r
</summary>\r
- <param name="ColumnObj"></param>\r
-</member><member name="M:Rico.LiveGridBase.escapeJSON(System.String)">\r
+</member><member name="P:Rico.StyleBase.bold">\r
<summary>\r
- Takes a given string and makes it JSON valid (http://json.org/)\r
+ True if the text should be displayed using a bold font\r
</summary>\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
+</member><member name="P:Rico.StyleBase.italic">\r
<summary>\r
- Methods and properties common to LiveGrid and LiveGridEdit\r
+ True if the text should be displayed in italics\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.BufferType">\r
- <summary>\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
+</member><member name="P:Rico.StyleBase.underline">\r
<summary>\r
- If grid is populated from an html table, then set HtmlSourceId to the id of the source table\r
+ True if the text should be underlined\r
</summary>\r
-</member><member name="P:Rico.LiveGrid.QueryDistinct">\r
+</member><member name="P:Rico.StyleBase.fontsize">\r
<summary>\r
- True if this should be a distinct sql query (default is false)\r
+ Font size in points\r
</summary>\r
-</member><member name="T:Rico.LiveGrid">\r
+</member><member name="P:Rico.StyleBase.GridOnly">\r
<summary>\r
- Class to define a LiveGrid\r
- A LiveGrid buffers its data in a Javascript array and can retrieve that data via AJAX\r
+ If true, then style is only applied to the grid, not to html or Excel exports\r
</summary>\r
-</member><member name="M:Rico.TableCollection.IndexOf(System.String)">\r
+</member><member name="P:Rico.StyleBase.BackColor">\r
<summary>\r
- Returns the index of the table with TblAlias or -1 if not found\r
+ Specifies the background color. One of the 16 standard color names, or #rrggbb.\r
</summary>\r
- <param name="TblAlias"></param>\r
-</member><member name="P:Rico.GridBase.gridVar">\r
+</member><member name="P:Rico.StyleBase.ForeColor">\r
<summary>\r
- Name of grid Javascript object\r
+ Specifies the font color. One of the 16 standard color names, or #rrggbb.\r
</summary>\r
-</member><member name="P:Rico.GridBase.optionsVar">\r
+</member><member name="P:Rico.StyleBase.HorizontalAlign">\r
<summary>\r
- Name of grid options Javascript object\r
+ Specifies horizontal alignment: Left, Right, Center, or NotSet (default)\r
</summary>\r
-</member><member name="F:Rico.GridBase.AutoFilter">\r
+</member><member name="P:Rico.StyleBase.Overflow">\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
+ Normally, overflowed content is hidden, but this allows content in the cell to scroll.\r
+ Only applies to the grid, not to exports.\r
</summary>\r
-</member><member name="F:Rico.GridBase.FilterAllToken">\r
+</member><member name="P:Rico.StyleBase.CssStyle">\r
<summary>\r
- The token in select filters used to indicate "show all values" (default: "___ALL___").\r
+ Used internally. Returns the style properties as a css string.\r
</summary>\r
-</member><member name="F:Rico.GridBase.defaultWidth">\r
+</member><member name="M:Rico.StyleBase.UnwrappedXlStyle">\r
<summary>\r
- if -1 (default), then use column heading width, otherwise this is the default width in pixels\r
+ Used internally. Returns the style properties as an Excel XML string without the style tag.\r
</summary>\r
-</member><member name="F:Rico.GridBase.allowColResize">\r
+</member><member name="T:Rico.StyleBase">\r
<summary>\r
- Allow user to resize columns? Default is true.\r
+ Base class for all style classes as well as the Column class.\r
</summary>\r
-</member><member name="F:Rico.GridBase.frozenColumns">\r
+</member><member name="P:Rico.Style.StyleID">\r
<summary>\r
- Number of frozen columns on the left (or right if direction=rtl). Default is 0.\r
- </summary>\r
-</member><member name="F:Rico.GridBase.RowLineHtEms">\r
+ StyleID's should not contain spaces or other special characters.\r
+ <list type="bullet">\r
+ <item><description>Use a StyleID of Default to style the entire grid</description></item>\r
+ <item><description>Use a StyleID of DefaultHdg to style the grid heading</description></item>\r
+ <item><description>Use a StyleID of ricoLG_evenRow and/or ricoLG_oddRow to stripe the grid (striping does not get exported).</description></item>\r
+ <item><description>Use a StyleID of ricoLG_selection to set the styling for the selected row.</description></item>\r
+ </list>\r
+ </summary>\r
+</member><member name="M:Rico.Style.CssRule">\r
<summary>\r
- Height of one line of text in ems. Default is 1.2, which should be fine for almost all situations.\r
+ Returns the style properties as a CSS rule\r
</summary>\r
-</member><member name="F:Rico.GridBase.windowResize">\r
+</member><member name="M:Rico.Style.WrappedXlStyle">\r
<summary>\r
- Resize grid when browser window is resized? Default is true.\r
+ Returns the style properties as an Excel XML style, including the style tag\r
</summary>\r
-</member><member name="P:Rico.GridBase.menuEvent">\r
+</member><member name="P:Rico.Style.xlNumberFormat">\r
<summary>\r
- Specifies when the grid's popup menu should be invoked \r
+ For SimpleGrids only\r
</summary>\r
-</member><member name="P:Rico.GridBase.DefaultStyle">\r
+</member><member name="P:Rico.Style.NumberFormat">\r
<summary>\r
- Style used for the entire grid - headings and data.\r
+ For SimpleGrids only\r
</summary>\r
-</member><member name="P:Rico.GridBase.DefaultHdgStyle">\r
+</member><member name="M:Rico.Style.WrappedXlStyleNF">\r
<summary>\r
- This holds the default style for headings. Use only if not using themes.\r
+ Returns the style properties plus number format as an Excel XML style, including the style tag\r
</summary>\r
-</member><member name="F:Rico.GridBase.Styles">\r
+</member><member name="T:Rico.Style">\r
<summary>\r
- Collection of styles used for individual headings.\r
+ Defines a style that can be applied to a grid cell.\r
+ Using a StyleID of ricoLG_evenRow or ricoLG_oddRow will stripe the grid, however striping does not get exported.\r
+ Using a StyleID of ricoLG_selection will set the styling for the selected row.\r
</summary>\r
-</member><member name="P:Rico.GridBase.HdgRowLines">\r
+</member><member name="M:Rico.StyleDictionary.Add(Rico.Style)">\r
<summary>\r
- Lines of text displayed in each heading row\r
+ Adds a Style object to the collection\r
</summary>\r
-</member><member name="P:Rico.GridBase.DefaultRowLines">\r
+ <param name="new_style"></param>\r
+</member><member name="P:Rico.StyleDictionary.Item(System.String)">\r
<summary>\r
- Lines of text displayed in each data row\r
+ Returns a Style object from the collection based on the style's StyleID\r
</summary>\r
-</member><member name="P:Rico.GridBase.OuterDivId">\r
+ <param name="StyleId"></param>\r
+</member><member name="P:Rico.StyleDictionary.Keys">\r
<summary>\r
- Returns the id of the outermost grid container\r
+ Returns all of the StyleID's in the collection\r
</summary>\r
-</member><member name="M:Rico.GridBase.GetColumnIdx(System.String)">\r
+</member><member name="P:Rico.StyleDictionary.Values">\r
<summary>\r
- Returns the index of the column with the given id\r
+ Returns all of the Style objects in the collection\r
</summary>\r
-</member><member name="M:Rico.GridBase.GetColumn(System.String)">\r
+</member><member name="M:Rico.StyleDictionary.Contains(System.String)">\r
<summary>\r
- Returns the column object with the given id\r
+ Returns true if the StyleID is in the collection\r
</summary>\r
-</member><member name="M:Rico.GridBase.GridRules">\r
+ <param name="StyleId"></param>\r
+</member><member name="M:Rico.StyleDictionary.Remove(System.String)">\r
<summary>\r
- Returns the set of css rules that apply to this grid\r
+ Removes the Style object with the given StyleID from the collection\r
</summary>\r
-</member><member name="T:Rico.GridBase">\r
+ <param name="StyleId"></param>\r
+</member><member name="T:Rico.StyleDictionary">\r
<summary>\r
- This class defines properties and functions used in SimpleGrid, LiveGrid and LiveGridEdit classes.\r
+ Container for a collection of Style objects\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="F: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="F:Rico.Column.canDrag">\r
<summary>\r
- Font size in points\r
+ Is the user allowed to drag a column value? Default is false.\r
</summary>\r
-</member><member name="P:Rico.StyleBase.GridOnly">\r
+</member><member name="F:Rico.Column.canFilter">\r
<summary>\r
- If true, then style is only applied to the grid, not to html or Excel exports\r
+ Is the user allowed to filter the column? Default is true.\r
</summary>\r
-</member><member name="P:Rico.StyleBase.BackColor">\r
+</member><member name="F:Rico.Column.control">\r
<summary>\r
- Specifies the background color. One of the 16 standard color names, or #rrggbb.\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.StyleBase.ForeColor">\r
+</member><member name="F:Rico.Column.filterUI">\r
<summary>\r
- Specifies the font color. One of the 16 standard color names, or #rrggbb.\r
- </summary>\r
-</member><member name="P:Rico.StyleBase.HorizontalAlign">\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
+ </list>\r
+ </summary>\r
+</member><member name="F:Rico.Column.filterColId">\r
<summary>\r
- Specifies horizontal alignment: Left, Right, Center, or NotSet (default)\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.StyleBase.Overflow">\r
+</member><member name="F:Rico.Column.ConfirmDeleteColumn">\r
<summary>\r
- Normally, overflowed content is hidden, but this allows content in the cell to scroll.\r
- Only applies to the grid, not to exports.\r
+ The text content of this column will be included in delete confirmation messages.\r
</summary>\r
-</member><member name="P:Rico.StyleBase.CssStyle">\r
+</member><member name="F:Rico.Column.multiplier">\r
<summary>\r
- Used internally. Returns the style properties as a css string.\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="M:Rico.StyleBase.UnwrappedXlStyle">\r
+</member><member name="F:Rico.Column.decPlaces">\r
<summary>\r
- Used internally. Returns the style properties as an Excel XML string without the style tag.\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="T:Rico.StyleBase">\r
+</member><member name="F:Rico.Column.thouSep">\r
<summary>\r
- Base class for all style classes as well as the Column class.\r
+ If column is a number, display the value with a thousands separator? Default is true.\r
</summary>\r
-</member><member name="P:Rico.Style.StyleID">\r
+</member><member name="F:Rico.Column.negSign">\r
<summary>\r
- StyleID's should not contain spaces or other special characters.\r
- <list type="bullet">\r
- <item><description>Use a StyleID of Default to style the entire grid</description></item>\r
- <item><description>Use a StyleID of DefaultHdg to style the grid heading</description></item>\r
- <item><description>Use a StyleID of ricoLG_evenRow and/or ricoLG_oddRow to stripe the grid (striping does not get exported).</description></item>\r
- <item><description>Use a StyleID of ricoLG_selection to set the styling for the selected row.</description></item>\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="M:Rico.Style.CssRule">\r
+</member><member name="F:Rico.Column.prefix">\r
<summary>\r
- Returns the style properties as a CSS rule\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="M:Rico.Style.WrappedXlStyle">\r
+</member><member name="F:Rico.Column.suffix">\r
<summary>\r
- Returns the style properties as an Excel XML style, including the style tag\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.Style.xlNumberFormat">\r
+</member><member name="F:Rico.Column.HdgStyleID">\r
<summary>\r
- For SimpleGrids only\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.Style.NumberFormat">\r
+</member><member name="F:Rico.Column.isNullable">\r
<summary>\r
- For SimpleGrids only\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
</summary>\r
-</member><member name="M:Rico.Style.WrappedXlStyleNF">\r
+</member><member name="F:Rico.Column.Writeable">\r
<summary>\r
- Returns the style properties plus number format as an Excel XML style, including the style tag\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
</summary>\r
-</member><member name="T:Rico.Style">\r
+</member><member name="F:Rico.Column.isKey">\r
<summary>\r
- Defines a style that can be applied to a grid cell.\r
- Using a StyleID of ricoLG_evenRow or ricoLG_oddRow will stripe the grid, however striping does not get exported.\r
- Using a StyleID of ricoLG_selection will set the styling for the selected row.\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
</summary>\r
-</member><member name="M:Rico.StyleDictionary.Add(Rico.Style)">\r
+</member><member name="F:Rico.Column.Length">\r
<summary>\r
- Adds a Style object to the collection\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
</summary>\r
- <param name="new_style"></param>\r
-</member><member name="P:Rico.StyleDictionary.Item(System.String)">\r
+</member><member name="F:Rico.Column.TypeName">\r
<summary>\r
- Returns a Style object from the collection based on the style's StyleID\r
+ Database property - set automatically by LiveGrid.GetColumnInfoFromDb()\r
</summary>\r
- <param name="StyleId"></param>\r
-</member><member name="P:Rico.StyleDictionary.Keys">\r
+</member><member name="F:Rico.Column.ColGroupIdx">\r
<summary>\r
- Returns all of the StyleID's in the collection\r
+ For internal use\r
</summary>\r
-</member><member name="P:Rico.StyleDictionary.Values">\r
+</member><member name="P:Rico.Column.Heading">\r
<summary>\r
- Returns all of the Style objects in the collection\r
+ Text displayed in the column heading.\r
</summary>\r
-</member><member name="M:Rico.StyleDictionary.Contains(System.String)">\r
+</member><member name="P:Rico.Column.Width">\r
<summary>\r
- Returns true if the StyleID is in the collection\r
+ Initial width of the column in pixels. Default is to use LiveGrid.defaultWidth.\r
</summary>\r
- <param name="StyleId"></param>\r
-</member><member name="M:Rico.StyleDictionary.Remove(System.String)">\r
+</member><member name="M:Rico.Column.NumberFormat">\r
<summary>\r
- Removes the Style object with the given StyleID from the collection\r
+ Returns an Excel-type number format string based on decPlaces, thouSep, prefix.\r
</summary>\r
- <param name="StyleId"></param>\r
-</member><member name="T:Rico.StyleDictionary">\r
+</member><member name="P:Rico.Column.DataType">\r
<summary>\r
- Container for a collection of Style objects\r
+ Type of data stored in the column.\r
</summary>\r
-</member><member name="F:Rico.LoadClient.ImgHeading">\r
+</member><member name="M:Rico.Column.script">\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
+ Internal function that returns the LiveGrid column options object, used to initialize the column on the client.\r
</summary>\r
-</member><member name="F:Rico.LoadClient.BaseLib">\r
- <summary>\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="F:Rico.LoadClient.Logging">\r
+</member><member name="T:Rico.Column">\r
<summary>\r
- Enable Javascript console logging? Useful for debugging. Default is false.\r
+ Base class for a LiveGrid column\r
</summary>\r
-</member><member name="F:Rico.LoadClient.HTML5">\r
+</member><member name="F:Rico.FormulaCol.Formula">\r
<summary>\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
+ SQL expression\r
</summary>\r
-</member><member name="F:Rico.LoadClient.Language">\r
+</member><member name="T:Rico.FormulaCol">\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
+ Calculated Column\r
</summary>\r
-</member><member name="F:Rico.LoadClient.LoadBaseLib">\r
+</member><member name="F:Rico.TableCol.ColName">\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
+ Column name in table or view\r
</summary>\r
-</member><member name="F:Rico.LoadClient.Striping">\r
+</member><member name="F:Rico.TableCol.TblAlias">\r
<summary>\r
- Apply row striping to LiveGrids? Default is true. Applies only when themes are used.\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.LoadClient.SupportedLangs">\r
+</member><member name="F:Rico.TableCol.TableIdx">\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
+ Used internally\r
</summary>\r
-</member><member name="F:Rico.LoadClient.jQueryThemePath">\r
+</member><member name="T:Rico.TableCol">\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
+ Column from table or view\r
</summary>\r
-</member><member name="P:Rico.LoadClient.LoadedLanguage">\r
+</member><member name="F:Rico.EditCol.pattern">\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
+ 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="F: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.LoadClient.checkQueryString">\r
+</member><member name="F:Rico.EditCol.max">\r
<summary>\r
- Load settings from QueryString? true for demo, false for anything else. Default is false.\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.LoadClient.checkWebConfig">\r
+</member><member name="F:Rico.EditCol.Help">\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_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
+ 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="F:Rico.EditCol.TxtAreaRows">\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
+ 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.LoadClient.jTheme">\r
+</member><member name="F:Rico.EditCol.TxtAreaCols">\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
+ 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.LoadClient.rTheme">\r
+</member><member name="F:Rico.EditCol.ColData">\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
+ column's default value in the form view\r
</summary>\r
-</member><member name="T:Rico.LoadClient">\r
+</member><member name="F:Rico.EditCol.SelectSql">\r
<summary>\r
- Loads the various Javascript, CSS, and image files required to make Rico function.\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="F: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.My.Resources.Resources.ResourceManager">\r
+</member><member name="F:Rico.EditCol.SelectFilter">\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
+ 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="F:Rico.EditCol.SelectValues">\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
+ 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="F:Rico.EditCol.SelectRows">\r
<summary>\r
- A strongly-typed resource class, for looking up localized strings, etc.\r
-</summary>\r
-</member><member name="T:Rico.SimpleGrid">\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="F:Rico.EditCol.FilterFlag">\r
<summary>\r
- Class to define a SimpleGrid\r
+ If true, then the grid is filtered by the default value (ColData) for this column (default=false)\r
</summary>\r
-</member><member name="F:Rico.LiveGridEdit.onFormOpen">\r
+</member><member name="F:Rico.EditCol.InsertOnly">\r
<summary>\r
- Javascript function to be called when the form opens to add or edit a record\r
+ If true, then only write this field to the database when peforming an insert (default=false).\r
</summary>\r
-</member><member name="F:Rico.LiveGridEdit.onFormClose">\r
+</member><member name="F:Rico.EditCol.UpdateOnly">\r
<summary>\r
- Javascript function to be called when the add/edit form closes\r
+ If true, then only write this field to the database when peforming an update (default=false).\r
</summary>\r
-</member><member name="F:Rico.LiveGridEdit.onFormSubmit">\r
+</member><member name="F:Rico.EditCol.ReadOnly">\r
<summary>\r
- Javascript function to be called when the add/edit form is submitted to the server\r
+ If true, data is displayed on the entry form but cannot be changed, text is gray (default=false). \r
+ Does not apply to entry types of S, SL, N, R, RL -- use FormView="hidden" instead.\r
</summary>\r
-</member><member name="F:Rico.LiveGridEdit.onSubmitResponse">\r
+</member><member name="F:Rico.EditCol.FormView">\r
<summary>\r
- Javascript function to be called when a response is received from the server after a form submittal\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="F: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="F: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="E:Rico.LiveGridEdit.DbDelete">\r
+</member><member name="F:Rico.EditCol.DescriptionCol">\r
<summary>\r
- Event raised right before the database deletion takes place.\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
- <param name="TabIdx">Index into the Tables collection. 0 is the main table.</param>\r
-</member><member name="E:Rico.LiveGridEdit.DbInsert">\r
+</member><member name="F:Rico.EditCol.noFormBreak">\r
<summary>\r
- Event raised right before the database insertion takes place.\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
- <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
+</member><member name="M:Rico.EditCol.isLookupField">\r
<summary>\r
- Event raised right before the database update takes place.\r
+ Returns true if the column is a lookup field (entry type SL, RL, or CL)\r
</summary>\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
+</member><member name="P:Rico.EditCol.EntryType">\r
<summary>\r
- Returns where clause based on table's primary key\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="T:Rico.SimpleGrid">\r
+ <summary>\r
+ Class to define a SimpleGrid\r
</summary>\r
- <param name="TabIdx"></param>\r
</member>\r
</members>\r
</doc>
\ No newline at end of file