Overview
Enthusiastically heralded as a defacto, must-have module for DotNetNuke, ListX provides unmatched, and unparalleled features making it the most useful and versatile module available on the market. Providing high-end custom formatted output and database integration to web projects has always been a hassle with DotNetNuke. While DNN provides all the customization abilities provided by the Module Developers, the layout and control of these are fixed and rigid, and provide only capabilities to control the class style used on the general output. ListX provides the most powerful universal presentation engine on the market. Not only can you build fully functional, hierarchical views of your data, but you can also create multiple ListX modules which interact with one another, each configured to perform complex display logic and runtime actions. Why build your modules from scratch, or build new modules just to display formatted reports when you can just use ListX?The root of ListX originated with the need to develop a universal presentation layer which could act as a complex data repeater, a single record property view or a completely interactive data editor. The web application required data grid layouts, search and filter interaction, property sheets as well as drill-down and editable views. Classically this would have been handled by creating many static modules, with pre-built repeaters and data grids to achieve formulated output. The system itself needed to be easily customizable by the web designers, capable of tweaking the User Interface without the need for writing code or recompiling the modules. Hence, ListX was born, pulling all these possibilities into one easy to use module.
/ Exceeding Expectations - Since it's conception, ListX has provided extraordinary capabilities to DNN web designers and developers. Imagine providing any type of data driven output to users with just a simple configuration, and easy integration.
- Elegant and Powerful Web Administration
- Customizable Queries with Interactive capabilities
- Dynamic Presentation for Viewing and Editing one or many records.
- Built in capabilities for -
- User defined Records-Per-Page
- Optional Page Selection
- Dynamic Alphabetic Filtering
- Custom Free-Text Searching
- Single and Multiple Column Sorting
- Custom Paging Capabilities
- AJAX Interaction for optimal speed
- Microsoft Excel data Exporting / Importing
- Event Driven Interaction
- Truly Intelligent Debugging
- File and image Upload
- Grouping Headers and Footers on Column Values
- Standard and Alternating Item Rendering
- Inline Column Formatting
- Grouped Checklists with Post-back free Item Selection
- Simplistic Integration with extreme visual impact
- Capable of leaping tall buildings in a single bound...(okay, so 9 out of 10)
/ Break the Mold - While many views are necessary for reading and displaying data, and providing interactive functionality to users - why be stuck with the same archaic view layouts? With ListX, you can build new front-end views of all of your database data. /
/ Expand your Horizons - Build new insights, and drill into data easily by scaling ListX integration across multiple module instances. Expand on all data interaction with limited restrictions. /
/ Build Within Budget - While you could spend hour upon hour building all modules from scratch, ListX provides real world, proven capabilities that allow you to simply configure ListX modules as Lists, Views, edit forms and nearly any other display type in one preexisting module. So you can focus on just the business logic. Leave the presentation to ListX! /
Blistering Fast Interaction
Taking the presentation layer further into the future, ListX provides the ability to utilize AJAX, Asynchronous Javascript and XML, to handle all the paging aspects of your data. With ListX and AJAX, viewing all the records in your presentation layer is accelerated to maximum speed and efficiency - posting back only the information necessary to the server for the desired page, and only updating the region on the browser page that has been affected by the new returned page information. Since DotNetNuke can sometimes load slower than other ASP.Net based applications, utilizing ListX with AJAX within DNN increases the overall speed and efficiency of the user experience.
Your Configuration – Anywhere, Anytime!
The entire set of View Options provided on the ListX module are stored for the specific page you are developing. In situations when you desire to utilize the same basic layout of a ListX Module between multiple instances, or when you need to duplicate the ListX on multiple installations of DotNetNuke, use the XML option to copy, or load an entire configuration. Press the button to load or retrieve the formalized XML structure identifying all properties. This makes it easy to copy the settings from one module or page into another instance of the ListX. Once clicked, you can Copy the contents of the XML Source text, or Paste the XML from your clipboard into the Source. To reload the module using the XML Source Text, click Load.
Build Solutions and Package these in your own Modules
Take your whole solution including Tabs/Pages, Modules, Files and Database schema and build a single ListX Package (LP) to distribute and reuse. Or, create PA’s out of your modules and install them like any other!
Tip: While ListX brings a huge array of functionality to the DotNetNuke world, you can improve your possibilities further by using ListX with our Toolbar control.
Table of Contents
Overview
Table of Contents
EULA - Software License Agreement
Control Panel
General
Search
Variables
Query
Actions
Format
Locking
Unlocking
XML Configuration
Saving Changes
Draft Mode
Runtime Issues Warning
Default Properties
Paging Properties
Filters and Sorting
AJAX Integration
Enabling AJAX Interaction
When NOT to use AJAX
Javascript
Site Integration
Debugging
Administration
Version Compatibility
Other Properties
Search Options
iSearchable Integration
Query Options
Quote Escaping
Runtime Variables
Custom Connections
Custom Connection (in the ListX Configuration)
Custom Paging
Oracle with Custom Paging
SQL 2005 with Custom Paging
Variables
Security
Protect Against SQL Injection
Protect Against HTML Injection
Protect Against ListX Injection
Message Actions
Managing Actions
Moving Actions
Editing Message Actions
Message Action Types
Action: Assignment
Action: Comment
Action: Email
Action: Execute
Action: File
Action: Input
Common Input Scenarios
XML Based Web Service
SOAP Based Web Service
Action: Log
Action: Message
Action: Output
Action: Redirect
Condition: If
Condition: Else-If
Condition: Else
Template Formatting
List Groups (Template Hierarchy)
Managing Template Groups
Editing Templates
Template Syntax
Group Statement
Default Item (No Results)
Default Item (No Query)
Column Values
Standard Column Output
System Values and Parameters
Advanced System Values
Input File (Form) Values
File (CSV/SQL) Import Process Values
Localization/Resource File Values
Runtime Values (Reflection)
Format – Custom Value Formatting
Standard .Net Formatters
Standard Numeric Formatting
Custom Numeric Formatting
Standard Date Formatting
Custom Date Formatting
Extended ListX Formatters
String Manipulation Formatters
LEFT
RIGHT
MID
UPPER
LOWER
LENGTH
REPLACE
PADLEFT
PADRIGHT
TRIM
TRIMLEFT
TRIMRIGHT
Encoding, Decoding
ENCODEURI
DECODEURI
ENCODEHTML
DECODEHTML.
ENCRYPT
DECRYPT
Runtime Verification and Validation
ISEMPTY
ISINROLE
ISSUPERUSER
ISNUMERIC
ISDATE.
CANEDIT
EXISTS
STARTSWITH
ENDSWITH
CONTAINS
INDEXOF
LASTINDEXOF
Advanced Tab and Custom Look-ups
TABID
TABID:COLUMN
TABNAME
TABTITLE
TABDESCRIPTION
SQLFIND
Coalesce
Coalesce Syntax
Examples
Example 1 – Column, Unassigned Querystring, Unassigned Form
Example 2 – Column, Unassigned Querystring, Assigned Form
Example 3 – Column, Unassigned Querystring, Assigned Empty Form
Example 4 – Column, Assigned Querystring, Assigned Form
Columns and Column Templates
Columns Syntax
Action Items
Example
Checkbox and Radio Lists
Check List Syntax
Example
Singular Check Item Syntax
Example
How to Use Checklists in your Solution
Example
Radio Item Syntax
Example
Sorting
Sorting Syntax
Example
Sub query
Sub querySyntax
Example
Alternate
Alternate Syntax
Example
Aggregations
Aggregation Syntax
Example
Set
Set Syntax
Example
MATH
MATH Syntax
Example
BITWISE Example
Condition Example
Condition Example (Strings)
Symbols and Functions
Logic Operators
Functions
IIF (IF And Only IF)
IIF Syntax
Example In Rendering
Example In Query
Escaping
Client Scripts And Utilities
AJAX Library
lxFetch
lxModule
Utilities Library
lxExpander
lxToggle
lxContainer
lxContainerGroup
lxSetValue
lxComboSelect
Validation Library
Group Validation
TEXTEDITOR – Rich Text with FTB
Examples
Standard - Data Grid
The Process
Query
Options
Format
List Item
Variables
Actions
Message Action – DeleteEmployee
Execute Action
Examples – Files and Images
The Process
Default Properties
Query
Format
Format – Add Form (Header / Footer)
Format – File Gallery (Detail)
Functionality
Query Variable - Description
Query Variable – Open File
Query Variable – Delete File
Actions
Action – Condition: If
Action – Execute
Action – File
Action – Condition: If
Action – File (Image Transformation)
Action – Execute
Message – Open File
Action - Execute
Action – File (Response)
Message – Delete File
Action - Execute
Examples – Web Service Integration
The Process
Formatting
Actions
Action - Message
Action - Assignment
Action - Assignment
Action - Input
Action – Condition: If
Action - Assignment
Demonstration
Examples (Extended)
ListX Skin Objects
Building ListX Packages (LP)
Building Custom Modules (PA)
Build your Modules
Create your Custom Controls
Build the PA (.dnn) file
The End Result
Repository
Log
Quick Builder
Appendix I - MIME Types
Appendix II - Connection Strings (OLE/ODBC.Net)
Appendix III - Version History
Quick Reference
Business Intelligence Force, Inc. (Bi4ce)
EULA - Software License Agreement
IMPORTANT! Do not install this SOFTWARE before you have read this license agreement. By proceeding to install this SOFTWARE you are indicating your acceptance of all the terms and conditions stated in this agreement.
This is a legal agreement between you (either as an individual or a single entity) and Business Intelligence Force, Inc. (Bi4ce) for this software product which includes computer software and may include associated media, printed materials, and "online" or electronic documentation (the "SOFTWARE"). By installing, copying or otherwise using this SOFTWARE you are agreeing to be bound by the terms of this agreement. If you do not agree to the terms of this Agreement, do not install or use the SOFTWARE and if it is a non-evaluation version, return it together with physical materials and media to the place you obtained them for a full refund.
1 GRANT OF LICENSE. This agreement grants you the following rights.
(i) EVALUATION LICENSE
You may install and use an unlimited number of copies of the SOFTWARE on an unlimited number of instances; however these website instances must not be available to the public and cannot be used for commercial purposes.
(ii) SINGLE INSTANCE LICENSE
You may install and use one copy of the SOFTWARE on a single website instance. The primary user of the computer on which the SOFTWARE is installed may make a second copy for his or her exclusive use on a portable computer.
(iii) MULTI INSTANCE LICENSE
You may use as many copies of the SOFTWARE as your multi instance license entitles you to, in the manner specified above. You are also entitled to make a corresponding number of secondary copies for portable computer use as specified above.
2. COPYRIGHT. The SOFTWARE is owned by Business Intelligence Force, Inc. (Bi4ce) and is protected by copyright laws and international treaty provisions, as well as other intellectual property laws and treaties. The SOFTWARE is licensed, not sold. You must therefore treat the SOFTWARE like any other copyrighted material.
3. TERM OF LICENSE. The license will continue until you physically destroy all copies of the SOFTWARE and merged portions thereof, and return any original program media and documentation to Business Intelligence Force, Inc. (Bi4ce).
4. OTHER RESTRICTIONS.
(i) TRANSFER
You may not rent or lease the SOFTWARE, but you may transfer the SOFTWARE and accompanying written materials on a permanent basis provided you retain no copies and the recipient agrees to the terms of this Agreement. If the SOFTWARE is an update, any transfer must include the update and all prior versions.
(ii) REVERSE ENGINEERING
You may not reverse engineer, decompile, or disassemble the SOFTWARE.
(iii) SEPARATION OF COMPONENTS
The SOFTWARE is licensed as a single product. Its component parts may not be separated for use on more than one instance, or accessed in any way other than through the provided user interface.
(iv) TERMINATION
Without prejudice to any other rights, Business Intelligence Force, Inc. (Bi4ce) may terminate this agreement if you fail to comply with the terms and conditions of this agreement. In such event, you must destroy all copies of the SOFTWARE and all of its component parts.
5. ENHANCEMENTS AND UPDATES. From time to time, at its sole discretion, Business Intelligence Force, Inc. (Bi4ce) may provide enhancements, updates, or new versions of the SOFTWARE on its then standard terms and conditions thereof. This Agreement shall apply to such enhancements.
6. DISTRIBUTION. Distribution by the user of any designers, components or other component parts (EXE's, DLL's, OCX's, Stored Procedures), executables, source code, or on-line help files distributed by Business Intelligence Force, Inc. (Bi4ce) as part of this product is prohibited.
You may not remove any proprietary notices, labels, trademarks from the SOFTWARE or associated documentation.
You may not modify, de-compile, disassemble, reverse engineer or translate the software.
LIMITED WARRANTY
You assume all responsibility for the selection of the SOFTWARE as appropriate to achieve the results you intend and for the installation of, use of, and results obtained from the SOFTWARE. Business Intelligence Force, Inc. (Bi4ce) warrants that the media on which you obtained SOFTWARE shall be free of manufacturing defects for a period of (60) sixty days from date of purchase. Except for the limited warranty set forth herein, the SOFTWARE is provided "as is." to the maximum extent permitted by applicable law, Business Intelligence Force, Inc. (Bi4ce) disclaims all warranties, either express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, and no infringement with respect to the SOFTWARE and the accompanying documentation. Without limiting the foregoing provisions, Business Intelligence Force, Inc. (Bi4ce) makes no warranty that the SOFTWARE will be error-free or free from interruptions or other failures or that the SOFTWARE will meet your requirements. Some states and jurisdictions do not allow limitations on implied warranties, so the above limitation may not apply to you. The foregoing provisions shall be enforceable to the maximum extent permitted by applicable law.
CUSTOMER REMEDIES. Business Intelligence Force, Inc. (Bi4ce) and its suppliers' entire liability and your exclusive remedy shall be, at Business Intelligence Force, Inc. (Bi4ce) option, either (a) return of the price paid or (b) repair or replacement of the SOFTWARE that does not meet Business Intelligence Force, Inc. (Bi4ce) Limited Warranty and which is returned to Business Intelligence Force, Inc. (Bi4ce) with a copy of your receipt or proof of purchase. This Limited Warranty is void if failure of the SOFTWARE has resulted from accident, abuse, or misapplication. Any replacement SOFTWARE will be warranted for the remainder of the original warranty period or thirty (30) days, whichever is longer.
NO LIABILITY FOR CONSEQUENTIAL DAMAGES. In no event shall Business Intelligence Force, Inc. (Bi4ce) or its suppliers be liable for any damages whatsoever (including, without limitation, damages for loss of business profits, business interruption, loss of business information, or other pecuniary loss) arising out of use of or inability to use this Business Intelligence Force, Inc. (Bi4ce) product, even if Business Intelligence Force, Inc. (Bi4ce) or its dealer have been advised of the possibility of such damages. Some countries do not allow the exclusion or limitation of certain implied warranties or the limitation of the foregoing warranty or the exclusion or limitation of incidental or consequential damages, in which case and to the extent such exclusion or limitation is not allowed some of the foregoing limitations and exclusions may not apply to you.
HIGH RISK ACTIVITIES. The SOFTWARE is not fault-tolerant and is not designed or intended for use in hazardous environments requiring fail-safe performance, including without limitation, in the operation of nuclear facilities, aircraft navigation or communication systems, air traffic control, weapons systems, direct life-support machines, or any other application in which the failure of the SOFTWARE could lead directly to death, personal injury, or severe physical or property damage (collectively, "High Risk Activities"). Business Intelligence Force, Inc. (Bi4ce) expressly disclaims any express or implied warranty of fitness for High Risk Activities.
GENERAL PROVISION. You shall have no right to sub-license any of the rights of this agreement, for any reason. In the event of the breach by you of this Agreement, you shall be liable for all damages to Business Intelligence Force, Inc. (Bi4ce), and this Agreement shall be terminated. If any provision of this Agreement shall be deemed to be invalid, illegal, or unenforceable, the validity, legality, and enforceability of the remaining portions of this Agreement shall not be affected or impaired thereby. In the event of a legal proceeding arising out of this Agreement, the prevailing party shall be awarded all legal costs incurred.