{"id":91,"date":"2011-02-17T16:01:57","date_gmt":"2011-02-17T21:01:57","guid":{"rendered":"http:\/\/cfdbplugin.com\/?page_id=91"},"modified":"2016-12-15T21:56:12","modified_gmt":"2016-12-16T02:56:12","slug":"cfdb-datatable","status":"publish","type":"page","link":"https:\/\/cfdbplugin.com\/?page_id=91","title":{"rendered":"[cfdb-datatable]"},"content":{"rendered":"

This documentation applies to version 2.6 and later<\/span><\/p>\n

Summary of Shortcode Options<\/strong><\/h1>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Option<\/strong><\/td>\nExample
\n<\/strong><\/td>\n		Description<\/strong><\/td>\n<\/tr>\n
form<\/strong><\/a><\/td>\n[cfdb-datatable form=\"myform\"<\/strong>]<\/code><\/td>\nRequired. Designates the form to display. All rows and columns are displayed by default<\/td>\n<\/tr>\n
role<\/strong><\/a><\/td>\n[cfdb-datatable form=\"myform\" role=\"Author\"<\/strong>]<\/code><\/td>\nMake short code only display output for user’s with minimum-required role. Choices are<\/p>\n
    \n
  • Administrator<\/li>\n
  • Editor<\/li>\n
  • Author<\/li>\n
  • Contributor<\/li>\n
  • Subscriber<\/li>\n
  • Anyone<\/li>\n<\/ul>\n

    WARNING<\/strong>: this setting is overridden by plugin setting in WP Admin page Contact -> Database Options -> Can See Submission when using shortcodes
    \n(since 2.4.1)<\/td>\n<\/tr>\n

show<\/strong><\/a><\/td>\n[cfdb-datatable form=\"myform\" show=\"col1,col2\"<\/strong>]<\/code><\/td>\nLimits columns to be shown to be those designated (comma-delimited list)<\/td>\n<\/tr>\n
hide<\/strong><\/a><\/td>\n[cfdb-datatable form=\"myform\" hide<\/span>=\"col1,col2\"<\/strong>]<\/code><\/td>\nDoes not show listed columns (comma-delimited list)<\/td>\n<\/tr>\n
header<\/strong><\/td>\n[cfdb-table form=\"myform\" header<\/span>=\"false\"<\/strong>]<\/code><\/td>\nShow or do not show the table header. Valid values are true<\/strong> (the default) and false<\/strong><\/td>\n<\/tr>\n
<\/a>headers<\/strong><\/td>\n[cfdb-table form=\"myform\" headers<\/span>=\"your-name=Name,ex_field1=Email\"<\/strong>]<\/code><\/td>\nAllows you to change the name displayed in the table header. Map a form field names to a more readable display names. (Since 2.5.1)<\/td>\n<\/tr>\n
limit<\/strong><\/a><\/td>\n[cfdb-datatable\u00a0form=\"myform\"\u00a0limit=\"10\"<\/strong>]<\/code><\/td>\nOne number: limit=”10″ means show first 10 rows. Is the same as limit=”0,10″
\nTwo Numbers: limit=”100,10″ means show 10 rows starting at row #100)<\/td>\n<\/tr>\n
random<\/strong><\/a><\/td>\n[cfdb-table form=\"myform\"\u00a0random=\"2\"<\/strong>]<\/code><\/td>\nDisplay 2 random rows from those that the short code finds. (Since 2.4)<\/td>\n<\/tr>\n
orderby<\/strong><\/a><\/td>\n[cfdb-datatable\u00a0form=\"myform\"\u00a0orderby=\"last-name,first-name\"<\/strong>]<\/code><\/td>\nSort rows by designated columns. Use “column-name desc” to sort in descending (reverse) order<\/td>\n<\/tr>\n
search<\/strong><\/a><\/td>\n[cfdb-datatable\u00a0form=\"myform\"\u00a0search<\/span>=\"Simpson\"<\/strong>]<\/code><\/td>\nSelect rows to display that have any cell with the search text in it (case insensitive). Intended to mimic behavior of the “Search” field in the DataTable<\/td>\n<\/tr>\n
filter<\/strong><\/a><\/td>\n[cfdb-datatable form=\"myform\" filter<\/span>=\"col1=Simpson\"<\/strong>]<\/code><\/td>\nSelect which rows to display based on filter expression. More powerful than “search”, it can filter on multiple columns with boolean and regular expressions. If both “search” and “filter” are specified, “search” is ignored.<\/td>\n<\/tr>\n
Options specific to this shortcode<\/em><\/td>\n<\/tr>\n
<\/a>edit<\/strong><\/td>\n[cfdb-datatable\u00a0form=\"myform\" edit=\"true\"<\/strong>]<\/code>
[cfdb-datatable\u00a0form=\"myform\" edit=\"cells\"<\/strong>]<\/code><\/td>\n		Enables editing mode to edit the cells and column names in the table (true) or just cells (cells). Only works if Editor plugin extension<\/a> is installed<\/span><\/strong>. Editing will not work unless the user is logged in and his role allows for editing (see Options page<\/strong>, Can Edit\/Delete Submission data<\/strong> setting. (since Version 2.6)Warning<\/strong>: table column headers can also be edited, but will not work properly if you are using “headers<\/strong>” in this short code to rename them.<\/td>\n<\/tr>\n
<\/a>editcolumns<\/strong><\/td>\n[cfdb-datatable\u00a0form=\"myform\" edit=\"cells\" editcolumns=\"column3,column5\"<\/strong>]<\/code><\/td>\nSpecify the columns to make editable. When omitted, all columns are editable.
Only works if Editor plugin extension<\/a> is installed<\/span><\/strong>.<\/td>\n<\/tr>\n
dt_options<\/strong><\/a><\/td>\n[cfdb-datatable\u00a0form=\"myform\" dt_options=\"bJQueryUI:true, sScrollX:'100%', bScrollCollapse:true\"<\/strong>]<\/code><\/td>\nAllows you to specify DataTable Javascript configuration features<\/a><\/td>\n<\/tr>\n
id<\/strong><\/td>\n[cfdb-datatable\u00a0form=\"myform\" id<\/span>=\"myid\"<\/strong>]<\/code><\/td>\nSets the id <\/strong>attribute on the table <\/strong>tag.
\nSame as for [cfdb-table]<\/a><\/td>\n<\/tr>\n
class<\/strong><\/td>\n[cfdb-datatable\u00a0form=\"myform\" class<\/span>=\"myclass\"<\/strong>]<\/code><\/td>\nSets the class <\/strong>attribute on the table <\/strong>tag.
\nSame as for [cfdb-table]<\/a>
\n* GENERALLY NOT\u00a0USED <\/strong>because DataTables add its styles.<\/td>\n<\/tr>\n
style<\/strong><\/td>\n[cfdb-datatable\u00a0form=\"myform\" id=\"myid\" style<\/span>=\"#myid th > td { font-size: x-small; background-color: #E8E8E8;\u00a0 }\"<\/strong>]<\/code><\/td>\nInjects input CSS into a style tag.
\nSame as for [cfdb-table]<\/a>
\n* GENERALLY NOT\u00a0USED <\/strong>because DataTables add its styles.<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n

 <\/p>\n

 <\/p>\n

Use[cfdb-datatable form=\"your-form\"]<\/code>. This shortcode provides a dynamically filterable and sortable table on your page. This is different than thefilter<\/code> parameter on the shortcode. Thefilter<\/code>parameter (such as in[cfdb-datatable form=\"your-form\" filter=\"field1=value1\"]<\/code>creates a table with only the data selected by the filter. But once you have a table showing on a page, you can further dynamically filter using the “Search” field above the displayed Datatable.<\/p>\n

Notes:<\/p>\n