Quest Software v6.2 Quick Apps User Guide
Publicité
Publicité
Quick Apps
FOR SHAREPOINT
v6.2
User Guide
©
2013 Quest Software, Inc.
ALL RIGHTS RESERVED.
This guide contains proprietary information protected by copyright. The software described in this guide is furnished under a software license or nondisclosure agreement. This software may be used or copied only in accordance with the terms of the applicable agreement. No part of this guide may be reproduced or transmitted in any form or by any means, electronic or mechanical, including photocopying and recording for any purpose other than the purchaser's personal use without the written permission of Quest Software, Inc.
If you have any questions regarding your potential use of this material, contact:
Quest Software World Headquarters
LEGAL Dept
5 Polaris Way
Aliso Viejo, CA 92656 USA www.quest.com
email: [email protected]
Refer to our Web site for regional and international office information.
TRADEMARKS
Quest, Quest Software, and the Quest Software logo are trademarks and registered trademarks of Quest Software, Inc in the United States of America and other countries. For a complete list of Quest Software's trademarks, please see http://www.quest.com/legal/trademark-information.aspx
. Other trademarks and registered trademarks are property of their respective owners.
Disclaimer
The information in this document is provided in connection with Quest products. No license, express or implied, by estoppel or otherwise, to any intellectual property right is granted by this document or in connection with the sale of Quest products. EXCEPT AS SET FORTH IN
QUEST'S TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS
PRODUCT, QUEST ASSUMES NO LIABILITY WHATSOEVER AND DISCLAIMS ANY EXPRESS,
IMPLIED OR STATUTORY WARRANTY RELATING TO ITS PRODUCTS INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTY OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, OR NON-INFRINGEMENT. IN NO EVENT SHALL QUEST BE LIABLE FOR ANY DIRECT,
INDIRECT, CONSEQUENTIAL, PUNITIVE, SPECIAL OR INCIDENTAL DAMAGES (INCLUDING,
WITHOUT LIMITATION, DAMAGES FOR LOSS OF PROFITS, BUSINESS INTERRUPTION OR LOSS
OF INFORMATION) ARISING OUT OF THE USE OR INABILITY TO USE THIS DOCUMENT, EVEN
IF QUEST HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. Quest makes no representations or warranties with respect to the accuracy or completeness of the contents of this document and reserves the right to make changes to specifications and product descriptions at any time without notice. Quest does not make any commitment to update the information contained in this document.
Quick Apps for SharePoint User Guide
Updated - August 2013
Software Version - v6.2
C
ONTENTS
. . . . . . . . . . . . . . 13
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .14
. . . . . . . . . . . . . . . . . .14
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
. . . . . . . . . . . . . . . . . . . . . . . . . .20
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .22
. . . . . . . . . . . . . . . . . . . . . . . . . . .23
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .23
. . . . . . . . . . . . . . . . . . . . . . .35
. . . . . . . . . . . . . . . . . . . . .36
. . . . . . . . . . . . . . . . . . . . . .38
. . . . . . . . . . . . . . . . . .39
. . . . . . . . . . . . . . . . . . . . . . . . . . .40
. . . . . . . . . . . . . . . . . . . . . . .42
. . . . . . . . . . . . . . . . . . .42
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .44
. . . . . . . . . . . . . . . . . . . . . . . . . . .45
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
. . . . . . . . . . . . . . . . . . . . . . . . . . .47
. . . . . . . . . . . . . . . . . . . . . .48
. . . . . . . . . . . . . . . . . .48
iii
Quick Apps for SharePoint
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
. . . . . . . . . . . . . . . . . . . . . . . . . .51
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
. . . . . . . . . . . . . . . . . . . . . . . . . . .54
. . . . . . . . . . . . . . . . . . . . . .55
. . . . . . . . . . . . . . . . . .55
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
. . . . . . . . . . . . . . . . . . . . . . .68
. . . . . . . . . . . . . . . . . . . . . 106
. . . . . . . . . . . . . . . . . . . . . . . . . . 107
. . . . . . . . . . . . . . . . . . . . . . . . 108
. . . . . . . . . . . . . . . . . . . . 108
. . . . . . . . . . . . . . . . . . . . . . . . . . 108
. . . . . . . . . . . . . . . . . . 111
. . . . . . . . . . . . . . . . . . . . . 118
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
. . . . . . . . . . . . . . . . . . . . . . . . . 124
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
. . . . . . . . . . . . . . . . . . . . . . . 136
. . . . . . . . . . . . . . . . . . . . . 137
. . . . . . . . . . . . . . . . . 138
. . . . . . . . . . . . . . . . . . . . . . . . . . 139
. . . . . . . . . . . . . . . . . . . . 141
iv
. . . . . . . . . . . . . . . . . 141
. . . . . . . . . . . . . . . . . 141
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
. . . . . . . . . . . . . . . . . . . . . . . . . . 150
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
. . . . . . . . . . . . . . . . . . . . . 152
. . . . . . . . . . . . . . . . . 152
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
. . . . . . . . . . . . . . . . . . . . . . . . . . . 156
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
. . . . . . . . . . . . . . . . . . . . . . . . . . 158
. . . . . . . . . . . . . . . . . . . . . . . 159
. . . . . . . . . . . . . . . . . . . 159
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163
. . . . . . . . . . . . . . . . . . . . . . . . . . 164
. . . . . . . . . . . . . . . . . . . . . . . . . 165
. . . . . . . . . . . . . . . . . . . . . . 165
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 168
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169
v
Quick Apps for SharePoint
. . . . . . . . . . . . . . . . . . . . . 170
. . . . . . . . . . . . . . . . . . . . . . . . . . 171
. . . . . . . . . . . . . . . . . . . . . . . 172
. . . . . . . . . . . . . . . . . . . . 172
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 174
. . . . . . . . . . . . . . . . . . . . . . . . . 177
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178
. . . . . . . . . . . . . . . . . . . . . 210
. . . . . . . . . . . . . . . . . . . . . 213
. . . . . . . . . . . . . . . . . . . . . 214
. . . . . . . . . . . . . . . . . . . . . . 215
. . . . . . . . . . . . . . . . . . . . . . . . . . 216
. . . . . . . . . . . . . . . . . . . . . . . . . 217
. . . . . . . . . . . . . . . . . . . . . 218
. . . . . . . . . . . . . . . . . . . . . . . . 219
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222
. . . . . . . . . . . . . . . . . . . . . . . . . 224
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225
. . . . . . . . . . . . . . . . . . 248
. . . . . . . . . . . . . . . . . . . . . . . 248
. . . . . . . . . . . . . . . . . . . . . 252
. . . . . . . . . . . . . . . . . 252
. . . . . . . . . . . . . . . . . . . . . . 254
. . . . . . . . . . . . . . . . . . . . . . . . 254
. . . . . . . . . . . . . . . . . . . . . . . . . . 255
. . . . . . . . . . . . . . . . . . . . . . . . . 261
vi
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 265
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 266
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267
. . . . . . . . . . . . . . . . . . . . . . . 267
. . . . . . . . . . . . . . . . . . . . . . . 268
. . . . . . . . . . . . . . . . . . . 268
. . . . . . . . . . . . . . . . . . . . . . . 268
. . . . . . . . . . . . . . . . . . . . . . . 269
. . . . . . . . . . . . . . . . . 270
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 273
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 275
. . . . . . . . . . . . . . . . . . . . . . . 279
. . . . . . . . . . . . . . . . . . 280
. . . . . . . . . . . . . . . . . . . . . . . . 281
. . . . . . . . . . . . . . . . . . . . 281
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 283
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 284
. . . . . . . . . . . . . . . . . . . . . . . . . . 284
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 285
. . . . . . . . . . . . . . . . . . . . 287
. . . . . . . . . . . . . . . . . . . . . . . . . . 288
. . . . . . . . . . . . . . . . . . . . . 289
. . . . . . . . . . . . . . . . . . 289
vii
Quick Apps for SharePoint
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 292
. . . . . . . . . . . . . . . . . . . . . . . . . 293
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 293
. . . . . . . . . . . . . . . . . . . . . . . . . . 294
. . . . . . . . . . . . . . . . . . . . 295
. . . . . . . . . . . . . . . . . 295
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 297
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 298
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 299
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 300
. . . . . . . . . . . . . . . . . . . . . . . . . . 303
. . . . . . . . . . . . . . . . . . . . . . . . 304
. . . . . . . . . . . . . . . . . . . . 304
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 306
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 308
. . . . . . . . . . . . . . . . . . . . 310
. . . . . . . . . . . . . . . . . . . . . . . . . . 311
. . . . . . . . . . . . . . . . . . . . . . . . . 312
. . . . . . . . . . . . . . . . . . . . . 312
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 313
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
. . . . . . . . . . . . . . . . . . . . . . . . . . . 315
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 315
. . . . . . . . . . . . . . . . . . . . . . 333
. . . . . . . . . . . . . . . . . . . . . 371
. . . . . . . . . . . . . . . . . . . . . . . . . . 372
viii
. . . . . . . . . . . . . . . . . . . . . . 373
. . . . . . . . . . . . . . . . . . . 373
. . . . . . . . . . . . . . . . . . . . . . . . . . 373
. . . . . . . . . . . . . . . . . . 376
. . . . . . . . . . . . . . . . . . . . . 383
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 391
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 392
. . . . . . . . . . . . . . . . . . . . . 405
. . . . . . . . . . . . . . . . . . . . . 406
. . . . . . . . . . . . . . . . . . . . . . . . . . 406
. . . . . . . . . . . . . . . . . . . . . . . 407
. . . . . . . . . . . . . . . . . . . . 407
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 409
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 410
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 411
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 412
. . . . . . . . . . . . . . . . . . . . . . . 422
. . . . . . . . . . . . . . . . . . . . . 425
. . . . . . . . . . . . . . . . . . . . . . . . 425
. . . . . . . . . . . . . . . . . . . . . . . . . . 426
. . . . . . . . . . . . . . . . . . . . . . . . 428
. . . . . . . . . . . . . . . . . . . . 428
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 429
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 430
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 431
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 432
ix
Quick Apps for SharePoint
. . . . . . . . . . . . . . . . . . . . . . . . . . 435
. . . . . . . . . . . . . . . . . . . . . . . 436
. . . . . . . . . . . . . . . . . . . . 436
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 437
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 438
. . . . . . . . . . . . . . . . . . . . . . . . . . . . 439
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 440
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 443
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 444
. . . . . . . . . . . . . . . . . . . 444
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 453
. . . . . . . . . . . . . . . . 455
. . . . . . . . . . . . . . . . 455
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 457
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 458
. . . . . . . . . . . . . . . . . . . 460
. . . . . . . . . . . . . . . . . . . . . 460
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 464
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 467
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 468
. . . . . . . . . . . . . . . . . . . . . . . . . . . 470
. . . . . . . . . . . . . . . . . . . . 470
x
. . . . . . . . . . . . . . . . . . . . . . . 472
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . 475
. . . . . . . . . . . . . . . . . . . . . . . . . 476
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 479
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 480
. . . . . . . . . . . . . . . . . . . . . . . . . . . 480
. . . . . . . . . . . . . . . . . . . . . . . . . . . 481
. . . . . . . . . . . . . . . 482
. . . . . . . . . . . . . . . . . . . . . . . 483
. . . . . . . . . . . . . . . . . . . 484
. . . . . . . . . . . . . . . . . . . 486
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 489
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 499
. . . . . . . . . . . . . . . . . . . . . . . . . . . 505
. . . . . . . . . . . . . . . . . . . . . 505
. . . . . . . . . . . . . . . . . . . . . . 505
. . . . . . . . . . . . . . . . . . . . . . . . 506
xi
Quick Apps for SharePoint xii
1
Introducing Quick Apps for
SharePoint
•
About this Guide
•
About Quick Apps for SharePoint
•
Features of Quick Apps for SharePoint
Quick Apps for SharePoint
About this Guide
This guide describes how to use the web parts component of Quick Apps for
SharePoint. It contains the information required to perform general tasks and is intended for network administrators, consultants, analysts, and any other IT professionals using Quick Apps for SharePoint.
Before using this guide, see the Quick Apps for SharePoint Quick Start Guide for installing and activating Quick Apps. The same document also introduces the basic operation of Quick Apps, using a simple configuration to externalize documents in a sample SharePoint environment.
About Quick Apps for SharePoint
Quick Apps for SharePoint enables you to build applications that can be easily supported, maintained, and upgraded to ensure their long-term impact and return on investment. Because web parts automates simple or mundane tasks, you can free up SharePoint development resources and satisfy business requirements without costly custom coding.
Features of Quick Apps for SharePoint
Quick Apps for SharePoint is deployed as a SharePoint Solution. The benefit of the solution package deployment is the ability to deploy web parts in selected
Web Applications using the SharePoint Central Administration site. It also provides the flexibility to turn on/off Quick Apps for SharePoint as a site feature.
When a new site or site collection is created, the Admin or Site Designer can activate the Quick Apps for SharePoint - Web Parts Library to enable the web parts for newly added site collections.
This product allows you to:
• accelerate SharePoint application development using ready-made templates to deliver project management, CRM, and help desk applications that are easily supported, maintained, and extended
• build applications that you can easily support and maintain
• extend applications beyond native capabilities and exceed user expectations with the use of tabular forms to save screen space, parent-child relationships to ensure reliable data entry, and hide/show-when logic to govern what data users can see
14
Introducing Quick Apps for SharePoint
• deliver sophisticated applications that are easily upgraded when new versions of SharePoint are released
• bring data together from all of your enterprise application systems, such as SAP, Oracle, Lotus Domino, without the hassle of manually copying the data into SharePoint
• if errors occur, view log files in the SharePoint ULS log (see "Viewing
Log Files" in the Quick Start Guide for more information)
• display, create, and edit data in your external systems using SI Web
Parts. Out of the box, the SI Web Parts support the DAO Provider for:
• Web Services
• SQL Server
• Oracle
• Domino Server using XML over HTTP
• Salesforce
• K2Server (for SharePoint 2010 only)
15
Quick Apps for SharePoint
16
Common Tabs
•
Appearance Tab
•
Layout Tab
•
Advanced Tab
•
Ribbon Appearance Tab
2
Quick Apps for SharePoint
Appearance Tab
ELEMENT
Title
Height
Width
Chrome State
Chrome Type
DESCRIPTION
Allows you to enter a title for the web part
Allows you to set the web part to a fixed height
Allows you to set the web part to a fixed width
Allows you to select if the web part can be minimized or not when you open the web part. If Minimized is selected, then only the
Title Bar displays.
Allows you to select the kind of border to display around the web part.
Layout Tab
ELEMENT
Hidden
Direction
Zone
Zone Index
DESCRIPTION
Select this check box if you want the web part hidden
Allows you to set how the text in the web part displays depending on the language, either from Left to Right or Right to Left
Allows you to set the zone on the page where the web part is located
Allows you to set the order of the web part in a zone (if the page contains multiple web parts)
Zone and Zone Index are only available through the out-of-box content editor in your web part.
Advanced Tab
ELEMENT
Allow Minimize
Allow Close
DESCRIPTION
Select this check box if you want the web part minimized
Select this check box if you want the web part removed from the page
18
Common Tabs
ELEMENT
Allow Hide
Allow Zone Change
Allow Connections
Allow Editing in Personal
View
Export Mode
Title URL
Description
Help URL
Help Mode
Catalog Icon Image URL
Title Icon Image URL
Import Error Message
Target Audience
DESCRIPTION
Select this check box if you want the web part hidden
Select this check box if you want the web part moved to a different zone
Select this check box if you want the web part to participate in connections to other web parts
Select this check box if you want the web part modified in a personal view
Allows you to select the level of data that can be exported for this web part
Allows you to add the title of a URL as extra information about the web part
Allows you to enter a description of the web part that is displayed as a Tooltip when you hover your mouse over the web part title or icon.
Allows you to enter the location of a file containing Help information about the web part.
Allows you to specify how a browser displays Help content for the web part, either in a separate window which you must close before returning to the Web Page (Mode), in a separate window that you do not need to close before returning to the Web Page
(Modeless), or in the current browser window (Navigate)
Allows you to specify the location of a file containing an image to be used as the web part icon in the Web Part List. The image size must be 16 by 16 pixels.
Allows you to specify the location of a file containing an image to be used in the web part title bar. The image size must be 16 by 16 pixels.
Allows you to specify a message that appears if there is a problem importing the web part
Allows you to have the Web Part to appear only to people who are members of a particular group or audience.
An audience can be identified by using a SharePoint group, a distribution list, a security group, or a global audience.
19
Quick Apps for SharePoint
Ribbon Appearance Tab
ELEMENT
SharePoint Ribbon Tab Name
DESCRIPTION
Allows you to edit the display name of the Ribbon tab. If this property is filled out, it overrides the Title property.
20
qCalendarView
•
Overview
•
qCalendarView Tabs
•
qCalendarView Procedures
3
Quick Apps for SharePoint
Overview
The qCalendarView aggregates data from one or more SharePoint lists and displays it in calendar form.
If you would like to learn more, click here to watch the training video.
The qCalendarView allows you to:
• Aggregate data from multiple lists that reside in different SharePoint sites. The lists to be aggregated are defined in the Viewed Lists property.
• Ensure the referential integrity of the records in the dependent lists by preventing the deletion of the parent record. The dependent lists are defined in the Viewed Lists property.
• View your data by Month, Week, or Day.
• Display non-recurring and recurring events from Calendar lists.
• Customize the look and feel for each part of the calendar by using a skin.
• Define a static filter using the CAML Filter expression or Complex Filter expression. The Complex Filter expression supports time functions
(for example, AddDays) and time expression (such as [TODAY]) to filter out the data based on the moving time window. This feature is called Data Aging.
• Access the most common functions on the data item, such as View
Properties, Edit Properties, Alert Me, Export to ICalendar, and Delete.
The author can turn off the context menu by setting the Enable
Context Menu property to False.
• Show or hide the calendar based on the site group and cross-site group membership of the currently logged-in user by using the Show
User Groups and Hide User Groups properties.
• Enable the chart view to consume a filter from another web part that implements IWebPartRow or IWebPartParameter interface.
The IWebPartParameter consumer implementation is labeled with Get Filter From in the web part Connection menu. This interface cannot be connected with the obsolete
IFilterProvider or IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete.
22
qCalendarView
To maintain the same look and feel across all web parts, save the web part as a template, and re-import it into the SharePoint gallery to reuse it.
qCalendarView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qCalendarView contains the following tabs:
•
•
•
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qCalendarView, the Display tab opens by default. The
Default tab contains the following:
TAB ITEMS
Viewed Lists
Custom Actions
DESCRIPTION
See
for more information.
See
for more information.
23
Quick Apps for SharePoint
TAB ITEMS
CAML Filter
Complex Filter
Begin Date Field Name
End Date Field Name
Recurrence Field Name
Display Field Name
Display Format
DESCRIPTION
Allows you to specify the CAML (Collaboration Application Markup
Language) query expression to filter your data. CAML is an XML-based query language. The CAML Filter is only applied to the top level discussions. The filter is not applied to the responses.
See “CAML Filter Help” on page 467 on more information on CAML Filter
expression.
You can use the Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML Filter is applied.
Note:
The Complex Filter is provided here only for backward compatibility reason. In the past, Complex filter was used to support date functions.
See
“Complex Filter Help” on page 475
on more information on
Complex Filter.
Allows you to enter the name of the field in the SharePoint list that contains the begin date information. The default value is Start Time, which is the begin date field name for the SharePoint calendar list. If the calendar displays data from another type of list, you may have to adjust the value of this property. For example, if you want to display data from the Tasks list based on the Due Date of the tasks, then use
Due Date as the value of this property.
Allows you to enter the name of the field in the SharePoint list that contains the end date information. This property is optional. The default value is
E
nd Time, which is the end date field name for the SharePoint calendar list. If the calendar displays data from another type of list, you may have to adjust the value of this property or leave the value of the properly blank if it is not applicable.
Allows you to enter the name of the field in the SharePoint list that contains the recurrence data. This property is optional. The default value is RecurrenceData, the name of the field for the SharePoint calendar list that contains the recurrence data. If the calendar displays data from another type of list, leave the value of the properly blank.
Only the event list can have recurrence data (SharePoint does not allow you to add a new field to the list with Recurrence type).
Allows you to enter the name of the field in the SharePoint list that contains the title for the item. The default value is Title, which is the name of the field for the SharePoint event list that contains the event title. If the calendar displays data from another type of list, you may have to adjust the value of this property. For example, if you want to display data from the Projects list, you may use Project Name for the value of this property.
If you want to display the information from more than one fields, then specify the format in the Display Format property.
Allows you to enter the format of the title. You can use the
<%FieldName%> field replacement expression to refer to a certain field. The FieldName is case sensitive. This property takes precedence over the Display Field Name property.
Example: "/<%%> - <%Location%> (<%Phone Number%>)/" displays "Meeting with client - Conference Room 55 (1-800-555-1818
Code: 2156)" in the title.
24
qCalendarView
TAB ITEMS
Tooltip Field Name
Tooltip Format
Searched Fields
Show Search All Fields
Control in Search Panel
Expand Panel Filter on
Load
Panel Button Location
DESCRIPTION
Allows you to enter the name of the field in the SharePoint list that contains the description for the item. The description for the item is displayed as a tooltip when you hover your mouse over an item in the calendar. The default value is Description, which is the name of the field for the SharePoint event list that contains the event description. If the calendar displays data from another type of list, you may have to adjust the value of this property. For example, if you want to display data from the Tasks list, you may use Task Description for the value of this property.
If you want to display the information from more than one field, specify the format in the Tooltip Format property.
Allows you to enter the format of the tooltip. You can use the
<%FieldName%> field replacement expression to refer to a certain field. The FieldName is case sensitive. This property takes precedence over the Tooltip Field Name property.
See
“Searched Fields” on page 34 for more information.
Allows you to determine whether the Filter panel should display the control to search all fields in the list.
The Search All Fields Control allows you to do the following:
• Combine the search all fields functionality with other search criteria that has been entered for specific fields.
• When the search all fields criteria is entered, the Filter panel constructs a filter expression with the "Contain" operator for the following fields in the list: Single line of text, Multiple lines of text,
Choice, Lookup, Person or Group and Hyperlink or Picture. The
Filter panel uses all keywords as the value to be searched.
Therefore, if you enter "High Priority" in the search all fields control and perform the search, it finds the following sentence:
‘This is a high priority task’
However, it does not find the following sentence:
‘The priority is not always high’
Allows you to automatically open the Filter panel by default so you can perform a search quickly. When set to true, the Filter panel opens when the web part is loaded for the very first time.
Allows you to determine the location of the Go, Reset, and Close buttons in the Filter panel. This property has 3 options:
• Top — The buttons in the panel appear at the top
• Bottom — The buttons in the panel appears at the bottom
• TopAndBottom — The buttons in the panel appears at the top and the bottom
25
Quick Apps for SharePoint
TAB ITEMS
New Item Panel Style
Search Session Name
LinkTo
LinkToTargetURL
DESCRIPTION
Allows you to define the style of the new item panel. The new item panel is displayed when you click the New button in the toolbar and there are multiple lists being aggregated in the view. The New Item panel lets the user select the list that the new item should be created into. There are two options for the style:
• Elaborate — the new item panel displays the list of possible content types for the list, the location and the description for the list. This is the default value.
• Compact — the new item panel displays the list of possible content types for the list but it does not display the location and the description for the list.
Allows the Calendar View to store the search criteria in the session variable with this name.
Note:
Do not confuse this property with the SetSessionName attribute in the Viewed Lists property. The SetSessionName attribute stores the record that is being clicked. The field value from the item that is stored in the session variable can then be consumed by another web part. As a best practice, keep the value of the two session names different.
Allows you to turn the field into a hyperlinked column to the specified
URL. The URL can be an absolute or relative URL. The LinkTo can use the <%field name%> field replacement expression. You must use the encoded form of the < and > characters, which are < and >, respectively.
If you use a relative URL, the URL is appended to the site URL of the target site. For example, specify
"Lists/Calendar/EditForm.aspx?ID=<%ID%>" as the value of this property. If the user clicks an event that comes from the Calendar list in
Workspace A, whose site URL is "http://mydomain/sites/mysite", the user is directed to http://mydomain/sites/mysite/Lists/Calendar/EditForm.aspx?ID=23
(this assumes that the user clicks the event with ID=23).
When the calendar view points to a document library, you can use a special field replacement expression <%FilePath%> to get a complete path for the file.
Allows you to make the field value a hyperlink to the URL specified in the TargetUrl attribute in the Viewed Lists property.
Use the LinkToTarget URL when you aggregate lists with different name.
In that case, specify a different TargetUrl for each list in the Viewed
Lists property and the calendar view redirects the user to the correct
URL depending on the list from where the clicked item comes.
26
TAB ITEMS
Link To Source
ID HTTP Parameter
Name
Show User Groups
Hide User Groups
qCalendarView
DESCRIPTION
Allows you to make the field value a hyperlink to the URL specified in the Source HTTP parameter of the current request. For this option to work, the current page URL must look like: http://.....?Source=....
When do you use this attribute as opposed to the L ink To or the Link To
Target URL attributes? A typical case is when the URL for the hyperlink is dynamic. This could be because it contains dynamic parameters or the URL is different depending on the referral page.
Use the LinkToSource when you want to make the URL in the link dynamic. In that case, you can pass in the URL for the link into the
HTTP parameter of your page. For example, say that we have a page where the user can select a particular contact from the Contacts list.
This page might be useful for several cases in your application and you cannot hard code the URL because you may want the user to be redirected to different URL depending where they are in the application.
In that case, you can specify the URL for the hyperlink in the URL of the page.
Allows the qListForm and several other web parts to an HTTP Parameter called ID to identify the item to be displayed or edited. This HTTP
Parameter is usually generated automatically by the viewer web part, such as qListView or qCalendarView, when you select an item to be displayed or edited.
Note:
If qListForm is placed on a web part page that is contained within a document library, the page generates an error if the value of the ID HTTP Parameter is bigger than the number of pages within the document library. To prevent this error from happening, rename the ID
HTTP Parameter.
By default, the value of this property is "ID". You can change the value of this property to something else, such as LID. In that case, when you select "View Properties" or "Edit Properties" in the context menu, the
URL of the display or edit form becomes: http://mysite.com/EditFormURL.aspx?LID=xxx
Set the same property in the qListForm to the same value.
Allows you to list SharePoint groups whose members can view the web part. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the web part. Separate site group names with commas (for example,
Administrators, Readers).
If a user is a member of a group that is defined in both Show User
Groups and Hide User Groups, the user cannot.
27
Quick Apps for SharePoint
Viewed Lists
The Viewed Lists section defines:
• the lists whose data is aggregated in the calendar
• the Dependent Lists for each list. If the Dependent Lists information is provided, the Calendar View checks whether or not there are child records in the Dependent Lists when the user tries to delete an item from the calendar. If there are, the Calendar View does not delete the selected item.
Viewed List contains the following list attributes:
LIST ATTRIBUTES
Site URL
List Name
Include Subsites
Include This Site
DESCRIPTION
The URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
The name of the SharePoint list that is edited or displayed by this
Calendar View. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list, you can use a single dot (.) as the list name.
Note:
This only works if the qCalendarView is contained in the
AllItems.aspx. For example, if you are replacing the Microsoft Calendar
View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qCalendarView ise set to Tasks. If you want to save the list as a template and then use it somewhere else, the name of the new list might not be Tasks and using this relative list name automatically picks up the new list name for the view.
If selected, the Calendar View searches all the subsites for a list whose name specified in the ListName and aggregate the information from those list.
Note:
If you have many subsites, the information may take a long time to aggregate. Use this attribute if you have only a few subsites.
You must test this feature in your environment to see whether or not the response comes back in a reasonable amount of time and the request does not time out.
Used in conjunction of the IncludeSubsites attribute. If you set this property to true, the list in the current site is not aggregated by the
Calendar View. The current site is the site whose URL is specified in the
SiteUrl attribute.
28
qCalendarView
LIST ATTRIBUTES
Is Rollup List
Rolled Up List Name
Site URL Field Name
Active Field Name
Reset Session Names
Set Session Name
DESCRIPTION
Indicates whether or not the list specified by the SiteUrl and ListName attributes contains the Site URLs of the lists to be aggregated instead of the data to be aggregated. If you set this to true, the list specified by the SiteUrl and ListName must have a field that contains the URL information. By default, the name of that field is Site URL. If you use different field name, specify the name using the SiteUrlFieldName attribute below
Used in conjunction with the Is Rollup List property, indicates the name of the lists to be rolled up if you check the Is Rollup List check box.
If you want to aggregate more than one list from each site specified in the rollup list, you can define more than one List elements with the same rollup list, but different Rolled Up List Name. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following:
<Lists>
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Public
Library" />
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Private
Library" />
</Lists>
Used in conjunction with the Is Rollup List property, indicates the field that contains the Site URLs of the lists to be aggregated. This attribute is optional if the field name is Site URL.
Note:
The Site URL field must be a single line of text field.
Used in conjunction with the Is Rollup List property. The rollup list may contain a Yes/No field to indicate whether or not a particular site should be included in the rollup. This property is optional if the name of this field is Active.
Note:
The Active field must be a Yes/No field.
Resets (sets to NULL) the value of the session variables whose name is specified in this attribute. You can specify multiple names by separating them with commas.
You can reset the session name if you have Multi Persistent Selectors in the target page. Usually, you must reset all but the last persistent selector session values. This ensures that the item that you want to pre-select in the last persistent selector is not filtered out by the previous persistent selector.
Allows the calendar to store the selected item in the session under the name specified in the attribute. The item is selected when the user clicks a hyperlink created by using the Link To, Link To Target URL or the Link To Source properties.
You can specify this attribute when you have a Persistent Selector web part in the target page and you want that persistent selector to pre-select the item the user chose in this calendar.
29
Quick Apps for SharePoint
LIST ATTRIBUTES
Target URL
New Form URL
Edit Form URL
Display Form URL
DESCRIPTION
When the LinktoTargetUrl attribute of a specific column is selected (in the Display tab), the data in that column becomes a hyperlink to the
URL specified in this attribute. The Target Url can use the <%field name%> field replacement expression. But you must use the encoded form of the < and > characters, which are < and > respectively.
Use the LinktoTargetUrl attribute if you want each list to have a different URL; for example, when you want to aggregate multiple lists from the same workspace and connect a certain column to the display form of the list. In that case, the URL to the display form of each list can be different.
Indicates the URL where the form to create a new item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the New Item button in the toolbar is clicked. If not defined, the user is redirected to the
NewForm.aspx of the list (or Upload.aspx for the document library).
Indicates the URL where the form to edit an item in the list resides. The
URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks Edit Properties in the Context Menu.
If not defined, the user is redirected to the EditForm.aspx of the list.
Redefining the Edit Form URL is useful if you have different ways of editing an item depending on the current view. For example, in the view for external vendor, you may want to give them an edit form that does not contain all the fields in the list.
Note:
The ID and Source HTTP parameters are automatically appended to the Edit Form URL during redirection.
This attribute is usually used in conjunction with the qListForm web part.
Indicates where the URL where the form to display an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks View Properties in the Context Menu. If not defined, the user is redirected to the
DisplayForm.aspx of the list.
Redefining the Display Form URL is useful if you have different way of displaying an item depending on the current view. For example, in the view for external vendor, you may want to give them a display form that does not contain all the fields in the list.
Note:
The ID and Source HTTP parameters are automatically appended to the Display Form URL during redirection.
This attribute is usually used in conjunction with the qListForm web part.
30
qCalendarView
Custom Actions
This property enables you to define additional buttons in the toolbar or context menu item in the context menu. You can program that button or context menu item to do a series of actions. The calendar view supports some built-in actions.
However, you can write your own custom action using one of the .NET languages, compile it and have it called by the calendar view.
You cannot select an item in the Calendar View. Therefore, the action invoked by the custom toolbar button is not applied to any item. Rather, you can use the custom toolbar button to redirect user to another page with GoToURL or GoToSource actions.
The custom action in the calendar view does not support the Save, Copy or Move action.
The Custom Actions tab allows you to add toolbar buttons and context menus, which contain one or more Action Items. You can associate the ActionItem with one or more Actions. Action defines a certain operation that is carried out by the action item when it is clicked.
When you add an action item, you can configure the following:
ACTION ITEM
PROPERTY
IsSeparator
ID
Text
Text Resource ID
Prompt Text
DESCRIPTION
Allows you to set the item as a separator.
Allows you to enter a unique ID that identifies the item. Use a descriptive identifier to configure the action item with the editor.
Allows you to enter how the action item displays in the toolbar.
Allows you to define this property if you support a a multi-lingual site.
This attribute defines the identifier of the string in the Resource List that is used as the resource ID of the web part. The Text Resource ID and the current cultural setting (identified with the Culture HTTP parameter) is used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the value in the Text attribute is used.
Allows you to prompt the user to click the toolbar button or the context menu item.
31
Quick Apps for SharePoint
ACTION ITEM
PROPERTY
Prompt Text Resource ID
DESCRIPTION
Image URL
Access Key (Toolbar Only)
Position
Show User Groups
Hide User Groups
Allows you to define this property if you support a multi-lingual site.
The property defines the identifier of the string in the Resource List that is used as the resource ID of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) is used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
Allows you to add an image for the action item by specifying the path to the image.
Allows you to define one character from the Text attribute that becomes the access key to this toolbar button or context menu item.
For example, if you define a letter T as the access key, you can press
ALT+T and the browser focuses on this button or context menu item.
If there are multiple elements on the page with the same access key, you can repeat ALT+T repeatedly until you get the focus on this toolbar button or context menu item.
Allows you to set the position of the button in the toolbar. The index starts with 0.
Allows you to list SharePoint groups whose members can view the web part. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the web part. Separate site group names with commas (for example,
Administrators, Readers).
If a user is a member of a group that is defined in both Show User
Groups and Hide User Groups, the user cannot
You can specify actions with the action item:
ACTION
Name
DESCRIPTION
An optional element that allows you to identify a given action in order to access it from another action. You can refer to this action from the
GoToURL action and from ICustomActionEx Interface. See
“ICustomActionEx Interface” on page 444 .
32
ACTION
Type
qCalendarView
DESCRIPTION
Allows you to determine the type of the action. Here are the options:
• Delete — deletes the item.
• GoToURL — redirects the user to a specific URL. You can define more parameters. Select one or more of the following sources:
• Input - you can retrieve the current user information as the value of the parameter.
-Session - the name of the session variable where the value comes from when the source is set to Session
-HttpRequest - the value of the parameter that is retrieved from the HTTP parameters in the page URL. The name of the HTTP parameter is defined in the SourceName attribute. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the
SourceName attribute is ProductType, the value of the
ProductType HTTP parameter, which is Hardware, is used as the value of the parameter.
-ListItem
-RowFromAnotherWebPart — The parameter for the GoToURL action can be retrieved from the output of another action that comes first in the sequence of actions defined in the
ActionItem. There are two types of action that can produce an output: an action with Type of ExecuteOperation, and an action with Type of Custom that points to custom action implementation of ICustomActionEx Interface. You do that by defining the SourceName attribute of the action. This is the syntax of the SourceName attribute when you use
ResultFormAction source:
<ActionName>.<ResultType>[.Name], where ActionName refers to the Name attribute of the action that produces the output, ResultType can be OutParameter (if the action result is returned through one of the out or inout parameter) or
RawData - (if the action result is returned as an object). Name is optional. It further designates the object we want to use for the parameter. You do not have to specify the Name when the
ResultType is RawData. However, if the ResultType is
OutParameter, this name specifies the name of the out or input key value pair.
-ResultFromAction - You must define a source name (where in the source you want to get your information from), name (the name of the parameter that is appended to the URL you specified), and Session
• GoToSource — redirects the user to the URL specified in the
Source HTTP parameter. The URL to the page must look like: http://...?Source=URL for this option to work.
• StartWorkflow — starts the specified workflow in the Workflow
Name field. You must enter a Workflow name.
• ReturnToMasterChart — returns the user to the master chart page. You use this action type if this web part is located in the drill down page.
• Custom — implements your own custom action and call it with this action type. Enter a Class name that implements the
ICustomActionEx or ICustomAction interface, or select a class from the list, if available.
33
Quick Apps for SharePoint
Searched Fields
This property defines what fields are displayed in the Filter panel. If defined, the calendar view displays the Filter button in the toolbar. To disable the search feature in the calendar view, you can leave this property blank. If defined, the calendar view displays Filter or Search menu items under the Actions button in the toolbar. To disable the search feature in the calendar view, you can leave this property blank.
Specify the following field properties:
FIELD PROPERTY
Field Name
Title
Description
Default Value
Default Operator
Fixed Operator
Use People Editor
Column Count
Enable Multi Choice
Sort Field
Sort Order
DESCRIPTION
Indicates the element you are editing.
Displays title for the field. The value can be a plain string or an encoded HTML string.
Describes the field. This is useful if you want to give a short instruction or explanation about the field.
Defines the default value for the field.
You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of February 14, 2002 is
2002-02-14T00:00:00Z.
Defines the default operator for the field.
Defines the operator for the field. If specified, the list to select the operator for this field is turned off.
Enables you to enter any user information that is in your directory service.
If you set this to True and the field to be searched is a People and
Group field, the Filter panel shows the People Editor control for entering the search criteria.
Defines the number of columns for the options in a multi-choice field or in a choice-and-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form.
If set to True, allows you to select multiple options for the choice-and-lookup field. Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types.
To search a cross-site lookup field, you must specify one or more
List elements inside the Field element. The cross-site lookup field is displayed as two drop downs.
Defines the field that is used to sort the value in the list menu. The field name is case sensitive.
Allows you to sort the values in ascending or descending order.
34
qCalendarView
FIELD PROPERTY
AutoPostBack
Parent Field
Parent Filter Field Name
Filter Field Name
Display Field Name
Display Format
Site URL
List Name
Site Name
DESCRIPTION
When set to true, this attribute causes the Filter panel to refresh when the user changes the selection in a lookup field or cross-site lookup field.
You need to set AutoPostBack to true if this field is a lookup or a cross-site lookup field and it is being used to filter another lookup or cross-site lookup field in the Filter panel.
Defines another lookup or cross-site lookup field that is used to filter this field.
Defines the field in the parent field that is used to filter this field. It is the primary key in the list that is used in the lookup or cross-site lookup field.
Defines the field in the list that is used by this lookup or cross-site lookup field that is filtered by the parent filter field.
Shows the name of the field whose value is displayed in the list menu. The field name is case sensitive. Use this attribute instead of the Display Format attribute if you only want to display a single field in the list menu.
Indicates the format of the value that is displayed in the list menu.
Define this attribute instead of the Display Field Name attribute if you want to display multiple fields in the list menu. You can use the field replacement expression <%Field%> to refer to a field.
Note:
You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Searched Fields editor in the List View Editor, where the
Editor encodes the characters automatically.
Indicates the Site URL of the field. You can use an absolute or relative URL.
Indicates the name of the List. The field name is case sensitive.
Indicates the name of the site specified in the Site URL. This is used in case you have multiple lists. In this case, the first list menu to select the list displays as "List Name in Site Name". You can use any name for the Site Name. It does not have to match the real title of the Site.
Legend Appearance Tab
The Legend Appearance Tab contains the following:
ELEMENT
Legend Title
Legend Color
Appearance
DESCRIPTION
Allows you to enter a title of the legend.
Allows you to select the list title and color and font color for a list that your selected in Viewed Lists.
35
Quick Apps for SharePoint
ELEMENT
Show Legend
Legend Show Mode
Legend Show User
Groups
Legend Hide User
Groups
DESCRIPTION
Allows you to show the legend.
Allows you to select where to position the legend.
Allows you to select the SharePoint members who can view the legend.
Allows you to select the SharePoint members who cannot view the legend.
Calendar Appearance Tab
The Calendar Appearance Tab contains the following:
ELEMENT
Skin Name
Calendar Width
Calendar Width Unit
Calendar Height
Row Height
Month View Visible Appointments Per
Day
Overflow Behavior
Default Calendar View
Enable Day View
Enable Week View
Enable Month View
First Day of Week
Last Day of Week
DESCRIPTION
Allows you to enter the skin name for the calendar view.
Allows you to enter the width of the calendar view in pixels. The default is 700.
Allows you to enter unit of measure for the calendar width.
Allows you to enter the height of the calendar view in pixels. The default is 500.
Allows you to specify the row height for each day/week view and the appointment for the month view in pixels.
Allows you to enter the number of appointments visible per day when in the month view. The default is 3.
Allows you to o scroll or expand the page when the calendar view is not large enough to display all the data.
Allows you to set the default view for the Calendar web part. This can be either Day, Week or Month.
Allows you to switch to view one day at a time in the
Calendar web part
Allows you to switch to view one week at a time in the
Calendar web part.
Allows you to switch to view one month at a time in the
Calendar web part.
Allows you to determine the first day that is displayed in the week view and month view. The default value is
Sunday.
Allows you to determine the last day that is displayed in the week view and month view. The default value is
Saturday.
36
ELEMENT
Allow Delete
Appearance Field Name
qCalendarView
DESCRIPTION
Allows you to determine whether or not the delete button should be shown on every appointment in the calendar.
The delete button appears when you hover your mouse over the appointment. If you set this property to false, the delete button is not shown during the mouse over. By default, Allow Delete is set to true.
Allows you to determine the name of the field whose values is used to determine the color of the appointment.
This allows appointments to be displayed in different colors based on the value in this predefined field. For example, to display all appointments in conference room 5 with red and all appointments in conference room 6 with blue, the Appearance Field Name would be "Location".
There are 2 additional fields that you can use as
Appearance Field Name. These fields are not part of the list but used internally by the Calendar View:
• Workspace URL — this is the URL of the site that contains the containing list. When using the
Workspace URL in the Appearance Field Name, you need to specify the absolute URL of the site in the
FieldValue attribute in the Color Appearance property, for example: http://www.mysite.com/site1
• List Name — this is the name of the list that contains the appointment. When using the List Name in the
Appearance Field Name, you need to specify the name of the list in the FieldValue attribute in the
Color Appearance property, for example: Project
Calendar
37
Quick Apps for SharePoint
ELEMENT
Color Appearance
DESCRIPTION
Allows you to determine the color of the appointment for a certain value in the field specified by the Appearance Field
Name. This property is an XML string in the following format:
<Appearance>
<AppointmentAppearance FieldValue="fieldValue"
BackgroundColor="color" FontColor="color" />
<AppointmentAppearance
FieldValueRange="number-number"
BackgroundColor="color" FontColor="color" />
</Appearance>
For example:
<Appearance>
<AppointmentAppearance FieldValue="Conference
Room 5" BackgroundColor="Red" FontColor="Black" />
<AppointmentAppearance FieldValue="Conference
Room 6" BackgroundColor="Blue" FontColor="Orange" />
</Appearance>
The following are the attributes of the Color Appearance property:
• FieldValue — specifies the value for the field.
• BackgroundColor — is optional and it specifies the background color of the appointment for the specified value in the FieldValue attribute. The color can be specified as a well-known color such as white, black, cyan, lightGray, as a RGB value such as 255,
255,255, or you can specify it as #FFFFFF, #CCDDEE.
• FontColor — is optional and it specifies the font color of the appointment for the specified value in the
FieldValue attribute. The color can be specified as a well-known color such as white, black, cyan, lightGray, as a RGB value such as 255, 255,255, or you can specify it as #FFFFFF, #CCDDEE. The
FontColor attribute is ignored if you specify a URL in the Link To property or set the Link To Source or Link
To Target URL properties to true.
• FieldValueRange — Instead of using the FieldValue attribute, you can also use this attribute to determine a range of value, such as 0-100, 101-200.
FieldValueRange can only be used if you specify the name of a Number or Currency field in the
Appearance Field Name property.
Toolbar Appearance Tab
The Toolbar Appearance Tab contains the following:
ELEMENT
Toolbar Skin Name
DESCRIPTION
Allows you to enter the skin name for the toolbar.
38
qCalendarView
ELEMENT
Show New Item Button
Show Connect to Outlook Button
Show Alert Me Button
DESCRIPTION
Allows you to show the New Item button in the toolbar.
Allows you to show the Connect to Outlook button in the toolbar. The Connect To Outlook button lets users view their SharePoint Discussion lists in their Microsoft Outlook
Calendar. The Connect To Outlook button works only if you have Microsoft Outlook installed in you computer and it only works for the SharePoint Discussion list.
Allows you to show the Alert Me button in the toolbar. The
Alert Me button creates a list-level alert.
Context Menu Appearance Tab
The Context Menu Appearance Tab contains the following:
ELEMENT
Enable Context Menu
Context Menu Skin Name
Show View Properties
Show Edit Properties
Show Manage Permissions
Show Alert Me
Show Workflows
DESCRIPTION
Allows you to show the context menu.
Allows you to set he skin name for the context menu.
Allows you to show the View Properties menu item in the context menu.
Allows you to show the Edit Properties menu item in the context menu.
Allows you to show the Manage Permissions menu item in the context menu.
Allows you to show the Alert Me menu item in the context menu.
Allows you to show the Workflows Properties menu item in the context menu.
39
Quick Apps for SharePoint
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
View Properties Context Menu Text
Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings whose value can change depending on the current culture setting. The
Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — The field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName"
/>
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) is used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
By default, the text for the View Properties context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the View Properties context menu item in the
Resource List and specify its Resource ID. This Resource
ID and the current cultural setting (identified with the
Culture HTTP parameter) is used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
40
qCalendarView
ELEMENT
Edit Properties Context Menu Text
Resource ID
Manage Permissions Context Menu
Text Resource ID
Alert Me Context Menu Text Resource
ID
Workflows Context Menu Text
Resource ID
New Button Text Resource ID
DESCRIPTION
By default, the text for the Edit Properties context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Edit Properties context menu item in the
Resource List and specify its Resource ID. This Resource
ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Manage Permissions context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Manage Permissions context menu item in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Alert Me context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Alert Me context menu item in the Resource
List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Workflows context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Workflows context menu item in the Resource
List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the New toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the New toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
41
Quick Apps for SharePoint
ELEMENT
Connect to Outlook Button Text
Resource ID
Alert Me Button Text Resource ID
Filter Button Text Resource ID
DESCRIPTION
By default, the text for the Connect to Outlook toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Connect to Outlook toolbar button in the
Resource List and specify its Resource ID. This Resource
ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Alert Me toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Alert Me toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Filter toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Filter toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
qCalendarView Procedures
You can perform the following procedures using qCalendarView:
•
Configuring qCalendar View
To configure qCalendarView
1.
Add qCalendarView to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
42
qCaptionDisplay
•
Overview
•
qCaptionDisplay Tabs
•
qCaptionDisplay Procedures
4
Quick Apps for SharePoint
Overview
The qCaptionDisplay is a web part that displays a message from a SharePoint list. The text for the message is identified with a Caption ID.
If you would like to learn more, click here to watch the training video.
Storing the message in a list, as opposed to hard coding it in a page, increases the site maintainability. This is useful if the site is replicated. If you need to make a change to the message, you only have to do it in one place; just change the list. The list usually resides outside of the replicated site.
You can localize the title and the messages displayed by the caption display. You can define different Title for different cultures using the Resource List and the
Title Resource ID properties. The culture for the page can be defined by appending the Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US
To use the caption display, you must first define a source list for the captions.
The SharePoint list for the caption display should contain these fields:
• Caption ID
—
This field is mandatory. It is a single-line text field that contains the identifier for the caption.
• Caption
—
This field is mandatory. This is a multiple-line text field that contains the message.
• Culture
—
This field is optional. You must have this field if you want to have different messages for a different culture. You can define different captions with the same Caption ID, but different Culture. You must leave the value for the default culture blank. For example:
CAPTION ID
sites.mysite.default.aspx
sites.mysite.default.aspx
CULTURE
id-ID
CAPTION
Welcome to my site
Selamat datang ke situs saya
Make sure that the Allow rich HTML text in the Caption field is set to No.
44
qCaptionDisplay
If your list uses different name for the fields, define the name in the Caption ID
Field Name, Caption Field Name and Culture Field Name properties.
The Caption field can contain plain text or a piece HTML.
You can create the source list easily by selecting Site Actions | More Options |
Custom List | Quest Caption Display List. This automatically creates a list that contains all of the above fields.
Define a convention for the Caption ID value that makes it easy for you to identify where the message is used. For example, use the URL of the page, remove the host name from the URL and replace all / with . (period). Therefore, if the page URL is http://hostname/sites/mysite/default.aspx, the Caption ID is sites.mysite.default.aspx.
qCaptionDisplay Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qCaptionDisplay contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
45
Quick Apps for SharePoint
Display Tab
When you open ezEdit in qCaptionDisplay, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Site URL
List Name
Caption ID
Caption ID Field Name
Caption Field Name
Culture Field Name
Show User Groups
Hide User Groups
DESCRIPTION
Allows you to enter the URL to the site that contains the list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
Allows you to enter a list name. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List Name.
Allows you to enter the identifier that locates the message in the list.
Allows you to enter the name of the field containing the caption ID. The default value is User Caption ID.
Allows you to enter the name of the field containing the message. The default value is Caption.
Allows you to enter the name of the field containing the Culture. The default value is User Culture.
Allows you to show groups where the user is a member of one of the
SharePoint groups listed. Separate site group names with commas.
Allows you to hide groups where the user is member of one of the
SharePoint groups listed. Separate site group names with commas.
46
qCaptionDisplay
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — The field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
47
Quick Apps for SharePoint
qCaptionDisplay Procedures
You can perform the following procedures using qCaptionDisplay:
•
Configuring qCaptionDisplay
To configure qCaptionDisplay
1.
Add qCaptionDisplay to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
48
qCascadingMenu
•
Overview
•
qCascadingMenu Tabs
•
qCascadingMenu Procedures
5
Quick Apps for SharePoint
Overview
The qCascadingMenu lets you create complex menus that occupy minimum screen real estate.
If you would like to learn more, click here to watch the training video.
qCascadingMenu offers the ability to:
• display items from multiple SharePoint lists. Each list can contain multiple top-level items.
• define a static FilterExpression using a Complex Filter expression. The ability to filter enables you to define the items to be displayed in your menu.
• show or hide the top-level items that come from a certain list based on the site group membership of the currently logged-in user.
• hide menu items whose target URLs are not accessible by the current user.
• define an icon for each menu item, and define the target frame for the target page.
• localize the title and the menu item text. You can define different Title for different cultures using the Resource List and the Title Resource
ID properties. Your can define the culture appending the Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US
To configure this web part, we recommend that you use the Quest Menu List custom list template. Use the template to define a source list for the menu items on a SharePoint site. For information on how to create the source list, see
“Configuring qCascadingMenu” on page 55 . This automatically creates a list
which contains the following columns by default:
COLUMN
Text
Menu ID
Parent Menu ID
DESCRIPTION
Provide the text for the menu item.
Provides the ID for the menu item.
Provides the ID of the menu item that is the parent of this menu item.
50
qCascadingMenu
COLUMN
Target Url
Target
Icon Url
Access Key
DESCRIPTION
Provides the target URL for the menu item.
Note:
This is not a Hyperlink field because Hyperlink field does not let you use a relative URL.
Indicates where to open the target page. Specify
_blank
to open the page in a new window. Leave the target column empty to redirect the current window to the target URL.
Provides the URL to the icon for the menu item.
Indicates the shortcut key to activate the menu item. You can activate the menu item by pressing ALT+Access Key Character.
Indicates the culture for this menu item Culture
You must map these columns in the source list to the corresponding field names in the Configuration section in the Web Part. For more information on the
Configuration section, see
“Configuration” on page 52 . For more information on
how to configure the qCascadingMenu Web Part, see
“Configuring qCascadingMenu” on page 55 .
qCascadingMenu Tabs
You can configure this Web Part through its tabs that are accessible through ezEdit. qCascadingMenu contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
51
Quick Apps for SharePoint
Display Tab
When you open ezEdit in qCascadingMenu, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Configuration
Target URL Relative to Master Page URL
Menu Flow
Vertical Flow Width
Skin Name
DESCRIPTION
See “Configuration” on page 52 for more information.
Allows you to append the value of the target URL to the URL of the master page. By default, this property is set to true to maintain backward compatibility with the existing applications who assumed that the relative
URL is appended to the relative URL of the master page.
Allows you to specify whether the menu should flow vertically or horizontally. The default value is Horizontal.
Allows you to enter the name of the field containing the caption ID. The default value is User Caption ID.
Allows you to select the skin name for the menu. If you have a custom skin, you can add it to the following folder for SharePoint
2010:C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins or for SharePoint 2013: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins
Note:
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Configuration
This property defines the source list and behavior of the cascading menu. The
Configuration element can contain one or more Menu elements. Each menu element can read a different source. This property is an XML string in the following format:
<Configuration>
<Menu SiteUrl="url" ListName="listName"
FilterExpression="filterExpression" TextFieldName="Text"
MenuIdFieldName="Menu Id" TargetUrlFieldName="Target Url"
TargetFieldName="Target" IconUrlFieldName="Icon Url"
AccessKeyFieldName="Access Key" CultureFieldName="Culture"
ShowUserGroups="Group1, Group2" HideUserGroups="Group1,
Group2" CheckUserAccess="true/false"/>
</Configuration>
52
qCascadingMenu
You can define the following in the Configuration section:
FIELD
Site URL
List Name
Filter Expression
Text Field Name
Menu ID Field Name
Parent Menu ID Field
Name
Target URL Field Name
Target Field Name
Icon URL Field Name
Culture Field Name
Access Key Field Name
Show User Groups
Hide User Groups
Check User Access
DESCRIPTION
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Allows you to enter the name of the list. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List
Name.
Allows you to filter the data. The Complex Filter Expression to filter the data. See
“Complex Filter Help” on page 475
for help on Complex Filter
Expression.
Allows you to set the field that contains the text for the menu item.
Allows you to set the name of the field that contains the menu ID for the menu item.
Allows you to set the name of the field that contains the parent ID for the menu item.
Allows you to set the name of the field that contains the indicator of where to open the target URL.
Allows you to set the name of the field that contains the indicator of where to open the target page.
Allows you to set the name of the field that contains the icon URL for the menu item.
Allows you to set the name of the field that contains the culture for the menu item.
Allows you to set the name of the field that contains the access key for the menu item.
Allows you to show groups where the user is a member of one of the
SharePoint groups listed. Separate site group names with commas.
Allows you to hide groups where the user is member of one of the
SharePoint groups listed. Separate site group names with commas.
Allows you to show only the menu items that point to the workspace which the current can access.
Note:
Performance can be affected when checking the access for each menu item, especially for large menus. Also, make sure that every menu item points to a page in a SharePoint site that is reachable from the current site (as opposed to any external site such as MSN, Google)
53
Quick Apps for SharePoint
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl —The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
54
qCascadingMenu
qCascadingMenu Procedures
You can perform the following procedures using qCascadingMenu:
•
Configuring qCascadingMenu
To configure qCascadingMenu
1.
Create a source list.
If you are using SharePoint 2010, from SharePoint 2010 Central Administration, select
Site Actions | More Options | Custom List | Quest Menu List
.
If you are using SharePoint 2013, from SharePoint 2013 Central Administration, select
Add an app | Quest Menu List.
2.
Name your list and click
Create
.
3.
Click
New Item
to add information to your source list. Click
Save
.
4.
Add qCascadingMenu to your site collection page.
5.
Open
ezEdit
.
The Display tab opens by default.
6.
From the Configuration section, select the source list created in
SharePoint, and click
OK
.
7.
Click Edit next to the list name.
8.
For each field name, select the corresponding column name (from the source list created in SharePoint). For example, for Text Field
Name, select Text; for Menu Id Field Name, select Menu Id. Click
OK
.
9.
If needed, configure the elements in the other tabs.
10. When done configuring each tab, click
OK
.
For an example of how to create a qCascading menu with parent/child relationships, see http://www.quest.com/tv/All-Videos/2088622632001/Create-cascading-parentchild-rel ationship-menus-with-Quick-Apps-for-SharePoint/Video/ .
55
Quick Apps for SharePoint
56
qChartView
•
Overview
•
qChartView Tabs
•
qChartView Procedures
6
Quick Apps for SharePoint
Overview
qChartView aggregates data from one or more SharePoint lists and displays it in different chart types.
If you would like to learn more, click here to watch the training video. qChartView has the following features:
• Different chart types including multi series chart, combination chart,
2D and 3D charts.
• Ability to display data from multiple lists, even when the lists are in different sites, site collections or web applications (as long as they are in the same configuration database).
• Ability to customize the look of the chart
• Ability to display one or more trend lines in the chart
• Dual Y Axis support, making your charts more readable when the minimum and maximum values in your data series are very different
• Ability to generate multiple data series based on dynamic data
• Ability to create drill down charts.
• Dynamic language switching and Flash and JavaScript (HTML5) support
qChartView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qChartView contains the following tabs:
•
•
•
•
•
•
•
58
qChartView
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in “ Common Tabs” on page 17 .
Display Tab
When you open ezEdit in qChartView, the Display Tab opens by default. The
Default tab contains the following:
ELEMENT
Viewed Lists
Chart Type
Configuration
Searched Fields
Turn On List View Link Mode
Turn On List Searcher Mode
DESCRIPTION
See “ Viewed Lists” on page 61
for more information
Allows you to select the type of chart used to display the data.
For examples of each chart type, see “ Sample Charts” on page 489 .
When you select one of the Multi Series, Scroll or Stacked chart type, you must define multiple data series in the Configuration property. Otherwise you will get a blank chart.
See “ Configuration” on page 63 for more information.
See “ Searched Fields” on page 66 for more information.
Allows you to link this chart view with qListView. When selected, the chart view will display the same data that is displayed in the listview, with the same filters and sort condition applied. The filters and the sort conditions are being passed by the List View using Session variable. Therefore, you must set the Search Session Name property to the same value as the Search Session Name property in the listview.
Note:
The chart view does not have Search/Filter panel available in this mode.
Allows you to perform a search before the chart view displays any data.
59
Quick Apps for SharePoint
ELEMENT
Show Search All Fields Control in Search Panel
Expand Filter Pane on Load
Panel Button Location
Search Session Name
CAML Filter
Complex Filter
DESCRIPTION
Determines whether the Filter panel should display the control to search all fields in the list. When set to true, the following control is shown in the Filter panel:
The Search All Fields Control allows you to do the following:
• Combine the search all fields functionality with other search criteria that has been entered for specific fields.
• When the search all fields criteria is entered, the Filter panel will construct a filter expression with the "Contain" operator for the following fields in the list: Single line of text, Multiple lines of text, Choice, Lookup, Person or
Group and Hyperlink or Picture. The Filter panel will use the entire keywords as the value to be searched.
Therefore, if you enter "High Priority" in the search all fields control and perform the search, it will find the following sentence:
‘This is a high priority task’
However, it will not find the following sentence:
‘The priority is not always high’
Allows you to automatically open the Filter panel by default so that you can perform a search quickly. When selected, the
Filter panel will open when the web part is loaded for the very first time.
Determines the location of the Go, Reset, and Close buttons in the Filter panel, either top, bottom, or both top and bottom.
If Turn On List View Link Mode is selected, the Chart View will retrieve the Viewed Lists and filter criteria from the session under this name. This value must match with the Search
Session Name property that you specify in the qListView. If the
Turn On List View Link Mode is not selected, the Chart View uses this search session name to store the search criteria specified in the Search/Filter panel.
Allows you to define a CAML (Collaboration Application Markup
Language) query expression to filter your data. CAML is an
XML-based query language.
CAML Filter is more efficient than the Complex Filter because the data filtering occurs in the SQL Server. Therefore, there is potentially much less data being transferred from the SQL
Server to the Web Server. However, the CAML Filter is slightly more difficult to write than the Complex Filter and there are a few things, such as Date function, that you can only do in
Complex Filter. If you specify the CAML Filter and the Complex
Filter, the CAML Filter is applied to the data first. The results of the CAML Filter will then be filtered again by the Complex
Filter. we recommend using the CAML Filter first. If that is not sufficient, you can then define the Complex Filter to filter your data further.
See “ CAML Filter Help” on page 467 on more information.
Allows you to define a static filter for the data. The static filter is combined with the dynamic filter specified by the user during runtime.
See “ Complex Filter Help” on page 475
on more information.
60
qChartView
Viewed Lists
This property defines the lists whose data is aggregated in the Chart View.
This property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" [optional attributes] />
</Lists>
The following are the elements for the Viewed Lists attribute.
ELEMENT
Site URL
List Name
Include Subsites
Include This Site
Is Rollup List
DESCRIPTION
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Allows you to set the name of the SharePoint list. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list, you can use a single dot (.) as the list name.
Allows you to search all subsites for a list whose name specified in the
ListName, and aggregate the information from those list.
Note:
If you have many subsites, the information may take a long time to aggregate. Use this attribute if you have only a small amount of subsites. You must test this feature in your environment to see whether or not the response comes back in a reasonable amount of time and the request does not time out.
Used in conjunction of the IncludeSubsites attribute. If you set this property to true, the list in the current site is aggregated by the Chart
View. The current site is the site whose URL is specified in the SiteUrl attribute.
Indicates whether or not the list specified by the SiteUrl and ListName attributes contains the Site URLs of the lists to be aggregated instead of the data to be aggregated. If you set this to true, the list specified by the SiteUrl and ListName must have a field that contains the URL information. By default, the name of that field is Site URL. If you use different field name, specify the name using the SiteUrlFieldName attribute below.
61
Quick Apps for SharePoint
ELEMENT
Rolled Up List Name
Site URL Field Name
Active Field Name
DESCRIPTION
Used in conjunction with the IsRollupList property, indicates the name of the lists to be rolled up if you set the IsRollupList to true.
If you want to aggregate more than one list from each site specified in the rollup list, you can define more than one List elements with the same rollup list, but different RolledUpListName. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following:
<Lists>
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Public
Library" />
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Private
Library" />
</Lists>
Used in conjunction with the IsRollupList property, indicates the field that contains the Site URLs of the lists to be aggregated. This attribute is optional if the field name is Site URL.
Note:
The Site URL field must be a single line of text field.
Used in conjunction with the IsRollupList property. The rollup list may contain a Yes/No field to indicate whether or not a particular site should be included in the rollup. This property is optional if the name of this field is Active.
Note:
The Active field must be a Yes/No field.
Examples of a Viewed Lists Property
1.
Aggregate the Tasks list from Project1 and /Project2 sites.
<Lists>
<List SiteUrl="Project1" ListName="Tasks" />
<List SiteUrl="Project2" ListName="Tasks" />
</Lists>
2.
Aggregate the Tasks list from all the subsites but exclude the current site.
<Lists>
<List SiteUrl="." ListName="Tasks"
IncludeSubsites="true"
IncludeThisSite="false" />
</Lists>
3.
Aggregate the Tasks list from the sites that are specified in the
MyProjectSites list.
<Lists>
<List SiteUrl="." ListName="MyProjectSites"
IsRollupList="true"
RolledUpListName="Tasks" />
</Lists>
62
qChartView
This example assumes that the MyProjectSites list contains a column called Site
URL and looks like the following example:
Site URL
Project 1
Project 2
Project 3
Configuration
This property defines how the data should be grouped in the X Axis and the data series for the chart.
This property is an XML string in the following format:
<Configuration LookupThresholdControlSetting=”On”>
<XAxis FieldName="FieldName" [optional attributes]/>
<Series>
<Items FieldName="FieldName"
AggregateFunction="Count|Avg|Sum|Min|Max|StdDev|Var"
[optional attributes]/>
<Items FieldName="FieldName"
AggregateFunction="Count|Avg|Sum|Min|Max|StdDev|Var"
[optional attributes]/>
</Series>
</Configruration>
The Configuration element should contain only one XAxis and one Series element. Each Series element may contain one or more Items element.
The Configuration section contains the following:
ELEMENT
Lookup Threshold
Field Name
DESCRIPTION
Allows you to set how web parts behave in relation to the List
View Lookup Threshold in SharePoint Resource Throttling. The options are:
• Default — uses the option you have set in the Configuration
Editor.
• On — searches all fields in lists, except Lookup fields.
• Off — searches all fields in lists, including Lookup fields.
• Explicit — searches only the fields explicitly defined in the web parts properties.
Specifies the name of the field that corresponds to the x axis data. This attribute is mandatory. The field name is case sensitive.
63
Quick Apps for SharePoint
ELEMENT
Sort Field Name
Sort Field Order
Case-sensitive Calculations
DESCRIPTION
Defines the field name where the values in the x axis is sorted. If you do not specify this attribute, the order of values in the x axis is dependent upon the order of the data in the list. The value of this property does not have to be the same as the value in the
Field Name attribute.
Specifies how the values in the column specified by the Sort Field
Name should be sorted. The options are ASC or DESC.
Allows you to perform case-sensitive calculations (sum, count, avg) on lists. The calculations are performed as case insensitive if this property is not selected.
If you want to add a data series, configure the following:
ELEMENT
Field Name (for Data Series)
Aggregate Function
Series Name
Chart Series Type
Filter Expression
Filter Field Name
Drill Down Chart URL
Show Values
Include in Legend
DESCRIPTION
Specifies the field whose values are aggregated and plotted against the values in the X Axis.
Note:
Only Number or Currency field can be used in the
FieldName. The field name is case sensitive.
Specifies the aggregation function to be performed on the field specified in the FieldName attribute. The following aggregation functions are supported: Count, Avg, Sum, StdDev, Var, Min, or
Max.
Allows the series name to be displayed in the legend as the title in case of multiple data series.
Defines the chart type for this series when you use one of the combination chart in the Chart Type property. The choices are:
COLUMN, AREA or LINE. This attribute is ignored for any non-combination chart type.
Defines the filter that is applied for the data in this series. The
filter is defined using the Complex Filter. See “ Complex Filter
Help” on page 475 for more information.
Determines the field name whose data is used to generate a dynamic data series. The chart view will analyze the data in this field and generate the filter expression for each data series automatically, one per unique value in the field. This attribute is useful if the data that you should use as the filter expression for the data series is dynamic.
Determines the URL of the page that contains the drill down chart for this data series.
Allows you to determine whether to show the values for this dataset. This attributes is only applicable for a multi-series chart.
Allows you to determine whether to include the series name of this dataset in the legend. This attributes is only applicable for a multi series chart.
64
qChartView
ELEMENT
Parent Y Axis
DESCRIPTION
Allows you to set the parent axis of the dataset - P (primary) or S
(secondary). Primary datasets are drawn as on the left y-axis and secondary on the right y-axis. In 3D Column (or stacked Column)
+ Line Combination Charts, the columns draw against primary y-axis and the lines against secondary y-axis. In 2D dual Y combination charts, you can choose what dataset to render against which y-axis. This attribute is only applicable for a chart with a dual y axis.
Examples of Configuration Property
The following is an example of the Configuration property if you want to display data from your Sales list. Your Sales list contains the sales amount for every month in the year. There are 3 fields in the list: Year, Month, and Amount. For example, say you want to display the month in the X axis. You also wants to create the data series dynamically based on the year field. Here is the XML:
<Configuration>
<Series>
<Items FieldName="Amount" AggregateFunction="Sum"
ChartSeriesType="COLUMN" FilterFieldName="Year" />
</Series>
<XAxis FieldName="Month" SortFieldName="Month" />
</Configuration>
65
Quick Apps for SharePoint
The following shows the resulting chart:
Searched Fields
This property defines what fields are displayed in the Search Filter panel. This property is an XML string in the following format:
<Fields>
<Field Name="fieldName" [optional attributes]/>
<!-- To search a cross site lookup field, use one of the following two formats -->
<Field Name="fieldName" DisplayFieldName="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName"
ListName="listName"/>
</Field>
<Field Name="fieldName" DisplayFormat="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName"
ListName="listName"/>
</Field>
</Fields>
66
qChartView
You can further edit fields using the following elements:
ELEMENT
Field Name
Title
Description
Default Value
Default Operator
Fixed Operator
Use People Editor
Column Count
Enable Multi Choice
Sort Field
Sort Order
AutoPostBack
Parent Field
DESCRIPTION
Indicates the element you are editing.
Displays title for the field. The value can be a plain string or an encoded HTML string.
Describes the field. This is useful if you want to give a short instruction or explanation about the field.
Defines the default value for the field.
You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of February 14, 2002 is
2002-02-14T00:00:00Z.
Defines the default operator for the field.
Defines the operator for the field. If specified, the list to select the operator for this field is turned off.
Enables you to enter any user information that is in your directory service.
If you set this to True and the field to be searched is a People and
Group field, the Filter panel will show the People Editor control for entering the search criteria.
Defines the number of columns for the options in a multi-choice field or in a choice-and-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form.
If selected, allows you to select multiple options for the choice-and-lookup field. Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types.
To search a cross-site lookup field, you must specify one or more
List elements inside the Field element. The cross-site lookup field is displayed as two drop downs.
Defines the field that is used to sort the value in the list. The field name is case sensitive.
Allows you to sort the values in ascending or descending order.
When selected, causes the Filter panel to refresh when the user changes the selection in a lookup field or cross-site lookup field.
You need to set AutoPostBack to true if this field is a lookup or a cross-site lookup field and it is being used to filter another lookup or cross-site lookup field in the Filter panel.
Defines another lookup or cross-site lookup field that is used to filter this field. The parent field must be listed before this field in the XML property.
67
Quick Apps for SharePoint
ELEMENT
Parent Filter Field Name
Filter Field Name
Display Field Name
Display Format
Site URL
List Name
Site Name
DESCRIPTION
Defines the field in the parent field that is used to filter this field. It is the primary key in the list that is used in the lookup or cross-site lookup field.
Defines the field in the list that is used by this lookup or cross-site lookup field that is filtered by the parent filter field.
Shows the name of the field whose value is displayed in the list.
The field name is case sensitive. Use this attribute instead of the
Display Format attribute if you only want to display a single field in the list.
Indicates the format of the value that is displayed in the list. Define this attribute instead of the Display Field Name attribute if you want to display multiple fields in the drop-down menu. You can use the field replacement expression <%Field%> to refer to a field.
Note:
You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Searched Fields editor in the List View Editor, where the
Editor will encode the characters automatically for you.
Indicates the Site URL of the field. You can use an absolute or relative URL.
Indicates the name of the List. The field name is case sensitive.
Indicates the name of the site specified in the Site URL. This is used in case you have multiple lists. In this case, the first drop-down menu to select the list will display as "List Name in Site
Name". You can use any name for the Site Name. It does not have to match the real title of the Site.
Chart Appearance Tab
The Chart Appearance Tab allows you to define characteristics of your charts.
Chart Appearance contains the following elements
ELEMENT
Chart Width
Chart Height
Chart Attributes
Trend Lines
Style
Series Appearance
DESCRIPTION
Allows you to specify the width of the chart in pixels.
Allows you to specify the height of the chart in pixels.
For more information, see “ Chart Attributes” on page 69
.
For more information, see “ Trend Lines” on page 94
.
For more information, see “ Styles” on page 95
.
For more information, see “ Series Appearance” on page 103 .
68
qChartView
Chart Attributes
Title and Axis Name
The Chart View allows you to add a caption, sub-caption, x-axis title, and y-axis title for your charts. You can configure the font properties for each of them individually or collectively. You can also apply styles and animation effects to them.
ELEMENT
Caption
Sub-caption
X-Axis Name
Y-Axis Name
Rotate Y Axis Name
Y Axis Name Width
DESCRIPTION
Allows you to add a title.
Allows you to add a subtitle to your chart.
Allows you to set the x-axis name.
Allows you to seta y-axis name.
Allows you to set rotate the name of the y-axis. The y-axis name is rotated by default on the chart. If you're using UTF-8 characters, those characters would not appear in rotated mode, as the qChartView uses embedded characters for rotation. In that case, you can opt to show y-axis name in horizontal form by setting this attribute to false.
Allows you to set the maximum width that the non-rotated y-axis title can assume.
Border and Background
Background refers to the entire background of the chart.
You can also have a border around the chart. By default, the border is on in 2D charts and off in 3D Charts.
69
Quick Apps for SharePoint
Shown below is a chart with a border around the chart.
ELEMENT
Show Border
Border Color
Border Thickness
Border Alpha
Background Color
Background Alpha
Background Ratio
Background Angle
Background Image or SWF
URL
Background Image or SWF
Alpha
DESCRIPTION
Allows you to show a border around the chart. By default, it is set to true in 2D charts and false in 3D charts.
Allows you to set the border color of the chart. Use hex color code.
To use the color picker, click on the color swatch square.
Allows you to set the border thickness of the chart (in pixels).
Allows you to set the border alpha (transparency) of the chart. The range is from 0-100.
Allows you to fill the background as gradient. If you need to define two (or more) colors, separate them by a comma.
Allows you to specify a respective alpha (transparency) for each color code that you've specified in the Background Color attribute,
Separate the alphas by comma. The range is from 0-100
Allows you to set the ratio of each color in the gradient on a scale of
100. The total ratios specified as this attribute should sum up to
100. For example, if you want to plot a equidistant gradient for 2 colors, specify Background Ratio as "0,100".
Allows you to set the angle of the gradient fill.
Allows you to specify an external image (GIF,JPEG, or PNG only) or a
SWF file as the background of the chart. Specify the URL (with relative path) of the background image or SWF File. Make sure that the image and the chart SWF file are in the same sub-domain.
If you specify an absolute URL, the background image will not be shown.
Allows you to configure the alpha of the background (loaded) image using this property.
70
Chart Canvas
Canvas refers to the area in which the chart is plotted.
qChartView
ELEMENT
Canvas Border Color
Canvas Border Thickness
Canvas Border Alpha
Canvas Background Color
Canvas Background Alpha
Canvas Background Ratio
Canvas Background Angle
Show Canvas Background
Show Canvas Base
Canvas Background Depth
Canvas Base Depth
DESCRIPTION
Allows you set the border color for the Canvas. Use hex color code. To use the color picker, click on the color swatch square.
Allows you set thickness of canvas border (in pixels)
Allows you set alpha for canvas border.
Allows you set the background color for the Canvas. Use hex color code. To use a gradient fill, specify all the colors of the gradient separated by commas.
Allows you to specify a respective alpha (transparency) for each color code that you've specified in Canvas Background Color attribute. Separate the alphas by comma.
Allows you to set the ratio of each color in the gradient on a scale of 100. The total ratios specified as this attribute should sum up to 100. For example, if you want to plot a equidistant gradient for 2 colors, specify canvasbgRatio as "0,100".
Allows you to set the angle of the gradient fill (in degrees -
0-360).
Allows you to set the canvas background for a 3D chart (and canvas).
Allows you to set the canvas base for a 3D chart (and canvas).
Allows you to set the depth of canvas background for a 3D chart
(and canvas).
Allows you to set the height of canvas base (in pixels) for a 3D chart (and canvas).
71
Quick Apps for SharePoint
Data Plot
Plot refers to the column, lines in a column, line chart respectively.
For all the charts, you can specify custom color for each data plot using the color attribute of <set /> element. The color must be in hex code format (RRGGBB) without #.
<chart ....>
<set label='Jan' value='420000' color='FF0000'/>
<set label='Feb' value='910000' color='00FF00'/>
<set label='Mar' value='720000' color='0000FF'/>
....
</chart>
By default, most charts have FFFFFF as the plot gradient color. If you wish to use solid fills for the column (or area), use the Plot Gradient Color attribute without any color defined for it, that is, plotGradientColor=''
<chart plotGradientColor='' ....>
<set label='Jan' value='420000' color='FF0000'/>
<set label='Feb' value='910000' color='00FF00'/>
<set label='Mar' value='720000' color='0000FF'/>
....
72
qChartView
</chart>
ELEMENT
Plot Gradient Color
Plot Fill Angle
Plot Fill Ratio
Plot Fill Alpha
Show Plot Border
Plot Border Dashed
Plot Border Dash Length
Plot Border Dash Gap
Use Round Edges
DESCRIPTION
Allows you to globally add a gradient color to the entire plot (column, area) of chart by specifying a color as its attribute.
Allows you set the fill angle for gradient if you've opted to fill the plot
(column, area) as gradient. The range is from 0 - 360.
Allows you set the ration for gradient if you've opted to fill the plot
(column, area) as gradient. The range is from 0 - 100.
Allows you set the fill alpha for gradient if you've opted to fill the plot
(column, area) as gradient.
Allows you to show or hide the plot border. By default, each data plot
(column, area, pie) shows a border.
Allows you to make the plot border dashed by setting this attribute to true.
Allows you to set the length of each dash.
Allows you to set the gap between each dash.
Allows you to plot columns/bars with rounded edges and glass effect gradients in charts that support 2D Columns or Bars (like column charts, bar charts, 2D combination charts).
Note:
In this mode, the following features do not work:
• When you plot the columns with rounded edges, shadow is applied to them by default and show Shadow attribute no longer works. If you want to remove shadow from this mode, override the shadow with a new shadow style (applied to DATAPLOT) with alpha as 0.
• Plot fill properties like gradient color, angle. no longer work as the colors for gradient are now calculated by the chart itself.
• Plot border properties no longer work in this mode. Also, you cannot render the border as dash in this mode.
73
Quick Apps for SharePoint
Data Labels
Data labels refer to the names for the data points that appear on the x-axis.
In the chart shown above, the dates are the data labels for the chart. By default, they get wrapped when there is not enough space on the chart.
ELEMENT
Show Labels
Label Display
Slant Labels
Stagger Lines
Label Step
DESCRIPTION
Allows you to show the data labels.
Allows you to display the data labels can be displayed on the charts in the following ways:
• Wrap — By default, all the labels are shown in wrap mode, which enables you to wrap your long x-axis labels in multiple lines.
• Rotate — allows you to rotate or slant the x-axis labels.
• Stagger — distributes labels into multiple lines (by default 2).
Note:
Rotate mode does not work if you have non-English characters in your x-axis labels as the charts use embedded fonts to render rotated labels.
Allows you to slant the labels at 45 degrees if you are using the Rotate mode for the Label Display.
Allows you to choose the number of lines to stagger the labels if you are using the Stagger mode for the Label Display.
Allows you to show every n-th label instead of all labels if your X Axis labels represent a continuous quantity like time and date.
74
qChartView
Data Values
Data values refer to the plot values such as line, column, and bar displayed beside it.
In the chart shown above, the dollar values appearing above the column are the data values.
ELEMENT
Show Values
Rotate Values
Place Values
Inside
DESCRIPTION
Allows you to show data values. By default, the data values are shown. To hide them, set this attribute to false.
Allows you to rotate the values. By default, the chart will show the data values horizontally.
Allows you to place the data values inside the columns.
75
Quick Apps for SharePoint
External Logo
You can load external logos at run-time to be displayed over the chart. The logos can be GIF/JPEG/PNG or SWF files that reside on the same sub-domain as the chart SWF.
ELEMENT
Logo URL
Logo Position
Logo Alpha
Logo Scale
Logo Link
DESCRIPTION
Allows you to specify the URL of the logo. You may use relative or absolute
URL as long as the image and the chart SWF file are in the same sub-domain.
Allows you to set the position of the logo can be configured using this attribute.
Allows you to set the opacity of the logo once it has loaded.
Allows you to set the scale of the logo, once it has loaded. The scale of 100 will display the logo in its original size. The scale of less than 100 will shrink the logo. The scale of more than 100 will enlarge the logo.
Allows you to link the logo to an external URL. This link can open in same window, new window, pop-up windows or frames. For information on how to
format the link, see “ Trend Lines” on page 94
.
76
qChartView
Font Properties
You can specify generic font properties for all the text on the chart using the attributes given below.
ELEMENT
Base Font Name
Base Font Size
Base Font Color
Outside Canvas Base
Font Name
Outside Canvas Base
Font Size
Outside Canvas Base
Font Color
DESCRIPTION
Allows you set the font face (family) of all the text (data labels, values) on chart. If you specify Outside Canvas Base Font Name attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
Allows you to set the base font size of the chart, that is, all the values and the names in the chart that lie on the canvas are displayed using the font size provided here. The range is from 0 - 72.
Allows you to set the base font color of the chart, that is, all the values and the names in the chart that lie on the canvas are displayed using the font color provided here. Use hex color code. To use the color picker, click on the color swatch square.
Allows you classify all the text in the chart into 2: the text inside the canvas which consists of only the tool tip and the data values and all the text outside the canvas. You can define a base font group for all the text outside the canvas as well.
This attribute sets the base font family of the chart font which lies outside the canvas, that is, all the values and the names in the chart that lie outside the canvas are displayed using the font name provided here.
Allows you to set the base font size of the chart, that is, all the values and the names in the chart that lie outside the canvas are displayed using the font size provided here. The range is from 0 - 72
Allows you to set the base font color of the chart, that is, all the values and the names in the chart that lie outside the canvas are displayed using the font color provided here.
Chart Palettes
qChartView offers 5 palettes. The palette theme configures colors of the following:
• Background and border
• Canvas border and background
• Fonts
• 4Div lines
• Tooltip
• Anchors
• Legend
77
Quick Apps for SharePoint
The internal palette does not cover the color of the data items. To change the color of the data items, use the Palette Colors attribute or Series Appearance property.
ELEMENT
Palette
Palette Colors
DESCRIPTION
Allows you to select the palette number.
Allows you to specify your own palette for data items by providing a list of hex colors.
Y Axis
Chart limits are the minimum and maximum y-axis values. qChartView automatically calculates the best chart limits when you do not specify them explicitly.
ELEMENT
Y Axis Min Value
Y Axis Max Value
Set Adaptive Y Min
Primary Y Axis Min Value
Primary Y Axis Max Value
Secondary Y Axis Min
Value
Secondary Y Axis Max
Value
Primary Y Axis Name
Secondary Y Axis Name
Set Adaptive Secondary Y
Min
DESCRIPTION
Allows you to set the chart limits explicitly.
Allows you to set the chart limits explicitly.
Note:
The Y Axis Max Value must be bigger than any of the values in the data series. Otherwise, the value will not be honored by the chart view.
Allows you to set whether the y-axis lower limit would be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
Allows you to explicitly set the lower limit of the primary y-axis. If you do not specify this value, it is automatically calculated by qChartView based on the data provided by you.
Allows you to explicitly set the upper limit of the primary y-axis. If you do not specify this value, it is automatically calculated by qChartView based on the data provided by you.
Allows you to explicitly set the lower limit of the secondary y-axis. If you do not specify this value, it is automatically calculated by qChartView based on the data provided by you.
Allows you to explicitly set the upper limit of the secondary y-axis. If you do not specify this value, it is automatically calculated by qChartView based on the data provided by you.
Allows you to set the primary y-axis title.
Allows you to set the secondary y-axis title.
Allows you to set whether the secondary y-axis lower limit would be
0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
78
qChartView
ELEMENT
Primary Y Axis Name
Width
Secondary Y Axis Name
Width
DESCRIPTION
Allows you to set choose a maximum width (in pixels) that is applied to primary y-axis name, if you do not rotate y-axis name.
If you opt to not rotate y-axis name, you can choose a maximum width (in pixels) that is applied to secondary y-axis name.
Division Lines
Divisional lines are horizontal lines running through the canvas. They break up the y axis into smaller units helping in better visual data interpretation.
ELEMENT
Adjust Division Lines
Number of Division Lines
Div Line Effect
Show Y Axis Values
Y Axis Values Step
Division Lines
DESCRIPTION
Allows you to explicitly specify the y-axis upper and lower limit values, and also the number of divisional lines. In those cases, you need to automatic adjustment of divisional lines by setting this attribute to false. Then you can specify the y-axis upper and lower limits using the Y Axis Max Value and Y Axis Min Value attributes respectively.
Allows you to set the number of divisional lines.
Allows you to enable to apply an effect, for example, EMBOSS, or
BEVEL to the divisional lines. This attribute is applicable to
MultiSeriesCombination3D chart type only.
Allows you to show all the y-axis values.
Allows you to skip every nth Y Axis value.
Allows you to set the color for divisional lines.
79
Quick Apps for SharePoint
ELEMENT
Division Lines Thickness
Division Lines Alpha
Is Dashed
Division Lines Dash Length
Division Lines Dash Gap
Show Alternate H Grid Color
Alternate H Grid Color
Alternate H Grid Alpha
Vertical Div Lines
Number of Vertical Div Lines
Vertical Div Lines Color
Vertical Div Lines Thickness
Vertical Div Lines Alpha
Is Dashed
Vertical Div Lines Dash
Length
Vertical Div Lines Dash Gap
Show Alternate V Grid Color
Alternate V Grid Color
Alternate V Grid Alpha
Show V Line Label Border
DESCRIPTION
Allows you to set the thickness of divisional lines. The range is from 1 - 5.
Allows you to set the alpha of divisional lines. The range is from 0
- 100.
Allows you to set the divisional line to be dashed.
Allows you to set the length of each dash.
Allows you to set the gap between each dash.
Allows you to set the horizontal grid bands alternately between the divisional lines for all 2D charts. They can be hidden by setting this attribute to false.
Allows you to set the color of the horizontal grid bands.
Allows you to set the alpha of the horizontal grid bands. The range is from 0 - 100.
Allows you to set the vertical divisional lines running through the canvas in a line/area chart. They help in relating the data to its respective label, when there is a large amount of data.
Allows you to set the number of vertical div lines.
Allows you to set the color of the vertical axis division lines.
Allows you to set the thickness of the vertical axis division lines in pixels.
Allows you to set the alpha of vertical axis division lines. The range is from 0 - 100.
Allows you to set the vertical axis division lines as dashed.
Allows you to set the length of each dash.
Allows you to set the gap between each dash..
Allows you to set the vertical grid bands alternately between the vertical divisional lines.
Allows you to set the color of the alternate vertical grid bands.
Allows you to set the alpha (transparency) of the alternate vertical grid bands.
Allows you to set the borders for all labels for vLines in the chart.
If you want to show label border for just a particular vLine, you can override this value by specifying border configuration for that specific vLine.
80
qChartView
Zero Plane
Zero plane is a plane which separates the positive and negative numbers on a chart having both of them.
ELEMENT
Show Zero Plane
Zero Plane Color
Zero Plane Alpha
Zero Plane Thickness
Zero Plane Show Border
Zero Plane Border Color
Zero Plane Mesh
DESCRIPTION
Allows you set the zero plane in the column, line, and the area chart. It can be removed in the line chart but not in the column or the area chart because they use this as their base to draw. It can be removed in the line chart by setting this attribute to false.
Allows you set the color of the zero plane.
Allows you set the alpha (transparency) of the zero plane. The range is from 0 -100.
Allows you set the thickness of the zero plane in pixels.
Allows you set the whether to show border of zero plane for a 3D chart.
Allows you set the border color of zero plane for a 3D chart.
Allows you set the whether to draw the zero plane as a wireframe mesh or as a filled plane. If set to true, a mesh on the zero plane of the chart is drawn. This attribute is applicable to
MultiSeriesCombination3D chart type only.
81
Quick Apps for SharePoint
Anchors
Each data point in a line or area chart is represented by an anchor. The anchors help identify the data point better in the chart. They also show a tool tip showing the data point details when the mouse is hovered over them, and can be linked to other pages as well.
ELEMENT
Draw Anchors
Anchor Alpha
Anchor Sides
Anchor Radius
Anchor Border Color
Anchor Border
Thickness
Anchor Background
Color
Anchor Background
Alpha
DESCRIPTION
Allows you show the anchors. The anchors are displayed by default. To hide them, set this attribute to false. Once the anchors are hidden, the tool tips for the data points will not be displayed and the links will not work.
Allows you set the alpha of entire anchors. The range is from 0 - 100. If you need to hide the anchors but still have tool tip and link, set Anchor
Alpha to ‘0’
Allows you to set the number of sides the anchor will have. For example, an anchor with 3 sides would represent a triangle, with 4 it would be a square. The range is from 3 - 20.
Allows you to set the radius (in pixels) of the anchor. The greater the radius, the bigger the anchor size.
Allows you to set the border color of anchors.
Allows you to set the border thickness (in pixels) of the anchors.
Allows you to set the background color of anchors.
Allows you to set the alpha of anchor background. The range is from 0 -
100.
82
qChartView
Tool Tip
A tool tip is shown when the mouse is hovered over a particular data point. It shows the following information:
• Single series chart (except pie & doughnut): Name & value
• Pie & Doughnut: Name & value/percentage
• Multi-series & combination chart: Series Name, Category Name, Data
Value
ELEMENT
Show Tool Tip
Show Tool Tip Shadow
Tool Tip Border Color
Tool Tip Background Color
Tool Tip Separator Character
Series Name in Tool Tip
Show Percent In Tool Tip
DESCRIPTION
Allows you to set the tool tip.
Allows you to show the tool tip shadow.
Allows you to customize the border color of the tool tip.
Allows you to customize the background color of the tool tip.
Allows you to specify a character to separate the name and value displayed in tool tip.
Allows you to control whether series name will appear in the tool tip. For multi-series and combination charts, qChartView shows the following information in tool tip (unless tool text is explicitly defined): "Series Name, Category Name, Data
Value".
Allows you to show percentage values in Tool Tip for Pie or
Doughnut chart. By default, the Pie or Doughnut chart shows percentage values in Tool Tip.
83
Quick Apps for SharePoint
Paddings and Margins
qChartView lets you define various paddings and margins using pixels. These attributes are listed one-by-one below.
By default, qChartView provides some padding between the chart border and the canvas. This is called the chart margin and each margin can be set individually.
ELEMENT
Left Margin
Right Margin
Top Margin
Bottom Margin
Canvas Left Margin
Canvas Right Margin
Canvas Top Margin
Canvas Bottom Margin
DESCRIPTION
Allows you to set the amount of empty space on the left side of your chart. Nothing is rendered in this space.
Allows you to set the amount of empty space on the right side of your chart. Nothing is rendered in this space.
Allows you to set the amount of empty space ton the top of your chart.
Nothing is rendered in this space.
Allows you to set the amount of empty space on the bottom of your chart. Nothing is rendered in this space.
Allows you to set the amount of empty space on the left side of the canvas. Nothing is rendered in this space.
Allows you to set the amount of empty space on the right side of the canvas. Nothing is rendered in this space.
Allows you to set the amount of empty space t on the top of the canvas.
Nothing is rendered in this space.
Allows you to set the amount of empty space on the bottom of the canvas. Nothing is rendered in this space.
84
qChartView
ELEMENT
Caption Padding
X Label Gap
Y Label Gap
X Axis Name Padding
Y Axis Name Padding
Y Axis Values Padding
Label Padding
Value Padding
Canvas Padding
Plot Space Percent
DESCRIPTION
Allows you to set the amount of space between the caption of the chart and the top of the chart canvas. If you have a sub-caption defined in the chart, it controls the space between the sub-caption and the top of the chart canvas.
Allows you to set the vertical space between the labels and canvas wall edge. If you want more space between the canvas and the x-axis labels, you can use this attribute to control it.
Allows you set the horizontal space between the canvas wall edge and the y-axis values or trend line values (on left/right side). This is particularly useful, when you want more space between your canvas and y-axis values.
Allows you to set the distance between the top of x-axis title and the bottom of data labels (or canvas, if data labels are not shown).
Allows you to set the padding between the y-axis name and values.
Allows you to set the padding between the left end of the chart canvas and the y-axis values.
Allows you to set the vertical space between the canvas bottom edge and the data labels.
Allows you to control the space between your columns/anchors and the value textboxes.
For a line/area chart, allows you to set the padding between the canvas border and the position where the line/area chart begins to draw is called canvas padding.
On a column chart, allows you to set the spacing between two columns.
By default, the spacing is set to 20% of canvas width. For example, if you wanted all columns to stick to each other without any space in between, you can set plotSpacePercent to 0. Similarly, if you want very thin columns, you can set plotSpacePercent to its max value of 80.
85
Quick Apps for SharePoint
Smart Labels and Lines
Smart labels are the labels for the pie/doughnut chart. The smart labels prevent overlapping of labels even when large number of labels are placed in close vicinity.
ELEMENT
Enable Smart Labels
Smart Line Color
Smart Line Thickness
Smart Line Alpha
Is Smart Line Slanted
Label Distance
Smart Label Clearance
Skip Overlap Labels
DESCRIPTION
Allows you to enable the smart labels (if required to save chart space or when there are few pie segments). When the smart labels are switched off, the pie labels would be displayed without the smart label lines. But if they number of labels increases and smart labels are not being used, then the labels might overlap.
Allows you to set the color of smart label connector lines.
Allows you to set the thickness (in pixels) of smart label connector lines.
Allows you to set the alpha (transparency) of smart label connector lines. The range is 0 - 100.
Allows you to set the smart lines (smart label connector lines) in two ways: Slanted or Straight.
Allows you to set the distance of the label/value text boxes from the pie/doughnut edge in pixels. You must set Enable Smart Labels to false for this attribute to take effect.
Allows you to set the clearance distance of a label (for sliced-in pies) from adjacent sliced out pies in pixels.
Allows you to skip the overlapping labels if you have too many labels in your pie chart (which is difficult to adjust even using smart labels).
In that case, you have the option to set this attribute to true. The labels of the least significant pies would be removed.
86
qChartView
ELEMENT
Show Percent Values
DESCRIPTION
Allows you to set the actual value of the pie segment to be displayed in the label or the percentage value. By default, the actual values are displayed. When you want to display their percentages, set this attribute to true.
Legend
In multi-series / combination charts, the series name of each dataset shows up in the legend of the chart. This helps you relate a data plot to its series name using its color. The legend does not appear for single-series charts because there is only one series in the chart.
Notice the legend below the chart helps identify the series name.
ELEMENT
Show Legend
Interactive Legend
Legend Caption
Legend Marker Circle
Reverse Legend
Legend Position
DESCRIPTION
Allows you to show the legend.
Allows you to make the legend interactive. Interactive Legend only works for a combination chart. In the combination chart, you can click the legend to show/hide the values of the data items. If you set
Interactive Legend to false, then legend will not be interactive.
Allows you to add a caption for the entire legend by setting the same here.
Allows you to use square legend keys or circular ones.
Allows you to reverse the order of items in legend.
Allows you to place the legend in 2 positions: RIGHT and BOTTOM. It gets placed below the canvas by default. To place it to the right of the chart canvas, set Legend Position = 'RIGHT'.
87
Quick Apps for SharePoint
ELEMENT
Allow Drag
Legend Background Color
Legend Background Alpha
Legend Border Color
Legend Border Thickness
Legend Border Alpha
Legend Shadow
Legend Scroll Background
Color
Legend Scroll Bar Color
Legend Scroll Button
Color
DESCRIPTION
Allows you to make the legend dragable. End viewers of the chart can drag the legend around on the chart.
Allows you to set the background color for the legend.
Allows you to set the background alpha (transparency) for the legend. The range is 0 - 100.
Allows you to set the border color for the legend.
Allows you to set the border thickness, in pixels, for the legend.
Allows you to set the border alpha for the legend. The range is 0 -
100.
Allows you to set a shadow for legend.
Allows you to set the background color of the scroll bar. If you've too many items on the legend, a scroll bar appears.
Allows you to set the bar color of the scroll bar. If you've too many items on the legend, a scroll bar shows up on the same.
Allows you to set the color of buttons on the scroll bar. If you've too many items on the legend, a scroll bar shows up on the same.If you've too many items on the legend, a scroll bar shows up on the same.
Number Formatting
qChartView offers you a lot of options to format your numbers on the chart from number prefixes and suffixes to controlling the decimal places to scaling your numbers based on a pre-defined scale.
ELEMENT
Format Number
Format Number Scale
Default Number Scale
Number Scale Unit
Number Scale Value
DESCRIPTION
Allows you to determine whether the numbers displayed on the chart are formatted using commas, for example, 40,000 if Format Number is true and 40000 if Format Number is false.
Allows you to determine whether to add K (thousands) and M
(millions) to a number after truncating and rounding it - for example, if Format Number Scale is set true, 1043 would become 1.04K (with decimals set to 2 places). Same with numbers in millions - a M will added at the end.
Allows you to set the default unit of the numbers that you are providing to the chart.
Allows you to set the unit of each block of the scale.
Allows you to set the range of the various blocks that constitute the scale.
88
qChartView
ELEMENT
Number Prefix
Number Suffix
Decimal Separator
Thousand Separator
In Decimal Separator
In Thousand Separator
Decimals
Force Decimals
Y Axis Value Decimals
DESCRIPTION
Allows you to add a prefix to all the numbers visible on the graph.
For example, to represent all dollars figure on the chart, you could specify this attribute to ' $' to show like $40000, $50000.
Allows you to add a suffix to all the numbers visible on the graph. For example, to represent all figure quantified as per annum on the chart, you could specify this attribute to ' /a' to show like 40000/a,
50000/a.
Allows you to specify the character to be used as the decimal separator in a number.
Allows you to specify the character to be used as the thousands separator in a number.
Allows you to input the decimal separator.
Allows you to input the thousand separator.
Allows you to set the number of decimal places to which all numbers on the chart would be rounded. The range is from 0 - 10.
Allows you to add 0 padding at the end of decimal numbers. For example, if you set decimals as 2 and a number is 23.4. If force
Decimals is set to 1, qChartView will convert the number to 23.40
(note the extra 0 at the end).
Allows you to specify the div line values decimal precision. The range is from 0 - 10.
3D Chart Attributes
The 3D Combination chart is a true 3D chart which offers features such as viewing from a specific camera angle, definition of light source, use of dynamic lighting, and rotation.
89
Quick Apps for SharePoint
The various elements of a 3D Combination chart are shown below:
ELEMENT
Is 2D
DESCRIPTION
Allows you to decide whether initially to draw a 2D view of the chart.
90
ELEMENT
Chart Order
Chart On Top
Auto Scaling
Allow Scaling
Animate 3D
Exe Time
Camera Angle
X/Camera Angle Y
qChartView
DESCRIPTION
Allows you to set the order by which different types of charts will appear. The value can be any combination of 'column', 'line' or 'area', each separated by a comma. By default, the order is: line, column, area. You can change to any order you like, for example, 'column, area, line' or 'line, area'.
Allows you to decide whether or not the chart canvas is placed over the extra chart elements (caption, subcaption, legend). This feature is visible when the chart canvas is zoomed/scaled. +
Allows you to decide whether or not the chart is allowed to best fit automatically after a user interaction, for example, rotation.
Allows you to set whether to allow zoom-in/zoom-out.
Note:
Scaling or use of mouse is compatible only with Windows
Operating System.
Allows you to show the initial plot animation. By default, the 3D chart is rendered with a default animation.
To globally set off all animation set Animation to false. This would not only set off 3D animations, but also disable all animations applied using
<styles>. The additional use of Animate 3D can override this value.
Hence, a combination of Animation = false and Animate 3D = true would disable all animations applied using <styles> but, enable animation of the 3D canvas.
Allows you to set the time that the chart takes to animate. This attribute also sets the time taken by the chart canvas to animate when the chart is transformed to any view (View3D, View 2D, Reset View).
Allows you to define the camera angle.
• Camera Angle X lets you specify the camera angle (for view around the chart vertically) from which the chart is viewed initially in no animation mode (when animate3D='0) . If not specified, the default value is 30. The range is from 0 to 360 and 0 to -360.
• Camera Angle Y lets you specify the camera angle (for view around the chart horizontally) from which the chart is viewed initially in no animation mode (when animate3D='0). If not specified, the default value is -45. The range is from 0 to 360 and
0 to -360.
Since this is a true 3D chart, it's rendered as a 3D model that is viewed from a specific camera angle. The camera can simply be defined as the eye of a real viewer. When you have set Animate 3D to 0, you can define the camera angle using two attributes - Camera Angle X and
Camera Angle Y.
When you use animation, you can also set up the starting camera view from which the camera view starts animating, and the final camera view to which the chart would finally be rotated. For this, you need to use Start Angle X, Start Angle Y, End Angle X and End Angle Y attributes.
91
Quick Apps for SharePoint
ELEMENT
Start Angle X/End Angle
X
Start Angle Y/End Angle
Y
Light Angle X/Light
Angle Y
Intensity
Dynamic Shading
DESCRIPTION
Start Angle X — Allows you to specify the view angle (for view around the chart vertically) at which rotation of the chart starts (when the chart is initialized). The rotation stops at endAngX. If not specified, the default values for both the attributes are 30. The range is from 0 to
360 and 0 to -360. This is for animated charts (when animate3D='1').
End Angle X — Allows you to specify the view angle (for view around the chart vertically) at which rotation of the chart ends (when the chart is initialized). The rotation starts at startAngX. If not specified, the default values for both the attributes are 30. The range is from 0 to
360 and 0 to -360. This is for animated charts (when animate3D='1').
Start Angle Y — Allows you to specify the view angle (for view around the chart horizontally) from which rotation of the chart starts (when the chart is initialized). The rotation stops at endAngY. If not specified, the default values for both the attributes are -45. The range is from 0 to 360 and 0 to -360. This is for animated charts (when animate3D='1').
End Angle Y — Allows you to specify the view angle (for view around the chart horizontally) at which rotation of the chart ends (when the chart is initialized). The rotation starts at startAngY. If not specified, the default values for both the attributes are -45. The range is from 0 to 360 and 0 to -360. This is for animated charts (when animate3D='1').
Light Angle X — Allows you to specify the angular position of the light source (for X-axis) w.r.t the chart world coordinate system. The range is from 0 to 360 and 0 to -360.
Light Angle Y — Allows you to specify the angular position of the light source (for Y-axis) w.r.t the chart world coordinate system. The range is from 0 to 360 and 0 to -360.
Allows you to control the intensity of the light that falls on the chart elements. The range of this attribute lies between 0 to 10. 10 would provide light with maximum intensity, and you will get the brightest view of the chart. If you set the value to 0, light is provided with least intensity. However, the chart will never appear in full darkness even you set intensity to 0. A faint light is always made available. By default, the value is set to 2.5.
Allows you to set the chart in dynamic shading/non-world mode. If set to false, the chart is in world mode.
For example, you can have a Combination 3D Chart that has two different lighting systems to light up the chart elements. The light source may be fixed outside the chart. This causes only those sides of the chart to get the light which face the light source. Thus, when the chart is manually rotated, dynamic shades are created on the chart surfaces. This system of lighting is called dynamic shading.
World lighting is where the light source is fixed with the chart. In this case, the light source rotates with the rotation of the chart. Hence, the surface facing the light source gets lightened and continues to be in the bright side despite any manual rotation of the chart being made, whereas the surface not facing the light keeps remaining in darkness with every chart rotation.
92
qChartView
ELEMENT
Bright 2D
Allow Rotation
Constrain Vertical
Rotation
Minimum Vertical
Rotation Angle
Maximum Horizontal
Rotation Angle
Z Depth
Z Gap Plot
YZ Wall Depth
ZX Wall Depth
XY Wall Depth
Clustered
DESCRIPTION
Allows you to set maximum brightness to the chart while being rendered in 2D mode. This is applicable only when you've set Dynamic
Shading to true. However, once you set this attribute to true, you cannot use Light Angle X and Light Angle Y attributes. Rather, it automatically sets up the light sources to give the brightest view of the chart in 2D mode.
Allows you to decide whether to stop any user interactive rotation of the chart or not. If it is set to false, the interactive rotation is barred.
Allows you to rotate up to 90 degrees (top or bottom) from 0 degree position. You can also specify these limits using Minimum Vertical
Rotation Angle and Maximum Vertical Rotation Angle attributes. This is only applicable to user's mouse interactively with the chart.
Allows you to set the minimum allowed angle up to which a user can rotate the chart vertically. This is only applicable to user's mouse interactively with the chart.
Allows you to set the maximum allowed angle up to which a user can rotate the chart horizontally. This is only applicable to user's mouse interactively with the chart.
Allows you to set the depth (3D thickness) of each DATAPLOT object using zDepth attribute.
Allows you to specify a gap between all dataplots in a 3D combination chart, as more than one DATAPLOT types can exist due to different datasets.
A Z Gap Plot set to 0 will show no gap between dataplots.
Allows you to set the depth of the YZ wall of 3D chart.
Allows you to set the depth of the ZX wall of 3D chart.
Allows you to set the depth of the XYwall of 3D chart.
Allows you to set a Combination 3D chart in clustered mode. In a
Combination 3D chart, you can plot multiple number of datasets which can be rendered as Column.
Custom About Menu Item
You can change the default "About Quick Apps for SharePoint" context menu item to show your label and link it to your own URL using the below attributes.
ELEMENT
Show About Menu Item
About Menu Item Label
DESCRIPTION
Allows you to set up a custom context menu in the chart, which can show your text and can be linked to your URL. For example, you can set the context menu of the chart to include "About your company name" and then link to your company home page. By default, the chart shows
"About Quick Apps for SharePoint" when right-clicked.
Allows you to set a menu item label for the custom context menu item.
93
Quick Apps for SharePoint
ELEMENT
About Menu Item Link
DESCRIPTION
Allows you to provide a link for the custom context menu item. You can specify the link in qChartView link format to be able to open the same in new window, pop-ups, frames or as JavaScript links.
Functional
These attributes let you control a variety of functional elements on the chart.
ELEMENT DESCRIPTION
Animation
Click URL
Allows you to control animation in your charts. If you do not want to animate any part of the chart, set this to false. This would also disable all animations applied using <styles>. Animate 3D can override this value. By default, animation is set to true.
Allows you to set a URL as a hotspot for a chart. For more information, see
Formatting Links.
Trend Lines
Trend Lines allow you to specify the horizontal/vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value.
Trend Lines contain the following:
ELEMENT
Start Value
End Value
Display Value
Color
Is Trend Zone
Thickness
Alpha
Dashed
Dash Length
Dash Gap
Value on Right
DESCRIPTION
Allows you to set the start value for the trend line
Allows you to set the ending y-axis value for the trend line
Allows you to display a string caption for the trend line by its side
Allows you to set the color of the trend line and its text
Allows you to set the trend as a zone rather than a line
Allows you to set the thickness of the trend line
Allows you to set the alpha transparency of the trend line
Allows you to set the trend line as a dashed line
Allows you to set the length of each dash in pixels
Allows you to set the gap length between each dash
Allows you to show if the trend line is on the right or left side of the chart
94
qChartView
ELEMENT
Tool Text
Parent Y Axis
DESCRIPTION
Allows you to show tool text when hovered over a trend line
Allows to you set whether the trend line should be plotted against a primary or secondary Y axis (If you use a dual Y Axis chart). If you do not use a dual Y axis chart, the trend line is plotted against the primary Y axis.
Styles
Styles help you apply font, effects and animations to various objects of the chart.
Styles lends a simple mechanism using which you can easily control the visual layout of charts.
Styles allows you to:
• Define your own style attributes using the Style Editor.
• Associate them with defined Objects of the chart from within the Style
Editor.
• Have better control over chart look & feel.
• Group together in one element in the XML document, thereby separating data from visual formatting.
• Store the entire style definition in a central location in your application, so that all charts within application can utilize it.
• Re-use style definitions. Each style can be applied to multiple chart objects or vice versa.
Each object on the chart has been assigned a unique name, for direct association with style definitions. For example, the background of the chart is termed as
BACKGROUND. Similarly, the plot (columns, lines, areas) on the chart is named as DATAPLOT. This enables you to associate each style to multiple chart objects or associate multiple chart objects to a particular style.
You can find the list of objects for each chart in individual Chart XML Sheet.
To define styles, use the Style Editor to generate the following XML:
<styles>
<definition>
<style name='MyFirstFontStyle' type='font' face='Verdana' size='12' color='FF0000' bold='1' bgColor='FFFFDD' />
95
Quick Apps for SharePoint
<style name='MyFirstAnimationStyle' type='animation' param='_xScale' start='0' duration='2' />
<style name='MyFirstShadow' type='Shadow' color='CCCCCC' />
</definition>
<application>
<apply toObject='Caption' styles='MyFirstFontStyle,MyFirstShadow' />
<apply toObject='Canvas' styles='MyFirstAnimationStyle' />
<apply toObject='DataPlot' styles='MyFirstShadow' />
</application>
</styles>
As you can see above, all the style related elements and attributes appear under the <styles> parent element. Children to <styles> element are <definition> and
<application> elements. As the name suggests, <definition> element contains your custom styles definition for the chart while under <application> element, you apply your custom defined styles to different chart objects.
You can define one or more styles for a chart from the Styles Editor. To add a style, click Add. To see more attributes for a particular style, click Edit for the style. To delete a style, select the check box of the style and click Delete.
Styles contains the following:
ELEMENT
Name
DESCRIPTION
Allows you to assign your custom name for the style definition. Style name can only include alphabets and numbers. Punctuation marks (including underscore) should not be used. Style name must be unique, that is, two style definitions cannot have the same name.
96
ELEMENT
Type
qChartView
DESCRIPTION
Allows you to set the following types:
• Font — allows you to control text properties for all the text on the chart.
You can set:
-Font — allows you to set the font type
-Size — allows you to set the font size
-Color — allows you to set the font color
-Bold — allows you to set the font weigh
-Underline — allows you to assign underline character
-Background Color — allows you to set the background color
-Border Color — allows you to set the border color
-Is HTML — allows you to render the text as HTML
-Left Margin — allows you to set the left margin of the text
-Letter Spacing — allows you to set the space between the letters in the text
• Animation — Allows you to define your custom animations for different elements of the chart. By default, qChartView animates the data plot
(columns, lines, area) only. However, you can define your custom animations for other chart objects (like captions, titles, values) in the XML.
Each chart object can have multiple animation properties (like x, y, xscale, yscale, alpha) and each sequence can have its own duration.
-Param — Allows you to you specify the property of chart object which you want to animate, such a _x (animate the x position), _y (animate the y position), _xScale (animate the x-scale), _yScale (animate the y-scale), alpha (helps the alpha transition animation effect), _rotation (animate pies and doughnuts in circles)
-Start — allows you to set the start value of the animation
-Duration — allows you to control the duration of animation in seconds
-Easing — allows you to specify the pattern of animation easing.
97
Quick Apps for SharePoint
ELEMENT
Type
DESCRIPTION
• Shadow — Allows you to apply shadow effect to any object on the chart.
-Distance — allows you to set the offset distance of the shadow
-Angle — allows you to set the angle of the shadow
-Color — allows you to set the color of the shadow
-Alpha — allows you to set the alpha transparency of the shadow
-BlurX — allows you set the amount of horizontal blur on the shadow.
Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur on the shadow.
Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Strength — allows you to set the strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background.
-Quality — allows you to set the number of times to apply the shadow effect. Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality. Shadow with lower values are rendered quicker
• Glow — lets you apply glow effects to objects on the chart.
-Color — allows you to set the color of the glow
-Alpha — allows you to set the alpha transparency of the glow
-BlurX — allows you set the amount of horizontal blur on the glow. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur on the glow. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Strength — allows you to set the strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background.
-Quality — allows you to set the number of times to apply the glow effect.
Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality.
Shadow with lower values are rendered quicker.
98
ELEMENT
qChartView
DESCRIPTION
• Bevel — Allows you to apply bevel effect for any of the chart objects.
-Angle — allows you to set the angle of the bevel
-Distance — allows you to set the offset distance of the bevel
-Shadow Color — allows you to set the shadow color of the bevel
-Shadow Alpha — allows you to set the alpha transparency value of the shadow color
-Highlight Color — allows you to set the highlight color of the bevel
-Highlight Alpha — allows you to set the alpha transparency value of the highlight color
-BlurX — allows you set the amount of horizontal blur on the bevel. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur on the bevel. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Strength — allows you to set the strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background.
-Quality — allows you to set the number of times to apply the bevel. Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality.
Shadow with lower values are rendered quicker.
• Blur — Allows you to create a blur effect for any object on the chart.
-BlurX — allows you set the amount of horizontal blur. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Quality — allows you to set the number of times to apply the filter. Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality.
Shadow with lower values are rendered quicker.
99
Quick Apps for SharePoint
Applying custom defined styles to chart objects
To apply your defined styles to chart objects, make sure that you have the list of chart objects present in each chart.
For example, the following chart objects are for 2D Single Series Column Chart:
OBJECT
NAME
DESCRIPTION
BACKGROUND BACKGROUND refers to the entire background of the chart.
CANVAS
CAPTION
DATALABELS
DATAPLOT
DATAVALUES
In 2D Charts, CANVAS refers to the area in which the actual chart is plotted. It is represented by a bounded rectangle. In 3D charts, it refers to the 3D base on which the columns are built.
CAPTION refers to the heading of the chart.
DATALABELS refer to the x-axis labels of the data.
DATAPLOT refers to the actual plot of the chart. For example, in Column 2D chart, columns are referred to as DATAPLOT. In
Pie chart, it's the pies.
DATAVALUES refer to the plot values that is, value of each data (line, column, bar, pie), which is displayed beside the data plot.
FEATURES
SUPPORTED
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
100
ANIMATION
PARAMETERS
SUPPORTED
• _alpha
• _x
• _y
• _xScale
• _yScale
• _alpha
• _x
• _y
• _xScale
• _yScale
• _alpha
• _x
• _y
• _alpha
• _x
• _y
• _alpha
• _x
• _y
• _xScale
• _yScale
• _alpha
• _x
• _y
qChartView
DIVLINES
HGRID
SUBCAPTION
TOOLTIP
TRENDLINES
TRENDVALUES
VLINES
XAXISNAME
DIVLINES are horizontal or vertical lines running through the canvas. Each divisional line signifies a smaller unit of the entire axis thus aiding the users in interpreting the chart.
HGRID refers to alternate color bands between two successive horizontal divisional lines.
SUBCAPTION refers to the sub-heading of the chart.
TOOLTIP refers to the tool tip shown when mouse is hovered over the data plots.
TRENDLINES refer to horizontal/vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value.
TRENDVALUES refer to the display values of trend-lines (if any).
VLINES are vertical separator lines that help you separate blocks of data. These lines run through the height of the chart, thereby segregating data into different blocks. In case of bar charts, they are horizontal and run through the width of chart.
XAXISNAME refers to the x-axis title of the chart.
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• Font (only
Font, Size and
Color attributes are supported)
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Shadow
• Glow
• Bevel
• Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• _alpha
• _y
• _yScale
• _alpha
• _y
• _xScale
• _yScale
• _alpha
• _x
• _y
• _alpha
• _y
• _xScale
• _yScale
• _alpha
• _x
• _y
• _alpha
• _y
• _xScale
• _yScale
• _alpha
• _x
• _y
101
Quick Apps for SharePoint
YAXISNAME
YAXISVALUES
YAXISNAME refers to the y-axis title of the chart.
YAXISVALUES refers to the limit values or divisional line values, which are displayed along the y-axis of the chart.
• • Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• • Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• _alpha
• _x
• _y
• _alpha
• _x
• _y
• _rotation
The following XML does the work of applying styles to different chart objects:
<application>
<apply toObject='Caption' styles='MyFirstFontStyle,MyFirstShadow' />
<apply toObject='Canvas' styles='MyFirstAnimationStyle' />
<apply toObject='DataPlot' styles='MyFirstShadow' />
</application>
Each <apply> element helps to apply multiple styles to one chart object; for example, in our code, we first apply the MyFirstFontStyle font style to Caption of the chart and then apply the shadow style MyFirstShadow to the same object.
If you are using multiple styles, ensure:
• you separate the style names using comma for example, <apply toObject='Caption' styles='MyFirstFontStyle,MyFirstShadow' />
• when you apply a single style to multiple objects, define <apply> element for each object and then assign the style for it. for example,
<apply toObject='Caption' styles='MyFirstShadow' />
<apply toObject='DataPlot' styles='MyFirstShadow' />
You CANNOT separate the object list by comma and then assign a single style to it - the following is INVALID:
<apply toObject='Caption,DataPlot' styles='MyFirstShadow' />
102
qChartView
• The style name specified during application has been defined earlier in style definition and the spelling are correct, else, qChartView will ignore it and log the error in Debug Window.
Series Appearance
This property enables you to specify the appearance of the data series and data items in the series.
This property is an XML string in the following format:
<Appearance>
<SeriesAppearance [optional attributes]>
<ItemAppearance [optional attributes] />
<ItemAppearance [optional attributes] />
</SeriesAppearances>
<SeriesAppearance [optional attributes]>
<ItemAppearance [optional attributes] />
<ItemAppearance [optional attributes]/>
</SeriesAppearances>
</Appearance>
The Appearance element can contain one or more Series Appearance elements.
Each Series Appearance element controls the appearance of the data series in the chart. Therefore, the first Series Appearance element controls the appearance of the first data series, the second one contains the second data series, and so on. See the Configuration property on how to define multiple data series in the chart.
103
Quick Apps for SharePoint
The Series Appearance contains the following:
ELEMENT
Color
Alpha
Ratio
Dashed
Show Plot Border
Plot Border Color
Plot Border
Thickness
Plot Border Alpha
Line Thickness
Line Dash Length
Line Dash Gap
Draw Anchors
Anchor Sides
Anchor Radius
Anchor Border
Color
Anchor Border
Thickness
Anchor
Background
Color
Anchor Alpha
Anchor
Background
Alpha
DESCRIPTION
Allows you to set the color using which columns, lines, area of that dataset would be drawn.
Allows you to set the alpha (transparency) of the entire dataset at the Series
Appearance level. The range is from 0 - 100.
Allows you to control the ratio of each color using a comma separated list of ratios, if you are showing columns as gradients,
Allows you to set whether this dataset would appear as dashed.
Allows you to set whether to show the border of this dataset.
Allows you to set the color of the plot border.
Allows you to set the thickness of the plot border lines.
Allows you to set the alpha transparency of the plot border lines
Allows you to set the thickness of the lines for the particular dataset in pixels.
Allows you to define the length of the dash, if the lines are to be shown as dash for the particular dataset.
Allows you to define the length of the gap between dashes, if the lines are to be shown as dash for the particular dataset.
Allows you set whether to draw anchors for the particular dataset. If the anchors are not shown, then the tool tip and links will not work for the dataset.
Allows you set the number of sides that the anchors of the particular dataset will have. For example, an anchor with 3 sides would represent a triangle, with
4 it would be a square and so on. The range is from 3 - 20.
Allows you to set the radius (in pixels) of the anchors of the particular dataset.
Greater the radius, bigger would be the anchor size.
Allows you set the border color of anchors of the particular dataset. Use hex code of colors. To use the color picker, click on the color swatch square.
Allows you set border thickness of anchors of the particular dataset in pixels.
Allows you set the background color of anchors of the particular dataset. Use hex code of colors. To use the color picker, click on the color swatch square.
Allows you set the alpha of entire anchors of the particular dataset. If you need to hide the anchors for the dataset but still enable tool tips, set this as 0.
Allows you set the alpha (transparency) of anchor background of the particular dataset. The range is from 0 - 100.
104
qChartView
The Series Appearance element can contain zero or more Item Appearance elements. If you do specify any Item Appearance element, every item in the series is displayed according to the settings in the Series Appearance element.
The Item Appearance is applied as follows:
• If you specify the Item Value in the Item Appearance, the settings are applied based on the X axis value of the item. For example, if the X axis shows the value of the Priority field in the Tasks list, you can make all the High priority items displayed in red.
• If you specify Y Axis Value Range in the Item Appearance, the settings are applied based on the Y axis value of the item. For example, you can highlight any data items that falls within a certain range with a certain color (low sales number with red, high sales number with blue).
• If neither is specified, the settings are applied in the order they are listed. This means the first Item Appearance controls the appearance of the first data item in the series, the second one controls the second data item in the series, and so on. In this case, if the data series has more items to display than the number of Item Appearance, the remaining items are displayed with the settings specified by the
Series Appearance. Having said this, it is better to define more Item
Appearance elements when you have a variable number of items to display in the chart.
Item Appearance contains the following:
ELEMENT
Item Value
Y Axis Value
Range
Color
Display Value
Tooltext
Alpha
DESCRIPTION
Allows you to specify the settings in the Item Appearance element that are applied to the data items whose X axis value match with the specified value.
Allows you to apply the color is applied based on the Y axis value of the item, if you specify Y Axis Value Range,
Allows you to define the color of data series at the Series Appearance level for multi-series and combination charts. However, if you wish to highlight a particular data item, you can specify its color at Item Appearance level.
Allows you to display a custom string value if instead of the numerical value of this data.
Allows you to display more information for the data item as tool tip. By default, qChartView shows the series Name, Category Name and value as tool tip text for that data item.
Allows you to define the alpha of datasets at the Series Appearance level for multi-series and combination charts, However, if you wish to highlight a particular data item, you can specify its alpha at Item Appearance level using this attribute. The range is from 0 - 100.
105
Quick Apps for SharePoint
ELEMENT
Dashed
Anchor Sides
Anchor Radius
Anchor Border
Color
Anchor Border
Thickness
Anchor
Background
Color
Anchor Alpha
Anchor
Background
Alpha
DESCRIPTION
Allows you to set whether the border of this data item should appear as dashed.
Lets you specify item specific sides of the anchor in a line/area chart. The range is from 3 - 20.
Lets you specify item specific radius (in pixels) of the anchor in a line/area chart.
Lets you specify item specific border color of the anchor. Use hex code of colors. To use the color picker, click on the color swatch square
Lets you specify item specific border thickness in pixels) of the anchor in a line/area chart.
Lets you specify item specific background color of the anchor in a line/area chart.
Lets you specify item specific alpha (transparency) of the anchor in a line/area chart. The range is from 0 - 100.
Lets you specify item specific alpha (transparency) of the anchor background in a line/area chart. The range is from 0 - 100.
Toolbar Appearance Tab
The Toolbar Appearance Tab contains the following:
ELEMENT
Toolbar Skin Name
Show Return to Master Chart Button
DESCRIPTION
Allows you to enter the skin name for the toolbar.
If selected, displays the Return To Master Chart Button.
This button will appear only if the Source parameter exists in the URL of the current page. When the user clicks this button, the user is returned back to the URL specified in the Source HTTP parameter.
106
qChartView
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
Return to Master
Chart Button Text
Resource ID
Filter Button Text
Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
By default, the text for the Return to Master Chart toolbar button is retrieved from the resource file that is included in the product. If the resource file in the culture that you want to use is not available, define the text for the Return to Master Chart toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Filter toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Filter toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
107
Quick Apps for SharePoint
qChartView Procedures
You can perform the following procedures using qChartView:
•
•
•
•
•
Using MultiSeriesStackedColumn2D and
MultiSeriesStackedColumn2DLineDual YAxis Charts
Configuring qChartView
To configure qChartView
1.
Add qChartView to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
Formatting Links
You can perform the following procedures with links:
•
•
•
•
Defining Links for a Chart
To define a link for any data plot
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, define the link attribute as in the following example: link='ShowDetails.asp%3FMonth%3DJan'
108
qChartView
With the above XML, the data plot (be it column, pie or line/area anchor), when clicked, will take to the page
ShowDetails.asp?Month=Jan, which might contain another chart to show detailed results for the month of January.
The chart view expects all the links in URL Encoded format, if you have characters special characters (such as ?,&) in your link. When the user clicks the link, the chart view decodes it and invokes
ShowDetails.asp?Month=Jan.
All the server-side scripting languages provide a generic function to
URL Encode any string.
Opening Links in a New Window
You can open the link in a new window instead of the same window.
To open a link in a new window
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, add n- before any link, as in the following example:, link='n-ShowDetails.asp%3FMonth%3DJan'
The above link, when clicked, opens in a new window.
Opening Links in Pop-up Windows
The chart view also allows you to open your links in pop-up windows.
To open a link in pop-up window
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, define the link as in the following example: link="P-detailsWin,width=400,height=300,toolbar=no,scrollbars=no
, resizable=no-ShowDetails.asp%3FMonth%3DJan"
Where:
• P- denotes that the link is to be opened in a new pop-up window.
• detailsWin specifies a name for the new window. If you want all the links to open in the same pop-up, use the same window name across all links. However, if you want each link to open in a new pop-up, specify a different window name for each link.
• height specifies the height of the window in pixels.
• width specifies the width of the window in pixels.
109
Quick Apps for SharePoint
• resizable when enabled, allows the user to manually resize the window by dragging its edges or corners.
• scrollbars specify whether or not to display the horizontal and vertical scrollbars that normally appear when the page content is larger tan the screen.
You can include other attributes, such as:
• menubar specifies whether or not to display a menu bar at the top of the window.
• toolbar specifies whether or not to display the main toolbar (with the back, forward, stop buttons).
• location specifies whether or not to display the location bar (the Address Bar in
Internet Explorer) - where URLs are typed and displayed.
• directories specifies whether or not to display any additional toolbar (for example, the Links Bar in Internet Explorer).
• status specifies whether or not to display the status bar at the foot of the window.
• left specifies the distance in pixels of the new window from the left edge of the screen. (This applies to Internet Explorer. For Netscape Navigator use screenX).
• top specifies the distance in pixels of the new window from the top edge of the screen. (This applies to Internet Explorer. For Netscape Navigator use screenY).
• fullscreen when enabled causes the window to open in full-screen mode (Internet
Explorer only.)
• -ShowDetails.asp%3FMonth%3DJan denotes the actual link to be invoked
Linking to Frames
The chart view allows you to open links in specified frames too. To do so, you just specify the name of the frame in the link itself.
To open link in a specified frame
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, set the link as in the following example: link='F-FrameName-ShowDetails.asp%3FMonth%3DJan'
Where:
• F denotes the link opens in a frame
• -FrameName denotes the name of the frame to be opened
• -ShowDetails.asp%3FMonth%3DJan denotes the actual link to be opened. The link needs to be URL Encoded.
110
qChartView
In this example, the main frameset is contained in FrameExample.html, which has two vertical frame pane- one on top containing the chart
(FramePages\FrameChart.html) and one on bottom to show the linked frame pages. The bottom pane by default shows FramePages\LowerFrame.html which contains the message "Click on columns above to view details".
The setup looks like the following:
Setting Number Formatting
You can perform the following procedures:
•
•
•
Setting Custom Thousand and Decimal Separator Character
•
•
Adding Number Prefix and Suffix
•
Formatting Y-axis Values Decimal in Manual Div-Lines Mode
111
Quick Apps for SharePoint
Controlling Decimal Precision
All the charts types in qChartView support the attribute decimals. This single attribute lets you control the decimal precision of all the numbers on the chart.
Using this attribute, you can globally set the number of decimal places of ALL numbers of the chart.
To globally set the number of decimal places
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
Enter a value in the Decimal box.
4.
Click
Save
.
For example, if you have numbers on your chart as 12.432, 13.4 and 13 and you set Decimals='2' , the numbers would be converted to 12.43, 13.4 and 13 respectively.
Similarly, if you had data as 0.12342, 0.134 and 0.13, and you set Decimals as
3, qChartView would output 0.124, 0.134 and 0.13 respectively.
112
qChartView
Even though the Decimals is set to 3, qChartView does not add the 0 padding to
0.13 to form 0.130. However, if you want your numbers on the chart to have trailing zeroes too, you can set Force Decimals=true and now the numbers would show as 0.124, 0.134 and 0.130 respectively, as shown in these examples:
Automatic Number Formatting
qChartView automatically formats your numbers by adding K,M (Kilo, Million) and proper commas to the numbers, as shown in this example:
The data for chart is 12500, 13400 and 13300. qChartView automatically formats the number scaling to convert to K (Thousands) & M (Millions).
If you do not want to truncate numbers
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number Scale, select
False
.
4.
Click
Save
.
113
Quick Apps for SharePoint
When you now view the chart, you will see the following:
In the example above, qChartView is showing full numbers on the chart. It has also added commas to the numbers at the required places.
If you do not want to set commas
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number, select
False
.
4.
From Format Number Scale, select
False
.
5.
Click
Save
.
The commas have been removed from numbers.
114
qChartView
Setting Custom Thousand and Decimal Separator
Character
By default, qChartView uses . (dot) as decimal separator and , (comma) as thousand separator character. However, you can customize this character depending on your requirements. For example, you can swap the separator characters.
To swap separator characters
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the In Decimal Separator, enter
,
.
4.
In the In Thousand Separator, enter
.
.
5.
Click
Save
.
Shown below is the output.
Adding Number Prefix and Suffix
qChartView allows you to add a prefix or suffix to all numbers on the chart.
To add a number prefix or suffix
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the Number Prefix box, enter a character or value.
For example, to represent dollar figures, enter $.
4.
In the Number Suffix box, enter a character or value.
For example, to represent figures quantified per annum, enter p.a.
115
Quick Apps for SharePoint
5.
Click
Save
.
If you intend to use special characters for Number Prefix or Number Suffix, URL
Encode them when using dataXML method. For example, if you wish to have numberSuffix as % (for example, 30%): numberSuffix='%25'
In dataURL method, you can directly specify the character.
Examples:
Formatting Y-axis Values Decimal in Manual Div-Lines
Mode
If you want to set the number of divisional lines on chart, you can control the decimals of y-axis values separately. For example, consider the following attributes and chart:
116
qChartView
Y Axis Min Value='115' Y Axis Max Value='140' Zero Plane=false Number of
Division Lines='3' >
In this chart, the chart lower limit, upper limit, and number of divisional lines have been manually set. qChartView will not automatically adjust divisional lines. In the chart, qChartView has truncated decimals from y-axis values, as it cannot find any other decimal values on the chart.
You can, however, show decimals on y-axis values in this case (when Zero Plane is false) using Y Axis Value Decimals attribute, for example Y Axis Min
Value='115' Y Axis Max Value='140' Zero Plane=false Number of Division
Lines='3' Y Axis Value Decimals='2' Decimals='0' >.
When you now see the chart, 2 decimal places on y-axis values appear. But, the other numbers on chart would still have 0 decimal places.
Force Decimals does not work in this mode.
117
Quick Apps for SharePoint
Setting Number Scaling
Number scaling lets you define your own scales for numbers and then apply it to all numbers on the chart.
For example, if your numbers on the chart are greater than 1000, qChartView scales them to K (Thousands) or M (Millions). For example, if you plot a chart with data as 12500, 13400 and 13300, you will see the following chart: qChartView has scaled the numbers down to K. By default, qChartView has the
K,M (1000,1000) scaling defined for each chart. You can, however, customize it.
You can perform the following procedures:
•
Adding Billions to Default Scaling
•
Adding Billions to Default Scaling
qChartView, by default, has 1000,1000 (K,M) scaling defined for all charts. It does not have the scaling for billions defined. You can modify the number scaling to add billion so that the final scale looks like 1000,1000,1000 (K,M,B).
This scale would look something like:
• 1000 = 1 K
• 1000 K = 1 M
• 1000 M = 1 B
To convert this scale into qChartView format
1.
From Chart Attributes, click
Edit
.
118
qChartView
2.
Click
Number Formatting
.
3.
In the Number Scale Value box, enter 1000,1000,1000.
4.
In the Number Scale Unit box, enter K,M,B.
5.
Click
Save
.
Whatever numeric figure was present on the left hand side of the table is put in Number Scale Value and whatever unit was present on the right side of the scale table has been put under Number Scale Unit
- all separated by commas.
If you want to set the chart formatting flags
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number, select
True
.
4.
From Format Number Scale, select
True
.
5.
In the Number Prefix box, enter
$
.
6.
Click
Save
.
When you now view a chart containing data in billions, you will see the following chart. Note that the chart now contains figure both in millions and billions.
Putting Time in Scale
If you want to plot time-related figures on the chart, you can set the time in each process to range from a few seconds to few days. You can build a scale indicating time and then specify it to the chart:
• 60 seconds = 1 minute
• 60 minute = 1 hr
119
Quick Apps for SharePoint
• 24 hrs = 1 day
• 7 days = 1 week
To convert this scale in qChartView
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the Default Number Scale box, enter
s
.
The default number scale is now represented in seconds.
4.
In the Number Scale Value box, enter
60,60,24,7
.
5.
In the Number Scale Unit box, enter
min,hr,day,wk
.
6.
Click
Save
.
Whatever numeric figure was present on the left hand side of the table is put in Number Scale Value and whatever unit was present on the right side of the scale table has been put under Number Scale Unit - all separated by commas.
If you want to set the chart formatting flags
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number, select
True
.
4.
From Format Number Scale, select
True
.
5.
Click
Save
.
When you now view the chart, you'll see that all the data has been automatically scaled to the best value:
• 38 is converted to 38s
• 150 is converted to 2.50min
• 11050 is converted to 3.07hr
• 334345 is converted to 3.87 day
120
• 1334345 is converted to 2.21wk
qChartView
Using MultiSeriesStackedColumn2D and
MultiSeriesStackedColumn2DLineDual
YAxis Charts
To use MultiSeriesStackedColumn2D and
MultiSeriesStackedColumn2DLineDualYAxis
For example, you want to use a list that shows total sales for products and services from 2001-2006.
1.
Open qChartView in ezEdit.
2.
Edit the Viewed Lists section and select a list.
3.
In the Chart Type section, select
MultiSeriesStackedColumn2D
or
MultiSeriesStackedColumn2DLineDualYAxis
.
4.
Edit the Configuration section, and select a field name; for example,
Year.
5.
Click
Add Data Series
and add two data series; for example:
Each series represents a stack within group of stacks.
6.
Click
Edit
in each data series and enter a filter expression. This step is optional.
121
Quick Apps for SharePoint
Use a filter expression only if your data is a subset of all list data.
In this example, Products and Services are subsets for the overall
Sales list, enter a filter expression such as ProductType=’Product’ for the Product series and ProductType="Services’ for the Services series.
7.
Select a filter field name for each data series; for example, Name.
qChartView stacks the data according to filter field’s value. If the Filter
Field Name is not set, the chart is not rendered as stack.
You can use the same field name in each series if you enter a filter expression.
Each series represents a stack within group of stacks.
122
qDiscussionView
•
Overview
•
qDiscussionView Tabs
•
qDiscussionView Procedures
7
Quick Apps for SharePoint
Overview
qDiscussionView allows you to view multiple discussions lists at once. These discussion lists can reside in another site, another site collection, or another web application as long as they are in the same configuration database.
If you would like to learn more, click here to watch the training video.
qDiscussionView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qDiscussionView contains the following tabs:
•
•
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
124
qDiscussionView
Display Tab
When you open ezEdit in qDiscussionView, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Viewed Lists
Display Fields
Searched Fields
Expand Filter panel on
Load
Panel Button Location
Show Apply On Top
Level Discussions Only in Search Panel
Show Search All Fields
Control in Search Panel
Turn on List Searcher
Mode
DESCRIPTION
See
“Viewed Lists” on page 127 for more information
See
“Display Fields” on page 131 for more information
See
“Searched Fields” on page 134 for more information
Allows you to automatically open the Filter panel by default so that the user can perform a search quickly. When set to true, the Filter panel opens when the web part is loaded for the very first time.
Allows you to determine the location of the Go, Reset and Close buttons in the Filter panel. This property has 3 options:
• Top — The buttons in the panel appear at the top
• Bottom — The buttons in the panel appears at the bottom
• TopAndBottom — The buttons in the panel appears at the top and the bottom
Allows you to determine whether the check box, “Apply only on Top
Level Discussions”, is shown in the Filter panel. If you select this check box when performing the search, the qDiscussionView will filter only the top level discussion and the search results are shown in the proper structure. If you deselect this check box when performing the search, the search results are displayed in a flat structure.
Allows you to determine whether the Filter panel should display the control to search all fields in the list.
The Search All Fields Control allows you to do the following:
• Combine the search all fields functionality with other search criteria that has been entered for specific fields.
• When the search all fields criteria is entered, the Filter panel will construct a filter expression with the "Contain" operator for the following fields in the list: Single line of text, Multiple lines of text,
Choice, Lookup, Person or Group and Hyperlink or Picture. The
Filter panel will use the entire keywords as the value to be searched. Therefore, if you enter "High Priority" in the search all fields control and perform the search, it will find the following sentence:
‘This is a high priority task’
However, it will not find the following sentence:
‘The priority is not always high’
Allows you to determine if you want to perform a search before the
Discussion View display any data.
125
Quick Apps for SharePoint
ELEMENT
CAML Filter
Sort Fields
Row Double Click
Action
Search Session Name
ID HTTP Parameter
Name
DESCRIPTION
Allows you to specify the CAML (Collaboration Application Markup
Language) query expression to filter your data. CAML is an XML-based query language. The CAML Filter will only be applied to the top level discussions. The filter will not be applied to the responses.
See the “CAML Filter Help” on page 467
on more information.
Allows you to define the initial sorting criterion for the discussion. This is the syntax for this property:
FieldName1 [SortDirection], FieldName1
[SortDirection]
SortDirection is either ASC (ascending order) or DESC (descending order).
Note:
FieldName and SortDirection are case sensitive. If the
SortDirection is not specified, ascending order is assumed. For example, if you want to display the discussions from the newest to the oldest, you can specify the following sort expression: Created DESC.
Allows you to define what happens when a discussion or a response in the tree list view is double-clicked. There are 3 options:
• ExpandOrCollapse — The discussion or the response is expanded or collapsed if it contains responses. This is the default option.
• GoToDisplayForm — Allows you to go the display form for this discussion or response.
• GoToEditForm — Allows you to go to the edit form for this discussion or response.
Allows the Discussion View to store the search criteria in the session variable with this name.
Note:
Do not confuse this property with the SetSessionName attribute in the Viewed Lists property. The SetSessionName attribute stores the record that is being clicked. The field value from the item that is stored in the session variable can then be consumed by another web part. As a best practice, keep the value of the two session names different.
Allows the qListForm and several other web parts to use an HTTP
Parameter called ID to identify the item to be displayed or edited. This
HTTP Parameter is usually generated automatically by the viewer web part, such as qListView or qCalendarView, when you select an item to be displayed or edited.
Note:
If qListForm is placed on a web part page that is contained within a document library, the page will generate an error if the value of the ID HTTP Parameter is bigger than the number of pages within the document library. To prevent this error from happening, rename the ID
HTTP Parameter.
By default, the value of this property is "ID". You can change the value of this property to something else, such as LID. In that case, when you select "View Properties" or "Edit Properties" in the context menu, the
URL of the display or edit form becomes: http://mysite.com/EditFormURL.aspx?LID=xxx
Set the same property in the qListForm to the same value.
126
qDiscussionView
Viewed Lists
The Viewed Lists section defines:
• the discussion lists whose data is viewed in qDiscussionView and how it is aggregated. You can define the lists to be aggregated one by one, in a Rolled-Up list, or from lists with a particular name from all the subsites (recursive rollup)
• the dependent lists for each list. If the Dependent Lists information is provided, qDiscussionView will check whether or not there are child records in the Dependent Lists when you delete items from the view.
If there are any, qDiscussionView will not delete the selected items.
You will need the qListForm web part in order to establish a relationship between different lists.
When you select which items you would like to view, the Viewed Lists section shows the items in the following format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName"
IncludeSubsites="true/false" IncludeThisSite="true/false"
IsRollupList="true/false" SiteUrlFieldName="fieldName"
RolledUpListName="listName" TargetUrl="targetUrl"
SetSessionName="sessionName" ResetSessionNames="name1, name2" NewFormUrl="URL" EditFormUrl="URL"
DisplayFormUrl="URL">
<!-- To define dependent lists, add a DependentLists element inside the List element -->
<DependentLists>
<List SiteUrl="siteUrl" ListName="listName"
KeyFieldName="keyFieldName" />
<List SiteUrl="siteUrl" ListName="listName"
KeyFieldName="keyFieldName" />
</DependentLists>
</List>
<List ...></List>
<List ...></List>
</Lists>
127
Quick Apps for SharePoint
The following are the elements for the Viewed List attribute.:
ELEMENT
Site URL
List Name
Include Subsites
Include This Site
Is Rollup List
DESCRIPTION
The URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
The name of the SharePoint list that is edited or displayed by this
Discussion View. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list, you can use a single dot (.) as the list name.
Note:
This only works if the qDiscussionView is contained in the
AllItems.aspx. For example, if you are replacing the Microsoft
Discussion View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qDiscussionView is set to Tasks. If you want to save the list as a template and then add it somewhere else, the name of the new list might not be Tasks and using this relative list name will automatically pick up the new list name for the view.
If set to true, the Discussion View will search all the subsites for a list whose name specified in the ListName and aggregate the information from those list.
Note:
If you have many subsites, the information may take a long time to aggregate. Use this attribute if you have only a small amount of subsites. You must test this feature in your environment to see whether or not the response comes back in a reasonable amount of time and the request does not time out.
Used in conjunction of the IncludeSubsites attribute. If you set this property to true, the list in the current site will be aggregated by the
Discussion View. The current site is the site whose URL is specified in the SiteUrl attribute.
Indicates whether or not the list specified by the SiteUrl and ListName attributes contains the Site URLs of the lists to be aggregated instead of the data to be aggregated. If you set this to true, the list specified by the SiteUrl and ListName must have a field that contains the URL information. By default, the name of that field is Site URL. If you use different field name, specify the name using the SiteUrlFieldName attribute.
128
qDiscussionView
ELEMENT
Rolled Up List Name
Site URL Field Name
Active Field Name
Reset Session Names
Set Session Name
Target URL
DESCRIPTION
Used in conjunction with the IsRollupList property, indicates the name of the lists to be rolled up if you set the IsRollupList to true.
If you want to aggregate more than one list from each site specified in the rollup list, you can define more than one List elements with the same rollup list, but different RolledUpListName. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following:
<Lists>
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Public
Library" />
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Private
Library" />
</Lists>
Used in conjunction with the IsRollupList property, indicates the field that contains the Site URLs of the lists to be aggregated. This attribute is optional if the field name is Site URL.
Note:
The Site URL field must be a single line of text field.
Used in conjunction with the <Link>IsRollupList property. The rollup list may contain a Yes/No field to indicate whether or not a particular site should be included in the rollup. This property is optional if the name of this field is Active.
Note:
The Active field must be a Yes/No field.
Resets (sets to NULL) the value of the session variables whose name is specified in this attribute. You can specify multiple names by separating them with commas; for example TaskSession, IssueSession.
You can reset the session name if a discussion may have one or more tasks associated with it. In addition to storing the selected discussion in the session, you may store the dependent task information in the session as well. This means that every time you store a new discussion into a session, you need to reset the dependent task information from the session as well.
Defines the name of the session variable where the Discussion View will store the item whose column is being clicked by the user. The user can click the item if one of the LinkTo, LinkToTarget or the LinkToSource attributes in the Display Fields property is defined.
This attribute is usually used if you have another web part (such as the qListForm) that can consume the stored values from the session.
You can set the session name when you want to consume the item from a session variable in a qListForm later.
When the LinkToTarget attribute of a specific column is set to true (in the Display Fields property), the data in that column becomes a hyperlink to the URL specified in this attribute. The TargetUrl can use the <%field name%> field replacement expression. But you must use the encoded form of the < and > characters, which are < and > respectively.
Use the LinkToTargetUrl attribute if you want each list to have a different URL; for example, when you want to aggregate multiple lists from the same workspace and connect a certain column to the display form of the list. In that case, the URL to the display form of each list is different.
129
Quick Apps for SharePoint
ELEMENT
New Form URL
Reply Form URL
Edit Form URL
Display Form URL
DESCRIPTION
Indicates the URL where the form to create a new item resides. The
URL is relative to the Site URL of the list. The user is redirected to the specified URL when one of the New buttons in the toolbar is clicked. If not defined, the user is redirected to the NewForm.aspx of the list (or
Upload.aspx for the document library).
Redefining the New Form URL is useful if you have different way of creating an item depending on the current view. For example, in the view for external vendor, you may want to give them a new form that does not contain all the fields in the list.
Note:
The Source HTTP parameter is automatically appended to the
New Form URL during redirection.
This attribute is usually used in conjunction with qListForm.
Indicates the URL where the form to create a new response resides.
The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the Reply button in the toolbar or in the preview panel or the Reply context menu item is clicked. If not defined, the user is redirected to the URL specified in the NewFormUrl, if one is defined.
Otherwise, the user is redirected to the NewForm.aspx of the list.
Redefining the Reply Form URL is useful if you want to have a different form to create a reply than the one that is used to create a new discussion. For example, in the form to create a reply, you may want to use 2 qListForms. The first qListForm is used to display the detail of the parent discussion and the second qListForm is used to create the response itself.
Note:
The Source HTTP parameter is automatically appended to the
Reply Form URL during redirection.
This attribute is usually used in conjunction with qListForm.
Indicates the URL where the form to edit an item in the list resides. The
URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks Edit Properties in the Context Menu.
If not defined, the user is redirected to the EditForm.aspx of the list.
Redefining the Edit Form URL is useful if you have different ways of editing an item depending on the current view. For example, in the view for external vendor, you may want to give them an edit form that does not contain all the fields in the list.
Note:
The ID and Source HTTP parameters are automatically appended to the Edit Form URL during redirection.
This attribute is usually used in conjunction with qListForm.
The URL where the form to display an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks View Properties in the Context Menu.
If not defined, the user is redirected to the DisplayForm.aspx of the list.
Redefining the Display Form URL is useful if you have different way of displaying an item depending on the current view. For example, in the view for external vendor, you may want to give them a display form that does not contain all the fields in the list.
Note:
The ID and Source HTTP parameters are automatically appended to the Display Form URL during redirection.
This attribute is usually used in conjunction with qListForm.
The URL to the site that contains the dependent list.
Site URL
130
qDiscussionView
ELEMENT
List Name
Key Field Name
DESCRIPTION
The name of the dependent list. The list name is case sensitive.
The name of the field in the dependent list that contains the ID of the parent item. It is the foreign key in the dependent list. The key field is usually a single line of text that contains the parent item ID or a cross-site lookup field to the parent list. The name is case sensitive.
Display Fields
This property defines the fields that should be displayed in the tree list panel of qDiscussionView.
This property is an XML string in the following format:
<Fields LookupThresholdControlSettings=”On”>
<Field Name="fieldName" [optional attributes]/>
<!-- Grouped field -->
<Field Name="fieldName" Grouped="true"
SortDirection="asc|desc" GroupExpanded="true|false" />
</Fields>
The Display Field contains the following elements:
ELEMENT
Lookup Threshold
Title
Title Resource ID
DESCRIPTION
Controls how web parts behave in relation to the List View Lookup
Threshold in SharePoint Resource Throttling. The options are:
• Default — uses the option you have set in the Configuration
Editor.
• On — searches all fields in lists, except Lookup fields.
• Off — searches all fields in lists, including Lookup fields.
• Explicit — searches only the fields explicitly defined in the web parts properties.
Indicates the title of the field. This is useful if the real field name is too long and you want to abbreviate the title in the field header, or if you simply want to display a different title in the field header. If this attribute is not specified, the value specified in the Name attribute is used in the field header. For example:
<Field Name="Created By" Title="Author" />
Indicates the identifier in the Resource List that is used as the title of the field. The TitleResourceID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the <Link>Resource List. If the string with the given identifier is not found, the default Title is used.
131
Quick Apps for SharePoint
ELEMENT
Width
Align
Item Style
Item CSS Class
Display Field Name
Display Format
Show User Groups
Hide User Groups
Hyperlink Field Target
DESCRIPTION
Indicates the width of the field. You can specify the value in pixels
(Width="20px") or percentage (Width="20%").
We recommend leaving at least one field where you do not specify this property. That field will take up the remaining width of the page. For example:
<Field Name="Subject" Width="100px" />
Indicates the horizontal alignment for the field. The values is one of the following: left, right, or center. For example:
<Field Name="Created" Align="right" />
Indicates the style for the item in the odd number row. You can define the style as you would in a CSS class; for example, color: red; font-weight: bold
Indicates the distinct style for the column and you already have defined the style in an external CSS file.
If specified, indicates a cross-site lookup field. It contains the name of the field in the cross-site list that contains the value to be displayed. The field name is case sensitive.
A cross-site lookup field enables you to lookup a list that resides in another site, another site collection, or another web application as long as it is in the same configuration database. You need the qListForm web part to create a cross-site lookup field.
If specified, indicates a cross-site lookup field. It contains the format of the value that is displayed. Define this attribute if you want to display values from multiple fields. You can use the field replacement expression <%Field%> to refer to a field.
Note:
You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Display Fields editor in the Discussion View Editor, where the
Editor will encode the characters automatically for you.
Allows you to show groups where the user is a member of one of the SharePoint groups listed. Separate site group names with commas.
Allows you to hide groups where the user is a member of one of the SharePoint groups listed. Separate site group names with commas.
If this field is a SharePoint Hyperlink or Picture field, indicates the target window for the hyperlink. For example, use "_blank" if you want to open the target URL in a new window. If this attribute is left blank, the target URL will open in the current window.
This attribute will not affect the hyperlink column created with the
LinkTo, LinkToSource or LinkToTargetURL attributes.
132
ELEMENT
Link To
Link To Target
Link To Source
Is Complex Category
qDiscussionView
DESCRIPTION
Indicates that the Discussion View will turn the field into a hyperlinked column to the specified URL. The URL can be an absolute or relative URL. The LinkTo can use the <%field name%> field replacement expression. You must use the encoded form of the
<
and
>
characters, which are < and >, respectively unless you type in the value in the Display Fields editor in the
Discussion View Editor, where the Editor will encode the characters automatically for you.
If you use a relative URL, the URL is appended to the site URL of the target site. For example, specify
"Lists/TeamDiscussion/EditForm.aspx?ID=<%ID%>" as the value of this property. If you click a customer record that comes from the Customers list in Workspace A, whose site URL is
"http://mydomain/sites/mysite", you are directed to http://mydomain/sites/mysite/Lists/TeamDiscussion/EditForm.asp
x?ID=23 (assuming you click the discussion with ID=23).
Here is an example on how to make the Subject field a hyperlink column to the edit form of the Discussion list:
<Field Name="Subject"
LinkTo="Lists/TeamDiscussion/EditForm.aspx?
ID=<%ID%>&Source=../../default.aspx"
/>
If set to true, indicates the Discussion View will make the field value a hyperlink to the URL specified in the <Link>TargetUrl attribute in the <Link>Viewed Lists property.
Use this element when you aggregate lists with different name. In that case, you specify a different TargetUrl for each list in the
Viewed Lists property and the Discussion View will redirect the user to the correct URL depending on the list where the clicked item comes from.
The Discussion View will make the field value a hyperlink to the
URL specified in the Source HTTP parameter of the current request. For this option to work, the current page URL must look like: http://.....?Source=....
Use this element when the URL for the hyperlink is dynamic. This could be because it contains dynamic parameters or the URL is different depending on the referral page.
Also, when you want to make the URL in the link dynamic. In that case, you can pass in the URL for the link into the HTTP parameter of your page.
If selected, you can set the following:
• Complex Category Index Site URL — By default, the complex category index list resides in the same site as the discussion list itself. If this is not the case, then you must specify the
URL of the site that contains the index list here.
• Complex Category Index List Name — By default, the complex category index list is named "<Discussion list name>
Categories". For example, if your discussion list name is
"Team Discussion", then its index list name is "Team
Discussion Categories". If this is not the case, then you must specify the name of the index list here.
133
Quick Apps for SharePoint
ELEMENT
Grouped
DESCRIPTION
Allows you to group data by:
• Sort Direction — This attribute determines whether the values in the header of the grouped field must be displayed in ascending or descending order. The options are asc for ascending order or desc for descending order. The default value is asc.
• Group Expanded — If set to true, the group is initially expanded. Otherwise, it is collapsed. If not specified, the default value is false.
Note:
Grouping is not supported on any field that has "Allow
Multiple Values" enabled.
Searched Fields
This property defines which fields are displayed in the Filter panel. If defined, the discussion view displays Filter or Search menu items under the Actions button in the toolbar. To disable the search feature in the discussion view, you can leave this property blank.
This property is an XML string in the following format:
<Fields>
<Field Name="fieldName" [optional attributes]/>
<!-- To search a cross site lookup field, use one of the following two formats -->
<Field Name="fieldName" DisplayFieldName="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName"
ListName="listName"/>
</Field>
<Field Name="fieldName" DisplayFormat="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName"
ListName="listName"/>
</Field>
</Fields>
You can further edit fields using the following elements:
ELEMENT
Field Name
Title
Description
DESCRIPTION
Indicates the element you are editing.
Displays title for the field. The value can be a plain string or an encoded HTML string.
Describes the field. This is useful if you want to give a short instruction or explanation about the field.
134
qDiscussionView
ELEMENT
Default Value
Default Operator
Fixed Operator
Use People Editor
Column Count
Enable Multi Choice
Sort Field
Sort Order
AutoPostBack
Parent Field
Parent Filter Field Name
Filter Field Name
Display Field Name
DESCRIPTION
Defines the default value for the field.
You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of February 14, 2002 is
2002-02-14T00:00:00Z.
Defines the default operator for the field.
Defines the operator for the field. If specified, the list to select the operator for this field is turned off.
Enables you to enter any user information that is in your directory service.
If you set this to True and the field to be searched is a People and
Group field, the Filter panel shows the People Editor control for entering the search criteria.
Defines the number of columns for the options in a multi-choice field or in a choice-and-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form.
If set to True, allows you to select multiple options for the choice-and-lookup field. Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types.
To search a cross-site lookup field, you must specify one or more
List elements inside the Field element. The cross-site lookup field is displayed as two drop downs.
Defines the field that is used to sort the value in the drop-down menu. The field name is case sensitive.
Allows you to sort the values in ascending or descending order.
When set to true, this attribute causes the Filter panel to refresh when the user changes the selection in a lookup field or cross-site lookup field.
You need to set AutoPostBack to true if this field is a lookup or a cross-site lookup field and it is being used to filter another lookup or cross-site lookup field in the Filter panel.
Defines another lookup or cross-site lookup field that is used to filter this field. The parent field must be listed before this field in the XML property.
Defines the field in the parent field that is used to filter this field. It is the primary key in the list that is used in the lookup or cross-site lookup field.
Defines the field in the list that is used by this lookup or cross-site lookup field that is filtered by the parent filter field.
Shows the name of the field whose value is displayed in the drop-down menu. The field name is case sensitive. Use this attribute instead of the Display Format attribute if you only want to display a single field in the drop-down menu.
135
Quick Apps for SharePoint
ELEMENT
Display Format
Site URL
List Name
Site Name
DESCRIPTION
Indicates the format of the value that is displayed in the drop-down menu. Define this attribute instead of the Display Field Name attribute if you want to display multiple fields in the drop-down menu. You can use the field replacement expression <%Field%> to refer to a field.
Note:
You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Searched Fields editor in the List View Editor, where the
Editor will encode the characters automatically for you.
Indicates the Site URL of the field. You can use an absolute or relative URL
Indicates the name of the List. The field name is case sensitive.
Indicates the name of the site specified in the Site URL. This is used in case you have multiple lists. In this case, the first drop-down menu to select the list will display as "List Name in Site
Name". You can use any name for the Site Name. It does not have to match the real title of the Site.
View Appearance Tab
The View Appearance Tab contains the following:
ELEMENT
Selection Column Type
Maximum Top Level
Discussions Per Page
Expand To Level
Show Preview Panel
DESCRIPTION
Allows you to set the row selection type. The options are:
• None: The user must click the row to select it.
• MultiRowSelector: The discussion view will display a checkbox as the first column. To select a row, the user checks the checkbox for that row. To select multiple rows, the user checks the checkbox for each row to be selected.
Allows you to set the maximum number of top level discussions to be displayed on one page.
Allows you to determine how many levels should be expanded when the Discussion View is loaded for the first time.
Allows you to display the preview panel.
136
qDiscussionView
ELEMENT
Skin Name
Splitter Skin Name
Splitter Orientation
Tree View List Panel Size
Preview Panel Size
Grid Lines
DESCRIPTION
Allows you to specify the skin name for the tree list panel in the
Discussion View. The skin name is associated with a folder under the following directory in the web server:
C:\Program Files\Common Files\Microsoft Shared\Web
ServerExtensions\12\TEMPLATE\LAYOUTS\QuestSoftware\DevE xpress\9.3\Themes
The skin folder will contain the CSS file and images needed to control the visual appearance of the grid. If none of the provided skins satisfy your need, you can copy one of the existing skins and modify it. You must follow the CSS class name convention in the CSS file, which is class name followed by the skin name; for example, dxtlControl_Office2003Blue.
Allows you to specify the skin name for the splitter in the
Discussion View.
The skin folder will contain the CSS file and images needed to control the visual appearance of the grid. If none of the provided skins satisfy your need, you can copy one of the existing skins and modify it. You must follow the CSS class name convention in the CSS file, which is class name followed by the skin name; for example, RadSplitter_Office.
Allows you to divide the treeview and the Preview panel either horizontally or vertically using a splitter.
Allows you to set the height (when the splitter orientation is
Horizontal) or the width (when the splitter orientation is
Vertical) of the treeview list panel in pixels.
Allows you to set the height (when the splitter orientation is
Horizontal) or the width (when the splitter orientation is
Vertical) of the Preview panel in pixels.
Allows you to specify if the tree list can display no grid lines, horizontal grid line, vertical grid lines or both depending on the
Grid Lines property.
Toolbar Appearance Tab
The Toolbar Appearance Tab contains the following:
ELEMENT
Toolbar Skin Name
Show Filter Button at Top
Show New Item Button
Show Delete Button
DESCRIPTION
Allows you to enter the skin name for the toolbar.
Allows you to show the Filter button as a top level button. If not selected, the Filter button is displayed under the Actions button.
Allows you to show the New Item button in the toolbar.
Allows you to show the Delete button in the toolbar.
137
Quick Apps for SharePoint
ELEMENT
Show Connect to Outlook
Button
Show Alert Me Button
Show Reply Button
Show Expand All Button
Show Collapse All Button
DESCRIPTION
Allows you to show the Connect to Outlook button in the toolbar.
The Connect To Outlook button lets users view their SharePoint
Discussion lists in their Microsoft Outlook Calendar. The Connect
To Outlook button will work only if you have Microsoft Outlook installed in you computer and it only works for the SharePoint
Discussion list.
Allows you to show the Alert Me button in the toolbar. The Alert
Me button creates a list-level alert.
Allows you to show the Reply button in the toolbar. This allows you to reply to a discussion.
Allows you to show the Expand All button in the toolbar. This allows you to expand all nodes in the treeview.
Allows you to show the Collapse All button in the toolbar. This allows you to collapse all nodes in the treeview.
Context Menu Appearance Tab
The Context Menu Appearance Tab contains the following:
ELEMENT
Enable Context Menu
Context Menu Skin Name
Show View Properties
Show Edit Properties
Show Reply
Show Delete Item
Show Manage Permissions
Show Alert Me
View Properties Context Menu
Text
Edit Properties Context Menu Text
Reply Context Menu Text
DESCRIPTION
Allows you to show the context menu.
Allows you to set the skin name for the context menu.
Allows you to show the View Properties menu item in the context menu.
Allows you to show the Edit Properties menu item in the context menu.
Allows you to show the Reply menu item in the context menu.
Allows you to show the Expand All button in the toolbar. This allows you to expand all nodes in the treeview.
Allows you to show the Manage Permissions menu item in the context menu.
Allows you to show the Alert Me menu item in the context menu.
Allows you to enter the text for the View Properties Context
Menu.
Allows you to enter the text for the Edit Properties Context
Menu.
Allows you to enter the text for the Reply Context Menu.
138
qDiscussionView
ELEMENT
Delete Item Context Menu Text
Manage Permissions Context
Menu Text
Alert Me Context Menu Text
DESCRIPTION
Allows you to enter the text for the Delete Item Context
Menu.
Allows you to enter the text for the Manage Permissions
Context Menu.
Allows you to enter the text for the Alert Me Context Menu.
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part , whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures.
The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — The field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName"
/>
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The
URL can be absolute (http://...) or relative to the current page
URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
139
Quick Apps for SharePoint
ELEMENT
View Properties Context
Menu Text Resource ID
Edit Properties Context
Menu Text Resource ID
Reply Context Menu
Text Resource ID
Delete Item Context
Menu Text Resource ID
Manage Permissions
Context Menu Text
Resource ID
Alert Me Context Menu
Text Resource ID
DESCRIPTION
By default, the text for the View Properties context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the View Properties context menu item in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Edit Properties context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Edit Properties context menu item in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Reply context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Reply context menu item in the
Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Delete Item context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Delete Item context menu item in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Manage Permissions context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Manage
Permissions context menu item in the Resource List and specify its
Resource ID. This Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Alert Me context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Alert Me context menu item in the
Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
140
qDiscussionView
ELEMENT
Filter Button Text
Resource ID
DESCRIPTION
By default, the text for the Filter toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Filter toolbar button in the Resource
List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
qDiscussionView Procedures
You can perform the following procedures using qDiscussionView:
•
•
•
Configuring qDiscussionView with the Complex Category Index List
Configuring qDiscussionView
To configure qDiscussionView
1.
Add qDiscussionView to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
Sorting the qDiscussionView
You can sort the entries in the qDiscussionView by clicking the column header.
Clicking the column header again will alternate between ascending and descending order.
Due to the hierarchical nature of the discussions and their responses, the sorting will sort the node against another nodes in the same level. For example, if the following discussion structure exists:
* Discussion 1
- Response 1.1
141
Quick Apps for SharePoint
- Response 1.1.1
- Response 1.1.2
- Response 1.2
- Response 1.2.1
- Response 1.2.2
* Discussion 2
- Response 2.1
- Response 2.1.1
- Response 2.1.2
- Response 2.2
- Response 2.2.1
- Response 2.2.2
When you click the Subject column header:
• Discussion 1 is sorted against Discussion 2
• Response 1.1 is sorted against Response 1.2.
• Response 2.1 is sorted against Response 2.2.
• Response 1.1.1 is sorted against Response 1.1.2.
• Response 1.2.1 is sorted against Response 1.2.2.
• Response 2.1.1 is sorted against Response 2.1.2.
• Response 2.2.1 is sorted against Response 2.2.2.
To clear the sorting for a certain column
• Press Ctrl and click the column header.
To sort multiple columns
• Press Shift and click other column headers.
The sort index depends on which column you click first. For example, if you click Created field and then click Shift + Subject field, the entries are sorted based on the Created field first and then Subject field, regardess the Subject field appeared first.
142
qDiscussionView
Understanding the Complex Category
Index List
The Complex Category Index List allows qDiscussionView to function like the
Lotus Notes response document which contains a category attribute. qDiscussionView maintains the index list when one or more discussions are deleted. You must mark the complex category field in your discussion list, so qDiscussionView will know that the complex category field exists and the index list is updated.
To mark the complex category field in your discussion list
1.
From the menu, select ezEdit.
2.
From the Display Fields section, select Edit.
3.
Select Edit for each field name you want displayed.
4.
Select the Is Complex Category check box, and click OK.
The Complex Category Index List can contain multiple categories such as:
Category1, Category2, Category3. In this case, the discussion is displayed in each of the multiple categories in the treeview. For example, if Discussion A contained ‘Category1, Category2, Category3’ in the Complex Category Index
List, it would be displayed in the treeview view as follows:
- Category1
- Discussion A
- Category2
- Discussion A
- Category3
- Discussion A
The sorting is disabled when you use grouped complex category field.
The category field can contain nested categories, such as:
Category1\Category2\Category3. In this case, the discussion is displayed in the nested categories in the treeview. For example, if Discussion A contained
‘Category1\Category2\Category3’ in the complex category field, it would be displayed in the treeview as follows:
- Category1
- Category2
143
Quick Apps for SharePoint
- Category3
Discussion A
The category field can contain a mix of multiple and nested categories. For example, if Discussion A contained ‘Category1, Category2, Category3,
Level1\Level2\Level3’ in the complex category field, it would be displayed in the listview as follows:
-- Category1
- Discussion A
- Category2
- Discussion A
- Category3
- Discussion A
- Level1
- Level2
- Level3
Discussion A
In order to support complex categories while maintaining good performance, the
Complex Category must be indexed. Another SharePoint list is used to store the index. There are two ways to create the Complex Category Index list.
To create the Complex Category Index List
1.
From qDiscussionView, select Create Complex Category Index List.
2.
Accept the default site URL or enter another site URL.
3.
Enter the list name.
Once created, the index appears when you get lists from the Viewed
List section of the web part.
For mass creation of the Complex Category Index list after discussion lists are migrated from Lotus Notes, use the Complex Category Indexer tool. After the migration job, there are many unindexed discussion lists. This tool creates the
Complex Category Index list and populate it at the same time.
144
qDiscussionView
Configuring qDiscussionView with the
Complex Category Index List
If you have a Discussion list that you want to appear in different categories, you would configure the Complex Category Index List. The Complex Category Index
List allows qDiscussionView to function like the Lotus Notes response document which contains a category attribute.
qDiscussionView maintains the index list when one or more discussions are deleted. You must mark the complex category field in your discussion list, so qDiscussionView will know that the complex category field exists and the index list is updated.
To configure qDiscussionView with Complex Category Index List
1.
Create a discussion board list in SharePoint. For example, create a discussion board list called "Discussion".
2.
Create a column for Discussion. Enter the name "Category" and select
Single Line of Text
or
Multiple Lines of Text
as the Type.
Refer to the SharePoint documentation on how to create a column and discussion board list.
3.
Create a SharePoint page, add a qDiscussionView web part, and open
ezEdit
. In Viewed Lists, select
Discussion
.
4.
From the qDiscussionView drop-down menu, select
Create Complex
Category Index List
.
The New Category dialog box opens.
5.
Enter a Complex Category Index Site URL and List Name.
145
Quick Apps for SharePoint
The List Name defaults to discussion board list name plus Categories.
For example, the default list name is Discussion Categories.
6.
Open
ezEdit
of the qDiscussionView web part. a) From Display Fields, select
Edit
next to "Category" created in step
2. b) Select
Is Complex Category
check box.
c) Enter a Complex Category Index Site URL and Complex Category
Index List Name. This name must the same as the list name entered in Step 5 (in our example, Discussion Categories).
7.
Replace SharePoint's out-of-the-box web parts on the NewItem,
EditItem, and ViewItem pages with qListForm web parts.
You must replace the out-of-the-box web part with the qListForm to use the Complex Category Discussion feature in qListForm.
a) Hide out-of-the box web parts. From the web part drop-down, select
Edit Web Part
. From the Layout section, select the
Hidden
check box.
146
b) Add a qListForm web part. Open
ezEdit
.
c) For Form Type, select NewListItem to replace Default New Form from the out-of-the-box web part.
d) Create two more qListForm web parts. Open
ezEdit
. For Form
Type, select:
• DisplayListItem to replace Default Display Form from the out-of-the-box web part
• EditListItem to replace Default Edit Form from the out-of-the-box web part
qDiscussionView
8.
In each qListForm web part: a) select
Edit
from Display Fields and select
Edit
next to Category
(created in step 2).
b) select
Complex Category
as the Field Type. Enter a Complex
Category Index Site URL and List Name. This name must the same as the list name entered in Step 5 (in our example, Discussion
Categories).
You can now use qListForm to view, edit, and update complex categories and view discussion threads grouped by complex categories.
147
Quick Apps for SharePoint
148
qDynamicLayout
•
Overview
•
qDynamicLayout Tabs
•
qDynamicLayout Procedures
8
Quick Apps for SharePoint
Overview
The qDynamicLayout Web Part allows you to create a customized layout by placing multiple Web Parts and HTML elements on one page. This helps you manage page space more effectively.
qDynamicLayout Tabs
You can configure this Web Part through its tabs that are accessible through ezEdit. qDynamicLayout contains the following tabs:
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in “Common Tabs” on page 17.
Display Tab
When you open ezEdit in qDynamicLayout , the Display tab opens by default. The
Default tab contains the following editable sections:
•
•
•
Layout
The Tab Layout allows you to pick where to add the tabs and what the tabs should be named.
The following is an example of the XML string in the Layout section.
<FormLayout Type="Tab" Orientation="HorizontalTop">
150
qDynamicLayout
<Container ID="Test" Label="DiscussionView" Description="" />
</FormLayout>
The following are elements found in the Layout section.
ELEMENTS
ID
Label
Description
DESCRIPTION
Allows you to give an ID to each tab
The IDs can contain letters ([A-Z, a-z]), digits ([0-9]), hyphens ("-"), and underscores ("_") only.
Allows you to name each tab
Allows you to add a description to each tab, if necessary
View Setting
The View Setting section allows you to select in what tabs the Web Parts should appear and in which order. The following is an example of the XML String in the
View Settings section.
<ViewSetting>
<Content Type="WebPart" ContainerID="1">
<WebPart ID="g_59f7fda1_4405_45c8_bba0_f354db68bab8"
Type="DiscussionView" ClientId="MSOZoneCell_WebPartWPQ18" />
</Content>
</ViewSetting>
The following are elements found in the View Settings section.
ELEMENTS
Web Part Title
Web Part Type
Container
Tab ID
DESCRIPTION
Indicates the name the Web Part to be added
Indicates the type of Web Part to be added
If you have more than one qDynamicLayout Web Part, the Container indicates if a Web Part is already part of another qDynamicLayout Web
Part and the name of that qDynamicLayout Web Part. You cannot configure these Web Parts from another qDynamicLayout Web Part. You can configure only those Web Parts that are contained in the qDynamicLayout you are editing.
Allows you to select the tab where to add the Web Part. The Tab ID appears when you configure the IDs in the Layout section
151
Quick Apps for SharePoint
Skin Name
The Skin Name area allows you to select the skin name for the Web Part. If you have a custom skin, you can add it to the following folder:
• for SharePoint 2010: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\
Skins
• for SharePoint 2013: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\
Skins
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
qDynamicLayout Procedures
You can perform the following procedures using qDynamicLayout:
•
Configuring qDynamicLayout
If a Web Part is hidden or closed, you cannot add it to qDynamicLayout.
If you delete qDynamicLayout, only the qDynamicLayout container is deleted, the Web Parts contained within it are not.
You cannot configure the View Settings section until you have added a Web Part to a tab in qDynamicLayout.
To configure qDynamicLayout
1.
Add the qDynamicLayout Web Part to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
152
qDynamicLayout
You do not have to add a Web Part to a tab right away. You can add one later or add more Web Parts to the same tab.
To add a Web Part later or add more Web Parts to the same tab
1.
From Site Actions, select
Edit Page
.
2.
Select
Add a Web Part
.
3.
Select a Web Part and click
Add
.
4.
From qDynamicLayout Web Part, select
ezEdit
.
5.
From View Settings section, select
Edit
.
6.
Select the Web Part you just added.
7.
Select the Tab ID for the Web Part.
8.
Click
OK
.
– OR –
1.
From Site Actions, select
Edit Page
.
2.
From qDynamicLayout Web Part, select a tab.
3.
Select
Add a Web Part
.
4.
Select a Web Part and click
Add
.
5.
From qDynamicLayout Web Part, select
ezEdit
.
6.
From View Settings section, select
Edit
.
7.
Select the Web Part you just added.
8.
Select the Tab ID for the Web Part.
9.
Click
OK
.
You can configure a Web Part within a qDynamicLayout Web Part.
To configure a Web Part within a qDynamicLayout Web Part
1.
From Site Actions, select
Edit Page
.
2.
From qDynamicLayout Web Part, select a tab.
3.
From the tab, select
ezEdit
.
4.
Configure and save the Web Part.
153
Quick Apps for SharePoint
154
qExcelViewer
•
Overview
•
qExcelViewer Tabs
•
qExcelViewer Procedures
9
Quick Apps for SharePoint
Overview
qExcelViewer lets you view data in Microsoft Excel. The Excel viewer works in conjunction with the qListView.
If you would like to learn more, click here to watch the training video.
qExcelViewer Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qExcelViewer contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qExcelViewer, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Session Name
Show Header
DESCRIPTION
Allows you to enter the name of the Session variable where the Excel
Viewer expects to find all the information that has been set by a qListView. This name must match the Search Session Name in qListView.
Allows you to show the column name in the first row.
156
qExcelViewer
ELEMENT
Display Fields
DESCRIPTION
See
“Display Fields” on page 157 for more information.
Display Fields
This property defines the fields that should be displayed in the Excel spreadsheet.
This property is optional if the properties in the Custom Display section are specified. In that case, the default display for the search results is turned off and the custom display is used. You can also combine a custom display with the
Display Fields; for example, if you want to display the data in the grid and to provide the summary of the data or disclaimer using the custom display.
This property is an XML string in this format:
<Fields LookupThresholdControlSetting=”On”>
<Field Name="fieldName" [optional attributes]/>
<Field Name="fieldName" [optional attributes]/>
</Fields>
The Display Fields section contains the following:
ELEMENT
Lookup Threshold
Title
Align
Display Field Name
DESCRIPTION
Allows you to set how web parts behave in relation to the List View Lookup
Threshold in SharePoint Resource Throttling. The options are:
• Default — uses the option you have set in the Configuration Editor.
• On — searches all fields in lists, except Lookup fields.
• Off — searches all fields in lists, including Lookup fields.
• Explicit — searches only the fields explicitly defined in the web parts properties.
Allows you to set the title for the field header. This is useful if the real field name is too long and you want to abbreviate the title in the field header, or if you simply want to display a different title in the field header. If this attribute is not specified, the value specified in the Name attribute is used in the field header.
Allows you to set the alignment for the field.
Allows you to specify the name of a field in the cross-site list. You only specify this if the field that you are trying to display is a cross-site lookup field.
If you want to display multiple fields from the cross-site lookup field, use the Display Format.
157
Quick Apps for SharePoint
ELEMENT
Display Format
DESCRIPTION
Allows you to set the format of the value that is displayed in a cross-site lookup field. You use this attribute if you want to display values from multiple fields. You can use the field replacement expression <%Field%> to refer to a field. However, you must use the encoded form of the < and > characters, which are < and >, respectively, unless you use the Excel
Viewer Editor which will encode it automatically for you.
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — The field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
158
qExcelViewer
qExcelViewer Procedures
You can perform the following procedures using qExcelViewer:
•
Configuring qExcelViewer
To configure qExcelViewer
1.
Create a new blank page and give it an
.aspx
extension. This name must appear in the Excel Viewer URL property of qListView.
2.
Add qExcelViewer to your page.
3.
Open
ezEdit
.
The Display tab opens by default.
4.
Configure each element as needed and click
OK
.
5.
If needed, configure the elements in the other tabs.
6.
When done configuring each tab, click
OK
.
159
Quick Apps for SharePoint
160
qHelpLink
•
Overview
•
qHelpLink Tabs
•
qHelpLink Procedures
10
Quick Apps for SharePoint
Overview
qHelpLink provides a context-sensitive help functionality. The help link enables each page to be connected to a different help file or to no help file (in which case the help link will not be visible). This capability lets the site administrator or author issue the help files in stages.
If you would like to learn more, click here to watch the training video.
The help link information is stored in a SharePoint list. The SharePoint list for the help link should contain:
• Context ID
—
This field is mandatory. This is a single line of text that contains the identifier for the help URL.
• Help Url
—
This field is mandatory. This is a single line of text that contains the URL for the help file.
• Culture
—
This field is optional. You must have this field if you want to have a different Help URL for different culture. You can define different Help URLs with the same Caption ID but different Help URL.
You must leave the value for the default culture blank. For example:
CONTEXT ID
sites.mysite.default.aspx
sites.mysite.default.aspx
CULTURE HELP URL
id-ID defaultHelp.aspx
defaultHelp.id-ID.aspx
If your list uses different names for the fields, you must define the name in the
Context ID Field Name, Help Url Field Name, and Culture Field Name properties.
The Help URL field may contain an absolute or a relative URL.
You can create the source list easily by using the “Quest Help List” when you select Site Actions | More Options | Custom Lists. This will automatically create a list that contains all of the above fields.
162
qHelpLink
qHelpLink Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qHelpLink contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qHelpLink, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Site Url
List Name
Context ID
Context ID Field Name
Help Url Field Name
DESCRIPTION
Allows you to set the URL to the site that contains the list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Allows you to set the name of the list. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List Name.
Allows you to set the identifier to locate the help URL in the list.
Note:
Define a convention for the Context ID value that will make it easy for you to identify where the help URL is used. For example, use the page URL, remove the host name from the URL, and replace all /
(slash) with . (dot). Therefore, if the page URL is http://hostname/sites/mysite/default.aspx, the Context ID is sites.mysite.default.aspx
Allows you to set the name of the field containing the context ID. The default value is User Context ID.
Allows you to set the name of the field containing the message. The default value is Help URL.
163
Quick Apps for SharePoint
ELEMENT
Culture Field Name
Help Text
CSS Class
CSS Style
Target
DESCRIPTION
Allows you to set the name of the field containing the Culture. The default value is User Culture.
Allows you to set the text for the help link. The default value is Help.
You can replace this value with HTML such as <img border="0" title="Help" src="imageURL"> to display an image instead of text.
Allows you to set the CSS style for the help link. The default value is empty. You can define this as you would define the styles in a CSS class.
Allows you to set the CSS class name for the help link. The class name must be defined in an external CSS file. If defined, this priority takes precedence over the CSS Style class.
Allows you to define how the help file should be displayed. The default value is _blank, which means the help file opens in a new window.
Another alternative is the name of a frame or another window.
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — The field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
164
qHelpLink
ELEMENT
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
qHelpLink Procedures
You can peform the following procedures using qHelpLink:
•
Configuring qHelpLink
To configure qHelpLink
1.
Add qHelpLink to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
165
Quick Apps for SharePoint
166
qItemDisplay
•
Overview
•
qItemDisplay Tabs
•
qItemDisplay Procedures
11
Quick Apps for SharePoint
Overview
qItemDisplay displays the item that was put into a session variable by another web part, such as qListView or qListForm. If you want to select something from a large list, you can use a combination of qItemDisplay and qListView. qListView is used to select the item and qItemDisplay is used to display the item after it is selected. Because qItemDisplay is a row provider, you can use this web part to pass the selected item to qListForm to be consumed or to a qListView to filter the data.
qItemDisplay supports multiple languagesDynamic language switching and
Flash and JavaScript (HTML5) support. You can define different a Title for different languages using the Resource List and the Title Resource ID properties.
If you would like to learn more, click here to watch the training video.
qItemDisplay Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qItemDisplay contains the following tabs:
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
168
qItemDisplay
Display Tab
When you open ezEdit in qItemDisplay, the Display tab opens by default.The
Default tab contains the following:
ELEMENT
Session Name
Site URL
List Name
Display Field Name
Display Format
No Selected Item Message
No Selected Item Redirect
Url
Style
DESCRIPTION
Allows you to set the name of the session variable where qItemDisplay retrieves the selected item information. This name must be set to the same value as the name specified in the:
• Set Session Name attribute in the Viewed Lists property of the qListView if you use the listview to select the item.
• Set Session Name property of the qListForm if you use the List
Form to put the item into the session
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash (/) to denote the root path.
Allows you to set the name of the SharePoint list. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list, you can use a single dot (.) as the list name.
Allows you to set the name of the field that you want to display in the selector. The field name is case sensitive.
If you want to display information from multiple fields, use the
Display Format properties. The Display Field Name property is ignored if the Display Format property is defined.
Allows you to configure the format of the items that are displayed.
This property can contain a plain text value or a piece of HTML. You can use a field replacement expression (<%field name %>) to refer to a field name. For example, you can display Employee ID and
Employee Name as follows:
<strong>Employee ID</strong>: <%Employee ID %><br>
<strong>Employee Name</strong>: <%Employee Name%>
The item is displayed as:
Employee ID: 1001
Employee Name: John Smith
Allows you to set the message that is displayed if the qItemDisplay does not find the selected item information in the session variable.
The default value is No Item Selected.
Allows you to specify the URL to which the user is redirected if the qItemDisplay does not find the selected item information in the
Session. The page specified by this URL usually contains the web part to select the item.
Allows you to set the style for the display. The default value is empty. You can define this as you would define the styles in a CSS class.
169
Quick Apps for SharePoint
ELEMENT
CSS Class
DESCRIPTION
Allows you to set the CSS class name for the display. The class name must be defined in an external CSS file. If defined, this priority takes precedence over the CSS Style class.
Toolbar Appearance Tab
The Toolbar Appearance Tab contains the following:
ELEMENT
Toolbar Skin Name
Change Value Button Text
Change Value Button Icon URL
Change Value Button URL
DESCRIPTION
Allows you to enter the skin name for the toolbar.
Allows you to change the selected item that is displayed in qItemDisplay. Because qItemDisplay is read-only, the user must go to another page to change the value. That other page usually contains another web part, such as qListView. The Selected Item
Display provides a button in the toolbar to redirect the user to the Change Value page. This property defines the text for that button. The default value is Change Value. You may want to change this value to something else, for example, Change
Selected Project, or Change Selected Customer
Allows you to define the URL for the icon for the Change Value button. This property is optional if you do not want to have an icon on the button.
Allows you to define the URL for the change value page. If this property is not defined, the Change Value button will not be displayed.
Note:
This value is usually the same as the value in the No
Selected Item Redirect URL.
170
qItemDisplay
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — The field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
171
Quick Apps for SharePoint
qItemDisplay Procedures
You can perform the following procedures using qItemDisplay:
•
Configuring qItemDisplay
To configure qItemDisplay
1.
Add qItemDisplay to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
172
qListForm
•
Overview
•
qListForm Tabs
•
qListForm Procedures
12
Quick Apps for SharePoint
Overview
The qListForm replaces the Microsoft List Form web part. qListForm provides many features to create relationships among lists. The only native SharePoint capability that creates relationships between two lists is the lookup field.
However, the lookup field can only see one field from a list that resides in the same workspace. This limits your ability to create a sophisticated application across several workspaces.
With qListForm, you have the ability to:
• support different content type in the list
• support dynamic language switching and Flash and JavaScript
(HTML5)
• place the List Form in any page, including list-supporting forms, such as DispForm.aspx, EditForm.aspx, NewForm.aspx, and Upload.aspx.
• create, update, or display an item from lists in another site. The target list is defined using Site URL and List Name properties.
• define a custom toolbar button. You can associate the custom toolbar button with one or more actions. The list form has some pre-defined actions, such as Save, Delete, Copy or Move. You can also write your own custom action and hook it up with the list form.
• use various form types: DisplayListItem, NewListItem, EditListItem,
DisplayDocument, UploadDocument, CreateDocument and
EditDocument. This is defined in the Form Type property.
• filter a lookup/cross-site lookup field with another lookup/cross-site lookup field using the master-detail capability
• insert an image, upload documents, and do a spell-check using the
Rich Text Editor.
• customize the Rich Text Editor’s toolbar using Rich Text Editor Toolbar
Settings.
• create collapsible sections in the Rich Text Editor. For more
information, see “Creating and Editing Collapsible Sections” on page 218
.
• show or hide user fields based on the SharePoint group membership of the user.
• define whether to hide, show, enable, or disable a field, a group of fields or a tab in the list form based on the condition of the fields.
• create a new document and define the metadata for the new document, and enter the metadata for multiple file uploads.
174
qListForm
• redirect users after saving information: GoToNextPageUrl,
GoToSource and TrySourceThenNextPageUrl.
• define a different URL for the Save and Close button, Cancel button and the Edit Item button.
• create a new record or update records in dependent lists.
• ensure the referential integrity of the records in the dependent lists by preventing the deletion of the parent record.
• manage attachments in the List Form if the target list is attachment-enabled.
• insert an image as an attachment to the list item using the Image
Manager toolbar button.
• define a mask for the input. Enforcing the format increases the consistency and data correctness.
• create a description for each field in plain text or HTML.
• define a new title for the field.
• assign a fixed value to a field, and assign a formatted value to a field based on values in other fields.
• fill the value of a field from a value stored in the Session variable.
• create a cross-site lookup field. A cross-site lookup field is similar to the SharePoint lookup field, except it can look up multiple lists in any workspaces that are accessible from the current site by the current user.
• sort entries in the cross-site lookup field.
• auto-fill a field based on value of a field that belongs to a parent field.
The parent field can be a lookup field or a cross-site lookup field. This feature ensures data consistency and correctness when the value from the parent field is replicated in the target field.
• hide a field. A hidden field is processed during postback, but it will not be displayed.
• create a read only field.
• store the displayed, new, or updated items into the Session. This feature enables a List Form to communicate with another web part, such as qSelector in another page.
• display the options for multi-choice fields in multiple columns.
175
Quick Apps for SharePoint
• send an email while editing or creating an item using the List Form
Emailer.
The List Form Emailer requires you to put the MailSettings configuration in the web.config file. You have to do this because the List Form Emailer does not use the
SharePoint email capability due to its limitation of sending a maximum of 1000 characters.
The MailSettings configuration looks like the following (you only have to add the lines with bold font):
<configuration>
<configSections>
<sectionGroup name="QuestSoftware">
<section name="MailSettings" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089" />
</sectionGroup>
</configSections>
<QuestSoftware>
<MailSettings OutboundSmtpServer="Smtp server name or IP address"/>
</QuestSoftware>
</configuration>
• use IRowConsumer and IWebPartRow interfaces to auto-fill a certain field based on field in a consumed row.
The IRowConsumer interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled Consume Row From (Obsolete) in the web part Connections menu. Use the
IWebPartRow consumer implementation that is labeled with Get Row From.
The IWebPartRow consumer implementation is labeled with Get Row From in the web part Connection menu. This interface cannot be connected with the obsolete
IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete.
• use IRowProvider and IWebPartRow interfaces to provide a row to another web part, such as qListView or qSelector.
The IWebPartRow implementation is labeled with Send Row To in the web part
Connection menu. This interface cannot be connected with the obsolete IRowConsumer or IFilterConsumer implementation. Do not connect this new interface with the old interface that is marked obsolete.
The IRowProvider interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled Consume Row From (Obsolete) in the web part Connections menu. Use the
IWebPartRow consumer implementation that is labeled with Send Row To.
176
qListForm
• have certain fields or group of fields hidden, shown, disabled or enabled based on certain conditions.
If you would like to learn more, click here to watch the training video
.
User Permissions
In order for qListForm to work, the user must have a minimum set of permissions in their permission level.
FORM TYPE
NewListItem
UploadDocument
EditListItem
EditDocument
DisplayListItem
DisplayDocument
CreateDocument
MINIMUM SET OF PERMISSIONS
Item, Edit Items, View Items, View Pages, Browse User Information,
Open
Add Item, Edit Items, View Items, View Application Pages, View
Pages, Browse User Information, Open
Items, View Items, View Pages, Browse User Information, Open
Items, View Items, View Application Pages, View Pages, Browse
User Information, Open
View Items, View Pages, Open
View Items, View Application Pages, View Pages, Open
Add Item, Edit Items, View Items, View Application Pages, View
Pages, Browse User Information, Open
If you do not meet the above minimum requirements, you will see "Access is denied" message either when the list form is loaded or when it is saved.
177
Quick Apps for SharePoint
qListForm Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qListform contains the following tabs:
•
•
•
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qListForm, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Site URL
DESCRIPTION
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
If you want to connect the List Form with another web part in Microsoft
SharePoint Designer, the Site URL property must contain an absolute
URL.
178
ELEMENT
List Name
qListForm
DESCRIPTION
Allows you to enter the name of the SharePoint list or document library that is edited or displayed by this List Form. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list that contains the form, you can use a single dot (.) as the list name.
Note:
This only works if the qListForm is contained in the
NewForm.aspx, EditForm.aspx, DispForm.aspx or Upload.aspx. For example, if you are replacing the Microsoft List Form in the
NewForm.aspx of the Tasks list and you use a single dot as the List
Name, the List Name property of the qListForm is set to Tasks. If you want to save the list as a template and then add it somewhere else, the name of the new list might not be Tasks and using this relative list name will automatically pick up the new list name for the form.
179
Quick Apps for SharePoint
ELEMENT
Form Type
Form Layout
Display Fields
Custom Actions
DESCRIPTION
Allows you to choose one of the following:
• DisplayListItem — The form is used to display a list item (all fields is read only).
• NewListItem — The form is used to create a new item in the list.
• EditListItem — The form is used to edit a list item.
• DisplayDocument — The form is used to display a document metadata.
• UploadDocument — The form is used to upload a document into a document library.
• EditDocument — The form is used to modify a document metadata.
• CreateDocument — The form is used to create a new document in the document library in a similar manner as the NewListItem except it will display the "File Name" field as the first field in the form.
When you click the Save and Close button, a document is created and the metadata specified in the form is applied to the new document. After the document is created, the qListForm will append
EditDoc=1 HTTP parameter to the URL where the user is redirected to. If the redirected page contains a qListView, it will open up the newly created document. The target folder of the new document is specified by the RootFolder HTTP parameter in the URL. If the
RootFolder is not specified, the document is created in the root folder of the document library. The qListForm determines which template is used to create the new document using one of the following methods:
-By using the document template specified in the content type. The content type is specified by the ContentTypeId HTTP parameter in the URL. If the ContentTypeId is not specified, the default content type is used by the list form.
-The user can select a document template from a document library.
The 2 properties of the list form, Template List Site URL and
Template List Name, specify the Site URL and List Name of the doc library that contains the document template. When both are specified, the qListForm will display a drop-down menu above the
Field Name field that contains list of documents in that doc library.
The user can then select a document that will serve as a template for the new document.
When this property is set to DisplayListItem, EditListItem,
DisplayDocument, or EditDocument, the URL of the current page must contain an ID HTTP parameter to indicate the identifier of the item to be displayed or edited. The ID HTTP parameters are usually included by the listview when you click New Item in its toolbar or
View Properties or Edit Properties in its context menu.
.
See “Display Fields” on page 186
.
See “Custom Actions” on page 199
.
180
qListForm
ELEMENT
Custom Action Error
Display
Form Initialization
Actions
Form Component
Behavior
DESCRIPTION
Determines where the error message is displayed if the custom action throws an exception. The options are:
• Inline — the error message is displayed in the list form above the displayed fields.
• Popup — the error message is displayed in a popup dialog box.
• InlineAndPopup — the error message is displayed in a popup dialog box and inline above the displayed fields.
Allows the List Form to be automatically pre-populated when the Form
Type property is set to NewListItem, CreateDocument or
UploadDocument. The List Form will call the defined custom actions that are specified in this property.
The fields that cannot be automatically pre-populated are:
• Auto-fill field (fixed value, consume value from an HTTP parameter, calculated format, consume value from a session, consume row from a row provided by another web part, auto fill with a lookup or cross-site lookup field)
• BDC Column
• SI Column
• Complex category field
• Cross site lookup field
See the
“Custom Layout Help” on page 457
chapter on how to write a custom action to initialize the list form.
This property is an XML string in this format:
<FormInitialization>
<Action Name=”initial 1” Type="Custom"
Class="MyCompany.DevStudio.SampleFormInitializationAction,
MyCompany.DevStudio, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=451cac61f7ec4225" / >
<Action Name=”initial 2” Type="Custom"
Class="MyCompany.DevStudio.SampleFormInitializationAction2,
MyCompany.DevStudio, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=451cac61f7ec4225" / >
</FormInitialization>
Form initialization is a way to auto fill the form. It should not be used in conjunction with another auto fill method. If you do this, the result is unpredictable (that is sometimes the value from form initialization will take precedence, but sometimes the value from the other auto fill method will take precedence).
See “Form Component Behavior” on page 204
.
181
Quick Apps for SharePoint
ELEMENT
Save Button Click
Action
Next Page URL
Cancel Button Click
Action
Go Back URL
DESCRIPTION
Determines what will happen when the user clicks the Save and Close button on the toolbar. These are the choices for this property:
• GoToNextPageUrl — Go to the page specified in the Next Page URL property. You can use this option if you always want the user to go to the same URL every time they save the form.
• GoToSource — Go to the page specified in the Source HTTP parameter. For this option to work, the URL of the current page must contain the Source HTTP parameter (http://...?Source=...).
This option will give you the same behavior as the Microsoft List
Form. If you open the form using qListView, the listview automatically sets the Source HTTP parameter for you. If you use this option and the Source HTTP is not in the URL, the list form will give you an error.
• TrySourceThenNextPageUrl — Go to the page specified in the
Source http parameter if one exists. If not, go to the page specified in the Next Page URL property. This option is the most commonly used one. Most of the time, you want to go the URL specified in the
Source HTTP parameter. However, if that parameter is not available
(for example, the user may type in the URL directly in the address bar), you want to have an alternative URL to go to.
Allows you to set the page to go to when the user clicks the Save and
Close button on the toolbar if the Save Button Click Action property is set to GoToNextPageUrl or TrySourceThenNextPageUrl.
Determines what will happen when the user clicks the Cancel button on the toolbar.
• SameActionAsSaveAndClose — This is the default value. You may want to select another option if you want the Cancel button to behave differently than the Save and Close button. This option is useful if you want to guide the user through a series of steps when doing data entry. For example, when user is in Form1, clicking Save and Close will bring them to Form 2 while clicking Cancel button will bring them back to the home page.
• GoToGoBackUrl — Go to the page specified in the Go Back URL property. You can use this option if you always want the user to go to the same URL every time they save the form.
• GoToSource — Go to the page specified in the Source HTTP parameter. For this option to work, the URL of the current page must contain the Source HTTP parameter (http://...?Source=...).
This option will give you the same behavior as the Microsoft List
Form. If you open the form using qListView, the listview automatically sets the Source HTTP parameter for you. If you use this option and the Source HTTP is not in the URL, the list form gives you an error.
• TrySourceThenGoBackUrl — Go to the page specified in the Source http parameter if one exists. If not, go to the page specified in the
Go Back URL property. This option is the most commonly used one.
Most of the time, you want to go the URL specified in the Source
HTTP parameter. However, if that parameter is not available (for example, the user may type in the URL directly in the address bar), you want to have an alternative URL to go to.
Allows you to set which page to go to after the user clicks the Cancel button on the toolbar if the Cancel Button Click Action property is set to
GoToGoBackUrl or TrySourceThenGoBackUrl.
182
qListForm
ELEMENT
ID HTTP Parameter
Name
Edit Form URL
Display Form URL
Dependent Lists
Set Session Name
Reset Session Name
Display Attachment
Field
Display Creation and
Modification Info
DESCRIPTION
Allows you to set an ID to identify the item to be displayed or edited.
This HTTP Parameter is usually generated automatically by the viewer webpart, such as qListView or qCalendarView, when the user selects an item to be displayed or edited.
However, if qListForm is placed on a webpart page that is contained within a document library, the page will generate an error if the value of the ID HTTP Parameter is bigger than the number of pages within the document library. To prevent this error from happening, rename the ID
HTTP Parameter.
By default, the value of this property is "ID". You can change the value of this property to something else, such as LID. In that case, the qListForm will get the ID of the item to be displayed or edited from the HTTP
Parameter called LID.
Allows you to set the page to go to after the Edit Item button is clicked.
If not defined, the user will redirected to the EditForm.aspx of the list.
Note:
The Edit Item button will show up when the Form Type is set to
Display Item or Display Document and the Show Edit Button property is set to true.
Displays the history of changes in the Multiple Lines of Text field when the Append Changes to Existing Text setting in the field is turned on. The user can click one of the texts in the history list to view that version of the text. This property define the URL of the Display Form to display previous version of the text. If this property is not defined, the default
Display Form of the list is used.
See “Dependent Lists” on page 208
.
Defines the name of the session variable where:
• The edited or newly created item is stored when it is saved.
• The item that is being displayed or edited is stored when it is loaded.
Use the list form to display a Task and a listview underneath it to display
Task Serial Notes. The list form will filter the listview so that the listview will only show the serial notes for the displayed task. When you click the
New Item button to create a new task serial notes, you want some of the fields in the task serial notes to be auto-filled with the fields from the current task. In that case, you set the session name in the list form so that the current task is stored in the session and you can consume it in the new form for the task serial notes.
Allows you to reset the List Form (set to NULL) the value of the session variable whose name is specified in this attribute. You can specify multiple names by separating them with commas.
Indicates whether or not the Attachment field should be displayed. Even though you set this property to true, the attachment field is only displayed if the attachment capability is enabled in the list setting. The attachment field is also not shown for a document in a document library
Indicates whether or not the creation and modification info at the bottom of the list form should be displayed. The creation and modification information is only displayed when the list form's Form Type is set to
EditListItem, DisplayListItem, EditDocument or DisplayDocument.
183
Quick Apps for SharePoint
ELEMENT
Display Required Fields
Message
Enable Multiple File
Upload
Check Overwrite
Existing File Checkbox
Show Save File as
Textbox
Enable AJAX
Template List Site URL
Template List Name
Hide Parent Folder
Name
DESCRIPTION
Allows you to set required fields" message at the top of the list form is shown. If set to false, the message is hidden. By default, this property is set to true. The required fields message is only displayed when the list form is in new or edit mode regardless of the value of this property.
Determines whether or not the multiple file upload capability in the list form is enabled when the Form Type is set to UploadDocument. If set to true, the multiple file upload capability is enabled. If set to false, the multiple file upload capability is disabled and the user can only use the single file upload interface to upload a file.
Determines the default value of the Overwrite Existing File checkbox in the upload document form. This check box is only available when you set the Form Type to UploadDocument. By default, the Overwrite Existing
File checkbox is checked. Set this property to false to clear the Overwrite
Existing File checkbox by default.
Enables you to show the Save File As textbox when you are uploading a single document using the List Form. The Save File As textbox enables you to rename the file during upload, just in case the document library already contains a file with the same name. By default, this property is set to false.
Allows you to enable AJAX. If you turn off AJAX, the list form has to refresh the whole page (as opposed to just refreshing the list form) when a certain operation occurs, such as a postback from a lookup field.
There is a known issue in the SharePoint People Editor control where it cannot persist its value during AJAX operation. The SharePoint People
Editor control is used when you set the Use People Editor attribute of a
People and Group field to true. Therefore, AJAX needs to be disabled when the People Editor control and an auto-postback lookup field exist in the form.
Allows you to specify the List Name of the document library that contains the document template that is used to create a new document when the
Form Type is ‘CreateDocument’.
When both the Template List Site URL and the Template List Name are specified, the qListForm will display a drop-down menu above the Field
Name field that contains list of documents in that doc library. The user can then select a document that will serve as a template for the new document.
Allows you to specify the Site URL of the document library that contains the document template that is used to create a new document when the
Form Type is ‘CreateDocument’
Allows you to hide the parent folder name. When the qListForm uses a
Document Library to Edit/Display an item, the parent folder name shows up on the top.
Form Layout
This property enables you to define the layout of the fields in the List Form. If this property is not defined, the List Form will display the fields in two column format: the first column is the field title and the second column is the control for the field.
184
qListForm
This property is related to the Display Fields Property. The Form Layout property defines the layout type and the containers. In order to place a certain field in a specific container, you will use the ContainerID attribute of the Field element in the Display Fields Property.
The Form Layout section contains the following:
ELEMENT
Form Layout Type
DESCRIPTION
Allows you to select one of the following tabs:
• Tab Layout — groups the fields in multiple tabs.
You can add tabs to this layout by setting values for the following:
-ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields
Property.
-Label — the label for the container. Otherwise, if the container needs a label, it will use the ID.
-ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas.
-HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the
HideUserGroups and ShowUserGroups.
• Custom Layout — uses the custom layout manager class specified in the
LayoutManagerClassName attribute to layout the fields. Using the custom layout, you can write your own custom Layout Manager where you can layout the fields in any way you want it or even create your own custom controls in the form. For more detail on how to write your own
custom Layout Manager class, see “Custom Layout Help” on page 457 .
You can add containers to this layout by setting values for the following:
-ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields
Property.
-Type — they type of container.
-Label — the label for the container. Otherwise, if the container needs a label, it will use the ID.
-ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas.
-HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the
HideUserGroups and ShowUserGroups.
185
Quick Apps for SharePoint
ELEMENT
Form Layout Type
DESCRIPTION
• MultiColumn Layout — display the data in multiple columns. You can select the number of columns, and select if you want to render and control in a single row (displays the Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.)
• Tab and MultiColumn Layout — groups the fields in multiple tabs and in multiple columns in each tab.
You can add tabs to this layout by setting values for the following:
-ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the ContainerID attribute of the Field element in the Display Fields
Property.
-Label — the label for the tab. Otherwise, if the container needs a label, it will use the ID.
-ShowUserGroups — the tab is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple
SharePoint group names here by separating them with commas.
-HideUserGroups — the tab is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple
SharePoint group names here by separating them with commas. The
HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and
ShowUserGroups.
-Render and Control in a single row — the tab displays the Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.
Display Fields
This property defines what fields should be displayed in the List Form and how the fields are populated.
When you select the Edit button, a dialog box opens with a list of field names based on the list you have selected. You can enter a title and description for each field name.
You can add more details to the field names.
ELEMENT
Field Name
Title
DESCRIPTION
Displays the field name.
Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
186
qListForm
ELEMENT
Title Resource ID
Tooltip
Tooltip Resource
ID
Description
Description
Resource ID
Width (in pixels)
Column Span
Row Span
Hidden
Group Name
Column Count
Hide Select and
Unselect All
DESCRIPTION
If supporting a multi-lingual site, you may want to display a different Title for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The TitleResourceID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default Title is used.
Allows you to set the text that is displayed in the tooltip when you hover your mouse over the control for the field in the list form. If you do not specify this attribute, the display name of the field is used as the tooltip text.
If supporting a multi-lingual site, you may want to display a different tooltip for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The Tooltip
Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default tooltip is used.
Allows you to set the field description. It can be a plain string or an encoded
HTML string. The Description is added below the field value.
If supporting a multi-lingual site, you may want to display a different description for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field.
The Description Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier is not found, the default description is used.
Allows you to set the width of the control in pixels.
Note:
Some controls, such as the Rich Text Editor, have minimum width and it will not honor the specified width if it is smaller than its minimum width.
Allows you to set the span of the column.
Allows you to set the span of the row.
Allows you to hide the field.If the field is hidden, the List Form will not modify that field at all. If you hide the field using the Hidden attribute, the field is processed according to the way it is defined, but it will not be shown in the
List Form.
Allows you to create dynamic behavior for a group of fields. The list form can be defined to have dynamic behavior where certain fields or group of fields can be hidden, shown, disabled, or enabled based on certain conditions. The value in the Group Name field is referred to in the Form Component Behavior property.
Allows you to define the number of columns that the choices for the multi-choice field should be broken into. This is useful if you have many choices in your multi-choice field to minimize the vertical scrolling when entering the data into the list form. This attribute is ignored if the field is not a multi-choice field.
Allows you to hide the Select All and Unselect All links in the multi-choice field control. If not specified, the Select All and Unselect All links are shown by default. This attribute is ignored if the field is not a multi-choice field.
187
Quick Apps for SharePoint
ELEMENT
Auto Post Back
Use People Editor
Use Current User as Default Value
Do not Render as
Hyperlink
Disable Resize
Expand Options on Load
Show User
Groups
Hide User Groups
DESCRIPTION
If selected, allows the control to refresh the form when its value changes.
This attribute is applicable for the following field types: Lookup field,
Cross-site lookup field, Yes/No and Choice. This attribute is ignored for other field types. This attribute should be set to true in the following scenarios:
• When a lookup field or cross site lookup field is defined as the Parent
Field of another field.
• When a lookup field, cross site lookup field, Yes/No, or choice field is being used in the conditions of the Form Component Behavior property.
If selected, allows the qListForm to display the People Editor control for the
People and Group field. With the People Editor control, you can lookup any user in your directory service. By default, the value is false. If set to false, the qListForm will display the users from the site user list.
This attribute only effects the People and Group field. It is ignored for any other fields.
Note:
There is a known issue in the SharePoint People Editor control where it cannot persist its value during AJAX operation. Therefore, you need to set
Enable AJAX property to false when you use the People Editor control and have an auto-postback lookup field in the form.
If selected, allows the name of the current user to become the default value of the People and Group field when the Form Type is set to New List Item or
Upload Document. This attribute is ignored if the Form Type property is set to another value or when the field is not a People and Group field. By default, the value is false.
This attribute affects the display of the Person or Group field, the lookup field or the cross-site lookup field when the Form Type is set to Display List Item or Display Document. If set to true, the value of those kinds of field is rendered as plain text instead of hyperlink.
This attribute determines whether or not the Rich Text Editor for the Rich Text
Field can be resized. To resize a Rich Text Editor, you can drag the resize handle in the lower right hand corner of the editor. The resize handle is hidden when this attribute is set to true.
Allows you to expand the list of users or options when selected.
Allows you to list SharePoint groups whose members can view the web part.
Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the web part. Separate site group names with commas (for example, Administrators,
Readers).
If users are defined in Show User Groups and Hide User Groups, Hide Groups takes precedence.
188
qListForm
ELEMENT
Mask
Prompt Character
Parent Field
Parent Filter Field
Name
Filter Field Name
Field Type
DESCRIPTION
Allows you to define the format of the input for a single line of text field. This property is ignored for another field type. The mask can contain characters and input-mask-flags such as:
# — digit or space, optional. If this position is blank in the mask, it is rendered as a prompt character.
L — uppercase letter, optional. Restricts input to the ASCII letters A-Z.
l (lower case L) — lowercase letter, optional. Restricts input to the ASCII letters a-z.
a — accepts any character
<n..m> — restricts the user input to the declared numeric range, for example: <0..255>. The numeric range mask part must occupy multiple characters of the mask.
<option1|option2|option3> — restricts user input to one of the set options, for example: <Sun|Mon|Tue|Wed|Thu|Fri|Sat>.
\ — escapes a mask character, turning it into a literal. "\\" is the escape sequence for a backslash.
All other characters — all non mask elements will appear as themselves.
Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user.
Allows you to define the character that is displayed and saved in place of the empty characters when you specify a Mask. If not specified, "_" (underscore) is used as the default prompt character. Specify only a single character in this attribute.
Allows you to define another lookup or cross-site lookup field that is used to filter this field. The parent field must be listed before this field in the XML property.
Allows you to define the field in the parent field that is used to filter this field.
In other words, it is the primary key in the list that is used in the lookup or cross-site lookup field.
Allows you to define the field in the list that is used by this lookup or cross-site lookup field that is filtered by the parent filter field.
Allows you to select a field type. More options are available depending on the field type selected. The default is regular field. See the following fields for more information:
•
•
Consume Value from an HTTP Parameter
•
•
Autofill with a lookup/cross-site lookup field
•
Consume value from a row provided by another web part
•
•
•
•
•
Fixed Value
You can assign a fixed value to a field using the FixedValue attribute.
189
Quick Apps for SharePoint
For example, to assign Accounting to the Department field:
<Field Name="Department" FixedValue="Accounting"/>
Additionally, you can use special variables for the FixedValue attribute.
• <CurrentUserID/>
— this value is replaced by the ID of the currently logged in user. If you want to assign the current user to the People and Group field, use this variable. For example, if you'd like to assign a task to the currently logged in user, you can specify the following
Field element: <Field Name="Assigned To"
FixedValue="<CurrentUserID/>" />
• <CurrentUserName/>
— this value is replaced by the name of the currently logged in user.
• <CurrentUserEmail/>
— this value is replaced by the email of the currently logged in user.
• <CurrentLoginName/>
— this value is replaced by the login name of the currently logged in user. The login name is usually in the form of domain\username.
• <Today/>
— this value is replaced by today's date.
• <Now/>
— this value is replaced by the current date and time.
You can edit the following:
ELEMENT
Allow Edit
DESCRIPTION
Allows you to edit the fixed value field.The value that is retrieved from the
Fixed Value attribute will only be used to initialize the field. Afterwards, the user can modify the value as they wish and save it.
Consume Value from an HTTP Parameter
The HTTP Parameter Consumer field gets its value from an HTTP parameter. This is the attribute to create an HTTP Parameter Consumer field:
ELEMENT
Consume HTTP
Parameter Name
Allow Edit
DESCRIPTION
Allows you to enter the name of the HTTP parameter whose value is to be consumed.
Allows you to edit the fixed value field.The value that is retrieved from the
Fixed Value attribute will only be used to initialize the field. Afterwards, the user can modify the value as they wish and save it.
For example, the URL of the current page is:
190
qListForm
http://www.mysite.com/page1.aspx?InitTitle=NewItem
You may specify the following Display Fields property in order to initialize the
Title field with the InitTitle HTTP parameter:
<DisplayFields>
<Fields ContentType="Task">
<Field Name="Title"
ConsumeHTTPParameterName="InitTitle" />
</Fields>
</DisplayFields>
Calculated Format
You can format a value of a field using values from other fields by using the
CalculatedFormat attribute. The value of the another field can be referred to using the <%fieldName%> field replacement expression. You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Display Fields editor in the List Form Editor, where the Editor will encode the characters automatically for you.
For example, if you want to format the Full Name field as Last Name, First Name, the Field element should be specified as:
<Field Name="Full Name" CalculatedFormat="<%Last Name%>,
<%First Name%>" />
Another example is to assign a ten-digit number to the AccountNumber field using the ID of the list item. If the ID is less than 10 digits, it is padded with zeros.
<Field Name="AccountNumber" CalculatedFormat="<%{0:0000000000}
ID%>"/>
This attribute can also be used to make a field read-only. For example, to make the AccountNumber a read-only field:
<Field Name="AccountNumber"
CalculatedFormat="<%AccountNumber%>" />
Autofill with a lookup/cross-site lookup field
The Auto Fill field gets its value from the parent field. The parent field must be a lookup field or a cross-site lookup field.
191
Quick Apps for SharePoint
The following are the attributes to create an auto-fill field:
ELEMENT
Parent Field
DESCRIPTION
Allows you to defines the name of the parent field. The parent field must be specified before any of the child fields.
Allows you to define the field in the parent field where the value comes from Auto Fill Display
Field Name
Auto Fill Display
Format
Allow Edit
Allows you to define the string format for the values. This attribute takes precedence over the Auto Fill Display Field Name attribute. The format of the
Auto Fill Display Format is the same as the format used in the Calculated
Format attribute.
Allows you to define if this field is editable. By default, the list form displays this field type as a non-editable field. If this attribute is set to true, this field is editable.
For example, a List Form is used to edit the Employee list. Manager is a field in the Employee list, and it is a lookup field. Two other fields, ManagerFirstName and ManagerLastName, are filled based on the row selected in the Manager field.
The Fields element for the Manager, ManagerFirstName,and ManagerLastNam
e
will look like the following:
<DisplayFields>
<Fields ContentType="Employee">
<Field Name="Manager" AutoPostBack="true"/>
<Field Name="ManagerFirstName" ParentField="Manager"
AutoFillDisplayFieldName="FirstName"/>
<Field Name="ManagerLastName" ParentField="Manager"
AutoFillDisplayFieldName="LastName"/>
</Fields>
</DisplayFields>
Set the AutoPostBack attribute to true in the parent field. Otherwise, the
ManagerFirstName and the ManagerLastName fields will not be refreshed when the user selects another manager.
Consume value from a row provided by another web part
The row consumer field gets its value from the row that is consumed by this List
Form. To create a row consumer field, you must connect the List Form with another web part that implements the IRowProvider interface (such as the qSelector or qMultiSelectors).
192
qListForm
These are the attributes to create a row consumer field:
ELEMENT
Consume Row
Display Field
Name
Consume Row
Display Format
DESCRIPTION
Allows you to defines the field name in the row from where the value comes.
Allow Edit
Allows you to define the string format for the values. This attribute takes precedence over the Consume Row Display Field Name attribute. The format of the Consume Row Display Format is the same as the format used in the
Calculated Format attribute.
Allows you to define if this field is editable. By default, the list form displays this field type as a non-editable field. If this attribute is set to true, this field is editable.
For example, a List Form is used to edit a Tasks list. The Tasks list contains a
Project Name field, and this field is configured as a row consumer field. The row is provided by a qSelector web part that displays the list of projects from the
Projects list and is connected to the List Form.
<DisplayFields>
<Fields ContentType="Task">
<Field Name="ProjectName"
ConsumeRowDisplayFieldName="Name"/>
</Fields>
</DisplayFields>
Consume value from a session
Session consumer field gets its value from a row that is stored in the session object. The concept is similar to Row Consumer Field Attributes. However, if you need to get values from multiple providers, you must use the Session Consumer
Field instead of Row Consumer Field because the List Form can only be connected to one row provider.
To create a session consumer field, you must first declare a Sessions element.
A Sessions element can contain one or more Session elements. The Sessions element contains the information about the list where the row stored in the session comes from. After the Sessions element is defined, you can use it in the
Field element. The XML for the session consumer field looks like the following:
<DisplayFields>
<Sessions>
<Session Name="sessionName" SiteUrl="siteUrl"
ListName="listName"/>
</Sessions>
<Fields ContentType="contentType1">
<Field Name="field Name"
193
Quick Apps for SharePoint
ConsumeSessionName="sessionName"
ConsumeSessionDisplayFieldName="displayFieldName"/>
</Fields>
</DisplayFields>
These are the attributes to create a row consumer field:
ELEMENT
Name
Site URL
List Name
Consume Session
Display Field
Name
Consume Session
Display Format
Allow Edit
DESCRIPTION
Allows you to enter the name of the session you want to consume.
Allows you to enter the URL of the list site.
Allows you to enter the list name.
Allows you to defines the field name in the session from where the value comes.
Allows you to define the string format for the values. This attribute takes precedence over the Consume Session Display Field Name attribute. The format of the Consume Session Display Format is the same as the format used in the Calculated Format attribute.
Note:
If you select New List Item type as Form type, leave this field blank unless it is in simple text format.
Allows you to define if this field is editable. By default, the list form displays this field type as a non-editable field. If this attribute is set to true, this field is editable.
You can replace the Consume Session Display Field Name attribute with
Consume Session Display Format if you want to use multiple fields as the source of values for this field.
For example, a List Form is used to edit a Tasks list. The Tasks list contains a
Project Name field, and this field is configured as a session consumer field. The row is provided by a qSelector web part in another page that is visited before this page is opened.
<DisplayFields>
<Sessions>
<Session Name="ProjectsSession" SiteUrl="../../.."
ListName="Projects" />
</Sessions>
<Fields ContentType="Task">
<Field Name="ProjectName"
ConsumeSessionName="ProjectsSession"
ConsumeSessionDisplayFieldName="Name"/>
</Fields>
</DisplayFields>
194
qListForm
Lookup Field
You can sort and filter the entries for the Lookup fields by using the Sort Field and CAML Filter attributes, respectively. These attributes are ignored if the field is not a lookup field.
For example, if you want to sort the Related Task lookup field by its title and only want to show high priority tasks, you can specify the following configuration:
<Field Name="Related Task" SortField="Title"
CamlFilter="<Eq>
 <FieldRef Name="Priority"
/>
 <Value Type="Choice">(1)
High</Value>
</Eq>" />
Cross-site Lookup
Cross-site lookup is the capability of the List Form to refer to multiple lists in different sites.
To use this feature, create a single-line-of-text field, not a lookup field.
Internally, the List Form will store the field value in this format: siteUrl;#listName;#listItemId.
For example, add a Document Type field to the metadata of every document that you store in the document library. One way of doing this is to make this field a choice field. However, if you need to change the options for the Document Type, you have to go to every document library in every site to change it. The same problem occurs if you make the Document Type field a SharePoint lookup field
(because SharePoint can look up a list in the same site). The solution is to make the Document Type field a cross-site lookup field. You can create a Document
Type list in a centralized place and create a DocumentType field (as single line of text field) in every document library. Configure this field as:
<Field Name="DocumentType" DisplayFieldName="Type"
SortField="Type" AutoPostBack="true">
<List SiteUrl="../../.." SiteName="Dashboard"
ListName="DocumentType" />
</Field>
The Display Field Name attribute can be replaced with Display Format attribute if you want to display multiple fields in the drop-down menu. The value of the
Display Format attribute is in the same format as that of the Calculated Format attribute.
The above configuration assumes the following conditions:
• The DocumentType list resides three levels above the current page
(indicated by ../../.. in the Site URL attribute).
195
Quick Apps for SharePoint
• The Document Type list contains one field called Type that contains the text for the document type, such as Budget, Proposal, Manual.
• You want to display the document types sorted alphabetically using the Sort Field attribute. If you do not specify the Sort Field, the document types are sorted in the order they appear in the list; sorted by list item ID.
• The Site Name attribute is a text description of the Site URL. It does not have to match with the real name of the site pointed to by Site
URL.
• You want the form to be refreshed every time you select another item by specifying AutoPostBack="true". This is necessary if this field is a parent field of other fields in the form and the child fields are visible.
Otherwise, it is optional.
You can specify more than one List element inside the Field element. If you do, the List Form will display two dropdowns. The first drop-down menu selects the list and the second drop-down menu selects the items in the list. This function makes the Site Name important because the first drop-down menu displays the list as List Name in SiteName.
System Integration
System Integration (SI) field gets its values from a data column accessible through the System Integration Framework
—
the same mechanism used by SI
Web Parts to connect to external data sources.
In order to use the SI Field, the qListForm should be added to a web part page which belongs to a SharePoint site that has System Integration configuration defined. It also requires that the Catalog property be defined prior to specifying the SI Field.
The required attributes for a field of this type:
ELEMENT
Entity Name
Operation Name
Data
Member/Data
Index
DESCRIPTION
Allows you to specify which entity to use from Catalog property.
Allows you to specify which entity operation to use from Catalog property to retrieve the options from the external system. The syntax for the operation is
EntityName.OperationName. Both the entity and the operation must already be defined in the Catalog property.
Allows you to specify the data table name that contains the options in case the operation returns multiple tables. If the external system returns multiple data tables without names, you can use the DataIndex attribute to refer to the table. The index is a number and it starts with 0 (not 1).
196
qListForm
ELEMENT
Data Text Field
Data Value Field
Secondary Field
Name
Data Value Field
Eliminate
Duplicate Values
DESCRIPTION
Allows you to specify the column in the data table whose value is displayed in the drop-down menu.
Allows you to specify the column in the data table that contains the real value that should be saved back to the external system.
Note:
Define the DataTextField/DataValueField to be the primary key column for your external data and any other columns as the source for the secondary fields to ensure data integrity; however, it is not required.
Allows you to specify an additional column in the data table whose value is displayed in the drop-down menu. This is an optional field. Secondary fields are elements under the regular display field so you can specify one or more fields. These fields is read-only.
Allows you to specify the column in the data table from which the actual value is used that is associated with the displayed Secondary Field.
Allows you to specify whether you want to eliminate duplicate values in the drop-down menu.
197
Quick Apps for SharePoint
ELEMENT
Use Item Picker
DESCRIPTION
Allows you to specify whether to use an entity item picker or a drop-down list to display the System Integration column. The default is to use the drop-down list. If you select to use the item picker, you may specify zero or more Finder Operations to be used by the entity item picker. The Finder
Operation references the entity.operation defined in the System Integration
Catalog property. You can define one or more entity/operation in the Catalog to help filter the data returned from the external system. Select the Add
Operation button to add a Finder Operation:
-Finder Operation — specifies a valid entity and operation defined in
Catalog property to be used in the LookupOperation.
-Filter Field — the field name to be used for filtering. If the operator takes an argument, the filtering happens in the back-end server. If not, the filtering happens in the web server by using the data view filter.
The filter field name is also used to match the finder operation during the item picker search.
-Data Member/Data Index — defines the data table name that contains the options in case the operation returns multiple tables. If the external system returns multiple data tables without names, you can use the
DataIndex attribute to refer to the table. The index is a number and it starts with 0 (not 1).
The Item Picker option provides the ability to filter a large amount of data before bringing the filtered data into the list form. The default, drop-down list, option will bring all the data over to SharePoint and display it all in a list.
Make sure to take into account the amount of data that is returned when deciding the best option to display SI column data using drop-down menu or item picker.
Here is an example:
<DisplayFields>
<Sessions />
<Fields ContentType="Task">
<Field Name="Title" />
<Field Name="Priority" />
<Field Name="Status" />
<Field Name="AWEmployeeID"
LookupOperation="Product.EmployeeList" DataMember="row"
DataTextField="LoginID" DataValueField="EmployeeID">
<SecondaryField Name="AWContactID"
DataValueField="EmployeeID" />
<SecondaryField Name="AWLoginID"
DataValueField="LoginID" />
</Field>
</Fields>
</DisplayFields>
198
qListForm
Complex Category
The Complex Category field allows the SharePoint discussion view webpart to function like the Lotus Notes response document which contains a category attribute.
Categories that allow multiple values are not supported.
The attributes for a field of this type:
ELEMENT
Edit Mode
Complex
Category Index
Site URL
Complex
Category Index
List Name
Height
Expand to Level
DESCRIPTION
Allows you to define how the treeview for the complex category control should be displayed. There are two options:
• Inline — the treeview control is displayed in the form itself which enable the user to assign and edit the complex category values directly in the form
• Popup — the treeview control will display the complex category value as a read only field with and Edit link. When the user clicks the Edit link, it will display the treeview in a popup dialog box. The Popup option is recommended if you have many categories to be displayed in the treeview.
Allows you to index the Complex Category field. Another SharePoint list is used to store the index. The Complex Category Index Site URL is the site URL of the index list. If not defined, the Complex Category Index Site URL will default to the current site URL.
Allows you to set the list name of the index list. If not defined, the Complex
Category Index List Name will default to the name of the discussion list plus
Categories. For example, if your discussion list name is Team Discussion, then the index list name is Team Discussion Categories.
Allows you to define the height of the complex category control in pixels. If not specified, it will always fit the whole categories in the form without a scrollbar
Allows you to define the number of category levels that can be expanded when the complex category control is loaded for the first time.
Custom Actions
This property enables you to define additional buttons in the toolbar. You can program that button to do a series of actions. The list form supports some built-in actions. However, you can write your own custom action using one of the
.NET languages, compile it and have it called by the list form.
Custom actions allows you to:
199
Quick Apps for SharePoint
• Add a second save button that will go to different page than the default save button.
• Validate the data with your own logic before saving it. You can cancel the operation if the data fails the validation.
• Copy a document library to another document library after it is saved.
• Create a custom toolbar item to start a workflow.
• With the ability to write your own custom action, you can virtually do anything to the data when you click the custom button that you define.
Here are the schema of this property:
<CustomActions>
<Toolbar>
<ActionItem ID="UniqueID" Text="text"
TextResourceID="textResourceID" Position="0"
PromptText="promptText"
PrompTextResourceID=”prompTextResourceID” ImageUrl=”URL”
AccessKey=”AccessKeyCharacter”>
<Action Type="Save" />
<Action Type="Delete" />
<Action Type="Move" TargetFolder="targetFolder"
TargetSiteURL="targetSiteUrl"
TargetListName="targetListName" />
<Action Type="Copy" TargetFolder="targetFolder"
TargetSiteURL="targetSiteUrl"
TargetListName="targetListName" />
<Action Type="GoToURL" URL="TargetURL">
<Parameter Name="parameterName"
Source="Session" SourceName="fieldName"
SessionName=”sessionName” />
<Parameter Name="parameterName"
Source="RowFromAnotherWebPart" SourceName="fieldName" />
<Parameter Name="parameterName"
Source="HttpRequest" SourceName="httpParameterName" />
<Parameter Name="parameterName"
Source="ListItem" SourceName="fieldName" />
</Action>
<Action Type="GoToSource"/>
<Action Type="Custom" Class="IUIActionImpl" />
</ActionItem>
</Toolbar>
</CustomActions>
The Custom Actions element contains one Toolbar element. The Context Menu element can contain one or more Action Item element. You can associate the
Action Item with one or more Action elements. The Action element defines a certain operation that is carried out by the toolbar button when it is clicked.
200
qListForm
The Custom Actions section contains the following:
ELEMENT
IsSeparator
ID
Text
Text Resource ID
Position
Prompt Text
Prompt Text Resource ID
Perform Validation
Image URL
Access Key (Toolbar Only)
Position
Show User Groups
DESCRIPTION
Allows you to set the item as a separator.
Allows you to enter a unique ID that will identify the item. Use a descriptive identifier to configure the action item with the editor.
Allows you to enter how the action item is displayed in the toolbar.
Allows you to define this property if you support a a multi-lingual site. This attribute defines the identifier of the string in the Resource
List that is used as the text of the web part. The Text Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the value in the Text attribute is used.
Allows you to define the position of the button in the toolbar. The index starts with 0 (not 1).
Allows you to prompt the user to click the toolbar button or the context menu item.
Allows you to define this property if you support a multi-lingual site.
The property defines the identifier of the string in the Resource List that is used as the prompt text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
Allows you to perform validation on the form, such as making sure all the required fields are filled in, before the form is submitted.
Perform a validation if you are creating a button that will update the data. You do not need to set this to true if you are creating a cancel button or a button to redirect user to another page. When this
Boolean is set to true for action items associated with a custom action, the web part will perform validation before invoking the custom action. For example, if there are required fields that are not filled in, the custom action will not be invoked.
Allows you to set the URL for the image for the toolbar button. You may use an absolute or relative URL here.
Allows you to define one character from the Text attribute that becomes the access key to this toolbar button or context menu item. For example, if you define a letter T as the access key, you can press ALT+T and the browser will put the focus on this button or context menu item. If there are multiple elements on the page with the same access key, you can repeat ALT+T repeatedly until you get the focus on this toolbar button or context menu item.
Allows you to set the position of the button in the toolbar. The index starts with 0 (not 1).
Allows you to list SharePoint groups whose members can view the web part. Separate groups with commas.
201
Quick Apps for SharePoint
ELEMENT
Hide User Groups
DESCRIPTION
Allows you to list SharePoint groups whose members cannot view the web part. Separate site group names with commas (for example, Administrators, Readers).
If users are defined in Show User Groups and Hide User Groups,
Hide Groups takes precedence.
When you add an action, you can configure the following:
ELEMENT DESCRIPTION
Sequence
Name
Allows you to change the order the actions are executed by selecting a different number in the Sequence drop-down menu. The order the actions appear in the action list is the sequence the actions are executed.This is not an attribute of the
Action element. It is an auto-generated number that indicates when the given action is executed.
An optional element which allows you to identify a given action in order to access it from another action. You can refer to this action from the GoToURL action and from
ICustomActionEx Interface. For more information on ICustomActionEx,
see “ICustomActionEx Interface” on page 444 .
202
qListForm
ELEMENT DESCRIPTION
Action Type Allows you to determine the type of the action. Here are the options:
• Save — saves the item.
• Delete — deletes the item.
• Move — moves a document to another folder or another library. This action only works for document in a document library.
• Copy — This is the action to copy a document to another folder or another library. This action only works for document in a document library.
• CloseDialog — closes a dialog window. It only takes effect if it is triggered in context of a SharePoint dialog. If the web part containing the custom action is inside a browser window, nothing will happen. This action is useful in the following scenario: The qListForm is used in conjunction with qListView. A row is selected in the qListView which causes you to navigate (through a GoToUrl action in the context menu or hyperlink from a Link To configuration) to another web page where qListForm is configured to allow you to view/edit all fields belonging to the data row. A qListForm residing on this page can contain a custom action named "Save and Close" chaining 2 custom action types: Save followed by CloseDialog. When the user chooses to open this new page in a
SharePoint Dialog, at the end of editing the item, he can hit this "Save and
Close" custom action (in the toolbar of the web part) to perform save and close in a single click. If a GoTo action is introduced between a Save action and a
CloseDialog action then the dialog will not close.
• GoToURL — redirects the user to a specific URL. You can define more parameters.
-URL — defines the target URL when the action type is set to GoToURL. If needed, the URL can contain fixed HTTP parameter like: http://www.mysite.com?Parameter1=value1.
-Open URL — defines how the URL is opened for the GoToURL custom action.
There are 3 different options: Dialog, NewWindow, and CurrentWindow.
You can define additional HTTP parameters for the GoToURL action by defining one or more Parameter element. Here are the attributes for the Parameter element:
-Name — This attribute defines the name of the HTTP parameter that is generated.
-Source — This attribute defines where the value of the parameter comes from. The values are Session, HTTPRequest, RowFromAnotherWebPart,
ResultFromAction, or Input.
-SourceName — This attribute defines the field name where the value comes from when the source is set to Session or Input. This attribute defines the
HTTP parameter name where the value comes from when the source is set to
HTTPRequest. The SourceName attribute uses
ActionName.SourceName.Name notation to access the ActionResult value.
Because this parameter value is used to construct a URL query string, a simple object is expected. Currently, the SourceName can be “RawData” and
“OutParameter” which access the RawData part or OutputParameter part of
ActionResult. RawData does not need the Name attribute but OutParameter does, which is equal to OutputParameter name.
-SessionName — This attribute defines the name of the session variable where the value comes from when the source is set to Session.
203
Quick Apps for SharePoint
Action Type • GoToSource — redirects the user to the URL specified in the Source HTTP parameter. The URL to the page must look like: http://...?Source=URL for this option to work.
• StartWorkflow — starts the specified workflow in the Workflow Name drop-down field
• ReturnToMasterChart — returns the user to the master chart page. You use this action type if this web part is located in the drill down page.
• Custom — implements your own custom action and call it with this action type.
Enter a Class name that implements the ICustomActionEx or ICustomAction interface, or select a class from the drop-down list, if available. For more information on custom actions,
“Custom Action Help” on page 443 .
Form Component Behavior
This property is used to control the conditional behavior of the different components in the form, such as a field, a group of fields or a tab. There are four different conditional behaviors that can be specified: Show When, Hide When,
Enabled When, and Disabled When. For fields, there are three additional conditional behaviors that can be specified: Valid When, Invalid When, and
Required When.
ValidWhen, InvalidWhen, and RequiredWhen come into play with SharePoint List
Item and Column validation. The validation is processed in the following manner:
1.
The Form Component Behavior is processed first. If it succeeds
(meaning no condition is true for InvalidWhen and no condition fails for ValidWhen and no condition is true for RequiredWhen), it goes on to perform SharePoint Column and List Item Validation. If they succeed, then Save and Close procedures follow.
2.
The implementation of SharePoint List and Column validation applies to qListForm Save and Close action only. If user defines a custom action that has "performValidation" flag set to true, it will only enforce Form Component Behavior and will ignore List and Column
Validation.
This property is an XML string in this format:
<FormComponentBehavior>
<Component Type="Field/Group/Container"
ID="ComponentID">
<ShowWhen>
[Condition specified in CAML Filter format]
</ShowWhen>
<HideWhen>
[Condition specified in CAML Filter format]
</HideWhen>
<EnabledWhen>
[Condition specified in CAML Filter format]
</EnabledWhen>
204
qListForm
<DisabledWhen>
[Condition specified in CAML Filter format]
</DisabledWhen>
<InvalidWhen Message=”Custom Message when condition is true”>
[Condition specified in CAML Filter format]
</InvalidWhen>
<ValidWhen Message=”Custom Message when condition is true”>
[Condition specified in CAML Filter format]
</ValidWhen>
<RequiredWhen Message=”Custom Message when condition is true”>
[Condition specified in CAML Filter format]
</RequiredWhen>
</Component>
<Componet ...>
<Component ...>
</FormComponentBehavior>
The Form Component Behavior element can contain one or more Component elements. Each Component element controls the behavior of a specific component in the form like a field or tab.
The Component element contains the following elements:
ELEMENT
Type
ID
DESCRIPTION
Defines the type of the component that is assigned the dynamic behavior.
The choices are: Field, Group, or Container (that is, tab).
Defines the ID or name of the component whose behavior is defined to be dynamic. When the Type is set to Field, this ID refers to the Name of a field that is defined in the Display Fields property. When the Type is set to
Group, this ID refers to the Group Name attribute of a field that is defined in the Display Fields property. When the Type is set to Container, this ID refers to the ID of a container that is defined in the Form Layout property.
The Component element may contain any or none of the following conditional behavior elements:
ELEMENT
Show When
Hide When
Enabled When
DESCRIPTION
Defines the conditions of when the form component should be shown.
Defines the conditions of when the form component should be hidden.
This conditional behavior takes precedence over the other conditional behavior. Therefore, if Hide When and Show When are defined and both evaluate to true, the component is hidden.
Defines the conditions of when the form component should be enabled.
205
Quick Apps for SharePoint
ELEMENT
Disabled When
Required When
Valid When
Invalid When
DESCRIPTION
Defines the conditions of when the form component should be disabled.
This conditional behavior takes precedence over the Enabled When conditional behavior. Therefore, if Enabled When and Disabled When are defined and both evaluate to true, the component is disabled.
Defines the conditions of when the form component should be required.
This conditional behavior is for fields only. It has no effect on a field that has been defined as required by SharePoint. A custom message can be specified. It is displayed when the Required When condition is satisfied.
The message is displayed by default in red after the input control on the form. However you can specify any text or HTML code as the Message attribute.
Defines the conditions of when the form component should be valid. This conditional behavior is for fields only. A custom message can be specified.
It is displayed when the Valid When condition is satisfied. The message is displayed by default in red after the input control on the form. However you can specify any text or HTML code as the Message attribute.
Defines the conditions of when the form component should be invalid.
This conditional behavior is for fields only. This conditional behavior takes precedence over the Valid When conditional behavior. Therefore, if Valid
When and Invalid When are defined and both evaluate to true, the field is invalid. A custom message can be specified. It is displayed when the
Invalid When condition is satisfied. The message is displayed by default in red after the input control on the form. However you can specify any text or HTML code as the Message attribute.
For fields of type text, numeric or date/time, regular expression matching can be used for validation. Use the “Matching” operator in the conditional behavior element.
The following are some examples of how to use this property:
1.
Show the Resolved Date and Resolved By fields when the Status field is changed to "Resolved". By specifying both fields’ GroupName attribute in the Display Fields property to “ResolvedFieldsGroup”, it is defined that both fields belong to the same group.
<FormComponentBehavior>
<Component Type="Group" ID="ResolvedFieldsGroup">
<ShowWhen>
<Eq><FieldRef Name="Status"/><Value
Type="Choice">Resolved</Value></Eq>
</ShowWhen>
</Component>
</FormComponentBehavior>
2.
Enable the "Amount Paid" field when the Invoice Status field is changed to "Paid".
<FormComponentBehavior>
<Component Type="Field" ID="Amount Paid">
<EnabledWhen>
206
qListForm
<Eq><FieldRef Name="Invoice Status"/><Value
Type="Choice">Paid</Value></Eq>
</EnabledWhen>
</Component>
</FormComponentBehavior>
3.
Hide the Reason field when the Project Status field is not "Behind"
<FormComponentBehavior>
<Component Type="Field" ID="Reason">
<HideWhen>
<Neq><FieldRef Name="Project Status"/><Value
Type="Choice">Behind</Value></Neq>
</HideWhen>
</Component>
</FormComponentBehavior>
4.
Show error message if field, Assigned To, is blank when Status is “In
Process”
<FormComponentBehavior>
<Component Type="Field" ID="Assigned To">
<InvalidWhen Message="Assigned To Must be filled if
Status is In Process">
<And>
<IsNull>
<FieldRef Name="AssignedTo" />
</IsNull>
<Eq>
<FieldRef Name="Status" />
<Value Type="Choice">In
Progress</Value>
</Eq>
</And>
</InvalidWhen>
</Component>
</FormComponentBehavior>
5.
Field % Complete must be between 0 and 100
<FormComponentBehavior>
<Component Type="Field" ID="% Complete">
<ValidWhen Message="% Complete must be between 0 and 100">
<And>
<Geq>
<FieldRef Name="PercentComplete" />
<Value Type="Number">0</Value>
</Geq>
<Leq>
<FieldRef Name="PercentComplete" />
<Value Type="Number">1</Value>
</Leq>
</And>
</ValidWhen>
</Component>
207
Quick Apps for SharePoint
</FormComponentBehavior>
Dependent Lists
This property identifies the child lists to be updated when the List Form saves the changes to the current list item.
This property works in conjunction with the Form Type property. When the Form
Type property is set to EditListItem or EditDocument, the List Form will update the values in the child lists. When the Form Type property is set to NewListItem or UploadDocument, the List Form will create a new record in the child lists. This is useful when you have two lists with a one-to-one relationship.
This property also prevents the deletion of the current item if there are any child records in the specified lists. The user can delete a record when the Form Type property is set to DisplayListItem or EditListItem.
The value of this property is an XML string in this format:
<Lists>
<List SiteUrl="siteURL" ListName="listName"
KeyFieldName="keyFieldName">
<Field SourceFieldName="sourceFieldName"
TargetFieldName="targetFieldName"/>
</List>
</Lists>
The Lists element can contain multiple List elements. One List element represents one child list. These are the attributes of the List element:
ELEMENT
Site URL
List Name
Key Field Name
DESCRIPTION
Allows you to set the URL of the site that contains the child list.
Allows you to set the name of the child list. The name is case sensitive
Allows you to set the name of the field in the child list that contains the ID of the parent item. The key field is usually a single line of text that contains the parent item ID or a cross-site lookup field to the parent list.
The name is case sensitive.
The List element can contain zero or more Field elements. One Field element represents a field in the child list that needs to be updated. These are the attributes of the Tasks list:
• Source
—
The name of the field in the parent list where the value comes from. The name is case sensitive.
208
qListForm
• Target
—
The name of the field in the child list where the value is copied to when the parent record is saved. The name is case sensitive.
The following diagram illustrates parent child relationship between two different lists.
The Project Phases list is the parent list of the Tasks list. The ID field is the primary key in the Project Phases list because the value of the ID field is guaranteed to be unique (every SharePoint list and library contains a field called
ID. This field cannot be modified and its value is uniquely auto-generated by
SharePoint). The Phase List Item ID is the foreign key in the Tasks list. We replicate the value of the Project List Item ID, Project Name and Phase Name into the fields with the same name in the Tasks list.
For example, if the List Form is configured to edit an item in the Project Phases list, then every time we modify the information in the Project Phase list we need to make sure the values that are replicated and the Tasks lists are modified. The following is how the Dependent List property should be setup:
<Lists>
<List SiteUrl="." ListName="Tasks" KeyFieldName="Phase
List Item ID">
<Field SourceFieldName="Project List Item
ID"TargetFieldName="Project List Item ID"/>
<Field SourceFieldName="Project
Name"TargetFieldName="Project Name"/>
<Field SourceFieldName="Phase
Name"TargetFieldName="Phase Name"/>
</List>
</Lists>
209
Quick Apps for SharePoint
System Integration Tab
This property defines the entity and the operations related to the entity. This property is an XML string in this format:
<Catalog>
<Entity Name="entityName" System="systemName"
Service="serviceName" Default="true/false">
<Properties>
<Property Name="propertyName" Type="typeName"
Value="propertyValue" />
<Property Name="propertyName" Type="typeName"
Value="propertyValue" />
</Properties>
<Operation Name="operationName" Method="methodName"
Default="True/False" >
<Parameter Source="sourceType"
SessionName="sessionName" SourceName="sourceName"
Type="parameterType" Name="parameterName"
Usage="usageType" Value="value" />
<Parameter Source="sourceType"
SessionName="sessionName" SourceName="sourceName"
Type="parameterType" Name="parameterName"
Usage="usageType" Value="value" />
</Operation>
</Entity>
<Entity>...</Entity>
</Catalog>
Entities contain the following elements:
ELEMENT
System
Service
Name
Set Session Name
DESCRIPTION
Allows you to specify the system name that is defined in the
System Integration configuration file. If the system name does not exist in the System Integration configuration file, you will get an error.
Allows you to specify the service name that is defined in the System
Integration configuration file. The service name that you specify here must belong to system that you specify in the System attribute. If the service name does not exist in the System
Integration configuration file, you will get an error.
Allows you to specify the name of the entity which must be unique within this Catalog. The name does not have to match with any name in your external system. However, it is recommended that you use a descriptive name for your entity.
Allows you to enter name of the session variable where the edited or newly created item is stored when it is saved, or the item that is being displayed or edited is stored when it is loaded.
210
qListForm
ELEMENT
Reset Session Names
Default
DESCRIPTION
Allows you to reset (set to NULL) the value of the session variable whose name is specified in this attribute. Specify multiple names by separating them with commas.
Allows you to define this entity as the default for the list form. If this element is not specified, the first entity that is listed in the catalog becomes the default entity. The default operation of the default entity is the operation that is used to retrieve the data when the list form is loaded for the first time in edit or display mode.
You can add operations to your entities by configuring the following elements:
ELEMENT
Name
Method
Default
DESCRIPTION
Allows you to specify the name of the operation. This name does not have to match with any name in your external system. This name is used to refer to this operation in the Action property.
Allows you to specify the r eal name of the operation in your external system. For example, it may refer to the name of a web service method. Or it may refer to the name of a stored procedure in your SQL Server database.
Allows you to define this operation as the default. The default operation is the first operation that is called to retrieve the entity to be displayed or edited. If this attribute is not specified, the first operation listed in the entity becomes the default operation.
You can define parameters for the operation by configuring the following elements:
ELEMENT
Name
DESCRIPTION
Allows you to specify the name of the parameter.
211
Quick Apps for SharePoint
ELEMENT
Source
Usage
DESCRIPTION
Allows you to define the source of this parameter. The source can be one of the following:
• DefaultValue — the value of the parameter that is the default
• NullValue — the value of the parameter is blank
• FixedValue — the value of the parameter that is defined in the
Value attribute
• HttpRequest — the value of the parameter that is retrieved from the HTTP parameters in the page URL. The name of the
HTTP parameter is defined in the SourceName attribute. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the SourceName attribute is ProductType, the value of the
ProductType HTTP parameter, which is Hardware, is used as the value of the parameter.
• Input — the value of the parameter that is retrieved from one of the input fields in the form. You specify the name of the input field in the SourceName attribute. Additionally, you can retrieve the current user information as the value of the parameter. You can specify one of the following name in the
SourceName attribute to retrieve the current user information:
• RowFromAnotherWebPart — the value of the parameter that is retrieved from the row that is consumed from another web part. You specify the name of the field that is consumed in the
SourceName attribute.
• Session — the value of the parameter that is retrieved from the row that is stored in the session. You specify the name of the session in the SessionName attribute. You specify the name of the field that is consumed in the SourceName attribute.
• ComplexType — the value of the parameter is an object based on the Type attribute and Member definition inside the
Parameter. Array and nested complex types are supported.
• Array — the value of the parameter is an array of values
• XML — the value of the parameter that is dynamically built when the condition is execute at runtime
Allows you to define the direction for this parameter. The options are In, Out, InOut, or ReturnValue.
You can define one or more Property elements.
ELEMENT
Name
Type
Value
DESCRIPTION
Allows you to specify the name of the property. Refer to the documentation for the DAO Provider to your external system will tell you the name of the property that you must define.
Allows you to specify type of value that is specified in the Value attribute. Example: System.String.
Allows you to specify the value of the property.
212
qListForm
Toolbar Appearance Tab
The Toolbar Appearance tab contains the following:
ELEMENT
Toolbar Location
Toolbar Skin Name
Show Save Button
Show Cancel Button
Show Edit Button
Show Delete Button
Show Mark Private/Public Button
Show Manage Permissions Button
Show Manage Copies Button
Show Version History Button
Show Workflows Button
Show Alert Me Button
Save and Close Button
Cancel Button Text
DESCRIPTION
Allows you to define where a toolbar for the list form should be displayed. The choices are TopAndBottom, Top,
Bottom or None. Select None if you do not want to display the regular toolbar. Only the Ribbon buttons are displayed in this case.
Allows you to enter the skin name for the toolbar.
Allows you to display the Save and Close button.
Allows you to display the Cancel button.
Allows you to display the Edit Item button when the Form
Type is set to DisplayListItem or DisplayDocument.
Allows you to show the Delete button in the toolbar.
Allows you to display the Mark Private/Public toggle button. This button will only be displayed for a new form or an edit/display form and the logged in user is the creator of the item. If an item is marked as private, only the creator can see it.
In New or Edit mode, if this property is changed for an item, the change takes place when the Save button is clicked. In Display mode, if this property is changed for an item, the change takes place immediately with the following popup message:
“Are you sure you want to make this item private? This change will take place immediately” or
“Are you sure you want to make this item public? This change will take place immediately”
Allows you to display the Manage Permissions button.
Allows you to display the Manage Copies button.
Allows you to display the Version History button.
Allows you to display the Workflows button.
Allows you to show the Alert Me button in the toolbar. The
Alert Me button creates a list-level alert.
Allows you to display text for Save and Close button.
Allows you to display text for the Cancel button.
213
Quick Apps for SharePoint
Control Appearance Tab
To configure the rich text editor toolbar to show/hide specific buttons, edit the configuration file of the Telerik rich text editor. This file can be found at
C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\EnhancedRichTextToolsFile
.xml if you are using SharePoint 2010 or C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\EnhancedRichTextToolsFile
.xml if you are using SharePoint 2013.
It is an XML file where you can comment out the tools using XML comment tags
(For example: <!--<tool name="Undo" />--> to hide the undo button).
ELEMENT
Rich Text Editor Skin Name
DESCRIPTION
Allows you to select the skin name for the rich text editor. The rich text editor appears in the form when the Type attribute of the Field element in the Display Fields property is set to RichText. If you have a custom skin, you can add it to the following folder for
SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Note:
Clear your browser cache frequently while working with custom skins. In IE, CSS cache can be cleared by clicking the
Clear
Cache
button in the CSS tab of Developer Tools, located under the
Tools menu of the browser.
Allows you to select the Toolbars to include in the rich text editor.
Rich Text Editor Toolbar
Settings
Complex Category Tree
Skin Name
Allows you to specify the skin name for the Complex Category Tree in the list form. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
214
qListForm
Drop-Down Skin Name Allows you to specify the skin name for the drop-down menu control for the choice field. If you have a custom skin, you can add it to the following folderfor SharePoint 2010:C:\Program
Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Email Notification Tab
The Email Notification Tab contains the following:
ELEMENT
Display Email Notification
Setting
Subject
Message
Allow Custom Message
Include Link to List or
Library
Include Link to Item
Include Document as
Attachment
Rich Text Editor Skin Name
DESCRIPTION
Allows you to determines whether or not the email notification section should be displayed in the List Form. The email notification will enable the user to send an email to one or more recipients when an item is added or modified.
Allows you to specify the default subject that is displayed by the list item email.
Allows you to specify the default message that is displayed by the list item email.
Allows you to set the list item to allow the user to modify the message.
Allows you to allows the hyperlinks to the AllItems.aspx of the list or document library.
Allows you to determine whether the message will include the hyperlink to the newly added or modified list item.
Allows you to allow the email to contain the selected document as attachments.
Allows you to specify the skin name for the rich text editor in the
Send Email panel. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
215
Quick Apps for SharePoint
Localization Tab
By default, the text for the toolbar buttons is retrieved from the resource file that is included in the product. However, if the resource file in the culture that you want to use is not available, define the text for the toolbar button in the Resource
List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) is used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
Save and Close Button
Text Resource ID
Cancel Button Text
Resource ID
Delete Button Text
Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list.
The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
Allows you to enter a text resource ID for the Save and Close button.
Allows you to enter a text resource ID for the Cancel button.
Allows you to enter a text resource ID for the Delete button.
216
qListForm
ELEMENT
Edit Button Text Resource
ID
Approve/Reject Item
Button Text Resource ID
Check In Button Text
Resource ID
Check Out Button Text
Resource ID
Manage Permissions
Button Text Resource ID
Manage Copies Button
Text Resource ID
Version History Button
Text Resource ID
Workflows Button Text
Resource ID
Alert Me Button Text
Resource ID
Mark Private Button Text
Resource ID
Mark Public Button Text
Resource ID
Indicates Required Field
Button Text Resource ID
Parent Folder Button Text
Resource ID
Destination Folder Button
Text Resource ID
DESCRIPTION
Allows you to enter a text resource ID for the Edit button.
Allows you to enter a text resource ID for the Approve/Reject Item button.
Allows you to enter a text resource ID for the Check In button.
Allows you to enter a text resource ID for the Check Out button.
Allows you to enter a text resource ID for the Manage Permissions button.
Allows you to enter a text resource ID for the Manage Copies button.
Allows you to enter a text resource ID for the Version History button.
Allows you to enter a text resource ID for the Workflows button.
Allows you to enter a text resource ID for the Alert Me button.
Allows you to enter a text resource ID for the Mark Private button.
Allows you to enter a text resource ID for the Mark Public button.
Allows you to enter a text resource ID for the Indicates Required
Field button.
Allows you to enter a text resource ID for the Parent folder button.
Allows you to enter a text resource ID for the Destination Folder button.
qListForm Procedures
You can perform the following procedures using qListForm:
•
•
Creating and Editing Collapsible Sections
•
217
Quick Apps for SharePoint
Configuring qListForm
To configure qListForm
1.
Add qListForm to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
Creating and Editing Collapsible Sections
Collapsible Sections are useful for organizing documents that contain a lot of information since you can use them to collapse one or more paragraphs into a single line. You can expand the paragraphs when necessary by clicking the triangle that appears to the left of a collapsed section. In Lotus Notes, this capability already exists and for users migrating from Notes to SharePoint, this feature allows for seamless migration of this type of text.
There are three editing modes in rich text editor:
• Design
—
allows you to turn a section of text to collapsible or expanded
• HTML
—
allows you to work directly with specified markup to turn text into a collapsible section
• Preview
—
allows you to click to expand or collapse a section of text that is marked up as collapsible text.
Collapsible text does not work in Internet Explorer 7.
To create a collapsible section
1.
Select the text that you want to collapse.
2.
Click
Apply Section.
The selected text becomes a collapsible section with a section header with a default title of “New Section”. This title can be changed.
To remove a collapsible section
1.
Select the section header.
218
qListForm
2.
Click
Remove Section
.
Nested sections can be created by allowing a section header and section repeated inside the parent section. The section header can be aligned to the left
(default), right, and center.
Placing a List Form
To place a List Form on a regular page, just drag and drop the it to a web part zone and then configure it.
To use the List Form in list-supporting forms (DispForm.aspx,
EditForm.aspx, NewForm.aspx, and Upload.aspx)
1.
Open the form in Microsoft SharePoint Designer.
You cannot edit the list-supporting forms in the browser because list-supporting forms cannot be edited until you customize it in the
Microsoft SharePoint Designer.
2.
Right-click the existing Microsoft List Form and then select the web part Properties.
3.
Expand the Layout section in the property panel.
4.
Check the Hidden checkbox.
Do not delete the Microsoft List Form. Doing so may render your list unusable.
When placing the List Form in the Upload.aspx of a document library, you must check both the Hidden and the Close the Web Part checkboxes. Otherwise, the document properties will not be saved.
5.
Drag and drop the qListForm onto the web part zone and configure it.
Configure the qListForm using the property panel in the web browser after you place it onto the list supporting form. Select
Site Actions |
Edit Page
. You can also establish the connection between the list form and other web parts in the browser that way.
219
Quick Apps for SharePoint
220
qListView
•
Overview
•
Configuration Wizard
•
qListView Tabs
•
qListView Procedures
13
Quick Apps for SharePoint
Overview
qListView aggregates data from one or more SharePoint lists and displays the information in a grid.
qListView has an intuitive user interface that allows you to:
• Configure the most complex aspects of web parts. This user interface is accessed from the Configure item on the web part menu at the upper right corner of the list display.
• Aggregate data from multiple lists from various SharePoint sites. The lists to be aggregated are defined in the Viewed Lists property. You can define the lists that you want to aggregate individually in the property, define it in a centralized list or ask the listview to aggregate lists with a specific name from all the subsites (recursive rollup).
• Display hierarchical data. For example, you can display the information from the Customer list and Sales list in the same view.
• Display data from lists with multiple content types. The listview displays a New button for each content type in the list so that the user can create items with different content types from the listview.
• Ensure the referential integrity of the records in the dependent lists by preventing the deletion of the parent record.
• Divide the data into multiple pages to limit their size and render pages faster. This feature is called Paging. There are two Paging Modes available: Numeric Pager and Next Previous. If the number of rows in a table is more than the specified Page Size, the data is divided into multiple pages and a Pager is displayed at the bottom of the listview to enable the user to navigate to different pages.
• Define a static filter using CAML Filter expression or Complex Filter expression. Both types of filter expression supports time functions and time expression (such as [TODAY]) to filter out data based on a moving time window. This feature is called Data Aging.
• Define the dynamic filter or search criteria using the Find panel. The web part author can define the fields that are shown in this panel using the Searched Fields property.
• Filter a lookup/cross-site lookup field with another lookup/cross-site lookup field.
• Replace the value of a certain field in the list. The user can either mass-replace the value of the selected item or define the condition for the items to be replaced.
• Define the initial static sort expression using the Sort Fields property.
The listview can sort the data based on multiple fields.
222
qListView
• Sort the data in the listview by clicking the grid headers.
• Define multiple levels of grouping on the data using the Grouped attribute in the Display Fields property. You can also display the sum or item counts in the group header.
• Support the List Searcher mode in listview. If Turn On List Searcher
Mode is set to True, the listview does not display data until the user performs a search.
• Turn off the individual buttons in the toolbar.
• Manage the folders from one or more lists/document libraries in the
Folder Panel.
• Display the value of a cross-site lookup field. A cross-site lookup field is similar to the SharePoint lookup field, except that it can look up multiple lists in any workspaces that are accessible from the current site by the current user. The cross-site lookup field is identified by the
Display Field Name or Display Format attributes in the Display Fields property. You can use qListForm to populate a cross-site lookup field.
• Access the most common functions for data items, such as View
Properties, Edit Properties and Send Email. If enabled, you can access the context menu by right-clicking the entry in the listview.
The Send Email item in the context menu enables the user to send an email with a custom message to one or more recipients. The email message may contain the link to the item, the link to the list or library and in case of document library, the document as an attachment. This feature requires you to put the MailSettings configuration in your web.config file. You need to do this because the Send Email does not use the SharePoint email capability due to its limitation of sending a maximum of 1000 characters. The
MailSettings configuration looks like this (you only have to add the lines with bold font):
<configuration>
<configSections>
<sectionGroup name="QuestSoftware">
<section name="MailSettings" type="System.Configuration.SingleTagSectionHandler, System, Version=1.0.5000.0,
Culture=neutral, PublicKeyToken=b77a5c561934e089" />
</sectionGroup>
</configSections>
<QuestSoftware>
<MailSettings OutboundSmtpServer="Smtp server name or IP address"/>
</QuestSoftware>
</configuration>
• Change the URL of the new form, edit form, and display form using the Viewed Lists property.
• Show or hide the listview based on the site group membership of the currently logged in user.
• Display the data in virtually any format that can be achieved with
JavaScript and HTML. With this feature, you can create many types of custom reports on the data.
223
Quick Apps for SharePoint
• Support dynamic language switching and Flash and JavaScript
(HTML5)
• Export data to Microsoft Excel in conjunction with qExcelViewer.
• Provide data from the whole listview to another web part using
IWebPartTable interface.
• Consume a filter from another web part that implements
IRowProvider or IFilterProvider interface.
The IFilterConsumer interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled Consume Filter From (Obsolete) in the web part Connections menu. Use the
IWebPartParameter consumer implementation that is labeled with Get Filter From.
The listview is a consumer for the IWebPartParameter interface. This capability enables the chart view to consume a filter from another web part that implements IWebPartRow or IWebPartParameter interface.
The IWebPartParameter consumer implementation is labeled with Get Filter From in the web part Connection menu. This interface cannot be connected with the obsolete
IFilterProvider or IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete
If you would like to learn more, click here to watch the training video.
Configuration Wizard
qListView uses a configuration wizard to walk you through basic configuration
tasks. For more information on using the Configuration Wizard, see “Configuring
Basic Settings using the Configuration Wizard” on page 261 .
224
qListView
qListView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qListView contains the following tabs:
•
•
•
•
•
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qListView, the Display tab opens by default. The Default tab contains the following:
ELEMENT
Viewed Lists
Display Fields
Child View Display
Fields
Searched Fields
DESCRIPTION
See
“Viewed Lists” on page 229 for more information.
See
“Display Fields” on page 236 for more information.
Defines the fields that should be displayed in the view for the child records.
See “Display Fields” on page 236
for more information.
See
“Searched Fields” on page 241 .
225
Quick Apps for SharePoint
ELEMENT
Fields Excluded from
Replace Panel
Show Include Sub
Folders Check Box In
Search Panel
Show Search All Fields
Control in Search Panel
Expand Child View on
Load
Expand Filter panel on
Load
Panel Button Location
DESCRIPTION
Defines which fields from the list must be excluded from the Field Name drop-down menu in the Replace panel.
This property is an XML in this format:
<Fields>
<Field Name="Field1"/>
<Field Name="Field2"/>
</Fields>
The Fields element can contain one or more Field elements. The Field element can contain one attribute, which is the Name attribute. The
Name attribute is the display name of the field to be excluded from the
Replace panel.
Determines whether the Include Sub Folders checkbox is displayed in the Filter panel. When you select this property and the Show Folders
Button property in the Toolbar Appearance tab, the Include Sub Folders checkbox will appear as the first row in the search/Filter panel.
Note:
Select this element when the folder panel is enabled and the view and the search are limited only on the currently selected folder.
The Include Sub Folders checkbox is useful if you want to include the subfolders of the current folder in the search.
Determines whether the Filter panel should display the control to search all fields in the list. When set to true, the following control is shown in the Filter panel:
The Search All Fields Control allows you to do the following:
• Combine the search all fields functionality with other search criteria that has been entered for specific fields.
• When the search all fields criteria is entered, the Filter panel will construct a filter expression with the "Contain" operator for the following fields in the list: Single line of text, Multiple lines of text,
Choice, Lookup, Person or Group and Hyperlink or Picture. The
Filter panel will use the entire keywords as the value to be searched. Therefore, if you enter "High Priority" in the search all fields control and perform the search, it will find the following sentence:
‘This is a high priority task’
However, it will not find the following sentence:
‘The priority is not always high’
Determines if the child view is expanded or collapsed when the listview is loaded for the first time. By default, this property is set to false which means the hierarchical listview does not expand the child view. If set to true, the entire child view expands when the listview is loaded for the first time.
Allows you to automatically open the Filter panel by default so that the user can perform a search quickly. When set to true, the Filter panel opens when the web part is loaded for the first time.
Determines the location of the Go, Reset and Close buttons in the Filter panel. This property also determines the location of the Go and Close buttons in the Replace panel.
226
qListView
ELEMENT
New Item Panel Style
Custom Actions
CAML Filter
Complex Filter
CAML Filter for Folders
Apply CAML Filter on
First Level Folder Only
Maximum Row Count
DESCRIPTION
Defines the style of the new item panel. The new item panel is displayed when you click the New button in the toolbar and there are multiple lists being aggregated in the view. The new item panel lets the user select which list the new item should be created into. There are two options for the style:
• Elaborate — the new item panel displays the list of possible content types for the list, the location and the description for the list. This is the default value.
• Compact — the new item panel displays the list of possible content types for the list but it does not display the location and the description for the list.
See
“Custom Actions” on page 243 .
Allows you to specify the CAML (Collaboration Application Markup
Language) query expression to filter your data. CAML is an XML-based query language. The CAML Filter will only be applied to the data. The filter will not be applied to the responses.
See “CAML Filter Help” on page 467 on more information on CAML Filter
expression.
Allows you to use the Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML
Filter is applied.
Note:
The Complex Filter is provided here only for backward compatibility reason. In the past, Complex filter was used to support date functions.
See
“Complex Filter Help” on page 475
on more information about
Complex Filter.
Allows you to filter the folders that are displayed in the folder panel.
This is useful if you maintain the metadata on your folders and want to display folders with specific properties.
See “CAML Filter Help” on page 467 on more information on CAML Filter
expression.
Allows you to apply the CAML Filter for folders only on the first level folder. By default, the value is false. If set to true, the listview applies the CAML Filter for folders on the first level folder (that is, folders located directly under the root folder) but will not apply the CAML Filter on the subsequent level.
Determines the maximum number of rows that are retrieved from the list. As an example of when you may need to do this, when you want to show the last 5 documents that were modified recently. In this case, you will set the Maximum Row Count property to 5.
Most of the time when you use this property, turn off the paging feature and show all of the rows in one page. In this case, you need to set the
Page Size property (in the Grid Appearance tab) to a bigger number than in the Maximum Row Count property.
227
Quick Apps for SharePoint
ELEMENT
Sort Fields
Child View Sort Fields
Search Session Name
Enable New Item Link in Child View
Disable Multi Column
Sorting
Enable AJAX
Turn On List Searcher
Mode
DESCRIPTION
Defines the initial sorting criterion for the data. This is the syntax for this property:
FieldName1 [SortDirection], FieldName1 [SortDirection]
SortDirection is either ASC (ascending order) or DESC (descending order). The FieldName and the SortDirection are case sensitive. If the
SortDirection is not specified, ascending order is assumed. For example:
First Name ASC, Last Name DESC, Company
Defines the initial sorting criterion for the data in the view for the child records. This property has the same syntax as that of the Sort Fields property.
The listview will store the search criteria, last selected folder, sort criteria and other listview dynamic settings in the session variable with this name.
The listview also use the Search Session Name to communicate those settings to qExcelViewer and qChartView located in the page whose
URL specified in the Excel Viewer URL or Chart Viewer URL property, respectively. Therefore, the Search Session Name in those web parts must be set to the same value as the session name in this listview.
Allows you to display the New Item link in the child view.
Allows you to sort the listview one column at a time. This means that if the user clicks a column header to sort the data by that column, any previous sort with another column is cancelled.
The default value of this property is false, which means the user can sort using multiple columns.
Allows you to enable AJAX for the listview. AJAX enables the listview to carry out some operations within the grid without refreshing the whole page. For example, when you sort a column by clicking its column header or change the page by clicking the pager, the listview only refreshes the data in the grid without causing the whole page to post back. However, there are times when AJAX causes some issues. In this case, you must disable the AJAX capability of the listview.
The following are some known situations where you need to disable
AJAX:
• In Internet Explorer 6, the data grid will fail to carry out the AJAX operation. If your user base reports this issue, you can disable the
AJAX to fix it.
• If you use javascript's document.write() method in the Results
Body property of the Custom Display, the text that is generated using document.write() will not be rendered after the AJAX operation. This is true even if you do not call the document.write() directly within the Results Body but rather through another javascript function that calls document.write().
Allows the user to perform a search before the listview display any data.
228
qListView
ELEMENT
Excel Viewer URL
Chart Viewer URL
ID HTTP Parameter
Name
Show User Groups
Hide User Groups
DESCRIPTION
Allows you to set the URL of the page that contains qExcelViewer. If this property is specified, the Export to Excel button is displayed in the toolbar. The target page specified by the URL must contain qExcelViewer. The Search Session Name property of qExcelViewer must be set to the same value as the Search Session Name property of this qListView.
Allows you to set the URL of the page that contains qChartView. If this property is specified, the View in Chart button is displayed in the toolbar. The target page specified by the URL must contain qChartView.
The Search Session Name property of qChartView must be set to the same value as the Search Session Name property of this qListView.
Allows the qListForm and several other web parts to an HTTP Parameter called ID to identify the item to be displayed or edited. This HTTP
Parameter is usually generated automatically by the viewer web part, such as qListView or qCalendarView, when you select an item to be displayed or edited.
Note:
If qListForm is placed on a web part page that is contained within a document library, the page will generate an error if the value of the ID HTTP Parameter is bigger than the number of pages within the document library. To prevent this error from happening, rename the ID
HTTP Parameter.
By default, the value of this property is "ID". You can change the value of this property to something else, such as LID. In that case, when you select "View Properties" or "Edit Properties" in the context menu, the
URL of the display or edit form becomes: http://mysite.com/EditFormURL.aspx?LID=xxx
Set the same property in the qListForm to the same value.
Allows you to list SharePoint groups whose members can view the web part. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the
Web Part. Separate site group names with commas (for example,
Administrators, Readers).
If a user is a member of a group that is defined in both Show User
Groups and Hide User Groups, the user cannot view the Web Part.
Viewed Lists
This property defines the following behavior in the listview:
• The lists whose data is viewed in the listview and the manner it is aggregated. There are a few ways that you can aggregate information from multiple lists in the listview. First, you can define the lists to be aggregated one by one. Second, you can define the site URL for the aggregated lists in a Rolled-Up list. Third, you can aggregate the information from lists with a particular name from all the subsites
(recursive rollup).
229
Quick Apps for SharePoint
• The parent list and the child list in the hierarchical listview. You can only define one child element per list. The hierarchical listview does not work when you aggregate the information using the Rolled-Up list and recursive rollup.
• The Dependent Lists for each list. If the Dependent Lists information is provided, the listview checks whether there are child records in the
Dependent Lists when the user tries to delete items from the listview.
If there are any, the listview will not delete the selected items.
The following property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName"
IncludeSubsites="true/false" IncludeThisSite="true/false"
IsRollupList="true/false" SiteUrlFieldName="fieldName"
RolledUpListName="listName" TargetUrl="targetUrl"
SetSessionName="sessionName" ResetSessionNames="name1, name2" NewFormUrl="URL" EditFormUrl="URL"
DisplayFormUrl="URL">
<!-- To define a child list in a hierarchical listview, you can add List element in the parent List element. You can only have one child list. -->
<List SiteUrl="siteUrl" ListName="listName"
ParentKeyFieldName="parentKeyFieldName"
ChildKeyFieldName="childkeyFieldName"
TargetUrl="targetUrl" SetSessionName="sessionName"
ResetSessionNames="name1, name2" NewFormUrl="URL"
EditFormUrl="URL"
UseUploadFormInLayoutsFolder="true/false"
DisplayFormUrl="URL">
<!-- To define dependent lists, add a DependentLists element inside the List element -->
<DependentLists>
<List SiteUrl="siteUrl" ListName="listName"
KeyFieldName="keyFieldName" />
<List SiteUrl="siteUrl" ListName="listName"
KeyFieldName="keyFieldName" />
</DependentLists>
</List>
<List ...></List>
<List ...></List>
</Lists>
The
Lis
ts element can contain one or more List elements. The listview will aggregate the information from all of the List elements that you specify here. To define the hierarchical listview, each List element can contain one child List element.
230
qListView
The following are the elements for the Viewed List attribute.
ELEMENT
Site URL
List Name
Include Subsites
Include This Site
Is Rollup List
DESCRIPTION
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Note:
If you want to connect the listview with another Web Part in
Microsoft SharePoint Designer, the SiteUrl property must contain an absolute URL. We recommend that you keep all URLs in the Web Part configuration relative to ensure site portability. If you must, use an absolute URL temporarily, make the connection, and then change the
URL to a relative one.
Allows you to enter the name of the SharePoint list that is edited or displayed. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list, you can use a single dot (.) as the list name.
Note:
This only works if the qListView is contained in the
AllItems.aspx. For example, if you are replacing the Microsoft List View in the AllItems.aspx of the Tasks list and you use a single dot as the
ListName attribute, the ListName attribute of the qListView is set to
Tasks. If you want to save the list as a template and then add it somewhere else, the name of the new list might not be Tasks and using this relative list name will automatically pick up the new list name for the view.
If set to true, the listview searches all the subsites for a list whose name specified in the ListName and aggregate the information from those list.
Note:
If you have many subsites, the information may take a long time to aggregate. Use this attribute if you have only a small amount of subsites. You must test this feature in your environment to see whether or not the response comes back in a reasonable amount of time and the request does not time out.
Used in conjunction of the IncludeSubsites attribute. If you set this property to true, the list in the current site will not be aggregated by the listview. The current site is the site whose URL is specified in the
SiteUrl attribute.
Indicates whether or not the list specified by the SiteUrl and ListName attributes contains the Site URLs of the lists to be aggregated instead of the data to be aggregated. If you set this to true, the list specified by the SiteUrl and ListName must have a field that contains the URL information. By default, the name of that field is Site URL. If you use different field name, specify the name using the SiteUrlFieldName attribute.
231
Quick Apps for SharePoint
ELEMENT
Rolled Up List Name
Site URL Field Name
Active Field Name
Reset Session Names
Set Session Name
Target URL
DESCRIPTION
Used in conjunction with the IsRollupList property, indicates the name of the lists to be rolled up if you set the IsRollupList to true.
If you want to aggregate more than one list from each site specified in the rollup list, you can define more than one List elements with the same rollup list, but different RolledUpListName. For example, if you want to aggregate Public Library and Private Library document libraries from each site, you can specify the following:
<Lists>
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Public
Library" />
<List SiteUrl="." ListName="Project Sites" IsRollupList="true"
SiteUrlFieldName="Project Site URL" RolledUpListName="Private
Library" />
</Lists>
Used in conjunction with the IsRollupList property, indicates the field that contains the Site URLs of the lists to be aggregated. This attribute is optional if the field name is Site URL.
Note:
The Site URL field must be a single line of text field.
Used in conjunction with the <Link>IsRollupList property. The rollup list may contain a Yes/No field to indicate whether or not a particular site should be included in the rollup. This property is optional if the name of this field is Active.
Note:
The Active field must be a Yes/No field.
Indicates the listview resets (sets to NULL) the value of the session variables whose name is specified in this attribute. You can specify multiple names by separating them with commas; for example
TaskSession, IssueSession.
You can reset the session name if a list has one or more tasks associated with it. In addition to storing the selected list in the session, you may store the dependent task information in the session as well.
This means that every time you store a new list into a session, you need to reset the dependent task information from the session as well.
Defines the name of the session variable where the listview stores the item whose column is being clicked by the user. The user can click the item if one of the LinkTo, LinkToTarget or the LinkToSource attributes in the Display Fields property is defined.
This attribute is usually used if you have another Web Part (such as the qListForm) that can consume the stored values from the session.
You can set the session name when you want to consume the item from a session variable in a qListForm later.
When the LinkToTarget attribute of a specific column is set to true (in the Display Fields property), the data in that column becomes a hyperlink to the URL specified in this attribute. The TargetUrl can use the <%field name%> field replacement expression. But you must use the encoded form of the < and > characters, which are < and > respectively.
Use the LinkToTargetUrl attribute if you want each list to have a different URL; for example, when you want to aggregate multiple lists from the same workspace and connect a certain column to the display form of the list. In that case, the URL to the display form of each list is different.
232
qListView
ELEMENT
Create Document Form
URL
New Form URL
Edit Form URL
Display Form URL
DESCRIPTION
When specified, the New button (and all the buttons for specific content types underneath it) will redirect the user to the URL specified by this attribute. Normally, the page pointed to by CreateDocumentFormUrl will contain a qListForm to create the new document. For more detail about this, see the Create Document section of the qListForm chapter.
CreateDocumentFormUrl will affect all types of list, not just document library.
There is no difference between CreateDocumentFormUrl and
NewFormUrl when the list is not a document library. You can specify either to affect the target URL for the New button. But if both are specified, the CreateDocumentFormUrl will take precedence. When the list is a document library, CreateDocumentFormUrl will affect the New button and the NewFormUrl will affect the Upload button.
Indicates the URL where the form to create a new item resides. The
URL is relative to the Site URL of the list. The user is redirected to the specified URL when one of the New buttons in the toolbar is clicked. If not defined, the user is redirected to the NewForm.aspx of the list (or
Upload.aspx for the document library).
Redefining the New Form URL is useful if you have different way of creating an item depending on the current view. For example, in the view for external vendor, you may want to give them a new form that does not contain all the fields in the list.
Note:
The Source HTTP parameter is automatically appended to the
New Form URL during redirection.
This attribute is usually used in conjunction with the qListForm Web
Part.
Indicates the URL where the form to edit an item in the list resides. The
URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks Edit Properties in the Context Menu.
If not defined, the user is redirected to the EditForm.aspx of the list.
Redefining the Edit Form URL is useful if you have different ways of editing an item depending on the current view. For example, in the view for external vendor, you may want to give them an edit form that does not contain all the fields in the list.
Note:
The ID and Source HTTP parameters are automatically appended to the Edit Form URL during redirection.
This attribute is usually used in conjunction with the qListForm Web
Part.
The URL where the form to display an item in the list resides. The URL is relative to the Site URL of the list. The user is redirected to the specified URL when the user clicks View Properties in the Context Menu.
If not defined, the user is redirected to the DisplayForm.aspx of the list.
Redefining the Display Form URL is useful if you have different way of displaying an item depending on the current view. For example, in the view for external vendor, you may want to give them a display form that does not contain all the fields in the list.
Note:
The ID and Source HTTP parameters are automatically appended to the Display Form URL during redirection.
This attribute is usually used in conjunction with the qListForm Web
Part.
233
Quick Apps for SharePoint
ELEMENT
Launch Form In
Use Uploads Form in
Layouts Folder
DESCRIPTION
Defines how the form pages (NewForm, EditForm, DisplayForm) associated with a SharePoint list are launched. There are 3 different options: Dialog, New Window, and Current Window. This property defaults to <Empty> in which case the form dialog obeys the settings under List Settings/Advanced Settings.
Allows you to link to the Upload.aspx in the _Layouts folder instead of the Upload.aspx in the Forms folder of the document library. You need to set this attribute to true if you do not replace the Microsoft List Form in the Upload.aspx in the Forms folder with the qListForm. There is a bug in the Microsoft List Form in the Upload.aspx in the Forms folder where it will redirect the user to the Upload.aspx in the Layouts folder but it will generate an incorrect URL format (it uses ? instead of & before the HTTP parameters).
The List element for the child list must contain these additional attributes:
ELEMENT
Parent Key Field Name
Child Key Field Name
DESCRIPTION
Allows you to enter a name in the field in the parent list that will act as the filter for the child records. In other words, this is the primary key field in the parent list.
Allows you to enter a name in the field in the child list that is filtered by the value from the parent key field. In other words, this is the foreign key field in the child list.
The List element can contain only one DependentLists element. The
DependentLists element can contain one or more List element. The List element inside the DependentList can contain the following attribute:
ELEMENT
Site URL
List Name
Key Field Name
DESCRIPTION
Allows you to enter the URL to the site that contains the dependent list.
Allows you to enter the name of the dependent list. The list name is case sensitive. This property along with the SiteUrl defines the dependent list.
Allows you to enter the name of the field in the dependent list that contains the ID of the parent item. In another word, the KeyFieldName is the foreign key in the dependent list. The key field is usually a single line of text that contains the parent item ID or a cross-site lookup field to the parent list. The name is case sensitive
The following are examples of the Viewed Lists property:
234
qListView
1.
Aggregate the Tasks list from Project1 and Project2 sites. When the user selects a task by clicking on its linked column, the task is stored in a session named TaskSession. We also want to display the Task
Serial Notes as the child list.
<Lists>
<List SiteUrl="Project1" ListName="Tasks"
SetSessionName="TaskSession">
<List SiteUrl="Project1" ListName="Task Serial
Notes" />
</List>
<List SiteUrl="Project2" ListName="Tasks"
SetSessionName="TaskSession">
<List SiteUrl="Project2" ListName="Task Serial
Notes" />
</List>
</Lists>
2.
Aggregate the Tasks list from all the subsites, but exclude the current site. When the user select a task by clicking on its linked column, the task is stored in a session named TaskSession.
<Lists>
<List SiteUrl="." ListName="Tasks"
IncludeSubsites="true" IncludeThisSite="false"
SetSessionName="TaskSession"/>
</Lists>
3.
Aggregate the Tasks list from the sites that are specified in the
MyProjectSites list. When the user selects a task by clicking on of its linked column, the task is stored in a session named
TaskSession
.
<Lists>
<List SiteUrl="." ListName="MyProjectSites"
IsRollupList="true" RolledUpListName="Tasks"
SetSessionName="TaskSession"/>
</Lists>
In this example, we assume that the MyProjectSites list contains a column called Site URL and looks similar to the following:
Site URL
• Project 1
• Project 2
• Project 3
235
Quick Apps for SharePoint
4.
Display the information in the Phase list and specify the Tasks and
Issues list as the dependent list. This means if the user tries to delete a record from the Phase list, the listview checks whether there are any tasks or issues that depend on the phase record to be deleted.
We will also reset the ProjectSession when the user clicks a link column in the Phase listview.
<Lists>
<List SiteUrl="." ListName="Phase"
SetSessionName="PhaseSession"
ResetSessionNames="ProjectSession">
<DependentLists>
<List SiteUrl="." ListName="Tasks" KeyFieldName="Phase
List Item ID" />
<List SiteUrl="." ListName="Issues"
KeyFieldName="Phase List Item ID" />
</DependentLists>
</List>
</Lists>
Display Fields
This property defines the fields that should be displayed in the listview.
This property is optional if the properties in the Custom Display section is specified. In that case, the default display is turned off and the custom display is used. You can also combine the custom display with the Display Fields. A good example is when you want to display data in a grid and provide a summary of the data or a disclaimer using a custom display.
This property is an XML string in the following format:
<Fields LookupThresholdControlSettings=”On”>
<Field Name="fieldName" [optional attributes]/>
<!-- For a grouped field, you can specify one or more aggregated values -->
<Field Name="fieldName" Grouped="true" SortDirection="asc|desc"
GroupExpanded="true|false">
<Aggregate Function="aggregateFunction" FieldName="fieldName"
Text="text"/>
<Aggregate Function="aggregateFunction" FieldName="fieldName"
Text="text"/>
</Field>
</Fields>
236
qListView
The Display Field contains the following elements:
ELEMENT
Lookup Threshold
Title
Title Resource ID
Width
Align
Item Style
Item CSS Class
Fixed Value
DESCRIPTION
Controls how Web Parts behave in relation to the List View Lookup
Threshold in SharePoint Resource Throttling. The options are:
• Default — uses the option you have set in the Configuration Editor.
• On — searches all fields in lists, except Lookup fields.
• Off — searches all fields in lists, including Lookup fields.
• Explicit — searches only the fields explicitly defined in the web parts properties.
Indicates the title of the field. This is useful if the real field name is too long and you want to abbreviate the title in the field header, or if you simply want to display a different title in the field header. If this attribute is not specified, the value specified in the Name attribute is used in the field header. For example:
<Field Name="Created By" Title="Author" />
Indicates the identifier in the Resource List that is used as the title of the field. The TitleResourceID and the current cultural setting (identified with the Culture HTTP parameter) is used to retrieve the string in the
<Link>Resource List. If the string with the given identifier is not found, the default Title is used.
Indicates the width of the field. You can specify the value in pixels
(Width="20px") or percentage (Width="20%").
We recommend leaving at least one field where you do not specify this property. That field will take up the remaining width of the page. For example:
<Field Name="Subject" Width="100px" />
Indicates the horizontal alignment for the field. The values is one of the following: left, right, or center. For example:
<Field Name="Created" Align="right" />
Indicates the style for the item in the odd number row. You can define the style as you would in a CSS class; for example, color: red; font-weight: bold
Indicates the distinct style for the column and you already have defined the style in an external CSS file.
Fixed Value appears if you have selected Custom as a Display Field. This allows you to display text as a value for this field. This is useful when you want static text such as Edit displayed in a field. You can then make this text a hyperlink using either the Link To, Link To Target or Link To Source attributes. For example:
<Field Name="EditColumn" FixedValue="Edit"
LinkTo="Lists/ListName/EditForm.aspx?ID=<%ID%>" />
To display an icon instead of a text, you can do the following (it assumes that you have pencil.gif in the images folder in your site:
<Field Name="EditColumn" FixedValue="<img src="images/edit.gif" border=0>"
LinkTo="Lists/ListName/EditForm.aspx?ID=<%ID%>" />
237
Quick Apps for SharePoint
ELEMENT
Calculated Value
Display Field Name
DESCRIPTION
Calculated Value appears if you have selected Custom as a Display
Field.This attribute recognizes the field replacement expression
<%Field%> to refer to a field. The listview will replace the field replacement expression with the value of the field for each row of data. You must use the encoded form of the < and > characters, which are < and
>, respectively, unless you type in the value in the Display Fields editor in the List View Editor, where the Editor will encode the characters automatically for you.
You can use this attribute to:
• Display the values from multiple fields in one grid column. For example, to display a full name, you can concatenate the first name and last name as follows:
<Field Name="CalculatedFullName" Title="Full Name"
CalculatedValue="<%First Name%> <%Last Name%>" />
• Reformat the values of another field by using the “Display Format
. You can specify the Display Format in the Field replacement expression as follow:
<%{DisplayFormat}FieldName%>
For example, if you have a Date Time Field called "Start Date" and you want to display it in a short date format, you can use the following field replacement expression: <%{0:d}Start Date%>. To see the
available display format, see the “Display Format Help” on page 439 .
• Format the display of a certain column in the grid. For example, you can display the Status of your project with different colors depending on its value. In order to do this, you can write a JavaScript function and then call that JavaScript function using this attribute.
<Field Name="CalculatedProjectStatus" Title="Status"
CalculatedValue="<script>FormatProjectStatus('<%Status%& gt;');</scri pt>" />
The above example assumes you have a JavaScript method called
DisplayProjectStatus defined on your page or in a JavaScript file that is included in your page. That JavaScript method looks like:
<script language="javascript"> function FormatProjectStatus(status)
{
var displayedStatus = status;
if (status = 'Behind')
{
displayedStatus = '<font color="red">' + status + '</font>';
}
return displayedStatus;
}
</script>
You can format the value of the field in virtually any way you want..
Note:
You can only call one JavaScript function in the CalculatedValue attribute and the JavaScript function must return a string.
If specified, indicates a cross-site lookup field. It contains the name of the field in the cross-site list that contains the value to be displayed. The field name is case sensitive.
A cross-site lookup field enables you to lookup a list that resides in another site, another site collection, or another web application as long as it is in the same configuration database. You need the qListForm Web Part to create a cross-site lookup field.
238
qListView
ELEMENT
Display Format
Show User Groups
Hide User Groups
Hyperlink Field
Target
Link To
Link To Target
Link To Source
Open Link In
DESCRIPTION
If specified, indicates a cross-site lookup field. It contains the format of the value that is displayed. Define this attribute if you want to display values from multiple fields. You can use the field replacement expression
<%Field%> to refer to a field.
Note:
You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Display
Fields editor in the List View Editor, where the Editor will encode the characters automatically for you.
Allows you to show groups where the user is a member of one of the
SharePoint groups listed. Separate site group names with commas.
Allows you to hide groups where the user is a member of one of the
SharePoint groups listed. Separate site group names with commas.
If this field is a SharePoint Hyperlink or Picture field, indicates the target window for the hyperlink. For example, use "_blank" if you want to open the target URL in a new window. If this attribute is left blank, the target
URL will open in the current window.
This attribute will not affect the hyperlink column created with the LinkTo,
LinkToSource or LinkToTargetURL attributes.
Indicates that the list view turns the field into a hyperlinked column to the specified URL. The URL can be an absolute or relative URL. The LinkTo can use the <%field name%> field replacement expression. You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Display Fields editor in the
List View Editor, where the Editor will encode the characters automatically for you. If you use a relative URL, the URL is appended to the site URL of the target site. For example, specify
"Lists/TeamDiscussion/EditForm.aspx?ID=<%ID%>" as the value of this property. If you click a customer record that comes from the
Customers list in Workspace A, whose site URL is
"http://mydomain/sites/mysite", you are directed to http://mydomain/sites/mysite/Lists/TeamDiscussion/EditForm.aspx?ID=23
(assuming you click the discussion with ID=23).
Use this element when you aggregate lists with different name. In that case, you specify a different TargetUrl for each list in the Viewed Lists property and the listview redirects the user to the correct URL depending on the list where the clicked item comes from.
The list view will make the field value a hyperlink to the URL specified in the Source HTTP parameter of the current request. For this option to work, the current page URL must look like: http://.....?Source=....
Use this element when the URL for the hyperlink is dynamic. This could be because it contains dynamic parameters or the URL is different depending on the referral page. Also, when you want to make the URL in the link dynamic. In that case, you can pass in the URL for the link into the HTTP parameter of your page.
Allows you to define how the Link To Field opens. There are 3 different options: Dialog, NewWindow, and CurrentWindow.
Note:
If you are using Internet Explorer 9, the "NewWindow" option requires the user to set the following: Internet Options | General |Tabs|
Settings| When a pop-up is encountered | 'Always open pop-ups in a new window'.
239
Quick Apps for SharePoint
ELEMENT
HTML Encode
Do Not Render as
Hyperlink
Grouped
DESCRIPTION
If selected, the value in the field is encoded first prior to being displayed.
You need to set this to true if this field contains values that are surrounded by < and >, such as <abc>. Without the encoding, the value will not be displayed properly.
If selected, the value of fields is rendered as plain text instead of hyperlink.
Allows you to group data by:
• Sort Direction — This attribute determines whether the values in the header of the grouped field must be displayed in ascending or descending order. The options are asc for ascending order or desc for descending order. The default value is asc.
• Group Expanded — If set to true, the group is initially expanded.
Otherwise, it is collapsed. If not specified, the default value is false.
Note:
Grouping is not supported on any field that has "Allow Multiple
Values" enabled
In addition to the fields in the list, the listview recognizes several special fields. You can display the following fields, group the fields or use it as a field replacement expression in the CalculatedValue attribute.
• Item Location — The format of the Item Location value is ListName in SiteUrl. This field is useful when you aggregate multiple values into the listview to tell you where a particular item comes from.
• Workspace URL — This field contains the URL of the site that contains the containing list.
• List Name — This field contains the name of the containing list.
• Folder — The server relative URL of the folder that contains this item.
• File Path — The complete URL for a file in the document library. This variable is only available for document library.
The Field element can contain one or more Aggregate elements if its Grouped attribute is set to true. The following are the attributes of the Aggregate element:
ELEMENT
Text
Aggregate Function
Field Name
DESCRIPTION
Allows you to enter the text that will precede the aggregated value when displayed.
Allows you to select a function.
Allows you to enter a field name where the aggregation is performed.
The following is an example of a Field element that contains an aggregated value. In this case, we are grouping the information in the Tasks list based on the Priority field and displaying how many tasks are in each priority group.
240
qListView
<Fields>
<Field Name="Priority" Grouped="true">
<Aggregate Function="Count" FieldName="ID"
Text="Number of tasks"/>
</Field>
<Field Name="Title"/>
</Fields>
Searched Fields
This property defines which fields is displayed in the Filter panel. If defined, the listview displays Filter or Search menu items under the Actions button in the toolbar. To disable the search feature in the listview, leave this property blank.
This property is an XML string in the following format:
<Fields>
<Field Name="fieldName" [optional attributes]/>
<!-- To search a cross site lookup field, use one of the following two formats -->
<Field Name="fieldName" DisplayFieldName="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName"
ListName="listName"/>
</Field>
<Field Name="fieldName" DisplayFormat="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName"
ListName="listName"/>
</Field>
</Fields>
The Fields element can contain multiple Field elements:
ELEMENT
Field Name
Title
Description
Default Value
Default Operator
DESCRIPTION
Indicates the element you are editing.
Displays title for the field. The value can be a plain string or an encoded HTML string.
Describes the field. This is useful if you want to give a short instruction or explanation about the field.
Defines the default value for the field.
You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of February 14, 2002 is
2002-02-14T00:00:00Z.
Defines the default operator for the field.
241
Quick Apps for SharePoint
ELEMENT
Fixed Operator
Use People Editor
Column Count
Enable Multi Choice
Sort Field
Sort Order
AutoPostBack
Parent Field
Parent Filter Field Name
Filter Field Name
Display Field Name
DESCRIPTION
Defines the operator for the field. If specified, the drop-down menu to select the operator for this field is turned off.
Enables you to enter any user information that is in your directory service.
If you set this to True and the field to be searched is a People and
Group field, the Filter panel will show the People Editor control for entering the search criteria.
Defines the number of columns for the options in a multi-choice field or in a choice-and-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form.
Allows you to select multiple options for the choice-and-lookup field. Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types.
To search a cross-site lookup field, you must specify one or more
List elements inside the Field element. The cross-site lookup field is displayed as two drop downs.
Defines the field that is used to sort the value in the drop-down menu. The field name is case sensitive.
Allows you to sort the values in ascending or descending order.
Use the Filter panel to refresh when the user changes the selection in a lookup field or cross-site lookup field.
You need to set AutoPostBack to true if this field is a lookup or a cross-site lookup field and it is being used to filter another lookup or cross-site lookup field in the Filter panel.
Defines another lookup or cross-site lookup field that is used to filter this field. The parent field must be listed before this field in the XML property.
Defines the field in the parent field that is used to filter this field. It is the primary key in the list that is used in the lookup or cross-site lookup field.
Defines the field in the list that is used by this lookup or cross-site lookup field that is filtered by the parent filter field.
Shows the name of the field whose value is displayed in the drop-down menu. The field name is case sensitive. Use this attribute instead of the Display Format attribute if you only want to display a single field in the drop-down menu.
242
qListView
ELEMENT
Display Format
Site URL
List Name
Site Name
DESCRIPTION
Indicates the format of the value that is displayed in the drop-down menu. Define this attribute instead of the Display Field Name attribute if you want to display multiple fields in the drop-down menu. You can use the field replacement expression <%Field%> to refer to a field.
Note:
You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Searched Fields editor in the List View Editor, where the
Editor will encode the characters automatically for you.
Indicates the Site URL of the field. You can use an absolute or relative URL.
Indicates the name of the List. The field name is case sensitive.
Indicates the name of the site specified in the Site URL. This is used in case you have multiple lists. In this case, the first drop-down menu to select the list will display as "List Name in Site
Name". You can use any name for the Site Name. It does not have to match the real title of the Site.
Custom Actions
This property enables you to define additional buttons in the toolbar or context menu item in the context menu. You can program that button or context menu item to do a series of actions. The listview supports some built-in actions.
However, you can write your own custom action using one of the .NET
The toolbar button affects all the items that are selected in the listview. The context menu item affects only the item that is being right-clicked regardless of how many items are selected in your listview.
Here are some ways that you can use this functionality:
• Add a custom toolbar button called "Assign All to Me" that will assign all of the selected tasks in the listview to me.
• Add a custom toolbar called "Approve" that will change the status of all of the selected expense items to Approved.
• Create a custom context menu item called "Publish" that will move the right-clicked document into another document library.
• Create a custom context menu item or toolbar item to start a workflow.
243
Quick Apps for SharePoint
• With the ability to write your own custom action, you can virtually do anything to the data when you click the custom button that you define.
Here are the schema of this property:
<CustomActions>
<Toolbar>
<ActionItem ID="UniqueID" Text="text"
TextResourceID="textResourceID" Position="0"
PromptText="promptText"
PrompTextResourceID=”prompTextResourceID” ImageUrl=”URL”
AccessKey=”AccessKeyCharacter”>
<Action Type="Delete" />
<Action Type="Move" TargetFolder="targetFolder"
TargetSiteURL="targetSiteUrl"
TargetListName="targetListName" />
<Action Type="Copy" TargetFolder="targetFolder"
TargetSiteURL="targetSiteUrl"
TargetListName="targetListName" />
<Action Type="GoToURL" URL="TargetURL">
<Parameter Name="parameterName"
Source="Session" SourceName="fieldName"
SessionName=”sessionName” />
<Parameter Name="parameterName"
Source="RowFromAnotherWebPart" SourceName="fieldName" />
<Parameter Name="parameterName"
Source="HttpRequest" SourceName="httpParameterName" />
<Parameter Name="parameterName"
Source="ListItem" SourceName="httpParameterName" />
</Action>
<Action Type="GoToSource"/>
<Action Type="Custom" Class="IUIActionImpl" />
</ActionItem>
</Toolbar>
<ContextMenu>
<ActionItem ID="UniqueID" Text="text"
TextResourceID="textResourceID" Position="0"
PromptText="promptText"
PrompTextResourceID=”prompTextResourceID” ImageUrl=”URL”
AccessKey=”AccessKeyCharacter”>
<Action Type="Delete" />
<Action Type="Move" TargetFolder="targetFolder"
TargetSiteURL="targetSiteUrl"
TargetListName="targetListName" />
<Action Type="Copy" TargetFolder="targetFolder"
TargetSiteURL="targetSiteUrl"
TargetListName="targetListName" />
<Action Type="GoToURL" URL="TargetURL">
<Parameter Name="parameterName"
Source="Session" SourceName="fieldName"
244
qListView
SessionName=”sessionName” />
<Parameter Name="parameterName"
Source="RowFromAnotherWebPart" SourceName="fieldName" />
<Parameter Name="parameterName"
Source="HttpRequest" SourceName="httpParameterName" />
<Parameter Name="parameterName"
Source="ListItem" SourceName="httpParameterName" />
</Action>
<Action Type="GoToSource"/>
<Action Type="Custom" Class="IUIActionImpl" />
</ActionItem>
</ContextMenu>
</CustomActions>
The custom action in the listview does not support the Save action.
The Custom Actions element contains one Toolbar element and one Context
Menu element. These elements can contain one or more Action Item elements.
You can associate the Action Item with one or more Action elements. The Action element define a certain operation that is carried out by the action item when it is clicked.When you add an action item, you can configure the following:
ELEMENT
IsSeparator
ID
Text
Text Resource ID
Prompt Text
Prompt Text Resource ID
DESCRIPTION
Allows you to set the item as a separator.
Allows you to enter a unique ID that will identify the item. Use a descriptive identifier to configure the action item with the editor.
Allows you to enter how the action item is displayed in the toolbar.
Allows you to define this property if you support a a multi-lingual site.
This attribute defines the identifier of the string in the Resource List that is used as the title of the Web Part. The Text Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the value in the Text attribute is used.
Allows you to prompt the user to click the toolbar button or the context menu item.
Allows you to define this property if you support a multi-lingual site.
The property defines the identifier of the string in the Resource List that is used as the title of the Web Part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
245
Quick Apps for SharePoint
ELEMENT
Access Key (Toolbar Only)
Position
Show User Groups
Hide User Groups
DESCRIPTION
Allows you to define one character from the Text attribute that becomes the access key to this toolbar button or context menu item.
For example, if you define a letter T as the access key, you can press
ALT+T and the browser will put the focus on this button or context menu item. If there are multiple elements on the page with the same access key, you can repeat ALT+T repeatedly until you get the focus on this toolbar button or context menu item.
Allows you to set the position of the button in the toolbar. The index starts with 0.
Allows you to list SharePoint groups whose members can view the
Web Part. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the
Web Part. Separate site group names with commas (for example,
Administrators, Readers).
If a user is a member of a group that is defined in both Show User
Groups and Hide User Groups, the user cannot
When you add an action, you can configure the following:
ELEMENT
Name
DESCRIPTION
An optional element which allows you to identify a given action in order to access it from another action. You can refer to this action from the
GoToURL action and from I CustomActionEx Interface.
246
ELEMENT
Type
qListView
DESCRIPTION
Allows you to determine the type of the action. Here are the options:
• Delete — deletes the item.
• Move — allows you to move the item to a target. You must specify a
Target Site URL, Target List Name, and Target Folder. This action only works for document in a document library.
• Copy — allows you to copy the item to a target. You must specify a
Target Site URL, Target List Name, and Target Folder.
• GoToURL — redirects the user to a specific URL. You can define more parameters. Select one or more of the following sources:
-Input - you can retrieve the current user information as the value of the parameter
-Session - the name of the session variable where the value comes from when the source is set to Session
-HttpRequest - the value of the parameter that is retrieved from the
HTTP parameters in the page URL. The name of the HTTP parameter is defined in the SourceName attribute. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the
SourceName attribute is ProductType, the value of the ProductType
HTTP parameter, which is Hardware, is used as the value of the parameter.
-ListItem
-RowFromAnotherWebPart — The parameter for the GoToURL action can be retrieved from the output of another action that comes first in the sequence of actions defined in the ActionItem. There are two types of action that can produce an output: an action with Type of
ExecuteOperation, and an action with Type of Custom that points to custom action implementation of ICustomActionEx Interface. You do that by defining the SourceName attribute of the action. This is the syntax of the SourceName attribute when you use ResultFormAction source: <ActionName>.<ResultType>[.Name], where ActionName refers to the Name attribute of the action that produces the output,
ResultType can be OutParameter (if the action result is returned through one of the out or inout parameter) or RawData - (if the action result is returned as an object). Name is optional. It further designates the object we want to use for the parameter. You do not have to specify the Name when the ResultType is RawData. However, if the ResultType is OutParameter, this name specifies the name of the out or input key value pair.
-ResultFromAction
You must define a source name (where in the source you want to get your information from), name (the name of the parameter that is appended to the URL you specified), and Session (the name of the session variable where the value comes from when the source is set to
Session)
• GoToSource — redirects the user to the URL specified in the Source
HTTP parameter. The URL to the page must look like: http://...?Source=URL for this option to work.
• StartWorkflow — starts the specified workflow in the Workflow Name drop-down field. You must enter a Workflow name.
• ReturnToMasterChart — returns the user to the master chart page. You use this action type if this web part is located in the drill down page.
• Custom — implements your own custom action and call it with this action type. Enter a Class name that implements the ICustomActionEx or ICustomAction interface, or select a class from the drop-down list, if available.
247
Quick Apps for SharePoint
Folder Tree Appearance Tab
The Folder Tree Appearance Tab contains the following:
ELEMENT
Folder Tree Skin Name
Show Folder Tree on Page
Load
Folder Tree Height
DESCRIPTION
Allows you to specify the skin name.
Note:
The folder tree is enabled if you select the Show Folders
Button check box in the Toolbar Appearance tab.
If this check box and the Show Folders Button property are selected, the folder panel is initially expanded. This is convenient for your user if they use folders a lot in the lists or library.
Allows you to set the height of the folder panel in pixels. The default is 300.
Grid Appearance Tab
The Grid Appearance Tab contains the following:
ELEMENT
Selection Column Type
Paging Mode
Page Size
Hide Expand\Collapse Image
When No Child Item
DESCRIPTION
Allows you to set a column type:
• None: Use None if you want to click the row to select it or press Ctrl or Shift and click the row to select multiple rows.
• MultiRowSelector: Use this option if want the listview to display a check box as the first column. To select a row, select the check box for that row. To select multiple rows, select the check box for each row to be selected.
• SingleRowSelector: Use this option if want the listview to display a check box as the first column. To select a row, select the check box for that row.
Allows you to select the type of pager that is displayed at the bottom of the listview if the items must be divided into multiple pages.
Allows you to set the maximum number of rows that is displayed in one page. If the number of rows is larger than the
Page Size, the data is divided into several pages. You can navigate the pages using the Pager displayed at the bottom of the listview.
Allows you to hide the +/- sign next to a list item if the item contains 0 child items.
248
ELEMENT
Skin Name
Header Style
Header CSS Class
Pager Style
Pager CSS Class
Item Style
Item CSS Class
Alternating Item Style
Alternating Item CSS Class
qListView
DESCRIPTION
Allows you to select the skin name for the grid in the listview. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32
012\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32
012\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Allows you to enter the style for the header. You can define the style as you would in a CSS class.
Example: font-family: verdana; color: black; background-color:
#FFCC99; height: 20px;
Allows you to enter the CSS class name for the grid's header. If this property is specified, it will override the style defined in the
Header Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the pager. You can define the style as you would in a CSS class; for example, font-family: verdana; color: black; background-color: #FFCC99; height:
20px;
Allows you to enter the CSS class name for the pager. If this property is specified, it will override the style defined in the
Pager Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the item in the odd number row (1, 3, 5, and so on). You can define the style as you would in a CSS class; for example, color: red; font-weight: bold
Allows you to enter the CSS class name for the item in the odd-numbered row (1, 3, 5, and so on.). If this property is specified, it will override the style defined in the Item Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the item in the even-numbered row (2, 4, 6, and so on). You can define the style as you would in a CSS class; for example, font-family: verdana; color: yellow; font-weight: bold;
Allows you to enter the CSS class name for the item in the even number row (2, 4, 6, and so on). If this property is specified, it will override the style defined in the Alternating Item Style property. You must define the class specified here in an external CSS file.
249
Quick Apps for SharePoint
ELEMENT
Selected Item Style
Selected Item CSS Class
Main View Appearance Field
Name
Child View Appearance Field
Name
DESCRIPTION
Allows you to enter the style for the selected item in the grid.
You can define the style as you would in a CSS class; for example, backgroundcolor: orange !important; color: blue
!important;
You can add "!important" after the color name so that this color will override the selected item style provided by the skin.
Allows you to enter the CSS class name for the selected item in grid. If this property is specified, it overrides the style defined in the Selected Item Style property. You must define the class specified here in an external CSS file.
Allows you to define the name of the field whose values determine the color of the row in the main view. The value of this field is compared against the FieldValue and
FieldValueRange in the Color Appearance property.
Allows you to define the name of the field whose values determine the color of the row in the child view. The value of this field is compared against the FieldValue and
FieldValueRange in the Color Appearance property.
250
ELEMENT
Color Appearance
qListView
DESCRIPTION
Allows you to define the color of the rows in the main view, child view, and group header. This property is an XML string with the following format:
<Appearance>
<MainViewAppearance>
<RowAppearance FieldValue="value1"
BackgroundColor="color1" FontColor="color2" />
<RowAppearance FieldValueRange="number - number"
BackgroundColor="color3" FontColor="color4" />
</MainViewAppearance>
<ChildViewAppearance>
<RowAppearance FieldValue="value1"
BackgroundColor="color1" FontColor="color2" />
<RowAppearance FieldValueRange="number - number"
BackgroundColor="color3" FontColor="color4" />
</ChildViewAppearance>
<GroupeHeaderAppearance>
<RowAppearance FieldValue="value1"
BackgroundColor="color1" FontColor="color2" />
<RowAppearance FieldValueRange="number - number"
BackgroundColor="color3" FontColor="color4" />
</GroupHeaderAppearance>
</Appearance>
You must specify those elements in that sequence. For example, if you specify ChildViewAppearance before the
MainViewAppearance you will get an error that the XML is not valid.
To add color for the group header, you must enable grouping for displayed fields before specifying field value, background color and font color.
Select the Edit button, then click Add Row Appearance to enter values in the following:
• Field Value — value for the field
• Field Value Range — a range of values for the field
• Background Color — the background color of the row for the specified value in the Field Value attribute. The color can be specified as a well-known color such as white, black, cyan, lightGray, as a RGB value such as 255,
255,255, or you can specify it as #FFFFFF, #CCDDEE.
• Font Color — the font color of the row for the specified value in the Field Value attribute. The color can be specified as a well-known color such as white, black, cyan, light gray, as a RGB value such as 255, 255,255, or you can specify it as #FFFFFF, #CCDDEE. The Font Color attribute is ignored if you specify a URL in the LinkTo attribute or set the LinkToSource or LinkToTargetURL attributes to true.
251
Quick Apps for SharePoint
Toolbar Appearance Tab
The Toolbar Appearance tab contains the following:
ELEMENT
Toolbar Skin Name
Show Filter Button at Top
Show New Item Button
Show Upload Button
Show Folders Button
Show Delete Button
Show Replace Button
Show Copy/Move Button
Show Open with Windows Explorer
Button
Show Connect to Outlook Button
Show Alert Me Button
Show Export Button
Show Print Button
DESCRIPTION
Allows you to enter the skin name for the toolbar.
Allows you to show the Filter/Search button as a top level button. If not selected, If set to false, the Filter/Search button is shown under the Actions button.
Allows you to show the New Item button in the toolbar.
Allows you to show the Upload button in the toolbar.
Allows you to show the Folders button in the toolbar.
Allows you to show the Delete button in the toolbar.
Allows you to show the Replace button in the toolbar.
Allows you to show the Copy/Move button in the toolbar.
Allows you to show the Open with Windows Explorer button in the toolbar.
Allows you to show the Connect to Outlook button in the toolbar. The Connect To Outlook button lets users view their SharePoint lists in their Microsoft Outlook Calendar.
The Connect To Outlook button will work only if you have
Microsoft Outlook installed in you computer and it only works for the SharePoint list.
Allows you to show the Alert Me button in the toolbar. The
Alert Me button creates a list-level alert.
Allows you to show the Export button in the toolbar.
Allows you to show the Print button in the toolbar.
Context Menu Appearance Tab
The Context Menu Appearance tab contains the following:
ELEMENT
Enable Context Menu
DESCRIPTION
Allows you to show the context menu.
252
qListView
ELEMENT
Context Menu Method
Show View Properties
Show Edit Properties
Show Delete Item
Show Manage Permissions
Show Alert Me
Show Version History
Show Workflows
Show Check Out
Show Check In
Show Discard Check Out
Show Edit Document
Show Edit in Browser
Show Download a Copy
Show Create Document
Workspace
Show Send Mail
DESCRIPTION
Allows you to define how the context menu is shown if the Enable
Context Menu property is set to True. There are three options in this property:
• RightClick — The user can open the context menu by right clicking the row in the listview. This is the default option.
• ShowContextMenuColumn — The listview will show the context menu column. The context menu column shows a drop-down arrow image which will open the context menu when clicked.
• RightClickAndShowContextMenuColumn — The user can open the context menu either by right clicking the row or by using the context menu column.
Allows you to show the View Properties menu item in the context menu.
Allows you to show the Edit Properties menu item in the context menu.
Allows you to show the Expand All button in the toolbar. This allows you to expand all nodes in the treeview.
Allows you to show the Manage Permissions menu item in the context menu.
Allows you to show the Alert Me menu item in the context menu.
Allows you to show the Show Version History menu item in the context menu.
Allows you to show the Show Workflows menu item in the context menu.
Allows you to show the Show Check Out menu item in the context menu.
Allows you to show the Show Check In menu item in the context menu.
Allows you to show the Show Discard Check Out menu item in the context menu.
Allows you to show the Show Edit Document menu item in the context menu.
Allows you to show the Show Edit in Browser menu item in the context menu.
Allows you to show the Show Download a Copy menu item in the context menu.
Allows you to show the Show Create Document Workspace menu item in the context menu.
Allows you to show the Show Send Mail menu item in the context menu.
253
Quick Apps for SharePoint
ELEMENT
Show Publish/Unpublish
Major Version
DESCRIPTION
Allows you to show the Show Publish/Unpublish Major Version menu item in the context menu.
Email Notification Tab
The Email Notification Tab contains the following:
ELEMENT
Subject
Message
Allow Custom Message
Include Link to List or
Library
Include Link to Item
Include Document as
Attachment
Rich Text Editor Skin Name
DESCRIPTION
Allows you to specify the default subject that is displayed by the list item email.
Allows you to specify the default message that is displayed by the list item email.
Allows you to set the list item to allow the user to modify the message.
Allows you to allows the hyperlinks to the AllItems.aspx of the list or document library.
Allows you to determine whether the message will include the hyperlink to the newly added or modified list item.
Allows you to allow the email to contain the selected document as attachments.
Allows you to specify the skin name for the rich text editor in the
Send Email panel. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Custom Display Tab
The custom display properties lets the page designer customize the display of the data using HTML and JavaScript. The custom display appears after the default display (if the Display Fields property is defined).
254
qListView
Three properties define the custom display. The example in each property illustrates how to display the FullName field of the search results in an HTML table.
ELEMENT
Results Header
Results Body
Results Footer
DESCRIPTION
Allows you to set the value of this property that is rendered once before the Results Body. This property is a good place to include any JavaScript file, defining any JavaScript function, or define any
HTML elements for the header.
Example: These are the customers that match your search criteria.<br><table><tr><th>Full Name</th></tr>
Allows you to set the value of this property that is repeated once for every row in the search results. You can use the <%field name%> field replacement expression to refer to the value of a certain field.
Example: <tr><td><%FullName%></td>
Allows you to set the value of this property that is rendered once after the Results Body.
Example: </table>
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the Web Part , whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list.
The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
255
Quick Apps for SharePoint
ELEMENT
Title Resource ID
View Properties Context
Menu Text Resource ID
Edit Properties Context
Menu Text Resource ID
Manage Permissions
Context Menu Text
Resource ID
Alert Me Context Menu
Text Resource ID
Version History Context
Menu Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the Web Part. The Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
By default, the text for the View Properties context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the View Properties context menu item in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Edit Properties context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Edit Properties context menu item in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Manage Permissions context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Manage
Permissions context menu item in the Resource List and specify its
Resource ID. This Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Alert Me context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Alert Me context menu item in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Version History context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Version History context menu item in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
256
qListView
ELEMENT
Workflows Context Menu
Text Resource ID
Check Out Context Menu
Text Resource ID
Check In Context Menu
Text Resource ID
Undo Check Out Context
Menu Text Resource ID
Edit Document Context
Menu Text Resource ID
Edit in Browser Context
Menu Text Resource ID
DESCRIPTION
By default, the text for the Workflows context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Workflows context menu item in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Check Out context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Check Out context menu item in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Check In context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Check In context menu item in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Undo Check Out context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Undo Check Out
Context Menu in the Resource List and specify its Resource ID. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Edit Document context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Edit Document context menu in the Resource List and specify its Resource ID. This Resource
ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Edit in Browser context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Edit in Browser context menu in the Resource List and specify its Resource ID. This Resource
ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
257
Quick Apps for SharePoint
ELEMENT
Download Copy Context
Menu Text Resource ID
Create Document
Workspace Context Menu
Text Resource ID
Send Email Context Menu
Text Resource ID
Action Button Text
Resource ID
Filter Button Text
Resource ID
New Button Text Resource
ID
DESCRIPTION
By default, the text for the Download Copy context menu is retrieved from the resource file that is included in the product. If the resource file in the culture that you want to use is not available, define the text for the Download Copy in the Resource List and specify its
Resource ID. This Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Create Document Workspace context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the
Create Document Workspace context menu in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Send Email context menu is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Send Email context menu in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Action toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Action toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Filter toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Filter toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the New toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the New toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
258
qListView
ELEMENT
Upload Button Text
Resource ID
Upload Document Button
Text Resource ID
Upload Multiple
Documents Button Text
Resource ID
Delete Button Text
Resource ID
Show Folders Button Text
Resource ID
DESCRIPTION
By default, the text for the Upload toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the View in Chart toolbar button in the Resource List and specify its Resource ID here. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Upload Documents toolbar button is retrieved from the resource file that is included in the product.
However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the
Upload Documents toolbar button in the Resource List and specify its
Resource ID here. This Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Upload Multiple Documents toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Upload Multiple Documents toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Delete toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Delete toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Show Folders toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Show Folders toolbar button in the Resource List and specify its Resource ID here. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
259
Quick Apps for SharePoint
ELEMENT
Replace Button Text
Resource ID
Copy Move Button Text
Resource ID
Open with Windows
Explorer Button Text
Resource ID
Alert Me Button Text
Resource ID
Export Button Text
Resource ID
Print Button Text
Resource ID
DESCRIPTION
By default, the text for the Replace toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Replace toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Copy Move toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Copy Move toolbar button in the Resource List and specify its Resource ID here. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Open with Windows Explorer toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Open with Windows Explorer toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Alert Me toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Alert Me toolbar button in the Resource List and specify its Resource ID here. This Resource
ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Export toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Export toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Print toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Print toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
260
qListView
ELEMENT
View in Excel Button Text
Resource ID
View in Chart Button Text
Resource ID
DESCRIPTION
By default, the text for the View in Excel toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the View in Excel toolbar button in the Resource List and specify its Resource ID here. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the View in Chart toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the View in Chart toolbar button in the Resource List and specify its Resource ID here. This
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
qListView Procedures
You can perform the following procedures using qListView:
•
Configuring Basic Settings using the Configuration Wizard
•
Configuring Advanced Settings using ezEdit
Configuring Basic Settings using the
Configuration Wizard
To configure basic settings
1.
Add qListView to your page.
2.
Select the ezWizard menu item from the Web Part Menu of the qListView.
3.
Select one or more lists whose data you want to view, and click
Next.
4.
Select the fields you want displayed and the order you want them displayed. Click
Next.
If you want to change your selections, select
Previous
.
5.
Click
Finish
.
261
Quick Apps for SharePoint
Configuring Advanced Settings using ezEdit
To configure advanced settings
1.
Open
ezEdit
.
The Display tab opens by default.
2.
From the Viewed List section, click
Edit
.
This section is populated with lists selected when you configured basic settings.
3.
If you want to: a) edit one of these lists, click
Edit
.
b) Enter values in any fields.
c) To include a child list, select
Add Child List
.
You must select add a child list if you want add child view display fields.
d) To include a dependent list, select
Add Dependent List
.
– OR – a) add a new list, select
Add List
.
b) Enter the Site URL or if using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash (/) to denote the root path.
c) Select
Search Subsites
check box.
d) Click
Get Lists
.
e) Select the lists that you want to use and click
OK.
f) Click
Save
.
4.
From the Display Fields section, click
Edit
.
a) Select the Field Names that you wish to display.
b) If you want, click
Edit
to edit any of the fields.
c) Click the
Save
.
5.
From the Child View Display Fields section, select
Edit
.
6.
Select one or more fields to be displayed. Enter a title, width, and alignment. Click
Save
.
Click Edit next to a field name to further define a field.
262
qListView
7.
From the Searched Fields section, click
Edit
.
a) Select the Field Names that you wish to display.
b) Click the
Save
.
8.
From the Fields Excluded from Replace Panel section, click Edit.
a) Select one or more field names and the order you want them displayed.
b) Click OK.
9.
Select if you want any or all of the following:
• Show Include Sub Folders Check Box In Search Panel
• Show Search All Fields Control in Search Panel
• Expand Child View on Load
• Expand Filter panel on Load
10. Select a location for the panel button.
11. Select a new item panel style.
12. From the Custom Actions section, click
Edit
.
a) Right-click Toolbar Buttons and/or Context Menu to add action items and/or separators.
b) Click
OK
.
13. From the CAML Filter section, click
Edit.
a) Add conditions in the Tree View tab.
You can view the conditions in XML format in the XML View tab.
b) Click
Save
.
14. Add Complex Filters.
15. From the CAML Filter for Folders section, click
Edit
.
a) Add conditions in the Tree View tab.
You can view the conditions in XML format in the XML View tab.
b) Click
Save
.
16. Select if you want apply the CAML Filter on the first level folder only.
17. Enter a maximum row count.
18. In the Sort Fields section, enter a sorting criteria.
19. In the Child View Sort Fields section, enter a sorting criteria for the child view.
20. In the Search Session Name section, enter search criteria that other
Web Parts with this session variable can use.
21. Select if you want any or all of the following:
• Enable New Link in Child View
• Disable Multi Column Sorting
263
Quick Apps for SharePoint
• Enable AJAX
• Turn on List Searcher Mode
22. Enter the URL of a qExcelViewer Web part to allow you to export your lists to Excel.
23. Enter an ID HTTP Parameter name to allow the HTTP Parameter called ID to identify an item to be displayed or edited.
24. Enter the groups that are allowed or not allowed to view qListView.
25. Click
OK
.
264
qManagement
•
Overview
•
qManagement Tabs
•
qManagement Procedures
14
Quick Apps for SharePoint
Overview
qManagement allows you to view and manage your web parts in one location.
From qManagement, you can:
• easily view and explore the hierarchy of the site where qManagement is located and its subsites
• search for one or more web parts by type or by property
• replace a property value with another one to one or more web parts
• display your search and replace results in a table view
• open ezEdit in the table view
When you perform a search and replace, you will not see the ezEdit icon in the table view if you do not have proper permissions.
In order to see all sites and subsites in qManagement, you must have administrator permissions. If you do not have administrator permissions, some sites and subsites may not be displayed.
qManagement Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qManagement contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in “Common Tabs” on page 17.
266
qManagement
Display Tab
When you open ezEdit in qManagement, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Enable AJAX
Skin Name
Show User Groups
Hide User Groups
DESCRIPTION
When checked, allows you to enable AJAX for qManagement to carry out some operations within the web part without refreshing the whole page.
For example, when you sort a column by clicking its column header or change the page by clicking the pager, qManagement only refreshes the data in the grid without causing the whole page to post back.
AJAX must be disabled in Internet Explorer 6, the data grid will fail to carry out the AJAX operation. If a user reports this issue, you can disable the AJAX to fix it.
Note:
You must enable AJAX to set an AJAX timeout value.
Allows you to select the skin name for the web part. If you have a custom skin, you can add it to the following folder for SharePoint
2010:C:\Program Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins or for SharePoint 2013: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Allows you to list SharePoint groups whose members can view the web part. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the web part. Separate site group names with commas (for example,
Administrators, Readers).
Note:
If a user is a member of a group that is defined in both Show User
Groups and Hide User Groups, the user cannot view the web part.
Grid Appearance Tab
The Grid Appearance Tab contains the following:
ELEMENT
Paging Mode
Page Size
DESCRIPTION
Allows you to select the type of pager that is displayed at the bottom of qManagement if the items must be divided into multiple pages.
Allows you to set the maximum number of rows that is displayed in one page. If the number of rows is larger than the Page Size, the data is divided into several pages. You can navigate the pages using the Pager displayed at the bottom of qManagement.
267
Quick Apps for SharePoint
qManagement Procedures
You can perform the following procedures using qManagement:
•
•
•
•
Configuring qManagement
To configure qManagement
1.
Add qManagement to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Select the following:
• if you want to enable AJAX
• if you want to wait a specified amount of time for the result of an AJAX asynchronous postback operation
• the skin name
• if you want to display the web part to certain user groups
• if you want to hide the web part from certain user groups
4.
Click
OK
.
Exploring Web Parts
Once qManagement is configured, the Explorer View opens by default. The
Explorer View shows the site where qManagement is located as the root node, and all its subsites as child nodes. From the Explorer View, you can:
• open a SharePoint web part page
• open ezEdit
• delete a web part
268
qManagement
• get more details about the web part, such as web part type, web part product, and version number.
The actions available in the treeview depend on your SharePoint permissions.
Searching Web Parts
You can search a list of specific web parts by selecting web part names only or selecting web part names and entering property values.
To search Web Parts
1.
Open qManagement, and click
Search
.
2.
Select a web part type.
Click the ... button to select a single web part type or multiple web part types.
3.
Select a web part property.
The web part properties displayed depend on the web part type selected. If you have selected multiple web part types, then the common web part properties are displayed.
4.
Select a search condition, and enter a property value.
These steps are optional.
5.
Click
Go
.
The results is displayed in a table showing the following:
• Web Part title
• Web Part type
• the path where the web part is located
• an Edit icon which opens ezEdit for the found web part. You will not see the ezEdit icon if you do not have proper permissions.
269
Quick Apps for SharePoint
Setting New Property Values
Setting new property values in your web parts using qManagement may take a long time.
If it times out, you can increase the time-out value in the Web.Config file by setting the executionTimeout attribute.
This new time-out value is automatically applied to any web part that is on the same page as qManagement, and has an AJAX operation enabled.
Because it can take a long time, set new property values during off-peak hours.
If you want to see which web parts are affected by setting new values, perform a search first. You can search and replace properties in Web Parts only.
To set new property values
1.
Open qManagement, and click
Replace
.
2.
Select a web part type.
Click the ... button to open a dialog that allows you to select a single web part type or multiple web part types.
3.
Select a web part property.
The web part properties displayed depend on the web part type selected. If you have selected multiple web part types, the common web part properties are displayed.
4.
Select a search condition, and enter a property value.
These steps are optional.
5.
Enter a new property value.
Ensure you enter the applicable value you want set to a new value.
For example, if you enter the following:
• Web Part Type = qListView
• Web Part Property = Title
• Search Condition = Contains
• Property Value = Financial Department Web Part
• Set Property Value to = Human Resources
The new value is Human Resources, not Human Resources Web Part.
If you enter invalid values in the Web Parts property, that Web Part may become inoperable.
If you leave this value blank, the old property value is replaced with a blank value.
270
qManagement
6.
Click
Go
.
When you set a new property value, it cannot be undone.
The results is displayed in a table showing the following:
• the total number of results, including the number that have succeeded and/or failed
• Web Part title
• Web Part type
• the path where the Web Part is located
• an Edit icon which opens ezEdit for the found Web Part. You will not see the ezEdit icon if you do not have proper permissions.
• a status showing if setting the new property value succeeded or failed.
If you see a Failed status, you can click
Failed
to see an error message of why the action failed.
If you want to print your results, export the results to an Excel spreadsheet first.
271
Quick Apps for SharePoint
272
qMediaView
•
Overview
•
qMediaView Tabs
•
qMediaView Procedures
15
Quick Apps for SharePoint
Overview
qMediaView provides support for the SharePoint Picture and Asset Libraries. The
Picture Library provides the ability to upload and share pictures in SharePoint.
The Asset Library provides the same ability but with all your digital assets such as images, audio, video, and other content from many applications.
Playing audio and video files requires Microsoft Silverlight. To download, go to http://www.microsoft.com/getsilverlight/Get-Started/Install/Default.aspx. Make sure the status of Microsoft Silverlight is enabled in Internet Explorer’s Add-ons Manager.
To enable Silverlight in Internet Explorer Add-ons Manager
1. Click
Tools | Manage Add-ons
.
2. Select
All add-ons
.
3. Select
Enabled
for Microsoft Silverlight in the Add-on list. qMediaView allows you to:
• provides the ability to manage multiple media type resources in
SharePoint
• aggregate media from multiple picture libraries and asset libraries from various SharePoint sites
• select one or more audio or video files and play them consecutively in a playlist fashion
• view the media in several different ways: List, Metadata, Slide Show,
Image Gallery
• navigate the folder structures using breadcrumb navigation. The breadcrumb is displayed in between the ribbon button and the picture library view. The breadcrumb navigation bar is displayed as All >>
Site/Picture Library Name >> Folder Name >> Subfolder Name.
When there are multiple libraries defined in Viewed List property, the
Root node "All" is displayed allowing you to navigate to the aggregated view of the all picture libraries' root folder structure.
• divide the data into multiple pages to limit their size and render pages faster, known as Paging
• define the dynamic filter or search criteria using the Filter panel, and supports the List Searcher mode in the Media View
274
qMediaView
qMediaView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qMediaView contains the following tabs:
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qMediaView, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Viewed Lists
Display Fields
Searched Fields
DESCRIPTION
Allows you to set the URL to the site that contains the list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Allows you to set the name of the list. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List Name.
Allows you to set the identifier to locate the help URL in the list.
Note:
We recommend that you define a convention for the Context ID value that will make it easy for you to identify where the help URL is used. For example, use the page URL, remove the host name from the
URL, and replace all / (slash) with . (dot). Therefore, if the page URL is http://hostname/sites/mysite/default.aspx, the Context ID is sites.mysite.default.aspx
275
Quick Apps for SharePoint
ELEMENT
Enable AJAX
Skin Name
Expand Filter panel on
Load
Turn on Media Search
Mode
Show Search All Fields
Control in Search Panel
DESCRIPTION
Allows you to enable AJAX. AJAX enables the Media View to carry out some operations within the frame without refreshing the whole page.
For example, when you change the page by clicking the pager, the
Media View only refreshes the data in the grid without causing the whole page to post back. However, there are times when AJAX causes some issues. In this case, you must disable the AJAX capability of the
Media View.
The following are some known situations where you need to disable
AJAX:
• In Internet Explorer 6, the data frame will fail to carry out the
AJAX operation. If your user base reports this issue, you can disable the AJAX to fix it.
• If you use javascript's document.write() method in the Results
Body property of the Custom Display, the text that is generated using document.write() will not be rendered after the AJAX operation.This is true even if you do not call the document.write() directly within the Results Body but rather through another javascript function that calls document.write().
Allows you to specify the skin name for the frame in the Media View.
The skin name is associated with a folder under the following directory in the web server:
C:\Program Files\Common Files\Microsoft Shared\Web
ServerExtensions\12\TEMPLATE\LAYOUTS\QuestSoftware\DevExpress\
9.3\Themes
The skin folder will contain the CSS file and images needed to control the visual appearance of the grid. If none of the provided skins satisfy your need, you can copy one of the existing skins and modify it. You must follow the CSS class name convention in the CSS file, which is class name followed by the skin name; for example, dxtlControl_Office2003Blue.
Allows you to automatically open the Filter panel by default so that the user can perform a search quickly. When set to true, the Filter panel opens when the web part is loaded for the very first time.
Allows you to perform a search before the Media View displays any data.
Allows you to determine whether the Filter panel should display the control to search all fields in the list. When set to true, the following control is shown in the Filter panel:
The Search All Fields Control allows you to do the following:
• Combine the search all fields functionality with other search criteria that has been entered for specific fields.
• When the search all fields criteria is entered, the Filter panel will construct a filter expression with the "Contain" operator for the following fields in the list: Single line of text, Multiple lines of text,
Choice, Lookup, Person or Group and Hyperlink or Picture. The
Filter panel will use the entire keywords as the value to be searched. Therefore, if you enter "High Priority" in the search all fields control and perform the search, it will find the following sentence:
‘This is a high priority task’
However, it will not find the following sentence:
‘The priority is not always high’.
276
qMediaView
ELEMENT
Filter panel Button
Location
DESCRIPTION
Allows you to set the location of the Go, Reset and Close buttons in the
Filter panel. This property also determines the location of the Go and
Close buttons in the replace panel.
Viewed Lists
The Viewed Lists section defines the lists whose data is viewed in the Media
View. To aggregate information from multiple lists, define the lists one by one using this property.
The following property is an XML string in this format:
<Lists>
<List SiteUrl="." ListName="MyPicLib" />
<List SiteUrl="./TeamBlog" ListName="Photos" />
</Lists>
The following are the elements for the Viewed List attribute.
ELEMENT
Site URL
List Name
DESCRIPTION
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Allows you to set the name of the SharePoint list that is edited or displayed. The list name is case sensitive. If the list name contains spaces, include the spaces here as well.
To denote the current list, you can use a single dot (.) as the list name.
Note:
This only works if the qMediaView is contained in the
AllItems.aspx. For example, if you are replacing the Microsoft Media
View in the AllItems.aspx of the Tasks list and you use a single dot as the ListName attribute, the ListName attribute of the qMediaView is set to Tasks. If you want to save the list as a template and then add it somewhere else, the name of the new list might not be Tasks and using this relative list name will automatically pick up the new list name for the view.
Display Fields
This property defines the fields that should be displayed in the Media View.
This property is an XML string in the following format:
277
Quick Apps for SharePoint
<Fields>
<Field Name="Name" InternalName="FileLeafRef" />
<Field Name="Type" InternalName="DocIcon" />
<Field Name="Copy Source" InternalName="_CopySource"
/>
<Field Name="File Size" InternalName="FileSizeDisplay"
/>
<Field Name="Preview" InternalName="PreviewOnForm" />
<Field Name="Picture Width" InternalName="ImageWidth"
/>
<Field Name="Description" InternalName="Description"
/>
</Fields>
The Fields element can contain multiple field elements.The following are the elements for the Display Fields.
ELEMENT
Name
Title
Width
Align
DESCRIPTION
Specifies the name of the field. The field name is case sensitive. If the field name contains spaces, include the spaces in the name as well.
If you only specify the Name attribute, the field is displayed as it does in the Microsoft List View.
Allows you to set the title in the field header. This is useful if the real field name is too long and you want to abbreviate the title in the field header, or if you simply want to display a different title in the field header. If this attribute is not specified, the value specified in the Name attribute is used in the field header
Allows you to set the width of the field. You can specify the value in pixels (Width="20px") or percentage (Width="20%").
We recommend leaving at least one field where you do not specify this property.
Allows you to set the horizontal alignment for the field.
Searched Fields
This property defines which fields is displayed in the Filter panel. If defined, the
Media View displays the Filter menu items under the Actions tab. To disable the
Filter feature, leave this property blank.
This property is an XML string in the following format:
<Fields>
<Field Name="Name" InternalName="FileLeafRef" />
<Field Name="Title" InternalName="Title" />
<Field Name="File Type" InternalName="FileType" />
<Field Name="Site Name" InternalName="Site Name" />
</Fields>
278
qMediaView
The Fields element can contain multiple Field elements.The following are the elements for the Searched Fields.
ELEMENT
Name
Title
Width
DESCRIPTION
Specifies the name of the field. The field name is case sensitive. If the field name contains spaces, include the spaces in the name as well.
Allows you to set the displayed title for the field. The value can be a plain string or an encoded HTML string.
Allows you to set description that is displayed under the field value.
This is useful if you want to give a short instruction or explanation about the field.
View Appearance Tab
The View Appearance tab contains the following:
ELEMENT
Media View Type
Page Size
Paging Mode
DESCRIPTION
Allows you to view the media in the following ways:
• For a picture library: List, Metadata, Slide Show, or Image Gallery.
• For an asset library: All Assets and Thumbnails.
The mode that is used by the web part when the page is first loaded can be set using this property. The user can change the viewing mode on the fly as well using the View tab of the qMediaView Web Part.
Allows you to set the maximum number of items that are displayed in one page. If the number of items is larger than the Page Size, the data is divided into several pages. The user can navigate the pages using the
Pager displayed at the bottom of the page.
Allows you to set the type of pager that is displayed at the bottom of the page if the items must be divided into multiple pages. A numeric pager is more user-friendly because you are not bound to only next or previous pages. However, the numeric pager consumes a lot more resources to generate, especially when the list contains a large number of items. The next previous pager is more efficient when the following conditions are fulfilled:
• When the Display Fields property does not contain grouped fields.
• When the Viewed Lists property only contain one list.
279
Quick Apps for SharePoint
Slide Show Appearance Tab
The Slide Show Appearance Tab contains the following:
ELEMENT
Slide Show Style
Scroll Duration (milliseconds)
Frame Duration (milliseconds)
Wrap Frames
Slide Animation Type
Slide Animation Duration
(milliseconds)
Item Width (px)
Item Height (px)
DESCRIPTION
Allows you to specify the different styles for the slide show. You can change the style on the fly as well using the View tab of qMediaView. The options are as follows:
• AutomaticAdvance — Media items are scrolled automatically at the specified speed.
• ButtonsOver — Media items are scrolled by hovering over the control buttons for each scroll direction.
• Buttons — Media items are scrolled by clicking the control buttons for each scroll direction.
• SlideShow — Media items are automatically advanced with an optional transition effect (for example fade) instead of scrolling.
• SlideShowButtons — Media items are displayed by clicking the control buttons for each sliding direction.
• Carousel — Media items are automatically displayed in carousel style.
• CarouselButtons — Media items are displayed in carousel style by clicking the control buttons for each scroll direction.
• CoverFlow — Media items are automatically displayed in cover flow style.
• CoverFlowButtons — Media items are automatically displayed in cover flow style by clicking the control buttons for each flow direction.
Allows you to specify, in milliseconds, the speed for the scrolling frames. The default is 500.
Allows you to specify, in milliseconds, the speed each frame will display. The default is 500. This property is ignored in the
Buttons and SlideShowButtons modes.
Allows you to set the frame to scroll from the beginning again once it reaches the last frame.
Allows you to specify the skin name for the grid in the listview.
Specifies the type of the animation. The options are Fade, Pulse and CrossFade.
Allows you to specify the slide show animation duration in milliseconds. The default is 3000.This property is only applicable when the Slide Show Style is set to 'SlideShow' or
'SlideShowButtons'.
Allows you to specify the rotator item's width in pixels. The default is 550. This property is only applicable when the Slide
Show Style is set to 'SlideShow' or 'SlideShowButtons'.
Allows you to specify the rotator item's height in pixels. The default is 410. This property is only applicable when the Slide
Show Style is set to 'SlideShow' or 'SlideShowButtons'.
280
qMediaView
ELEMENT
Rotator Width (px)
Rotator Height (px)
Enable Ribbon Bar
Scroll Duration
DESCRIPTION
Allows you to specify the rotator width in pixels. The default is
550. This property is only applicable when the Slide Show Style is set to 'SlideShow' or 'SlideShowButtons'.
Allows you to specify the rotator height in pixels. The default is
410. This property is only applicable when the Slide Show Style is set to 'SlideShow' or 'SlideShowButtons'.
Allows you to specify if the Ribbon Bar is visible or hidden. The default is Visible. This property is only applicable when the
Slide Show Style is set to 'SlideShow' or 'SlideShowButtons'.
Allows you to specify possible directions for the scrolling frames. The options are Horizontal and Vertical. This property is only applicable when the Slide Show Style is set to a 'Button' type style.
qMediaView Procedures
You can perform the following procedures using qMediaView:
•
Configuring qMediaView
1.
Add qMediaView to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
281
Quick Apps for SharePoint
282
qMultiSelector
•
Overview
•
qMultiSelector Tabs
•
qMultiSelector Procedures
16
Quick Apps for SharePoint
Overview
qMultiSelector contains one or more
web part. When multiple selectors are displayed, one selector will filter the next one.
If you would like to learn more, click here to watch the training video.
qMultiSelector implements the row provider interface. It can provide a row to another Row Consumer web part or a filter to another Filter Consumer web part.
The List Form implements IRowProvider interface. It can provide a row to another Row Consumer web part or a filter to another Filter Consumer web part.
IRowProvider is obsolete. It is provided here only for backward compatibility reason.
When you establish the web part connection, this interface is labeled Provide Row To
(Obsolete) in the web part Connections menu. Use the IWebPartRow implementation that is labeled with Send Row To.
The List Form also implements IWebPartRow interface, and it can provide a row to another web part, such as qListView.
IWebPartRow is labeled with Send Row To in the web part Connection menu. This interface cannot be connected with the obsolete IRowConsumer or IFilterConsumer implementation. Do not connect this new interface with the old interface that is marked obsolete.
qMultiSelector Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qMultiSelector contains the following tabs:
•
•
•
•
•
•
284
qMultiSelector
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qMultiSelector, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Selector Direction
Configuration
DESCRIPTION
Allows you to control the positioning of the selectors. If LeftToRight is selected, the selectors are positioned side by side. If TopToBottom is selected, the selectors are stacked on top of one another.
Allows you to enter a list name. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List Name.
Configuration
This property defines the configuration for each selector. The property is in XML format. The following is an example of a valid Configuration string:
<Configuration>
<PersistentSelector Title="Select a Project"
SessionName="ProjectSession" SiteUrl="."
ListName="Projects" DisplayFieldName="Project Name"
DisplayFields="<Fields><Field Name="Project
ID"/><Field Name="Project
Name"/></Fields>" />
<PersistentSelector Title="The select a Phase"
ParentFilterFieldName="ID" FilterFieldName="Project List
Item ID" SessionName="PhaseName" SiteUrl="."
ListName="Phases" DisplayFieldName="Phase Name" />
</Configuration>
The top-level element is called Configuration. This element contains one or more
PersistentSelector elements. Each PersistentSelector element represents one qSelector selector. Most attributes in the PersistentSelector element are the same properties as those defined for qSelector without spaces in its name. For example, the Show Empty Selection property in the qSelector becomes the
ShowEmptySelection attribute in the PersistentSelector element.
285
Quick Apps for SharePoint
In addition, the PersistentSelector element recognizes the following attributes:
The Configuration section contains the following:
ELEMENT
Title
Site URL
List Name
Session Name
Parent Filter Field Name
Filter Field Name
Hidden
Display Field Name
Display Format
Display Fields
Eliminate Duplicate
Values
CAML Filter Expression
Complex Filter
Sort Field
Sort Ascending
DESCRIPTION
Allows you to enter a title that is displayed above the selector.
Allows you to enter the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL.
Allows you to enter a list name
Allows you to define the search session variable name where the qSelector stores the last selected item. If you want to associate several selectors, you must define the same Search Session Name property for all of them.
Allows you to enter the field name from the previous selector that is used to filter the information in this selector.
Allows you to enter the field name in the selector that filters the information.
Allows you hide the field to prevent other users from changing the selection.
Allows to enter the name of the field that you want to display in the selector.If you want to display information from multiple fields, use the
Display Format properties. The Display Field Name property is ignored if the Display Format property is defined.
Allows you to define the format of the items that are displayed in the selector. You can use field replacement expression (<%field name %>) to refer to a field name.
Allows you to define the fields that are displayed in the drop-down menu of the web part.
Allows you to define whether or not you want to eliminate duplicate values in the drop-down menu. This is useful in case you want to use the selector as a filter to another Web Part.
Allows you to enter a CAML (Collaboration Application Markup
Language) query expression to filter your data. CAML is an XML based query language. See
“CAML Filter Help” on page 467
on more information.
Allows you enter Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML Filter is applied, See
“Complex Filter Help” on page 475 on more information.
Allows you to enter a value that is used to sort the entries in the qSelector. This property accepts a single field name.
Allows you to sort the entries in the ascending order. Deselect this check boxif you want the entries in descending order. This field is ignored if the Sort Field property is not defined.
286
qMultiSelector
ELEMENT
Show Empty Selection
Empty Selection Item
Name
DESCRIPTION
Allows you to display the value of Empty Selection Item Name property as the first item.
You should check this property if you want the user to be able to select nothing. Selecting nothing returns the entire unfiltered list. Another case is when the qSelector acts as a filter to another web part and you want the ability to pass an empty filter. This means the other web part will display all its data unfiltered.
Allows you to display a specified value as the first item in the Selector when the Show Empty Selection is checked. The default is - Select One
-.
Allows you to display specified text that is displayed in the drop-down menu when it contains no list items. The default is <Empty>.
Allows you to set the width of the input part for the persistent selector.
Empty Drop-Down Item
Name
Persistent Width
Selector
Drop-Down Width
Drop-Down Height
Refresh Page When
Selection Changed
Allows you to set the width of the drop-down for the selector in pixels.
If you specify the width for each field in the Display Fields property in pixels, the value of this property is usually the total width of all fields.
Allows you to set the height of the drop-down menu.
Allows you to determine whether the page should be refreshed when you select another item in the selector. By default, the value is false, which means that the page is only posted back.
Selector Appearance Tab
The Selector Appearance Tab contains the following:
ELEMENT
Skin Name
DESCRIPTION
Allows you to select the skin name for the grid in the listview. If you have a custom skin, you can add it to the following folder for
SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
287
Quick Apps for SharePoint
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
288
qMultiSelector Procedures
You can perform the following procedures using qMultiSelector:
•
qMultiSelector
Configuring qMultiSelector
To configure qMultiSelector
1.
Add qMultiSelector to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
289
Quick Apps for SharePoint
290
qPageRedirector
•
Overview
•
qPageRedirector Tabs
•
qPageRedirector Procedures
17
Quick Apps for SharePoint
Overview
qPageRedirector sends users to a designated URL. To accomplish this, you could create a "My Home" hyperlink on your page that redirects the user to the
MyHomeRedirect.aspx page. In the MyHomeRedirect.aspx page, you would put a Page Redirector web part. qPageRedirector reads a list that contains two columns: User Name and URL. It will search the list for the entry with User Name equals to the current logged on user. If it finds it, it will redirect the user to the URL mapped to that user in the list.
The SharePoint list for the Page Redirector must contain these two fields:
• User Name
—
a user lookup field that defines the user.
• URL
—
a text field. It can contain relative or absolute URL
If your list uses different names for the fields, you must define the names in the
User Name Field Name and the URL Field Name property of the Page Redirector.
Here is the sample list:
USER NAME
Questdev\jsmith
Questdev\kbrown
URL
home/jsmith.aspx
home/kbrown.aspx
When jsmith logs in, it will redirect him to home/jsmith.aspx.
You can localize the title of the Page Redirector. You can define different Titles for different cultures using the Resource List and the Title Resource ID properties. You can use the Culture Selector web part to set the culture for the site. The Culture Selector web part will define the culture using the Culture HTTP parameter as shown in the following example: http://hostname/sites/sitename/default.aspx?Culture=en-US
If you would like to learn more, click here to watch the training video.
292
qPageRedirector
qPageRedirector Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qPageRedirector contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qPageRedirector, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Site URL
List Name
User Name Field Name
URL Field Name
DESCRIPTION
Allows you to enter the URL to the site that contains the list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
Allows you to enter a configuration list name.
Allows you to enter the name of the field containing the user information. The default value is User Name.
Allows you to enter the name of the field containing the URL to which the user is redirected. The default value is URL.
293
Quick Apps for SharePoint
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
294
qPageRedirector
qPageRedirector Procedures
You can perform the following procedures using qPageRedirector:
•
Configuring qPageRedirector
To configure qPageRedirector
1.
Add qPageRedirector to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
295
Quick Apps for SharePoint
296
qPanelMenu
•
Overview
•
qPanelMenu Tabs
•
qPanelMenu Procedures
18
Quick Apps for SharePoint
Overview
qPanelMenu groups navigation items into multiple panels. The panel menu is similar to that on the left side of Microsoft Outlook.
qPanelMenu has the ability to:
• display items from different SharePoint lists. Each SharePoint list can contain the definition for multiple panels. The source lists for the menu are defined in the Configuration property.
•
define a static FilterExpression using a Complex Filter expression
so you can define the items to be displayed in your menu.
• show or hide the top-level items that come from a certain list based on the site group membership of the currently logged-in user.
• hide menu items whose target URLs are not accessible by the current user
• define an icon for each menu item, and define the target frame for the target page.
• define different Title for different cultures using the Resource List and the Title Resource ID properties. Your can define the culture appending the
Culture
HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US
If you would like to learn more, click here to watch the training video
.
To configure this web part, we recommend that you use the Quest Menu List custom list template. Use the template to define a source list for the menu items on a SharePoint site. For information on how to create the source list, see
“Configuring qPanelMenu” on page 304
. This automatically creates a list which contains the following columns by default:
COLUMN
Text
Menu ID
Parent Menu ID
Target Url
DESCRIPTION
Provide the text for the menu item.
Provides the ID for the menu item.
Provides the ID of the menu item that is the parent of this menu item.
Provides the target URL for the menu item.
Note:
This is not a Hyperlink field because Hyperlink field does not let you use a relative URL.
298
qPanelMenu
COLUMN
Target
Icon Url
Access Key
DESCRIPTION
Indicates where to open the target page. Specify
_blank
to open the page in a new window. Leave the target column empty to redirect the current window to the target URL.
Provides the URL to the icon for the menu item.
Indicates the shortcut key to activate the menu item. You can activate the menu item by pressing ALT+Access Key Character.
Indicates the culture for this menu item Culture
You must map these columns in the source list to the corresponding field names in the Configuration section in the Web Part. For more information on the
Configuration section, see
. For more information on how to configure the qCascadingMenu Web Part, see
“Configuring qPanelMenu” on page 304
.
qPanelMenu Tabs
You can configure this Web Part through its tabs that are accessible through ezEdit. qPanelMenu contains the following tabs:
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
299
Quick Apps for SharePoint
Display Tab
When you open ezEdit in qPanelMenu, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Configuration
Target URL Relative to Master Page URL
Skin Name
Expand Effect
Expand Group
Indices
Expand All Parent
Menu Items on Load
Menu Width
Menu Height
Expand Mode
DESCRIPTION
See
“Configuration” on page 300 for more information.
Allows you to append the value of the target URL to the URL of the master page. By default, this property is set to true to maintain backward compatibility with the existing applications who assumed that the relative
URL is appended to the relative URL of the master page.
Allows you to select the skin name for the menu. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program
Files\Common Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins or for SharePoint 2013: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Allows you to set the visual effect that is applied when the panel items are expanded or collapsed. The default expand effect is Linear.
Allows you to set the indices of the groups that are expanded initially when the page is loaded. The index starts with 0. For example, if you want to expand the first and the third groups, specify: 0, 2
Allows you to expand all parent menu items when the page is loaded.
Parent menu items are all menu items that contain sub menu items underneath it. If you set this to true, you do not have to define the
Expanded Group Indices property since it will automatically expand the top level menu items as well.
Allows you to enter the width of the menu (in pixels).
Allows you to enter the height of the menu (in pixels).
Allows you to set the behavior of the panels when one is expanded or collapsed. The default expand mode is MultipleExpandedItems. This expand mode enables you to expand multiple panels at the same time.
Configuration
This property defines the source list and behavior of the cascading menu. The
Configuration element can contain one or more Menu elements. Each menu element can read a different source. This property is an XML string in the following format:
<Configuration>
<Menu SiteUrl="url" ListName="listName"
300
qPanelMenu
FilterExpression="filterExpression" TextFieldName="Text"
MenuIdFieldName="Menu Id" TargetUrlFieldName="Target Url"
TargetFieldName="Target" IconUrlFieldName="Icon Url"
AccessKeyFieldName="Access Key" CultureFieldName="Culture"
ShowUserGroups="Group1, Group2" HideUserGroups="Group1,
Group2" CheckUserAccess="true/false"/>
</Configuration>
The following example shows the panel menu whose entries come from 5 different lists. This means the panel menu will have 5 different panels. If you notice, the 3rd, 4th and 5th lists are not the regular panel menu lists as described in the Overview section. These panels display the client information from the Clients list into the panel menu. The entries are filtered differently in those panels so that the 3rd panel shows Active clients, the 4th panel shows
Prospective clients and the 5th panel shows Inactive clients. We map the Text
Field, Menu ID Field, and Target Url Field to different field in the Clients list.
<Configuration>
<Menu SiteUrl="." ListName="My Favorites" />
<Menu SiteUrl="." ListName="Quick Links" />
<Menu SiteUrl=".." ListName="Clients"
TextFieldName="Client Name" MenuIdFieldName="ID"
TargetUrlFieldName="Site Url" FilterExpression="Client
Status='Active'"/>
<Menu SiteUrl=".." ListName="Clients"
TextFieldName="Client Name" MenuIdFieldName="ID"
TargetUrlFieldName="Site Url" FilterExpression="Client
Status='Prospect'"/> <Menu SiteUrl=".."
ListName="Clients" TextFieldName="Client Name"
MenuIdFieldName="ID" TargetUrlFieldName="Site Url"
FilterExpression="Client Status='Inactive'"/>
</Configuration>
The following are the elements for the Configuration section:
ELEMENT
Site URL
List Name
Filter Expression
DESCRIPTION
Allows you to set the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
When using a relative URL, you can use a single dot (.) to denote the current path, a double dot (..) to denote the previous path, and a slash
(/) to denote the root path.
Allows you to enter the name of the list. The name is case sensitive. If the name of the list contains spaces, include the spaces in the List
Name.
Allows you to filter the data. The Complex Filter Expression to filter the
data. See “Complex Filter Help” on page 475 for help.
301
Quick Apps for SharePoint
ELEMENT
Menu ID Field Name
Parent Menu ID Field
Name
Target URL Field Name
Target Field Name
Icon URL Field Name
Culture Field Name
Access Key Field Name
Show User Groups
Hide User Groups
Check User Access
DESCRIPTION
Allows you to set the name of the field that contains the text for the menu item. This attribute is optional if the field name is Text.
Allows you to set the name of the field that contains the parent ID for the menu item. This attribute is optional if the field name is Parent
Menu ID.
Allows you to set the name of the field that contains the indicator of where to open the target URL. This attribute is optional if the field name is Target Url.
Allows you to set the name of the field that contains the indicator of where to open the target page. This attribute is optional if the field name is Target.
Allows you to set the name of the field that contains the icon URL for the menu item. This attribute is optional if the field name is Icon Url.
Allows you to set the name of the field that contains the culture for the menu item. This attribute is optional if the field name is Culture.
Allows you to set the name of the field that contains the access key for the menu item. This attribute is optional if the field name is Access Key.
Allows you to show groups where the user is a member of one of the
SharePoint groups listed. Separate site group names with commas.
Allows you to hide groups where the user is a member of one of the
SharePoint groups listed. Separate site group names with commas.
Allows you to show only the menu items that point to the workspace which the current can access.
Note:
Performance can be affected when checking the access for each menu item, especially for large menus. Also, make sure that every menu item points to a page in a SharePoint site that is reachable from the current site (as opposed to any external site, such as MSN, Google)
302
qPanelMenu
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
303
Quick Apps for SharePoint
qPanelMenu Procedures
You can perform the following procedures using qPanelMenu:
•
Configuring qPanelMenu
To configure qPanelMenu
1.
Create a source list.
If you are using SharePoint 2010, from SharePoint 2010 Central Administration, select
Site Actions | More Options | Custom List | Quest Menu List
.
If you are using SharePoint 2013, from SharePoint 2013 Central Administration, select
Add an app | Quest Menu List.
2.
Name your list and click
Create
.
3.
Click
New Item
to add information to your source list. Click
Save
.
4.
Add qPanelMenu to your site collection page.
5.
Open
ezEdit
.
The Display tab opens by default.
6.
From the Configuration section, select the source list created in
SharePoint, and click
OK
.
7.
Click
Edit
next to the list name.
8.
For each field name, select the corresponding column name (from the source list created in SharePoint). For example, for Text Field
Name, select Text; for Menu Id Field Name, select Menu Id. Click
OK
.
9.
If needed, configure the elements in the other tabs.
10. When done configuring each tab, click
OK.
304
qSelector
•
Overview
•
qSelector Tabs
•
qSelector Procedures
19
Quick Apps for SharePoint
Overview
qSelector displays data from a SharePoint list in a drop-down control. qSelector remembers the last item selected, even after you leave the page.
Using qSelector, you can:
• keep the context of your work. For example, you can manage multiple projects in one workspace easily by using qSelector. You can place a selector that displays the project information on every page in your application and use that selector to filter the data in the qListView or any other view on the page. Because the selector remembers the last item selected even as you move from page to page, you only see the data for the same project until you switch to another project.
• place a selector above a qListForm to select a certain item and then feed that item to the list form because the qSelector is a row provider.
• support dynamic language switching and Flash and JavaScript
(HTML5)
If you would like to learn more, click here to watch the training video.
qSelector supports multiple languages. You can define a different Title for different languages using the Resource List and the Title Resource ID properties.
The culture for the page can be defined by appending the Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US qSelector implements the following web part connection interfaces:
• IRowProvider interface, which provides a row to another Row
Consumer web part or a filter to another Filter Consumer web part.
The IRowProvider interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled Provide Row To (Obsolete) in the web part Connections menu. Use the
IWebPartRow implementation that is labeled with Send Row To.
306
qSelector
• IWebPartRow interface, which provides a row to another web part, such as qListView.
The IWebPartRow implementation is labeled with Send Row To in the web part
Connection menu. This interface cannot be connected with the obsolete IRowConsumer or IFilterConsumer implementation. Do not connect this new interface with the old interface that is marked obsolete.
• IFilterConsumer interface, which consumes a filter from another web part that implements IRowProvider or IFilterProvider interface.
The IFilterConsumer interface is obsolete. It is provided here only for backward compatibility reason. When you establish the web part connection, this interface is labeled Consume Filter From (Obsolete) in the web part Connections menu. Use the
IWebPartParameter consumer implementation that is labeled with Get Filter From.
• IWebPartParameter interface, which enables the selector to consume a filter from another web part that implements IWebPartRow or
IWebPartParameter interface.
The IWebPartParameter consumer implementation is labeled with Get Filter From in the web part Connection menu. This interface cannot be connected with the obsolete
IFilterProvider or IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete.
qSelector Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qSelector contains the following tabs:
•
•
•
•
•
•
307
Quick Apps for SharePoint
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qSelector, the Display tab opens by default. The Default tab contains the following:
ELEMENT
Search Session Name
Site URL
List Name
Display Field Name
Display Format
Display Fields
Eliminate Duplicate
Values
DESCRIPTION
Allows you to define the search session variable name where the qSelector stores the last selected item. If you want to associate several selectors, you must define the same Search Session Name property for all of them.
Allows you to enter the URL to the site that contains the list to be searched. The URL can be absolute (http://...) or relative to the current page URL.
Allows you to enter a list name
Allows to enter the name of the field that you want to display in the selector.If you want to display information from multiple fields, use the
Display Format properties. The Display Field Name property is ignored if the Display Format property is defined.
Allows you to define the format of the items that are displayed in the selector. You can use field replacement expression (<%field name %>) to refer to a field name.
Allows you to define the fields that are displayed in the drop-down menu of the web part. If defined, the choices in the drop-down menu are displayed in a grid.
This property is an XML string in this format:
<Fields>
<Field Name="fieldName" Width="width" />
<Field Name="fieldName" Width="width" />
</Fields>
The <Fields> element may contain one or more <Field> elements.
• Name - The name of the field. The field name is case-sensitive.
• Width - The display width of the field. The value can be in pixel (for example: 200px) or percent (for example: 30%).
Allows you to define whether or not you want to eliminate duplicate values in the drop-down menu. This is useful in case you want to use the selector as a filter to another Web Part.
308
qSelector
ELEMENT
CAML Filter Expression
Complex Filter
Sort Field
Sort Ascending
Show Empty Selection
Empty Selection Item
Name
Empty Drop-Down Item
Name
Refresh Page When
Selection Changed
DESCRIPTION
Allows you to enter a CAML (Collaboration Application Markup
Language) query expression to filter your data. For more information, see
“CAML Filter Help” on page 467
Allows you enter Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML Filter is applied. For more information, see
“Complex Filter Help” on page 475 .
Allows you to enter a value that is used to sort the entries in the qSelector. This property accepts a single field name.
Allows you to sort the entries in the ascending order. Deselect this check boxif you want the entries in descending order. This field is ignored if the Sort Field property is not defined.
Allows you to display the value of Empty Selection Item Name property as the first item.
You should check this property if you want the user to be able to select nothing. Selecting nothing returns the entire unfiltered list. Another case is when the qSelector acts as a filter to another web part and you want the ability to pass an empty filter. This means the other web part will display all its data unfiltered.
Allows you to display a specified value as the first item in the Selector when the Show Empty Selection is checked. The default is - Select One
-.
Allows you to display specified text that is displayed in the drop-down menu when it contains no list items. The default is <Empty>.
Allows you to determine whether the page should be refreshed when you select another item in the selector. By default, the value is false, which means that the page is only posted back.
309
Quick Apps for SharePoint
Selector Appearance Tab
The Selector Appearance Tab contains the following:
ELEMENT
Skin Name
Persistent Selector Width
Drop-Down Width
Drop-Down Height
DESCRIPTION
Allows you to select the skin name for the grid in the listview. If you have a custom skin, you can add it to the following folder for
SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Allows you to specify the width of the input part for the selector.
Allows you to specify the width of the drop-down menu for the selector in pixels. If you specify the width for each field in the
Display Fields property in pixels, the value of this property is usually the total width of all fields.
Allows you to specify the height of the drop-down menu for the selector.
310
qSelector
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
311
Quick Apps for SharePoint
qSelector Procedures
You can perform the following procedures using qSelector:
•
Configuring qSelector
To configure qSelector
1.
Add qSelector to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
312
qSIChartView
•
Overview
•
qSIChartView Tabs
•
qSIChartView Procedures
20
Quick Apps for SharePoint
Overview
The qSIChartView aggregates data from your external system and displays it in different chart types.
If you would like to learn more, click here to watch the training video. qSIChartView allows you to:
• produce 34 different chart types
• display data from multiple lists, even when the lists are in different sites, site collections, or web applications (as long as they are in the same configuration database).
• customize the look of the chart, including adding animation to your chart, and rendering your charts in Flash and Javascript
• view your web parts in SharePoint on PC, Mac, various browsers and iPad, iPhone mobile devices where Flash is not available
• display one or more trend lines in the chart
• Some charts support dual Y Axis, make your charts more readable with dual Y axis support
• filter your data, and generate multiple data series based on dynamic data
• create drill down charts
• display, create, and edit data in your external systems. Out of the box, this Web Part supports the DAO Provider for:
• Web Services
• SQL Server
• Oracle
• Domino Server using XML over HTTP
• Salesforce
• K2Server (for SharePoint 2010 only)
To better understand SI web parts, read the System Integration Developer Guide.
314
qSIChartView
qSIChartView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qSIChartView contains the following tabs:
•
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit in qSIChartView, the Display Tab opens by default. The
Default tab contains the following:
315
Quick Apps for SharePoint
ELEMENT
Catalog
Chart Type
Configuration
Searched Fields
Turn On List Searcher Mode
Expand Filter Pane on Load
Filter Usage Criteria
DESCRIPTION
See
“Catalog” on page 317 for more information.
Allows you to select the type chart used to display the data.
For examples of each chart type, see “Sample Charts” on page 489 .
When you select one of the Multi Series, Scroll or Stacked chart type, you must define multiple data series in the Configuration property. Otherwise you will get a blank chart.
See
“Configuration” on page 321 for more information.
See
“Searched Fields” on page 324 for more information.
Allows you to perform a search before the chart view displays any data.
Allows you to automatically open the Filter panel by default so that you can perform a search quickly. When selected, the
Filter panel opens when the web part is loaded for the first time.
Allows you to pass the filter criteria to the DAO provider layer.
The options are:
• PassToDAOProvider — The filter criteria is passed to the
DAO Provider. When you select this, the filter criteria is not used to filter the data that is returned by the external system (because the SI List View assumes that the data has been filtered by the external system).
• FilterData — The filter criteria is used to filter the data that is returned by the external system.
• PassToDAOProviderAndFilterData — The filter criteria is passed to the DAO Provider and is used to filter the data that is being returned by the external system.
When you select PassToDAOProvider or
PassToDAOProviderAndFilterData, you can use the filter criteria as parameter values in the operations in the Catalog property.
Specify the parameter source as Input and the source name as:
• FieldName.Value — to retrieve the value that is entered by the user in the filter panel for a specific field.
• FieldName.MaxValue — to retrieve the maximum value that is entered by the user in the Filter panel for the field that has Between operator, such as DateTime field.
• FieldName.Operator — to retrieve the operator that is specified by the user for a specific field.
For example, if you want to get the filter criteria for the
ProductID field, you can specify ProductID.Value and
ProductID.Operator in the SourceName of your operator in the
Catalog property.
Note:
There is a possibility that your back-end only handles
"Equals" operator. In that case, you can use the
FixedOperator="Equals" attribute in the Searched Fields property so that the user can only use the Equals operator.
316
qSIChartView
ELEMENT
Panel Button Location
Actions
Search Session Name
Complex Filter
Display Message from DAO
Provider
Custom Message Display
DESCRIPTION
Determines the location of the Go, Reset, and Close buttons in the Filter panel, either top, bottom, or both top and bottom.
See
for more information.
If Turn On List View Link Mode is selected, the Chart View will retrieve the Viewed Lists and filter criteria from the session under this name. This value must match with the Search
Session Name property that you specify in the qListView. If the
Turn On List View Link Mode is not selected, the Chart View uses this search session name to store the search criteria specified in the Search/Filter panel.
Allows you to define a static filter for the data. The static filter is combined with the dynamic filter specified by the user during runtime.
See
“Complex Filter Help” on page 475
on more information.
Allows you to display messages, such as informational messages or warnings at the top of a web part. For more information on DAO providers, see System Integration
Developer Guide.
See
“Custom Message Display” on page 332 .
Catalog
This property defines the entity and the operations related to the entity. This property is an XML string in this format:
<Catalog>
<Entity Name="entityName" System="systemName"
Service="serviceName" Default="true/false"
SetSessionName="sessionName"
ResetSessionNames="sessionName">
<Properties>
<Property Name="propertyName" Type="typeName"
Value="propertyValue" />
<Property Name="propertyName" Type="typeName"
Value="propertyValue" />
</Properties>
<Operation Name="operationName" Method="methodName"
Default="True/False" >
<Parameter Source="sourceType"
SessionName="sessionName" SourceName="sourceName"
Type="parameterType" Name="parameterName"
Usage="usageType" Value="value" />
<Parameter Source="sourceType"
SessionName="sessionName" SourceName="sourceName"
Type="parameterType" Name="parameterName"
Usage="usageType" Value="value" />
</Operation>
317
Quick Apps for SharePoint
</Entity>
<Entity>...</Entity>
</Catalog>
If you are using a Salesforce system, the parameters that are available depend on the method selected. See the System Integration Developer Guide for the methods and parameters.
Entities
The Catalog section contains one or more entities. An entity identifies which system and service you have defined in the Configuration Editor. An entity contains one or more operations that can be executed on the entity, and consists of the following attributes:
ATTRIBUTES
System
Service
Name
Set Session Name
Reset Session Names
Default
DESCRIPTION
Allows you to select a system name defined in the System Integration configuration file.
Allows you to select a service name defined in the System Integration configuration file. The service name that you specify must belong to system that you specify in the System attribute.
Allows you to set name of the entity which must be unique within this
Catalog. The name does not have to match with any name in your external system. However, it is recommended that you use a descriptive name for your entity.
Note:
The exception to this is for the K2 system, where the name must denote the K2 SmartObject unique name. This is provided in a drop-down list of available SmartObjects. Select the SmartObject you want to use. K2 is available in SharePoint 2010 only.
Allows you to define the name of the session variable where the selected item is stored.
Allows you to define the name of the session variable that is reset to
NULL when the item is deselected or cleared. You can reset a session when, for example, you have two items defined where one item is the parent item of the other one. When you store a new parent item in the session, you can reset the session for the child item.
Allows you to select this entity as the default.
318
qSIChartView
Operations
An operation contains the following properties.
PROPERTY
Name
Method Type
Method
Default
DESCRIPTION
Allows you to define the name of the operation. This name does not have to match with any name in your external system.
There are three supported types:
• TableDirect — select this type to return all the data in a table. Specify the schema and table name in the Method field below.
• Stored Procedure — select this type to use a stored procedure to update or return data. Specify the schema and stored procedure in the Method field below. Once a stored procedure is selected, the Editor updates with the parameters that are defined for the stored procedure. It is recommended that you do not add or remove these parameters or change the “Name”,
“Source”, or “Usage” fields.
• Text — select this type to use free form PL/SQL string to query or update the database. If your SQL string requires parameters, you will need to add them manually by clicking the Add Parameter button.
Note:
This attribute is only applicable for Oracle systems.
Allows you to set the real name of the operation in your external system. For example, it may refer to the name of a web service method. Or it may refer to the name of a stored procedure in your SQL Server database.
Allows you to select this operation as the default for the entity. The default operation is the first operation that is called to retrieve the entity to be displayed. If this attribute is not specified, the first operation listed in the entity becomes the default operation.
Operation Parameters
You can click Edit to add parameters to your operation. You can define the following:
PARAMETER DESCRIPTION
Name Allows you to set the parameter name that is used when calling the operation in your external system.
319
Quick Apps for SharePoint
PARAMETER DESCRIPTION
Source Allows you to define the source of this parameter, which can be one of the following:
• Default Value — the default value of the parameter type or default instance of the parameter type. You must specify a type and usage (the direction for the parameter). For example, if the parameter type is Boolean, the Default
Value for the parameter is false; if the parameter type is String, the default value is null. If a simple class or structure is involved, an instance of the object is created and used as the parameter value.
• NullValue — the value of the parameter is null. You must specify a type and usage.
• FixedValue — the value of the parameter. You must specify a value, type, and usage.
• HttpRequest — the value of the parameter is retrieved from the HTTP parameters in the page URL. You must specify a Source Name (the source name where the value is retrieved) and usage. As an example, say the current page URL is http://mysite.com/default.aspx?ProductType=Hardware. If the
SourceName attribute is ProductType, the value of the ProductType HTTP parameter, which is Hardware, is used as the value of the parameter.
• Input — you can link a field on the form to an operation parameter. You must specify a Source Name, type, and usage.
You can also use this source type to retrieve the current user information as the value of the parameter. You can retrieve the following information:
-CurrentUserName - display name of the current user
-CurrentLoginName - login name of the current user
-CurrentUserID - ID of the current user
-CurreUserEmail - email address of the current user
• RowFromAnotherWebPart — the value of the parameter that is retrieved from the row that is consumed from another web part. You must specify a
Source Name and type.
• Session — the value of the parameter that is retrieved from the row that is stored in the session. You specify Session Name (define the name of the session where the row of information is retrieved), Source Name, type, and usage.
• ComplexType — the value of the parameter is an object based on the Type attribute and Member definition inside the Parameter. Array and nested complex types are supported. You must specify type and usage.
• Array — the value of the parameter is an array of values. You must specify type and usage.
• XML — the value of the parameter that is dynamically built when the condition is execute at runtime. You must specify type and usage.
Note:
For sources related to Salesforce, see the System Integration Developer
Guide.
320
qSIChartView
Entity Properties
The Catalog section contains the following entity properties:
PROPERTY
Name
Type
Value
DESCRIPTION
Allows you to define the name of the property. The documentation for the connector to your external system will tell you the name of the property that you must define.
Allows you to define the type name of the value that is specified in the Value attribute. Example: System.String.
Allows you to define the value of the property.
Configuration
This property defines how the data should be grouped in the X Axis and the data series for the chart.
This property is an XML string in the following format:
<Configuration>
<XAxis FieldName="FieldName" [optional attributes]/>
<Series>
<Items FieldName="FieldName"
AggregateFunction="Count|Avg|Sum|Min|Max|StdDev|Var"
[optional attributes]/
<Items FieldName="FieldName"
AggregateFunction="Count|Avg|Sum|Min|Max|StdDev|Var"
[optional attributes]/
</Series>
</Configruration>
The Configuration element should contain only one X Axis and one Series element. Each Series element may contain one or more Items element.
Configuration Properties
The Configuration section contains the following properties:
ELEMENT
Data Index/Data Member
DESCRIPTION
Allows you to define the data table name that contains the options in case the operation returns multiple tables. If the external system returns multiple data tables without names, you can use the Data Index attribute to refer to the table. The index is a number and it starts with 0 (not 1).
Note:
These are optional.
321
Quick Apps for SharePoint
ELEMENT
Field Name
Display Format
Sort Field Name
Sort Field Order
DESCRIPTION
Specifies the name of the field that corresponds to the x axis data. This attribute is mandatory. The field name is case sensitive.
Allows you to specify how the X axis values are formatted when displayed. For more detail about the syntax of the Display Format
attribute, see “Display Format Help” on page 439 .
Defines the field name where the values in the x axis is sorted. If you do not specify this attribute, the order of values in the x axis is dependent upon the order of the data in the list. The value of this property does not have to be the same as the value in the
Field Name attribute.
Specifies how the values in the column specified by the Sort Field
Name should be sorted. The options are ASC or DESC.
Data Series
You can define a data series for the chart by configuring the following properties:
PROPERTY
Field Name
Aggregate Function
Series Name
Chart Series Type
Filter Expression
Filter Field Name
DESCRIPTION
Allows you to specify the field whose values are aggregated and plotted against the values in the Y Axis.
Note:
Only Number or Currency field can be used in the Field
Name. The field name is case sensitive.
Allows you to specify the aggregation function to be performed on the field specified in the Field Name attribute. The following aggregation functions are supported: Count, Avg, Sum, StdDev,
Var, Min, or Max.
Allows you to display a series name in the legend as title of the series.
Note:
This applies to multiple data series charts.
Allows you to define the chart type for this series when you use one of the combination chart in the Chart Type property. The choices are: COLUMN, AREA or LINE. This attribute is ignored for any non-combination chart type
Allows you to define the filter that is applied for the data in this series. The filter is defined using the Complex Filter expression.
For more information, see
“Complex Filter Help” on page 475
.
Allows you to determine the field name whose data is used to generate a dynamic data series. The chart view will analyze the data in this field and generate the filter expression for each data series automatically, one per unique value in the field. This attribute is useful if the data that you should use as the filter expression for the data series is dynamic.
322
qSIChartView
PROPERTY
Drill Down Chart URL
Show Values
Include in Legend
Parent Y Axis
DESCRIPTION
Allows you to determine the URL of the page that contains the drill down chart for this data series. A drill down is the capability to click a chart item to display more detailed information about the chart item.
Allows you to show the values for this dataset.
Note:
This attribute is only applicable for a multi series chart.
Allows you to determine if you want to include the series name of this dataset in the legend. This can be particularly useful when you're using combination charts and you've used the area/line chart to plot a trend, and you do not want the series name of that trend to appear in legend.
Note:
This attribute is only applicable for a multi series chart.
Allows you to set the parent axis of the dataset - P (primary) or S
(secondary). Primary datasets are drawn as on the left y-axis and secondary on the right y-axis. In 3D Column (or stacked Column)
+ Line Combination Charts, the columns draw against primary y-axis and the linesagainst secondary y-axis. In 2D dual Y combination charts, you can choose which dataset to render against which y-axis.
Note:
This attribute is only applicable for a chart with a dual y axis.
Examples of Configuration Property
The following is an example of the Configuration property if you want to display data from your Sales list. Your Sales list contains the sales amount for every month in the year. There are 3 fields in the list: Year, Month and Amount. For example, say you want to display the month in the X axis. You also wants to create the data series dynamically based on the year field. Here is the XML:
<Configuration>
<Series>
<Items FieldName="Amount" AggregateFunction="Sum"
ChartSeriesType="COLUMN" FilterFieldName="Year" />
</Series>
<XAxis FieldName="Month" SortFieldName="Month" />
</Configuration>
323
Quick Apps for SharePoint
The following shows the resulting chart::
Searched Fields
This property defines which fields is displayed in the Filter panel. If defined, the qSIChartView will display Filter button in the toolbar. To disable the search feature, leave this property blank.
This property is an XML string in the following format:
<SearchedFields>
<Fields>
<Field Name="fieldName" Title="title"
Description="description" Type="fieldType"
FixedOperator="fixedOperator"
DefaultOperator="defaultOperator"
DefaultValue="defaultValue"
DateTimeFormat="DateOnly|DateAndTime"
EnableMultiChoice="true/false" ColumnCount="columnCount"
/>
<Field Name="choiceField" Type="Choice">
<Option Text="option1" Value="value1" />
<Option Text="option2" Value="value2" />
324
qSIChartView
</Field>
<Field Name="choiceField" Type="Choice">
<Lookup Operation="EntityName.OperationName"
DataMember="tableName" DataIndex="indexNumber"
DataTextField="fieldName" DataValueField="fieldName" />
</Field>
</Fields>
</SearchedFields>
Fields
You can add the following values for the fields to be displayed.
VALUES
Field Name
Type
Description
DESCRIPTION
Displays the field name.
Allows you to define the type of the field. The qSIChartView supports the following types:
• Text
• DateTime
• Choice
• Number
• Currency
• DateTime
• Boolean
The type of the field determine the set of operators that can be applied to the search criteria for that field and the type of control that the user can use to enter the value for the search criteria.
Allows you to set the field description. It can be a plain string or an encoded
HTML string. The Description is added below the field value.
Field Properties
You can further define the fields by configuring the following properties:
ELEMENT
Field Name
DESCRIPTION
Indicates the element you are editing.
325
Quick Apps for SharePoint
ELEMENT
Type
Title
Default Value
Default Operator
Fixed Operator
Column Count
DateTime Format
Enable Multi
Choice
DESCRIPTION
Allows you to define the type of the field. The qSIChartView supports the following types:
• Text
• DateTime
• Choice
• Number
• Currency
• DateTime
• Boolean
The type of the field determine the set of operators that can be applied to the search criteria for that field and the type of control that the user can use to enter the value for the search criteria.
Displays title for the field. The value can be a plain string or an encoded HTML string.
Defines the default value for the field.
You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of
February 14, 2002 is 2002-02-14T00:00:00Z.
Defines the default operator for the field.
Defines the operator for the field. If specified, the drop-down menu to select the operator for this field is turned off.
Defines the number of columns for the options in a multi-choice field or in a choice-and-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form.
Allows you define DateTime or Date only. Available only if you have selected
DateTime type.
Allows you to select multiple options for the choice-and-lookup field.
Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types.
326
qSIChartView
ELEMENT
Choice
Population Type
DESCRIPTION
Allows you to define how you want to define the options in your Choice field.
It is a drop-down list with the following options: Manually or Using Operation in the Catalog. For more information, see the below paragraphs.
If you select Choice as the field type, you can define the options in your choice field.
You can hardcode the options directly under the Field element. Select the
ChoicePopulationType of ‘Manually’ to do this. Here is an example:
<Field Name="EmployeeStatus" Type="Choice">
<Option Text="Active" Value="1" />
<Option Text="Retired" Value="2" />
</Field>
If the Value attribute is not specified, the Text is used as the value.
You can specify an action that will retrieve the options from your external system. Select the ChoicePopulationType of ‘Using Operation in the Catalog’ to do this. Here is the syntax:
<Field Name="fieldName" Type="Choice">
<Lookup Operation="EntityName.OperationName"
DataMember="tableName"
DataTextField="textFieldName" DataValueField="valueFieldName" />
</Field> or
<Field Name="fieldName" Type="Choice">
<Lookup Operation="EntityName.OperationName" DataIndex="index"
DataTextField="textFieldName" DataValueField="valueFieldName" />
</Field>
The Operation defines the operation that is used to retrieve the options from the external system. The syntax for the operation is
EntityName.OperationName. Both the entity and the operation must already be defined in the Catalog property.
The DataMember defines the data table name that contains the options in case the operation returns multiple tables. If external system returns multiple data tables without name, you can use the DataIndex attribute to refer to the table. The index is a number and it starts with 0 (not 1).
The DataTextField defines the column in the data table whose value is displayed in the drop-down menu.
The DataValueField defines the column in the data table that contains the real value that should be saved back to the external system.
Actions
You can use this property to define one or more buttons in the toolbar. The button can be associated with one or more actions and each action can be associated with an operation for the entity. We also support several pre-defined action type that you can use. This approach makes a very powerful mechanism for you to execute multiple operations when a button is clicked.
The list form will not display a toolbar if you do not specify this property.
327
Quick Apps for SharePoint
This property is an XML string in this format:
<CustomActions>
<Toolbar>
<ActionItem ID="UniqueID" Text="text"
TextResourceID="textResourceID"
PerformValidation=”true/false” Position="0"
PromptText="promptText"
PrompTextResourceID=”prompTextResourceID” ImageUrl=”URL”
AccessKey=”AccessKeyCharacter”>
<Action Type="GoToURL" URL="TargetURL">
<Parameter Name="parameterName"
Source="Session" SourceName="fieldName"
SessionName=”sessionName” />
<Parameter Name="parameterName"
Source="RowFromAnotherWebPart" SourceName="fieldName" />
<Parameter Name="parameterName"
Source="HttpRequest" SourceName="httpParameterName" />
<Parameter Name="parameterName" Source="Input"
SourceName="fieldName" />
</Action>
<Action Type="GoToSource"/>
<Action Type="Custom" Class="IUIActionImpl" />
<Action Type="ExecuteOperation"
Operation="entityName.operationName" />
</ActionItem>
</Toolbar>
</CustomActions>
Action Items
Each action contains action items. You can configure the following action item properties:
PROPERTY
IsSeparator
ID
Text
Text Resource ID
Prompt Text
DESCRIPTION
Allows you to set the item as a separator.
Allows you to enter a unique ID that will identify the item. Use a descriptive identifier to configure the action item with the editor.
Allows you to enter how the action item is displayed in the toolbar.
Allows you to localize the label button. It defines the identifier of the string in the Resource List that is used as the Text Resource of the web part. The Text Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the value in the Text attribute is used.
Allows you to prompt the user to click the toolbar button or the context menu item.
328
qSIChartView
PROPERTY
Prompt Text Resource ID
Perform Validation
Image URL
Access Key (Toolbar Only)
Position
Show User Groups
Hide User Groups
DESCRIPTION
Allows you to define this property if you support a multi-lingual site.
The property defines the identifier of the string in the Resource List that is used as the prompt text resource of the web part. The
Resource ID and the current cultural setting (identified with the
Culture HTTP parameter) are used to retrieve the string in the
Resource List. If the string with the given identifier and culture is not found, the default is used.
Allows you to perform validation on the form, such as making sure all the required fields are filled in, before the form is submitted.
Perform a validation if you are creating a button that will update the data. You do not need to set this to true if you are creating a cancel button or a button to redirect user to another page. When this
Boolean is set to true for action items associated with a custom action, the web part will perform validation before invoking the custom action. For example, if there are required fields that are not filled in, the custom action will not be invoked.
Allows you to set the URL for the image for the toolbar button. You may use an absolute or relative URL here.
Allows you to define one character from the Text attribute that becomes the access key to this toolbar button or context menu item. For example, if you define a letter T as the access key, you can press ALT+T and the browser will put the focus on this button or context menu item. If there are multiple elements on the page with the same access key, you can repeat ALT+T repeatedly until you get the focus on this toolbar button or context menu item.
Allows you to set the position of the button in the toolbar. The index starts with 0 (not 1).
Allows you to list SharePoint groups whose members can view the
Custom Action button. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the Custom Action button. Separate site group names with commas
(for example, Administrators, Readers).
If users are defined in Show User Groups and Hide User Groups,
Hide Groups takes precedence.
329
Quick Apps for SharePoint
Action
You can add define actions to be associated with an action item by configuring the following properties:
PROPERTY DESCRIPTION
Sequence
Name
Action Type
Allows you to change the order the actions are executed by selecting a different number in the Sequence drop-down menu. The order the actions appear in the action list is the sequence the actions are executed.This is not an attribute of the
Action element. It is an auto-generated number that indicates when the given action is executed.
An optional element which allows you to identify a given action in order to access it from another action. You can refer to this action from the GoToURL action and from ICustomActionEx Interface. For more information on ICustomActionEx,
see “ICustomActionEx Interface” on page 444 .
See
.
Action Type
You can configure the following action types with each action.
The Result From Action parameter for the GoToURL action can be retrieved from the output of another action that comes first in the sequence of actions defined in the
ActionItem. There are two types of action that can produce an output:
• An action with Type of ExecuteOperation
• An action with Type of Custom that points to custom action implementation of
ICustomActionEx Interface
You can refer to the output of another action by defining the SourceName attribute of the action. This is the syntax of the SourceName attribute when you use ResultFormAction source:
• <ActionName>.<ResultType>[.Name]
• ActionName refers to the Name attribute of the action that produces the output.
• ResultType can be one of the following:
-OutParameter — if the action result is returned through one of the out or in/out parameter
-RawData — if the action result is returned as an object.
Do not replace OutParameter and RawData with actual values; ResultType must be entered as "OutParameter" or "RawData".
• Name is optional. It further designates the object we want to use for the parameter.
You do not have to specify the Name when the ResultType is RawData. However, if the ResultType is OutParameter, this name specifies the name of the out or inout key value pair.
330
qSIChartView
ACTION TYPE DESCRIPTION
Close Dialog
GoToURL
GoToSource
Closes a dialog window. It only takes effect if it is triggered in context of a
SharePoint dialog. If the web part containing the custom action is inside a browser window, nothing will happen. This action is useful in the following scenario: The qSIListForm is used in conjunction with qSIListView. A row is selected in the qListView which causes you to navigate (through a GoToUrl action in the context menu or hyperlink from a Link To configuration) to another web page where qSIListForm is configured to allow you to view/edit all fields belonging to the data row. A qSIListForm residing on this page can contain a custom action named "Save and Close" chaining two custom action types: ExecuteOperation followed by CloseDialog. When the user chooses to open this new page in a SharePoint Dialog, at the end of editing the item, he can hit this "Save and Close" custom action (in the toolbar of the web part) to perform save and close in a single click. If a GoTo action is introduced between a Save action and a CloseDialog action then the dialog will not close.
Redirects the user to a specific URL. You can define more parameters.
• URL — defines the target URL when the action type is set to GoToURL. If needed, the URL can contain fixed HTTP parameter like: http://www.mysite.com?Parameter1=value1.
• Open URL — defines how the URL is opened for the GoToURL custom action. There are 3 different options: Dialog, NewWindow, and
CurrentWindow.
You can define additional parameters for the GoToURL action by defining one or more Parameter element. Here are the attributes for the
Parameter element:
-Name — This attribute defines the name of the HTTP parameter that is generated.
-Source — This attribute defines where the value of the parameter comes from. The possible values are: Session, HTTPRequest,
RowFromAnotherWebPart, ResultFromAction, or Input.
-SourceName — This attribute defines the field name where the value comes from when the source is set to Session or Input. This attribute defines the HTTP parameter name where the value comes from when the source is set to HTTPRequest. The SourceName attribute uses
ActionName.SourceName.Name notation to access the ActionResult value. Because this parameter value is used to construct a URL query string, a simple object is expected. Currently, the SourceName can be
“RawData” and “OutParameter” which access the RawData part or
OutputParameter part of ActionResult. RawData does not need the
Name attribute but OutParameter does, which is equal to
OutputParameter name.
-SessionName — This attribute defines the name of the session variable where the value comes from when the source is set to Session.
Redirects the user to the URL specified in the Source HTTP parameter. The URL to the page must look like: http://...?Source=URL for this option to work.
Executes the operation that you specify in the Operation field Execute
Operation
ReturnToMaster
Chart
Custom
Returns the user to the master chart page. You use this action type if this web part is located in the drill down page
Implements your own custom action and call it with this action type. Enter a
Class name that implements the ICustomActionEx or ICustomAction interface, or select a class from the drop-down list, if available. For more information on
custom actions, “Custom Action Help” on page 443 .
331
Quick Apps for SharePoint
Custom Message Display
You can customize the display of error messages returned from the external system when calling a custom action or loading the external data. The Custom
Message Display property allows you to specify a custom message based on certain conditions.
We currently do not support mapping for the messages that the Display
Messages From DAO Provider property enables.
This property is an XML string in this format:
<CustomMessageDisplay>
<CustomMessage>
<DisplayWhen Message="Please contact site administrator!">
<Matches>
<FieldRef Name="Error Message" />
<Value Type="Text">
^The following error</Value>
</Matches>
</DisplayWhen>
</CustomMessage>
<CustomMessage>
<DisplayWhen Message="Invalid stored procedure name specified.">
<Contains>
<FieldRef Name="Error Message" />
<Value Type="Text">command not found</Value>
</Contains>
</DisplayWhen>
</CustomMessage>
</CustomMessageDisplay>
Custom Message Display Properties
CustomMessageDisplay contains the following properties:
• Display When — allows you to set the conditions to display a custom error message. When defining the Display When condition, the following operators are supported: Eq (Equal) Neq (Not Equal) Null,
Is Not Null, Begins With, Contains and Matches (for regular expression).
• Custom Message — The error message that you want displayed when the Display When condition is set.
332
qSIChartView
If a Display When condition is set during runtime but a custom message is not specified, the original message is displayed. If you want to hide the original message, use a blank string or any html code that renders no visible cues, such as <div> </div>, for the CustomMessage attribute.
When multiple Custom Message elements are defined for this property, the first
Custom Message, whose Display When condition is set, is used.
If no conditions are met, an error message from the selected external system is displayed.
Chart Appearance Tab
The Chart Appearance Tab allows you to define characteristics of your charts.
Chart Appearance contains the following elements
ELEMENT
Chart Width
Chart Height
Chart Attributes
Trend Lines
Style
Series Appearance
DESCRIPTION
Allows you to specify the width of the chart in pixels.
Allows you to specify the height of the chart in pixels.
For more information, see
“Chart Attributes” on page 333
.
For more information, see
For more information, see
For more information, see
“Series Appearance” on page 368 .
Chart Attributes
Title and Axis Name
The Chart View allows you to add a caption, sub-caption, x-axis title and y-axis title for your charts. You can configure the font properties for each of them individually or collectively. You can also apply styles and animation effects to them.
ELEMENT
Caption
Sub-caption
X-Axis Name
DESCRIPTION
Allows you to add a title.
Allows you to add a subtitle to your chart.
Allows you to set the x-axis name.
333
Quick Apps for SharePoint
ELEMENT
Y-Axis Name
Rotate Y Axis Name
Y Axis Name Width
DESCRIPTION
Allows you to seta y-axis name.
Allows you to set rotate the name of the y-axis. The y-axis name is rotated by default on the chart. If you're using UTF-8 characters, those characters would not appear in rotated mode, as the qSIChartView uses embedded characters for rotation. In that case, you can opt to show y-axis name in horizontal form by setting this attribute to false.
Allows you to set the maximum width that the non-rotated y-axis title can assume.
Border and Background
Background refers to the entire background of the chart.
You can also have a border around the chart. By default, the border is on in 2D charts and off in 3D Charts.
Shown below is a chart with a border around the chart.
ELEMENT
Show Border
Border Color
Border Thickness
Border Alpha
334
DESCRIPTION
Allows you to show a border around the chart. By default, it is set to true in 2D charts and false in 3D charts.
Allows you to set the border color of the chart. Use hex color code.
To use the color picker, click on the color swatch square.
Allows you to set the border thickness of the chart (in pixels).
Allows you to set the border alpha (transparency) of the chart. The range is from 0-100.
qSIChartView
ELEMENT
Background Color
Background Alpha
Background Ratio
Background Angle
Background Image or SWF
URL
Background Image or SWF
Alpha
DESCRIPTION
Allows you to fill the background as gradient. If you need to define two (or more) colors, separate them by a comma.
Allows you to specify a respective alpha (transparency) for each color code that you've specified in the Background Color attribute,
Separate the alphas by comma. The range is from 0-100
Allows you to set the ratio of each color in the gradient on a scale of
100. The total ratios specified as this attribute should sum up to
100. For example, if you want to plot a equidistant gradient for 2 colors, specify Background Ratio as "0,100".
Allows you to set the angle of the gradient fill.
Allows you to specify an external image (GIF,JPEG, or PNG only) or a
SWF file as the background of the chart. Specify the URL (with relative path) of the background image or SWF File. Make sure that the image and the chart SWF file are in the same sub-domain.
If you specify an absolute URL, the background image will not be shown.
Allows you to configure the alpha of the background (loaded) image using this property.
Chart Canvas
Canvas refers to the area in which the chart is plotted.
ELEMENT
Canvas Border Color
Canvas Border Thickness
DESCRIPTION
Allows you set the border color for the Canvas. Use hex color code. To use the color picker, click on the color swatch square.
Allows you set thickness of canvas border (in pixels)
335
Quick Apps for SharePoint
ELEMENT
Canvas Border Alpha
Canvas Background Color
Canvas Background Alpha
Canvas Background Ratio
Canvas Background Angle
Show Canvas Background
Show Canvas Base
Canvas Background Depth
Canvas Base Depth
DESCRIPTION
Allows you set alpha for canvas border.
Allows you set the background color for the Canvas. Use hex color code. To use a gradient fill, specify all the colors of the gradient separated by commas.
Allows you to specify a respective alpha (transparency) for each color code that you've specified in Canvas Background Color attribute. Separate the alphas by comma.
Allows you to set the ratio of each color in the gradient on a scale of 100. The total ratios specified as this attribute should sum up to 100. For example, if you want to plot a equidistant gradient for 2 colors, specify canvasbgRatio as "0,100".
Allows you to set the angle of the gradient fill (in degrees -
0-360).
Allows you to set the canvas background for a 3D chart (and canvas).
Allows you to set the canvas base for a 3D chart (and canvas).
Allows you to set the depth of canvas background for a 3D chart
(and canvas).
Allows you to set the height of canvas base (in pixels) for a 3D chart (and canvas).
Data Plot
Plot refers to the column, lines in a column, line chart respectively.
For all the charts, you can specify custom color for each data plot using the color attribute of <set /> element. The color must be in hex code format (RRGGBB) without #.
<chart ....>
<set label='Jan' value='420000' color='FF0000'/>
<set label='Feb' value='910000' color='00FF00'/>
<set label='Mar' value='720000' color='0000FF'/>
....
</chart>
336
qSIChartView
By default, most charts have FFFFFF as the plot gradient color. If you wish to use solid fills for the column (or area), use the Plot Gradient Color attribute without any color defined for it, that is plotGradientColor=''
<chart plotGradientColor='' ....>
<set label='Jan' value='420000' color='FF0000'/>
<set label='Feb' value='910000' color='00FF00'/>
<set label='Mar' value='720000' color='0000FF'/>
....
</chart>
337
Quick Apps for SharePoint
ELEMENT
Plot Gradient Color
Plot Fill Angle
Plot Fill Ratio
Plot Fill Alpha
Show Plot Border
Plot Border Dashed
Plot Border Dash Length
Plot Border Dash Gap
Use Round Edges
DESCRIPTION
Allows you to globally add a gradient color to the entire plot (column, area) of chart by specifying a color as its attribute.
Allows you set the fill angle for gradient if you've opted to fill the plot
(column, area) as gradient. The range is from 0 - 360.
Allows you set the ration for gradient if you've opted to fill the plot
(column, area) as gradient. The range is from 0 - 100.
Allows you set the fill alpha for gradient if you've opted to fill the plot
(column, area) as gradient.
Allows you to show or hide the plot border. By default, each data plot
(column, area, pie) shows a border.
Allows you to make the plot border dashed by setting this attribute to true.
Allows you to set the length of each dash.
Allows you to set the gap between each dash.
Allows you to plot columns/bars with rounded edges and glass effect gradients in charts that support 2D Columns or Bars (like column charts, bar charts, 2D combination charts).
Note:
In this mode, the following features do not work:
• When you plot the columns with rounded edges, shadow is applied to them by default and showShadow attribute no longer works. If you want to remove shadow from this mode, override the shadow with a new shadow style (applied to DATAPLOT) with alpha as 0.
• Plot fill properties like gradient color, angle. no longer work as the colors for gradient are now calculated by the chart itself.
• Plot border properties no longer work in this mode. Also, you cannot render the border as dash in this mode.
338
qSIChartView
Data Labels
Data labels refer to the names for the data points which appear on the x-axis.
In the chart shown above, the dates are the data labels for the chart. By default, they get wrapped when there is not enough space on the chart.
ELEMENT
Show Labels
Label Display
Slant Labels
Stagger Lines
Label Step
DESCRIPTION
Allows you to show the data labels.
Allows you to display the data labels can be displayed on the charts in the following ways:
• Wrap — By default, all the labels are shown in wrap mode, which enables you to wrap your long x-axis labels in multiple lines.
• Rotate — allows you to rotate or slant the x-axis labels.
• Stagger — distributes labels into multiple lines (by default 2).
Note:
Rotate mode does not work if you have non-English characters in your x-axis labels as the charts use embedded fonts to render rotated labels.
Allows you to slant the labels at 45 degrees if you are using the Rotate mode for the Label Display.
Allows you to choose the number of lines to stagger the labels if you are using the Stagger mode for the Label Display.
Allows you to show every n-th label instead of all labels if your X Axis labels represent a continuous quantity like time and date.
339
Quick Apps for SharePoint
Data Values
Data values refer to the plot values such as line, column, and bar displayed beside it.
In the chart shown above, the dollar values appearing above the column are the data values.
ELEMENT
Show Values
Rotate Values
Place Values
Inside
DESCRIPTION
Allows you to show data values. By default, the data values are shown. To hide them, set this attribute to false.
Allows you to rotate the values. By default, the chart will show the data values horizontally.
Allows you to place the data values inside the columns.
340
qSIChartView
External Logo
You can load external logos at run-time to be displayed over the chart. The logos can be GIF/JPEG/PNG or SWF files that reside on the same sub-domain as the chart SWF.
ELEMENT
Logo URL
Logo Position
Logo Alpha
Logo Scale
Logo Link
DESCRIPTION
Allows you to specify the URL of the logo. You may use relative or absolute
URL as long as the image and the chart SWF file are in the same sub-domain.
Allows you to set the position of the logo can be configured using this attribute.
Allows you to set the opacity of the logo once it has loaded.
Allows you to set the scale of the logo, once it has loaded. The scale of 100 will display the logo in its original size. The scale of less than 100 will shrink the logo. The scale of more than 100 will enlarge the logo.
Allows you to link the logo to an external URL. This link can open in same window, new window, pop-up windows or frames. For information on how to format the link, see
.
341
Quick Apps for SharePoint
Font Properties
You can specify generic font properties for all the text on the chart using the attributes given below.
ELEMENT
Base Font Name
Base Font Size
Base Font Color
Outside Canvas Base
Font Name
Outside Canvas Base
Font Size
Outside Canvas Base
Font Color
DESCRIPTION
Allows you set the font face (family) of all the text (data labels, values) on chart. If you specify Outside Canvas Base Font Name attribute also, then this attribute controls only the font face of text within the chart canvas bounds.
Allows you to set the base font size of the chart that is, all the values and the names in the chart which lie on the canvas are displayed using the font size provided here. The range is from 0 - 72.
Allows you to set the base font color of the chart that is, all the values and the names in the chart which lie on the canvas are displayed using the font color provided here. Use hex color code. To use the color picker, click on the color swatch square.
Allows you classify all the text in the chart into 2: the text inside the canvas which consists of only the tool tip and the data values and all the text outside the canvas. You can define a base font group for all the text outside the canvas as well.
This attribute sets the base font family of the chart font which lies outside the canvas that is, all the values and the names in the chart which lie outside the canvas are displayed using the font name provided here.
Allows you to set the base font size of the chart that is, all the values and the names in the chart which lie outside the canvas are displayed using the font size provided here. The range is from 0 - 72
Allows you to set the base font color of the chart that is, all the values and the names in the chart which lie outside the canvas are displayed using the font color provided here.
Chart Palettes
qSIChartView offers 5 palettes for you to choose from. The palette theme configures colors of the following:
• Background and border
• Canvas border and background
• Fonts
• 4Div lines
• Tooltip
• Anchors
• Legend
342
qSIChartView
The internal palette does not cover the color of the data items. To change the color of the data items, use the Palette Colors attribute or Series Appearance property.
ELEMENT
Palette
Palette Colors
DESCRIPTION
Allows you to select the palette number.
Allows you to specify your own palette for data items by providing a list of hex colors.
Y Axis
Chart limits are the minimum and maximum y-axis values. qSIChartView automatically calculates the best chart limits when you do not specify them explicitly.
ELEMENT
Y Axis Min Value
Y Axis Max Value
Set Adaptive Y Min
Primary Y Axis Min Value
Primary Y Axis Max Value
Secondary Y Axis Min
Value
Secondary Y Axis Max
Value
Primary Y Axis Name
Secondary Y Axis Name
Set Adaptive Secondary Y
Min
DESCRIPTION
Allows you to set the chart limits explicitly.
Allows you to set the chart limits explicitly.
Note:
The Y Axis Max Value must be bigger than any of the values in the data series. Otherwise, the value will not be honored by the chart view.
Allows you to set whether the y-axis lower limit would be 0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
Allows you to explicitly set the lower limit of the primary y-axis. If you do not specify this value, it is automatically calculated by qSIChartView based on the data provided by you.
Allows you to explicitly set the upper limit of the primary y-axis. If you do not specify this value, it is automatically calculated by qSIChartView based on the data provided by you.
Allows you to explicitly set the lower limit of the secondary y-axis. If you do not specify this value, it is automatically calculated by qSIChartView based on the data provided by you.
Allows you to explicitly set the upper limit of the secondary y-axis. If you do not specify this value, it is automatically calculated by qSIChartView based on the data provided by you.
Allows you to set the primary y-axis title.
Allows you to set the secondary y-axis title.
Allows you to set whether the secondary y-axis lower limit would be
0 (in case of all positive values on chart) or should the y-axis lower limit adapt itself to a different figure based on values provided to the chart.
343
Quick Apps for SharePoint
ELEMENT
Primary Y Axis Name
Width
Secondary Y Axis Name
Width
DESCRIPTION
Allows you to set choose a maximum width (in pixels) that is applied to primary y-axis name, if you do not rotate y-axis name.
If you opt to not rotate y-axis name, you can choose a maximum width (in pixels) that is applied to secondary y-axis name.
Division Lines
Divisional lines are horizontal lines running through the canvas. They break up the y axis into smaller units helping in better visual data interpretation.
ELEMENT
Adjust Division Lines
Number of Division Lines
Div Line Effect
Show Y Axis Values
Y Axis Values Step
Division Lines
344
DESCRIPTION
Allows you to explicitly specify the y-axis upper and lower limit values, and also the number of divisional lines. In those cases, you need to automatic adjustment of divisional lines by setting this attribute to false. Then you can specify the y-axis upper and lower limits using the Y Axis Max Value and Y Axis Min Value attributes respectively.
Allows you to set the number of divisional lines.
Allows you to enable to apply an effect, for example, EMBOSS, or
BEVEL to the divisional lines. This attribute is applicable to
MultiSeriesCombination3D chart type only.
Allows you to show all the y-axis values.
Allows you to skip every nth Y Axis value.
Allows you to set the color for divisional lines.
qSIChartView
ELEMENT
Division Lines Thickness
Division Lines Alpha
Is Dashed
Division Lines Dash Length
Division Lines Dash Gap
Show Alternate H Grid Color
Alternate H Grid Color
Alternate H Grid Alpha
Vertical Div Lines
Number of Vertical Div Lines
Vertical Div Lines Color
Vertical Div Lines Thickness
Vertical Div Lines Alpha
Is Dashed
Vertical Div Lines Dash
Length
Vertical Div Lines Dash Gap
Show Alternate V Grid Color
Alternate V Grid Color
Alternate V Grid Alpha
Show V Line Label Border
DESCRIPTION
Allows you to set the thickness of divisional lines. The range is from 1 - 5.
Allows you to set the alpha of divisional lines. The range is from 0
- 100.
Allows you to set the divisional line to be dashed.
Allows you to set the length of each dash.
Allows you to set the gap between each dash.
Allows you to set the horizontal grid bands alternately between the divisional lines for all 2D charts. They can be hidden by setting this attribute to false. The chart without the alternate horizontal grid bands would look as under:
Allows you to set the color of the horizontal grid bands.
Allows you to set the alpha of the horizontal grid bands. The range is from 0 - 100.
Allows you to set the vertical divisional lines running through the canvas in a line/area chart. They help in relating the data to its respective label, when there is a large amount of data.
Allows you to set the number of vertical div lines.
Allows you to set the color of the vertical axis division lines.
Allows you to set the thickness of the vertical axis division lines in pixels.
Allows you to set the alpha of vertical axis division lines. The range is from 0 - 100.
Allows you to set the vertical axis division lines as dashed.
Allows you to set the length of each dash.
Allows you to set the gap between each dash..
Allows you to set the vertical grid bands alternately between the vertical divisional lines.
Allows you to set the color of the alternate vertical grid bands.
Allows you to set the alpha (transparency) of the alternate vertical grid bands.
Allows you to set the borders for all labels for vLines in the chart.
If you want to show label border for just a particular vLine, you can override this value by specifying border configuration for that specific vLine.
345
Quick Apps for SharePoint
Zero Plane
Zero plane is a plane which separates the positive and negative numbers on a chart having both of them.
ELEMENT
Show Zero Plane
Zero Plane Color
Zero Plane Alpha
Zero Plane Thickness
Zero Plane Show Border
Zero Plane Border Color
Zero Plane Mesh
DESCRIPTION
Allows you set the zero plane in the column, line, and the area chart. It can be removed in the line chart but not in the column or the area chart because they use this as their base to draw. It can be removed in the line chart by setting this attribute to false.
Allows you set the color of the zero plane.
Allows you set the alpha (transparency) of the zero plane. The range is from 0 -100.
Allows you set the thickness of the zero plane in pixels.
Allows you set the whether to show border of zero plane for a 3D chart.
Allows you set the border color of zero plane for a 3D chart.
Allows you set the whether to draw the zero plane as a wireframe mesh or as a filled plane. If set to true, a mesh on the zero plane of the chart is drawn. This attribute is applicable to
MultiSeriesCombination3D chart type only.
346
qSIChartView
Anchors
Each data point in a line or area chart is represented by an anchor. The anchors help identify the data point better in the chart. They also show a tool tip showing the data point details when the mouse is hovered over them, and can be linked to other pages as well.
ELEMENT
Draw Anchors
Anchor Alpha
Anchor Sides
Anchor Radius
Anchor Border Color
Anchor Border
Thickness
Anchor Background
Color
Anchor Background
Alpha
DESCRIPTION
Allows you show the anchors. The anchors are displayed by default. To hide them, set this attribute to false. Once the anchors are hidden, the tool tips for the data points will not be displayed and the links will not work.
Allows you set the alpha of entire anchors. The range is from 0 - 100. If you need to hide the anchors but still have tool tip and link, set Anchor
Alpha to ‘0’
Allows you to set the number of sides the anchor will have. For example, an anchor with 3 sides would represent a triangle, with 4 it would be a square. The range is from 3 - 20.
Allows you to set the radius (in pixels) of the anchor. The greater the radius, the bigger the anchor size.
Allows you to set the border color of anchors.
Allows you to set the border thickness (in pixels) of the anchors.
Allows you to set the background color of anchors.
Allows you to set the alpha of anchor background. The range is from 0 -
100.
347
Quick Apps for SharePoint
Tool Tip
A tool tip is shown when the mouse is hovered over a particular data point. It shows the following information:
• Single series chart (except pie & doughnut): Name & value
• Pie & Doughnut: Name & value/percentage
• Multi-series & combination chart: Series Name, Category Name, Data
Value
ELEMENT
Show Tool Tip
Show Tool Tip Shadow
Tool Tip Border Color
Tool Tip Background Color
Tool Tip Separator Character
Series Name in Tool Tip
Show Percent In Tool Tip
DESCRIPTION
Allows you to set the tool tip.
Allows you to show the tool tip shadow.
Allows you to customize the border color of the tool tip.
Allows you to customize the background color of the tool tip.
Allows you to specify a character to separate the name and value displayed in tool tip.
Allows you to control whether series name will appear in the tool tip. For multi-series and combination charts, qSIChartView shows the following information in tool tip (unless tool text is explicitly defined): "Series Name, Category Name, Data
Value".
Allows you to show percentage values in Tool Tip for Pie or
Doughnut chart. By default, the Pie or Doughnut chart shows percentage values in Tool Tip.
Paddings and Margins
qSIChartView lets you define various paddings and margins using pixels. These attributes are listed one-by-one below.
348
qSIChartView
By default, qSIChartView provides some padding between the chart border and the canvas. This is called the chart margin and each margin can be set individually.
ELEMENT
Left Margin
Right Margin
Top Margin
Bottom Margin
Canvas Left Margin
Canvas Right Margin
Canvas Top Margin
Canvas Bottom Margin
Caption Padding
X Label Gap
DESCRIPTION
Allows you to set the amount of empty space on the left side of your chart. Nothing is rendered in this space.
Allows you to set the amount of empty space on the right side of your chart. Nothing is rendered in this space.
Allows you to set the amount of empty space ton the top of your chart.
Nothing is rendered in this space.
Allows you to set the amount of empty space on the bottom of your chart. Nothing is rendered in this space.
Allows you to set the amount of empty space on the left side of the canvas. Nothing is rendered in this space.
Allows you to set the amount of empty space on the right side of the canvas. Nothing is rendered in this space.
Allows you to set the amount of empty space t on the top of the canvas.
Nothing is rendered in this space.
Allows you to set the amount of empty space on the bottom of the canvas. Nothing is rendered in this space.
Allows you to set the amount of space between the caption of the chart and the top of the chart canvas. If you have a sub-caption defined in the chart, it controls the space between the sub-caption and the top of the chart canvas.
Allows you to set the vertical space between the labels and canvas wall edge. If you want more space between the canvas and the x-axis labels, you can use this attribute to control it.
349
Quick Apps for SharePoint
ELEMENT
Y Label Gap
X Axis Name Padding
Y Axis Name Padding
Y Axis Values Padding
Label Padding
Value Padding
Canvas Padding
Plot Space Percent
DESCRIPTION
Allows you set the horizontal space between the canvas wall edge and the y-axis values or trend line values (on left/right side). This is useful, when you want more space between your canvas and y-axis values.
Allows you to set the distance between the top of x-axis title and the bottom of data labels (or canvas, if data labels are not shown).
Allows you to set the padding between the y-axis name and values.
Allows you to set the padding between the left end of the chart canvas and the y-axis values.
Allows you to set the vertical space between the canvas bottom edge and the data labels.
Allows you to control the space between your columns/anchors and the value textboxes.
For a line/area chart, allows you to set the padding between the canvas border and the position where the line/area chart begins to draw is called canvas padding.
On a column chart, allows you to set the spacing between two columns.
By default, the spacing is set to 20% of canvas width. For example, if you wanted all columns to stick to each other without any space in between, you can set plotSpacePercent to 0. Similarly, if you want very thin columns, you can set plotSpacePercent to its max value of 80.
350
qSIChartView
Smart Labels and Lines
Smart labels are the labels for the pie/doughnut chart. The smart labels prevent overlapping of labels even when large number of labels are placed in close vicinity.
ELEMENT
Enable Smart Labels
Smart Line Color
Smart Line Thickness
Smart Line Alpha
Is Smart Line Slanted
Label Distance
Smart Label Clearance
Skip Overlap Labels
DESCRIPTION
Allows you to enable the smart labels (if required to save chart space or when there are few pie segments). When the smart labels are switched off, the pie labels would be displayed without the smart label lines. But if they number of labels increases and smart labels are not being used, then the labels might overlap.
Allows you to set the color of smart label connector lines.
Allows you to set the thickness (in pixels) of smart label connector lines.
Allows you to set the alpha (transparency) of smart label connector lines. The range is 0 - 100.
Allows you to set the smart lines (smart label connector lines) in two ways: Slanted or Straight. This attribute lets you choose between them.
Allows you to set the distance of the label/value text boxes from the pie/doughnut edge in pixels. You must set Enable Smart Labels to false for this attribute to take effect.
Allows you to set the clearance distance of a label (for sliced-in pies) from adjacent sliced out pies in pixels.
Allows you to skip the overlapping labels if you have too many labels in your pie chart (which is difficult to adjust even using smart labels).
In that case, you have the option to set this attribute to true. The labels of the least significant pies would be removed.
351
Quick Apps for SharePoint
ELEMENT
Show Percent Values
DESCRIPTION
Allows you to set the actual value of the pie segment to be displayed in the label or the percentage value. By default, the actual values are displayed. When you want to display their percentages, set this attribute to true.
Legend
In multi-series / combination charts, the series name of each dataset shows up in the legend of the chart. This helps you relate a data plot to its series name using its color. The legend does not appear for single-series charts because there is only one series in the chart.
Notice the legend below the chart helps identify the series name.
ELEMENT
Show Legend
Interactive Legend
Legend Caption
Legend Marker Circle
Reverse Legend
Legend Position
DESCRIPTION
Allows you to show the legend.
Allows you to make the legend interactive. Interactive Legend only works for a combination chart. In the combination chart, you can click the legend to show/hide the values of the data items. If you set
Interactive Legend to false, then legend will not be interactive.
Allows you to add a caption for the entire legend by setting the same here.
Allows you to use square legend keys or circular ones.
Allows you to reverse the order of items in legend.
Allows you to place the legend in 2 positions: RIGHT and BOTTOM. It gets placed below the canvas by default. To place it to the right of the chart canvas, set Legend Position = 'RIGHT'.
352
qSIChartView
ELEMENT
Allow Drag
Legend Background Color
Legend Background Alpha
Legend Border Color
Legend Border Thickness
Legend Border Alpha
Legend Shadow
Legend Scroll Background
Color
Legend Scroll Bar Color
Legend Scroll Button
Color
DESCRIPTION
Allows you to make the legend dragable. End viewers of the chart can drag the legend around on the chart.
Allows you to set the background color for the legend.
Allows you to set the background alpha (transparency) for the legend. The range is 0 - 100.
Allows you to set the border color for the legend.
Allows you to set the border thickness, in pixels, for the legend.
Allows you to set the border alpha for the legend. The range is 0 -
100.
Allows you to set a shadow for legend.
Allows you to set the background color of the scroll bar. If you've too many items on the legend, a scroll bar appears.
Allows you to set the bar color of the scroll bar. If you've too many items on the legend, a scroll bar shows up on the same.
Allows you to set the color of buttons on the scroll bar. If you've too many items on the legend, a scroll bar shows up on the same.If you've too many items on the legend, a scroll bar shows up on the same.
Number Formatting
qSIChartView offers you a lot of options to format your numbers on the chart from number prefixes and suffixes to controlling the decimal places to scaling your numbers based on a pre-defined scale.
ELEMENT
Format Number
Format Number Scale
Default Number Scale
Number Scale Unit
Number Scale Value
DESCRIPTION
Allows you to determine whether the numbers displayed on the chart are formatted using commas, for example, 40,000 if Format Number is true and 40000 if Format Number is false.
Allows you to determine whether to add K (thousands) and M
(millions) to a number after truncating and rounding it - for example, if Format Number Scale is set true, 1043 would become 1.04K (with decimals set to 2 places). Same with numbers in millions - a M will added at the end.
Allows you to set the default unit of the numbers that you are providing to the chart.
Allows you to set the unit of each block of the scale.
Allows you to set the range of the various blocks that constitute the scale.
353
Quick Apps for SharePoint
ELEMENT
Number Prefix
Number Suffix
Decimal Separator
Thousand Separator
In Decimal Separator
In Thousand Separator
Decimals
Force Decimals
Y Axis Value Decimals
DESCRIPTION
Allows you to add a prefix to all the numbers visible on the graph.
For example, to represent all dollars figure on the chart, you could specify this attribute to ' $' to show like $40000, $50000.
Allows you to add a suffix to all the numbers visible on the graph. For example, to represent all figure quantified as per annum on the chart, you could specify this attribute to ' /a' to show like 40000/a,
50000/a.
Allows you to specify the character to be used as the decimal separator in a number.
Allows you to specify the character to be used as the thousands separator in a number.
Allows you to input the decimal separator.
Allows you to input the thousand separator.
Allows you to set the number of decimal places to which all numbers on the chart would be rounded. The range is from 0 - 10.
Allows you to add 0 padding at the end of decimal numbers. For example, if you set decimals as 2 and a number is 23.4. If force
Decimals is set to 1, qSIChartView will convert the number to 23.40
(note the extra 0 at the end).
Allows you to specify the div line values decimal precision. The range is from 0 - 10.
3D Chart Attributes
The 3D Combination chart is a true 3D chart which offers features such as viewing from a specific camera angle, definition of light source, use of dynamic lighting, and rotation.
354
qSIChartView
The various elements of a 3D Combination chart are shown below:
ELEMENT
Is 2D
DESCRIPTION
Allows you to decide whether initially to draw a 2D view of the chart.
355
Quick Apps for SharePoint
ELEMENT
Chart Order
Chart On Top
Auto Scaling
Allow Scaling
Animate 3D
Exe Time
Camera Angle
X/Camera Angle Y
DESCRIPTION
Allows you to set the order by which different types of charts will appear. The value can be any combination of 'column', 'line' or 'area', each separated by a comma. By default, the order is: line, column, area. You can change to any order you like, for example, 'column, area, line' or 'line, area'.
Allows you to decide whether or not the chart canvas is placed over the extra chart elements (caption, subcaption, legend). This feature is visible when the chart canvas is zoomed/scaled. +
Allows you to decide whether or not the chart is allowed to best fit automatically after a user interaction, for example, rotation.
Allows you to set whether to allow zoom-in/zoom-out.
Note:
Scaling or use of mouse is compatible only with Windows
Operating System.
Allows you to show the initial plot animation. By default, the 3D chart is rendered with a default animation.
To globally set off all animation set Animation to false. This would not only set off 3D animations, but also disable all animations applied using
<styles>. The additional use of Animate 3D can override this value.
Hence, a combination of Animation = false and Animate 3D = true would disable all animations applied using <styles> but, enable animation of the 3D canvas.
Allows you to set the time that the chart takes to animate. This attribute also sets the time taken by the chart canvas to animate when the chart is transformed to any view (View3D, View 2D, Reset View).
Allows you to define the camera angle.
• Camera Angle X lets you specify the camera angle (for view around the chart vertically) from which the chart is viewed initially in no animation mode (when animate3D='0) . If not specified, the default value is 30. The range is from 0 to 360 and 0 to -360.
• Camera Angle Y lets you specify the camera angle (for view around the chart horizontally) from which the chart is viewed initially in no animation mode (when animate3D='0). If not specified, the default value is -45. The range is from 0 to 360 and
0 to -360.
Since this is a true 3D chart, it's rendered as a 3D model that is viewed from a specific camera angle. The camera can simply be defined as the eye of a real viewer. When you have set Animate 3D to 0, you can define the camera angle using two attributes - Camera Angle X and
Camera Angle Y.
When you use animation, you can also set up the starting camera view from which the camera view starts animating, and the final camera view to which the chart would finally be rotated. For this, you need to use Start Angle X, Start Angle Y, End Angle X and End Angle Y attributes.
356
qSIChartView
ELEMENT
Start Angle X/End Angle
X
Start Angle Y/End Angle
Y
Light Angle X/Light
Angle Y
Intensity
Dynamic Shading
DESCRIPTION
Start Angle X — Allows you to specify the view angle (for view around the chart vertically) at which rotation of the chart starts (when the chart is initialized). The rotation stops at endAngX. If not specified, the default values for both the attributes are 30. The range is from 0 to
360 and 0 to -360. This is for animated charts (when animate3D='1').
End Angle X — Allows you to specify the view angle (for view around the chart vertically) at which rotation of the chart ends (when the chart is initialized). The rotation starts at startAngX. If not specified, the default values for both the attributes are 30. The range is from 0 to
360 and 0 to -360. This is for animated charts (when animate3D='1').
Start Angle Y — Allows you to specify the view angle (for view around the chart horizontally) from which rotation of the chart starts (when the chart is initialized). The rotation stops at endAngY. If not specified, the default values for both the attributes are -45. The range is from 0 to 360 and 0 to -360. This is for animated charts (when animate3D='1').
End Angle Y — Allows you to specify the view angle (for view around the chart horizontally) at which rotation of the chart ends (when the chart is initialized). The rotation starts at startAngY. If not specified, the default values for both the attributes are -45. The range is from 0 to 360 and 0 to -360. This is for animated charts (when animate3D='1').
Light Angle X — Allows you to specify the angular position of the light source (for X-axis) w.r.t the chart world coordinate system. The range is from 0 to 360 and 0 to -360.
Light Angle Y — Allows you to specify the angular position of the light source (for Y-axis) w.r.t the chart world coordinate system. The range is from 0 to 360 and 0 to -360.
Allows you to control the intensity of the light that falls on the chart elements. The range of this attribute lies between 0 to 10. 10 would provide light with maximum intensity, and you will get the brightest view of the chart. If you set the value to 0, light is provided with least intensity. However, the chart will never appear in full darkness even you set intensity to 0. A faint light is always made available. By default, the value is set to 2.5.
Allows you to set the chart in dynamic shading/non-world mode. If set to false, the chart is in world mode.
For example, you can have a Combination 3D Chart that has two different lighting systems to light up the chart elements. The light source may be fixed outside the chart. This causes only those sides of the chart to get the light which face the light source. Thus, when the chart is manually rotated, dynamic shades are created on the chart surfaces. This system of lighting is called dynamic shading.
World lighting is where the light source is fixed with the chart. In this case, the light source rotates with the rotation of the chart. Hence, the surface facing the light source gets lightened and continues to be in the bright side despite any manual rotation of the chart being made, whereas the surface not facing the light keeps remaining in darkness with every chart rotation.
357
Quick Apps for SharePoint
ELEMENT
Bright 2D
Allow Rotation
Constrain Vertical
Rotation
Minimum Vertical
Rotation Angle
Maximum Horizontal
Rotation Angle
Z Depth
Z Gap Plot
YZ Wall Depth
ZX Wall Depth
XY Wall Depth
Clustered
DESCRIPTION
Allows you to set maximum brightness to the chart while being rendered in 2D mode. This is applicable only when you've set Dynamic
Shading to true. However, once you set this attribute to true, you cannot use Light Angle X and Light Angle Y attributes. Rather, it automatically sets up the light sources to give the brightest view of the chart in 2D mode.
Allows you to decide whether to stop any user interactive rotation of the chart or not. If it is set to false, the interactive rotation is barred.
Allows you to rotate up to 90 degrees (top or bottom) from 0 degree position. You can also specify these limits using Minimum Vertical
Rotation Angle and Maximum Vertical Rotation Angle attributes. This is only applicable to user's mouse interactivity with the chart.
Allows you to set the minimum allowed angle up to which a user can rotate the chart vertically. This is only applicable to user's mouse interactivity with the chart.
Allows you to set the maximum allowed angle up to which a user can rotate the chart horizontally. This is only applicable to user's mouse interactivity with the chart.
Allows you to set the depth (3D thickness) of each DATAPLOT object using zDepth attribute.
Allows you to specify a gap between all dataplots in a 3D combination chart, as more than one DATAPLOT types can exist due to different datasets.
A Z Gap Plot set to 0 will show no gap between dataplots.
Allows you to set the depth of the YZ wall of 3D chart.
Allows you to set the depth of the ZX wall of 3D chart.
Allows you to set the depth of the XYwall of 3D chart.
Allows you to set a Combination 3D chart in clustered mode. In a
Combination 3D chart, you can plot multiple number of datasets which can be rendered as Column.
Custom About Menu Item
You can change the default "About Quick Apps for SharePoint" context menu item to show your label and link it to your own URL using the below attributes.
ELEMENT
Show About Menu Item
About Menu Item Label
DESCRIPTION
Allows you to set up a custom context menu in the chart, which can show your text and can be linked to your URL. For example, you can set the context menu of the chart to include "About your company name" and then link to your company home page. By default, the chart shows
"About Quick Apps for SharePoint" when right-clicked.
Allows you to set a menu item label for the custom context menu item.
358
qSIChartView
ELEMENT
About Menu Item Link
DESCRIPTION
Allows you to provide a link for the custom context menu item. You can specify the link in qSIChartView link format to be able to open the same in new window, pop-ups, frames or as JavaScript links.
Functional
These attributes let you control a variety of functional elements on the chart.
ELEMENT DESCRIPTION
Animation
Click URL
Allows you to control animation in your charts. If you do not want to animate any part of the chart, set this to false. This would also disable all animations applied using <styles>. Animate 3D can override this value. By default, animation is set to true.
Allows you to set a URL as a hotspot for a chart. For more information, see
Formatting Links.
Trend Lines
Trend Lines allow you to specify the horizontal/vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value.
Trend Lines contain the following:
ELEMENT
Start Value
End Value
Display Value
Color
Is Trend Zone
Thickness
Alpha
Dashed
Dash Length
Dash Gap
Value on Right
DESCRIPTION
Allows you to set the start value for the trend line
Allows you to set the ending y-axis value for the trend line
Allows you to display a string caption for the trend line by its side
Allows you to set the color of the trend line and its text
Allows you to set the trend as a zone rather than a line
Allows you to set the thickness of the trend line
Allows you to set the alpha transparency of the trend line
Allows you to set the trend line as a dashed line
Allows you to set the length of each dash in pixels
Allows you to set the gap length between each dash
Allows you to show if the trend line is on the right or left side of the chart
359
Quick Apps for SharePoint
ELEMENT
Tool Text
Parent Y Axis
DESCRIPTION
Allows you to show tool text when hovered over a trend line
Allows to you set whether the trend line should be plotted against a primary or secondary Y axis (If you use a dual Y Axis chart). If you do not use a dual Y axis chart, the trend line is plotted against the primary Y axis.
Styles
Styles help you apply font, effects and animations to various objects of the chart.
Styles lends a simple mechanism using which you can easily control the visual layout of charts.
Styles allows you to:
• Define your own style attributes using the Style Editor.
• Associate them with defined Objects of the chart from within the Style
Editor.
• Have better control over chart look & feel.
• Group together in one element in the XML document, thereby separating data from visual formatting.
• Store the entire style definition in a central location in your application, so that all charts within application can utilize it.
• Re-use style definitions. Each style can be applied to multiple chart objects or vice versa.
Each object on the chart has been assigned a unique name, for direct association with style definitions. For example, the background of the chart is termed as
BACKGROUND. Similarly, the plot (columns, lines, areas) on the chart is named as DATAPLOT. This enables you to associate each style to multiple chart objects or associate multiple chart objects to a particular style.
You can find the list of objects for each chart in individual Chart XML Sheet.
To define styles, use the Style Editor to generate the following XML:
<styles>
<definition>
<style name='MyFirstFontStyle' type='font' face='Verdana' size='12' color='FF0000' bold='1' bgColor='FFFFDD' />
360
qSIChartView
<style name='MyFirstAnimationStyle' type='animation' param='_xScale' start='0' duration='2' />
<style name='MyFirstShadow' type='Shadow' color='CCCCCC' />
</definition>
<application>
<apply toObject='Caption' styles='MyFirstFontStyle,MyFirstShadow' />
<apply toObject='Canvas' styles='MyFirstAnimationStyle' />
<apply toObject='DataPlot' styles='MyFirstShadow' />
</application>
</styles>
As you can see above, all the style related elements and attributes appear under the <styles> parent element. Children to <styles> element are <definition> and <application> elements. As the name suggests, <definition> element contains your custom styles definition for the chart while under <application> element, you apply your custom defined styles to different chart objects.
You can define one or more styles for a chart from the Styles Editor. To add a style, click
Add
. To see more attributes for a particular style, click
Edit
for the style. To delete a style, select the check box of the style and click
Delete
.
Styles contains the following:
ELEMENT
Name
DESCRIPTION
Allows you to assign your custom name for the style definition. Style name can only include alphabets and numbers. Punctuation marks (including underscore) should not be used. Style name must be unique, that is, two style definitions cannot have the same name.
361
Quick Apps for SharePoint
ELEMENT
Type
DESCRIPTION
Allows you to set the following types:
• Font — allows you to control text properties for all the text on the chart.
You can set:
-Font — allows you to set the font type
-Size — allows you to set the font size
-Color — allows you to set the font color
-Bold — allows you to set the font weigh
-Underline — allows you to assign underline character
-Background Color — allows you to set the background color
-Border Color — allows you to set the border color
-Is HTML — allows you to render the text as HTML
-Left Margin — allows you to set the left margin of the text
-Letter Spacing — allows you to set the space between the letters in the text
• Animation — Allows you to define your custom animations for different elements of the chart. By default, qSIChartView animates the data plot
(columns, lines, area) only. However, you can define your custom animations for other chart objects (like captions, titles, values) in the XML.
Each chart object can have multiple animation properties (like x, y, xscale, yscale, alpha) and each sequence can have its own duration.
-Param — Allows you to you specify the property of chart object which you want to animate, such a _x (animate the x position), _y (animate the y position), _xScale (animate the x-scale), _yScale (animate the y-scale), alpha (helps the alpha transition animation effect), _rotation (animate pies and doughnuts in circles)
-Start — allows you to set the start value of the animation
-Duration — allows you to control the duration of animation in seconds
-Easing — allows you to specify the pattern of animation easing.
362
ELEMENT
Type
qSIChartView
DESCRIPTION
• Shadow — Allows you to apply shadow effect to any object on the chart.
-Distance — allows you to set the offset distance of the shadow
-Angle — allows you to set the angle of the shadow
-Color — allows you to set the color of the shadow
-Alpha — allows you to set the alpha transparency of the shadow
-BlurX — allows you set the amount of horizontal blur on the shadow.
Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur on the shadow.
Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Strength — allows you to set the strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background.
-Quality — allows you to set the number of times to apply the shadow effect. Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality. Shadow with lower values are rendered quicker
• Glow — lets you apply glow effects to objects on the chart.
-Color — allows you to set the color of the glow
-Alpha — allows you to set the alpha transparency of the glow
-BlurX — allows you set the amount of horizontal blur on the glow. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur on the glow. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Strength — allows you to set the strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background.
-Quality — allows you to set the number of times to apply the glow effect.
Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality.
Shadow with lower values are rendered quicker.
363
Quick Apps for SharePoint
ELEMENT DESCRIPTION
• Bevel — Allows you to apply bevel effect for any of the chart objects.
-Angle — allows you to set the angle of the bevel
-Distance — allows you to set the offset distance of the bevel
-Shadow Color — allows you to set the shadow color of the bevel
-Shadow Alpha — allows you to set the alpha transparency value of the shadow color
-Highlight Color — allows you to set the highlight color of the bevel
-Highlight Alpha — allows you to set the alpha transparency value of the highlight color
-BlurX — allows you set the amount of horizontal blur on the bevel. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur on the bevel. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Strength — allows you to set the strength of the imprint or spread. The higher the value, the more color is imprinted and the stronger the contrast between the shadow and the background.
-Quality — allows you to set the number of times to apply the bevel. Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality.
Shadow with lower values are rendered quicker.
• Blur — Allows you to create a blur effect for any object on the chart.
-BlurX — allows you set the amount of horizontal blur. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-BlurY — allows you to set the amount of vertical blur. Values that are a power of 2 (such as 2, 4, 8, 16 and 32) are optimized to render more quickly than other values.
-Quality — allows you to set the number of times to apply the filter. Valid values are 0 to 15. The default value is 1, which is equivalent to low quality. A value of 2 is medium quality, and a value of 3 is high quality.
Shadow with lower values are rendered quicker.
364
qSIChartView
Applying custom defined styles to chart objects
To apply your defined styles to chart objects, make sure that you have the list of chart objects present in each chart.
For example, the following chart objects are for 2D Single Series Column Chart:
OBJECT
NAME
DESCRIPTION
FEATURES
SUPPORTED
BACKGROUND BACKGROUND refers to the entire background of the chart.
CANVAS
CAPTION
DATALABELS
DATAPLOT
In 2D Charts, CANVAS refers to the area in which the actual chart is plotted. It is represented by a bounded rectangle. In 3D charts, it refers to the 3D base on which the columns are built.
CAPTION refers to the heading of the chart.
DATALABELS refer to the x-axis labels of the data.
DATAPLOT refers to the actual plot of the chart. For example, in Column 2D chart, columns are referred to as DATAPLOT. In
Pie chart, it's the pies.
•
Animation
•
Shadow
•
Glow
•
Bevel
•
Blur
• Animation
• Shadow
• Glow
• Bevel
• Blur
•
Animation
•
Font
•
Shadow
•
Glow
•
Bevel
•
Blur
•
Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
•
Animation
•
Shadow
•
Glow
•
Bevel
•
Blur
ANIMATION
PARAMETERS
SUPPORTED
•
_alpha
•
_x
•
_y
•
_xScale
•
_yScale
• _alpha
• _x
• _y
• _xScale
• _yScale
•
_alpha
•
_x
•
_y
•
_alpha
• _x
• _y
•
_alpha
•
_x
•
_y
•
_xScale
•
_yScale
365
Quick Apps for SharePoint
DATAVALUES
DIVLINES
HGRID
SUBCAPTION
TOOLTIP
TRENDLINES
TRENDVALUES
DATAVALUES refer to the plot values that is, value of each data (line, column, bar, pie), which is displayed beside the data plot.
DIVLINES are horizontal or vertical lines running through the canvas. Each divisional line signifies a smaller unit of the entire axis thus aiding the users in interpreting the chart.
HGRID refers to alternate color bands between two successive horizontal divisional lines.
SUBCAPTION refers to the sub-heading of the chart.
TOOLTIP refers to the tool tip shown when mouse is hovered over the data plots.
TRENDLINES refer to horizontal/vertical lines spanning the chart canvas which aid in interpretation of data with respect to some pre-determined value.
TRENDVALUES refer to the display values of trend-lines (if any).
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
•
Animation
•
Shadow
•
Glow
•
Bevel
•
Blur
•
Animation
•
Shadow
•
Glow
•
Bevel
•
Blur
•
Animation
•
Font
•
Shadow
•
Glow
•
Bevel
•
Blur
•
Font (only Font,
Size and Color attributes are supported)
•
Animation
•
Shadow
•
Glow
•
Bevel
•
Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
• _alpha
• _x
• _y
•
_alpha
•
_y
•
_yScale
•
•
•
•
•
•
•
•
•
•
•
•
•
•
_alpha
_y
_xScale
_yScale
_alpha
_x
_y
_alpha
_y
_xScale
_yScale
_alpha
_x
_y
366
qSIChartView
VLINES
XAXISNAME
YAXISNAME
YAXISVALUES
VLINES are vertical separator lines that help you separate blocks of data. These lines run through the height of the chart, thereby segregating data into different blocks. In case of bar charts, they are horizontal and run through the width of chart.
XAXISNAME refers to the x-axis title of the chart.
•
•
•
•
•
Animation
Shadow
Glow
Bevel
Blur
YAXISNAME refers to the y-axis title of the chart.
YAXISVALUES refers to the limit values or divisional line values, which are displayed along the y-axis of the chart.
•
Animation
•
Font
•
Shadow
•
Glow
•
Bevel
•
Blur
• Animation
• Font
• Shadow
• Glow
• Bevel
• Blur
•
Animation
•
Font
•
Shadow
•
Glow
•
Bevel
•
Blur
• _alpha
• _x
• _y
• _yScale
•
_alpha
•
_x
•
_y
• _alpha
• _x
• _y
•
_alpha
•
_x
•
_y
•
_rotation
The following XML does the work of applying styles to different chart objects:
<application>
<apply toObject='Caption' styles='MyFirstFontStyle,MyFirstShadow' />
<apply toObject='Canvas' styles='MyFirstAnimationStyle' />
<apply toObject='DataPlot' styles='MyFirstShadow' />
</application>
Each <apply> element helps to apply multiple styles to one chart object, for example, in our code, we first apply the MyFirstFontStyle font style to Caption of the chart and then apply the shadow style MyFirstShadow to the same object.
If you are using multiple styles, ensure:
• you separate the style names using comma for example, <apply toObject='Caption' styles='MyFirstFontStyle,MyFirstShadow' />
367
Quick Apps for SharePoint
• when you apply a single style to multiple objects, define <apply> element for each object and then assign the style for it. for example,
<apply toObject='Caption' styles='MyFirstShadow' />
<apply toObject='DataPlot' styles='MyFirstShadow' />
You CANNOT separate the object list by comma and then assign a single style to it - the following is INVALID:
<apply toObject='Caption,DataPlot' styles='MyFirstShadow' />
• The style name specified during application has been defined earlier in style definition and the spelling are correct, else, qSIChartView will ignore it and log the error in Debug Window.
Series Appearance
This property enables you to specify the appearance of the data series and data items in the series.
This property is an XML string in the following format:
<Appearance>
<SeriesAppearance [optional attributes]>
<ItemAppearance [optional attributes] />
<ItemAppearance [optional attributes] />
</SeriesAppearances>
<SeriesAppearance [optional attributes]>
<ItemAppearance [optional attributes] />
<ItemAppearance [optional attributes]/>
</SeriesAppearances>
</Appearance>
The Appearance element can contain one or more Series Appearance elements.
Each Series Appearance element controls the appearance of the data series in the chart. Therefore, the first Series Appearance element controls the appearance of the first data series, the second one contains the second data series, and so on. See the Configuration property on how to define multiple data series in the chart.
368
qSIChartView
The Series Appearance contains the following:
ELEMENT
Color
Alpha
Ratio
Dashed
Show Plot Border
Plot Border Color
Plot Border
Thickness
Plot Border Alpha
Line Thickness
Line Dash Length
Line Dash Gap
Draw Anchors
Anchor Sides
Anchor Radius
Anchor Border
Color
Anchor Border
Thickness
Anchor
Background
Color
Anchor Alpha
Anchor
Background
Alpha
DESCRIPTION
Allows you to set the color using which columns, lines, area of that dataset would be drawn.
Allows you to set the alpha (transparency) of the entire dataset at the Series
Appearance level. The range is from 0 - 100.
Allows you to control the ratio of each color using a comma separated list of ratios, if you are showing columns as gradients,
Allows you to set whether this dataset would appear as dashed.
Allows you to set whether to show the border of this dataset.
Allows you to set the color of the plot border.
Allows you to set the thickness of the plot border lines.
Allows you to set the alpha transparency of the plot border lines
Allows you to set the thickness of the lines for the particular dataset in pixels.
Allows you to define the length of the dash, if the lines are to be shown as dash for the particular dataset.
Allows you to define the length of the gap between dashes, if the lines are to be shown as dash for the particular dataset.
Allows you set whether to draw anchors for the particular dataset. If the anchors are not shown, then the tool tip and links will not work for the dataset.
Allows you set the number of sides that the anchors of the particular dataset will have. For example, an anchor with 3 sides would represent a triangle, with
4 it would be a square and so on. The range is from 3 - 20.
Allows you to set the radius (in pixels) of the anchors of the particular dataset.
Greater the radius, bigger would be the anchor size.
Allows you set the border color of anchors of the particular dataset. Use hex code of colors. To use the color picker, click on the color swatch square.
Allows you set border thickness of anchors of the particular dataset in pixels.
Allows you set the background color of anchors of the particular dataset. Use hex code of colors. To use the color picker, click on the color swatch square.
Allows you set the alpha of entire anchors of the particular dataset. If you need to hide the anchors for the dataset but still enable tool tips, set this as 0.
Allows you set the alpha (transparency) of anchor background of the particular dataset. The range is from 0 - 100.
369
Quick Apps for SharePoint
The Series Appearance element can contain zero or more Item Appearance elements. If you do specify any Item Appearance element, every item in the series is displayed according to the settings in the Series Appearance element.
The Item Appearance is applied as follows:
• If you specify the Item Value in the Item Appearance, the settings are applied based on the X axis value of the item. For example, if the X axis shows the value of the Priority field in the Tasks list, you can make all the High priority items displayed in red.
• If you specify Y Axis Value Range in the Item Appearance, the settings are applied based on the Y axis value of the item. For example, you can highlight any data items that falls within a certain range with a certain color (low sales number with red, high sales number with blue).
• If neither is specified, the settings are applied in the order they are listed. This means the first Item Appearance controls the appearance of the first data item in the series, the second one controls the second data item in the series, and so on. In this case, if the data series has more items to display than the number of Item Appearance, the remaining items are displayed with the settings specified by the
Series Appearance. Having said this, it is better to define more Item
Appearance elements when you have a variable number of items to display in the chart.
Item Appearance contains the following:
ELEMENT
Item Value
Y Axis Value
Range
Color
Display Value
Tooltext
Alpha
DESCRIPTION
Allows you to specify the settings in the Item Appearance element that are applied to the data items whose X axis value match with the specified value.
Allows you to apply the color is applied based on the Y axis value of the item, if you specify Y Axis Value Range,
Allows you to define the color of data series at the Series Appearance level for multi-series and combination charts. However, if you wish to highlight a particular data item, you can specify its color at Item Appearance level.
Allows you to display a custom string value if instead of the numerical value of this data.
Allows you to display more information for the data item as tool tip. By default, qSIChartView shows the series Name, Category Name and value as tool tip text for that data item.
Allows you to define the alpha of datasets at the Series Appearance level for multi-series and combination charts, However, if you wish to highlight a particular data item, you can specify its alpha at Item Appearance level using this attribute. The range is from 0 - 100.
370
qSIChartView
ELEMENT
Dashed
Anchor Sides
Anchor Radius
Anchor Border
Color
Anchor Border
Thickness
Anchor
Background
Color
Anchor Alpha
Anchor
Background
Alpha
DESCRIPTION
Allows you to set whether the border of this data item should appear as dashed.
Lets you specify item specific sides of the anchor in a line/area chart. The range is from 3 - 20.
Lets you specify item specific radius (in pixels) of the anchor in a line/area chart.
Lets you specify item specific border color of the anchor. Use hex code of colors. To use the color picker, click on the color swatch square
Lets you specify item specific border thickness in pixels) of the anchor in a line/area chart.
Lets you specify item specific background color of the anchor in a line/area chart.
Lets you specify item specific alpha (transparency) of the anchor in a line/area chart. The range is from 0 - 100.
Lets you specify item specific alpha (transparency) of the anchor background in a line/area chart. The range is from 0 - 100.
Toolbar Appearance Tab
The Toolbar Appearance Tab contains the following:
ELEMENT
Toolbar Skin Name
Show Return to Master Chart Button
DESCRIPTION
Allows you to enter the skin name for the toolbar.
If selected, displays the Return To Master Chart Button.
This button will appear only if the Source parameter exists in the URL of the current page. When the user clicks this button, the user is returned back to the URL specified in the Source HTTP parameter.
371
Quick Apps for SharePoint
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
Return to Master
Chart Button Text
Resource ID
Filter Button Text
Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
By default, the text for the Return to Master Chart toolbar button is retrieved from the resource file that is included in the product. If the resource file in the culture that you want to use is not available, define the text for the Return to Master Chart toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Filter toolbar button is retrieved from the resource file that is included in the product. If the resource file is not available, define the text for the Filter toolbar button in the Resource List and specify its Resource ID. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
372
qSIChartView
qSIChartView Procedures
You can perform the following procedures using qSIChartView:
•
•
•
•
•
Using MultiSeriesStackedColumn2D and
MultiSeriesStackedColumn2DLineDual YAxis Charts
Configuring qSIChartView
To configure qSIChartview
1.
Add qSIChartView to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
Formatting Links
You can perform the following procedures with links:
•
•
•
•
Opening Links in Pop-up Windows
Defining Links for a Chart
To define a link for any data plot
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, define the link attribute as in the following example: link='ShowDetails.asp%3FMonth%3DJan'
373
Quick Apps for SharePoint
With the above XML, the data plot (be it column, pie or line/area anchor), when clicked, will take to the page
ShowDetails.asp?Month=Jan, which might contain another chart to show detailed results for the month of January.
The chart view expects all the links in URL Encoded format, if you have characters special characters (such as ?,&) in your link. When the user clicks the link, the chart view decodes it and invokes
ShowDetails.asp?Month=Jan.
All the server-side scripting languages provide a generic function to
URL Encode any string.
Opening Links in a New Window
You can open the link in a new window instead of the same window.
To open a link in a new window
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, add n- before any link, as in the following example:, link='n-ShowDetails.asp%3FMonth%3DJan'
The above link, when clicked, opens in a new window.
Opening Links in Pop-up Windows
The chart view also allows you to open your links in pop-up windows.
To open a link in pop-up window
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, define the link as in the following example: link="P-detailsWin,width=400,height=300,toolbar=no,scrollbars=no
, resizable=no-ShowDetails.asp%3FMonth%3DJan"
Where:
• P- denotes that the link is to open in a new pop-up window.
• detailsWin specifies a name for the new window. If you want all the links to open in the same pop-up, use the same window name across all links. However, if you want each link to open in a new pop-up, specify a different window name for each link.
• height specifies the height of the window in pixels.
• width specifies the width of the window in pixels.
374
qSIChartView
• resizable when enabled, allows the user to manually resize the window by dragging its edges or corners.
• scrollbars specify whether or not to display the horizontal and vertical scrollbars that normally appear when the page content is larger tan the screen.
You can include other attributes, such as:
• menubar specifies whether or not to display a menu bar at the top of the window.
• toolbar specifies whether or not to display the main toolbar (with the back, forward, stop buttons).
• location specifies whether or not to display the location bar (the Address Bar in
Internet Explorer) - where URLs are typed and displayed.
• directories specifies whether or not to display any additional toolbar (for example, the Links Bar in Internet Explorer).
• status specifies whether or not to display the status bar at the foot of the window.
• left specifies the distance in pixels of the new window from the left edge of the screen. (This applies to Internet Explorer. For Netscape Navigator use screenX).
• top specifies the distance in pixels of the new window from the top edge of the screen. (This applies to Internet Explorer. For Netscape Navigator use screenY).
• fullscreen when enabled causes the window to open in full-screen mode (Internet
Explorer only.)
• -ShowDetails.asp%3FMonth%3DJan denotes the actual link to be invoked
Linking to Frames
The chart view allows you to open links in specified frames too. To do so, you just specify the name of the frame in the link itself.
To open link in a specified frame
1.
From Chart Attributes, click
Edit
.
2.
Click
Functional
.
3.
In the Click URL field, set the link as in the following example: link='F-FrameName-ShowDetails.asp%3FMonth%3DJan'
Where:
• F denotes the link opens in a frame
• -FrameName denotes the name of the frame to be opened
• -ShowDetails.asp%3FMonth%3DJan denotes the actual link to be opened. The link needs to be URL Encoded.
375
Quick Apps for SharePoint
In this example, the main frameset is contained in FrameExample.html, which has two vertical frame pane- one on top containing the chart
(FramePages\FrameChart.html) and one on bottom to show the linked frame pages. The bottom pane by default shows FramePages\LowerFrame.html which contains the message "Click on columns above to view details ".
The setup looks as:
Setting Number Formatting
You can perform the following procedures:
•
•
•
Setting Custom Thousand and Decimal Separator Character
•
Opening Links in Pop-up Windows
•
Adding Number Prefix and Suffix
•
Formatting Y-axis Values Decimal in Manual Div-Lines Mode
376
qSIChartView
Controlling Decimal Precision
All the charts types in qSIChartView support the attribute decimals. This single attribute lets you control the decimal precision of all the numbers on the chart.
Using this attribute, you can globally set the number of decimal places of ALL numbers of the chart.
To globally set the number of decimal places
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
Enter a value in the Decimal box.
4.
Click
Save
.
For example, if you have numbers on your chart as 12.432, 13.4 and 13 and you set Decimals='2' , the numbers would be converted to 12.43, 13.4 and 13 respectively.
Similarly, if you had data as 0.12342, 0.134 and 0.13, and you set Decimals as
3, qSIChartView would output 0.124, 0.134 and 0.13 respectively.
377
Quick Apps for SharePoint
Even though the Decimal is set to 3, qSIChartView does not add the 0 padding to 0.13 to form 0.130. However, if you want your numbers on the chart to have trailing zeroes too, you can set Force Decimals=true and now the numbers would show as 0.124, 0.134 and 0.130 respectively, as shown in the examples:
Automatic Number Formatting
qSIChartView automatically formats your numbers by adding K,M (Kilo, Million) and proper commas to the numbers, as shown in the example:
The data for chart is 12500, 13400 and 13300. qSIChartView automatically formats the number scaling to convert to K (Thousands) & M (Millions).
If you do not want to truncate numbers
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number Scale, select
False
.
4.
Click
Save
.
378
When you now view the chart, you will see the following:
qSIChartView
In the example above, qSIChartView is showing full numbers on the chart. It has also added commas to the numbers at the required places.
If you do not want to set commas
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number, select
False
.
4.
From Format Number Scale, select
False
.
5.
Click
Save
.
The commas have been removed from numbers.
379
Quick Apps for SharePoint
Setting Custom Thousand and Decimal Separator
Character
By default, qSIChartView uses . (dot) as decimal separator and , (comma) as thousand separator character. However, you can customize this character depending on your requirements. For example, you can swap the separator characters.
To swap separator characters
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the In Decimal Separator, enter
,
.
4.
In the In Thousand Separator, enter
.
.
5.
Click
Save
.
Shown below is the output.
Adding Number Prefix and Suffix
qSIChartView allows you to add a prefix or suffix to all numbers on the chart.
To add a number prefix or suffix
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the Number Prefix box, enter a character or value.
For example, to represent dollar figures, enter $.
4.
In the Number Suffix box, enter a character or value.
For example, to represent figures quantified per annum, enter p.a.
380
qSIChartView
5.
Click
Save
.
If you intend to use special characters for Number Prefix or Number Suffix, URL
Encode them when using dataXML method. For example, if you wish to have numberSuffix as % (for example, 30%): numberSuffix='%25'
In dataURL method, you can directly specify the character.
Examples:
Formatting Y-axis Values Decimal in Manual Div-Lines
Mode
If you want to set the number of divisional lines on chart, you can control the decimals of y-axis values separately. For example, consider the following attributes and chart:
381
Quick Apps for SharePoint
Y Axis Min Value='115' Y Axis Max Value='140' Zero Plane=false Number of
Division Lines='3' >
In this chart, the chart lower limit, upper limit, and number of divisional lines have been manually set. qSIChartView will not automatically adjust divisional lines. In the chart, qSIChartView has truncated decimals from y-axis values, as it cannot find any other decimal values on the chart.
You can, however, show decimals on y-axis values in this case (when Zero Plane is false) using Y Axis Value Decimals attribute, for example Y Axis Min
Value='115' Y Axis Max Value='140' Zero Plane=false Number of Division
Lines='3' Y Axis Value Decimals='2' Decimals='0' >.
When you now see the chart, 2 decimal places on y-axis values appear. But, the other numbers on chart would still have 0 decimal places.
382
Force Decimals does not work in this mode.
qSIChartView
Setting Number Scaling
Number scaling lets you define your own scales for numbers and then apply it to all numbers on the chart.
For example, if your numbers on the chart are greater than 1000, qSIChartView scales them to K (Thousands) or M (Millions). For example, if you plot a chart with data as 12500, 13400 and 13300, you will see the following chart: qSIChartView has scaled the numbers down to K. By default, qSIChartView has the K,M (1000,1000) scaling defined for each chart. You can, however, customize it.
You can perform the following procedures:
•
Adding Billions to Default Scaling
•
Adding Billions to Default Scaling
qSIChartView, by default, has 1000,1000 (K,M) scaling defined for all charts. It does not have the scaling for billions defined. You can modify the number scaling to add billion so that the final scale looks like 1000,1000,1000 (K,M,B).
This scale would look something like:
• 1000 = 1 K
• 1000 K = 1 M
• 1000 M = 1 B
383
Quick Apps for SharePoint
To convert this scale into qSIChartView format
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the Number Scale Value box, enter
1000,1000,1000
.
4.
In the Number Scale Unit box, enter
K,M,B
.
5.
Click
Save
.
Whatever numeric figure was present on the left hand side of the table is put in Number Scale Value and whatever unit was present on the right side of the scale table has been put under Number Scale Unit - all separated by commas.
If you want to set the chart formatting flags
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number, select
True
.
4.
From Format Number Scale, select
True
.
5.
In the Number Prefix box, enter
$
.
6.
Click
Save
.
When you now view a chart containing data in billions, you will see the following chart. Note that the chart now contains figure both in millions and billions.
384
qSIChartView
Putting Time in Scale
If you want to plot time-related figures on the chart, you can set the time in each process to range from a few seconds to few days. You can build a scale indicating time and then specify it to the chart:
• 60 seconds = 1 minute
• 60 minute = 1 hr
• 24 hrs = 1 day
• 7 days = 1 week
To convert this scale in qSIChartView
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
In the Default Number Scale box, enter
s
.
The default number scale is now represented in seconds.
4.
In the Number Scale Value box, enter
60,60,24,7
.
5.
In the Number Scale Unit box, enter
min,hr,day,wk
.
6.
Click
Save
.
Whatever numeric figure was present on the left hand side of the table is put in Number Scale Value and whatever unit was present on the right side of the scale table has been put under Number Scale Unit
- all separated by commas.
If you want to set the chart formatting flags
1.
From Chart Attributes, click
Edit
.
2.
Click
Number Formatting
.
3.
From Format Number, select
True
.
4.
From Format Number Scale, select
True
.
5.
Click
Save
.
When you now view the chart, you'll see that all the data has been automatically scaled to the best value:
• 38 is converted to 38s
• 150 is converted to 2.50min
• 11050 is converted to 3.07hr
• 334345 is converted to 3.87 day
• 1334345 is converted to 2.21wk
385
Quick Apps for SharePoint
Using MultiSeriesStackedColumn2D and
MultiSeriesStackedColumn2DLineDual
YAxis Charts
To use MultiSeriesStackedColumn2D and
MultiSeriesStackedColumn2DLineDualYAxis
For example, you want to use a list that shows total revenue (Sales minus Cost) for all products from 2001-2006.
1.
Open qSIChartView in ezEdit.
2.
Configure the Catalog section.
3.
In the Chart Type section, select
MultiSeriesStackedColumn2D
or
MultiSeriesStackedColumn2DLineDualYAxis
.
4.
Edit the Configuration section, and enter a field name; for example,
Year.
5.
Click
Add Data Series
and add two data series; for example:
386
Each series represents a stack within group of stacks.
qSIChartView
6.
Click
Edit
in each data series and enter a filter field name; for example, Name.
qChartView stacks the data according to filter field’s value. If the Filter
Field Name is not set, the chart is not rendered as stack.
You can use the same field name in each series if you enter a filter expression.
387
Quick Apps for SharePoint
388
qSIListForm
•
Overview
•
qSIListForm Tabs
•
qSIListForm Procedures
21
Quick Apps for SharePoint
Overview
qSIListForm is a form that displays data from external systems, such as SQL
Server, Web Services, K2, or Salesforce. It allows you to associate a custom toolbar button with one or more actions, and enables you to write complex validation logic.
This web part validates the following properties before setting them:
•
. If this succeeds, it will execute the custom action.
•
Fields that are marked as required. See “Required” on page 398
.
• Displayed Fields Type (if Number is selected as the type). See
qSIListForm allows you to:
• define a mask for the input. Enforcing the format increases the consistency and data correctness.
• create a description for each field. The description can be plain text or
HTML.
• define a new title for the field. This is useful if the title is too long or if you want to display a different title for the field.
• assign a fixed value to a field.
• assign a formatted value to a field based on values in other fields. The only requirement is that the parent fields must precede the field to be assigned.
• fill the value of a field from a value stored in the Session variable. This feature usually works in conjunction with another web part, such as qSISelector or qSIListView.
• auto-fill a certain field based on field in a consumed row.
• implement the IWebPartRow interface to provide a row to another web part, such as qSIListView or qSISelector.
• hide a field. A hidden field is processed during postback, but it will not be displayed.
• create a read -only field.
• store the displayed, new, or updated items into the Session. This feature enables a List Form to communicate with another web part, such as qSISelector in another page.
• display, create, and edit data in your external systems. Out of the box, this Web Part supports the DAO Provider for:
390
qSIListForm
• Web Services
• SQL Server
• Oracle
• Domino Server using XML over HTTP
• Salesforce
• K2Server (for SharePoint 2010 only)
• Define a different title for different languages using the Resource List and the Title Resource ID properties. You can also define different texts for the buttons in the list form toolbar for different languages.
The culture for the page can be defined by appending the
Culture
HTTP parameter to the page URL; for example, http://hostname/sites/sitename/default.aspx?Culture=en-US
If you would like to learn more, click here to watch the training video
.
To better understand SI web parts, read the System Integration Developer Guide.
qSIListForm Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qSIListForm contains the following tabs:
•
•
•
•
•
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
391
Quick Apps for SharePoint
Display Tab
When you open ezEdit from qSIListForm, the Display tab opens by default. The
Default tab contains the following.
ELEMENT
Catalog
Form Layout
Display Fields
Form Component
Behavior
Actions
Custom Action Error
Display
Form Initialization
Actions
DESCRIPTION
.
See “Display Fields” on page 395
.
See “Form Component Behavior” on page 401
.
.
Allows you to set where the error message is displayed if the custom action throws an exception. The options are:
• Inline — the error message is displayed in the list form above the displayed fields.
• Popup — the error message is displayed in a popup dialog box.
• InlineAndPopup — the error message is displayed in a popup dialog box and inline above the displayed fields.
Popup is the default.
This property will only affect the error message that is returned by the
ICustomAction implementation. It will not affect the error that is generated internally by the List Form.
Allows the List Form to be automatically pre-populated when the Form
Type property is set to NewEntity. The List Form will call the defined custom actions that are specified in this property.
You will not be able to use the form initialization action on an auto fill field such as fixed value field, consume value from an HTTP parameter field, calculated format field, consume value from a session field, or consume row from a row provided by another web part field.
See “Custom Layout Help” on page 457 on how to write a custom action
to initialize the list form.
This property is an XML string in this format:
<FormInitialization>
<Action Name=”initial 1” Type="Custom"
Class="MyCompany.DevStudio.SampleFormInitializationAction,
MyCompany.DevStudio, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=451cac61f7ec4225" / >
<Action Name=”initial 2” Type="Custom"
Class="MyCompany.DevStudio.SampleFormInitializationAction2,
MyCompany.DevStudio, Version=1.0.0.0, Culture=neutral,
PublicKeyToken=451cac61f7ec4225" / >
</FormInitialization>
Form initialization is a way to auto fill the form. It should not be used in conjunction with another auto fill method. If you do this, the result is unpredictable (that is, sometimes the value from form initialization will take precedence, but sometimes the value from the other auto fill method will take precedence).
392
qSIListForm
Form Type
Display Required Fields
Message
Display Message from
DAO Provider
Custom Message
Display
Allows you to choose one of the following:
• DisplayEntity — The form is used to display an entity (all fields are read-only).
• NewEntity — The form is used to create a new entity in the target system.
• EditEntity — The form is used to edit an entity.
Allows you to set required fields message at the top of the list form. If set to false, the message is hidden. By default, this property is set to true. The required fields message is only displayed when the list form is in new or edit mode regardless of the value of this property.
Allows you to display messages, such as informational messages or warnings at the top of a web part. For more information on DAO providers, see the System Integration Developer Guide.
See “Custom Message Display” on page 332
.
Form Layout
This property enables you to define the layout of the fields in the List Form. If this property is not defined, the List Form will display the fields in two column format: the first column is the field title and the second column is the control for the field.
This property is related to the Display Fields property. The Form Layout property defines the layout type and the containers. In order to place a certain field in a specific container, you will use the Tab/Container ID attribute of the Field element in the Display Fields property.
This property is an XML string in the following format:
<FormLayout Type="TabLayout">
<Container Type="containerType" ID="containerID1"
Label="tabText1" ShowUserGroups="group1,group2"
HideUserGroups="group3,group4">
<Container Type="containerType" ID="containerID2"
Label="tabText2" ShowUserGroups="group3,group4"
HideUserGroups="group1,group2">
</FormLayout>
The Form Layout element can contain zero or more Container elements. You may not have to define any container for a certain type of layout manager. Some custom layout manager may have a fixed set of containers that do not need to be defined.
393
Quick Apps for SharePoint
The Form Layout section contains the following:
FORM
LAYOUT TYPE
Tab Layout
Custom Layout
MultiColumn
Layout
DESCRIPTION
Groups the fields in multiple tabs. You can add tabs to this layout by setting values for the following:
• ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the
ContainerID attribute of the Field element in the Display Fields Property.
• Label — the label for the container. Otherwise, if the container needs a label, it will use the ID.
• ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas.
• HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the
HideUserGroups and ShowUserGroups.
Uses the custom layout manager class specified in the
LayoutManagerClassName attribute to layout the fields. Using the custom layout, you can write your own custom Layout Manager where you can layout the fields in any way you want it or even create your own custom controls in the form. For more detail on how to write your own custom Layout Manager class, see “Custom Layout Help” on page 493 .
You can add containers to this layout by setting values for the following:
• ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the
ContainerID attribute of the Field element in the Display Fields Property.
• Type — they type of container.
• Label — the label for the container. Otherwise, if the container needs a label, it will use the ID.
• ShowUserGroups — the container is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas.
• HideUserGroups — the container is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple SharePoint group names here by separating them with commas. The HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the
HideUserGroups and ShowUserGroups.
Displays the data in multiple columns. You can select the number of columns, and select if you want to render and control in a single row (displays the
Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.)
394
qSIListForm
FORM
LAYOUT TYPE
Tab and
MultiColumn
Layout
DESCRIPTION
Groups the fields in multiple tabs and in multiple columns in each tab.
You can add tabs to this layout by setting values for the following:
• ID — the identifier for the tab. This ID must be unique for each container that is defined in the Form Layout. This identifier is referred to in the
ContainerID attribute of the Field element in the Display Fields Property.
• Label — the label for the tab. Otherwise, if the container needs a label, it will use the ID.
• ShowUserGroups — the tab is shown if the current user is a member of at least one of the specified SharePoint groups. You can define multiple
SharePoint group names here by separating them with commas.
• HideUserGroups — the tab is hidden if the current user is a member of at least one of the specified SharePoint groups. You can define multiple
SharePoint group names here by separating them with commas. The
HideUserGroups attribute will take precedence if the current user is a member of one of the groups specified in the HideUserGroups and
ShowUserGroups.
• Render and Control in a single row — the tab displays the Label/Input control on the same row. If not selected, the Label/Input control is on separate row. Being on the separate row gives more screen real estate to render multiple columns. If this is selected, column span and row span attributes are applied to grouped field.
Display Fields
This property defines what fields should be displayed in the List Form and how the fields are populated.
You must configure Display Fields before configuring Form Component Behavior.
Data Index/Data Member
This section is optional.
The Data Index allows you to define the index of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables. If the data table does not have any meaningful name, use the Data Index propert
Y.
395
Quick Apps for SharePoint
The Data Member allows you to define the name of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables and those tables do not have any meaningful name. If the data table has meaningful name, you can refer to it by using the Data Member property.
If neither the Data Member or the Data Index is specified, the first data table in the data set is used.
Fields
You can add fields by selecting them from a list automatically displayed or by manually adding them.
Loading Fields
If the default operation of the external system (selected in the Catalog section) contains data, click
Load Fields
to display a list of fields. Select the fields you want to display in the web part.
Loading Fields is supported in the qSIListForm Web Part only.
Adding Fields
If the default operation does not contain data, select
Add Fields
.
You can add fields and enter values for the following:
VALUES
Field Name
Title
Description
DESCRIPTION
Displays the field name.
Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
Allows you to set the field description. It can be a plain string or an encoded
HTML string. The Description is added below the field value.
396
qSIListForm
Field Properties
Click
Edit
next to a field name to further define its properties by configuring the following:
PROPERTIES
Field Name
Title
Title Resource ID
Tooltip
Tooltip Resource
ID
Description
Description
Resource ID
Width (in pixels)
Column Span
Row Span
DESCRIPTION
Displays the field name.
Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. You can change the displayed title, for example, when the title is too long or to make the title more descriptive.
If supporting a multi-lingual site, you may want to display a different Title for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The TitleResourceID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default Title is used.
Allows you to set the text that is displayed in the tooltip when you hover your mouse over the control for the field in the list form. If you do not specify this attribute, the display name of the field is used as the tooltip text.
If supporting a multi-lingual site, you may want to display a different tooltip for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The Tooltip
Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default tooltip is used.
Allows you to set the field description. It can be a plain string or an encoded
HTML string. The Description is added below the field value.
If supporting a multi-lingual site, you may want to display a different description for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field.
The Description Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier is not found, the default description is used.
Allows you to set the width of the control in pixels.
Note:
Some controls, such as the Rich Text Editor, have minimum width and it will not honor the specified width if it is smaller than its minimum width.
Allows you to set the span of the column.
Allows you to set the span of the row.
397
Quick Apps for SharePoint
PROPERTIES
Type
Required
Hidden
Auto Post Back
Group Name
Mask
DESCRIPTION
Allows you to define the type of field. The following types are supported:
• SingleLineofText
• MultipleLinesofText
• RichText - disables resizing text
• Choice - allows you to define the options for the Choice field or retrieves the options for the names of the data table in a dataset.
• Number - when selected, allows you enter a minimum and maximum value, and select the number of decimal places and if you want these numbers as a percentage
• Currency
• DateTime - allows you to enter DateOnly or DateTime
• Boolean
Select this check box if this field is required.
Allows you to hide the field.If the field is hidden, the List Form will not modify that field at all. If you hide the field using the Hidden attribute, the field is processed according to the way it is defined, but it will not be shown in the
List Form.
If selected, allows the control to refresh the form when its value changes.
This attribute should be set to true in the following scenarios:
• When a choice field is used in the conditions of the Form Component
Behavior property.
• When a choice field is passed as a parameter to another operation that is used to populate another choice field.
Allows you to create dynamic behavior for a group of fields. The list form can be defined to have dynamic behavior where certain fields or group of fields can be hidden, shown, disabled, or enabled based on certain conditions. The value in the Group Name field is referred to in the Form Component Behavior property.
Allows you to define the format of the input. The mask can contain characters and input-mask-flags such as:
# — digit or space, optional. If this position is blank in the mask, it is rendered as a prompt character.
L — uppercase letter, optional. Restricts input to the ASCII letters A-Z.
l (lower case L) — lowercase letter, optional. Restricts input to the ASCII letters a-z.
a — accepts any character
<n..m> — restricts the user input to the declared numeric range, for example: <0..255>. The numeric range mask part must occupy multiple characters of the mask.
<option1|option2|option3> — restricts user input to one of the set options, for example: <Sun|Mon|Tue|Wed|Thu|Fri|Sat>.
\ — escapes a mask character, turning it into a literal. "\\" is the escape sequence for a backslash.
All other character — all non mask elements will appear as themselves.
Literals always occupy a static position in the mask at run time, and cannot be moved or deleted by the user.
398
qSIListForm
PROPERTIES
Prompt Character
Field Type
DESCRIPTION
Allows you to define a placeholder to enter a character that is displayed and saved in place of the empty characters when you specify a mask. If not specified, "_" (underscore) is used as the default prompt character. Specify only a single character in this attribute.
Allows you to select a field type. More options are available depending on the
field type selected. For more information, see “Field Types” on page 399 .
Field Types
Select one of the following field types.
FIELD TYPES
Regular Field
Fixed Value
Consume Value for an
HTTP Parameter
DESCRIPTION
Allows you to assign a regular field. This is the default.
You can assign a fixed value to a field using the FixedValue attribute. For example, to assign Accounting to the Department field:
<Field Name="Department" FixedValue="Accounting"/>
Additionally, you can use special variables for the FixedValue attribute.
-<CurrentUserID/> — this value is replaced by the ID of the currently logged in user. If you want to assign the current user to the People and Group field, use this variable. For example, if you'd like to assign a task to the currently logged in user, you can specify the following Field element: <Field
Name="Assigned To" FixedValue="<CurrentUserID/>"
/>
-<CurrentUserName/> — this value is replaced by the name of the currently logged in user.
-<CurrentUserEmail/> — this value is replaced by the email of the currently logged in user.
-<CurrentLoginName/> — this value is replaced by the login name of the currently logged in user. The login name is usually in the form of domain\username.
-<Today/> — this value is replaced by today's date.
-<Now/> — this value is replaced by the current date and time.
You can set the following:
• Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only.
The HTTP Parameter Consumer field gets its value from an HTTP parameter. This is the attribute to create an HTTP Parameter
Consumer field. You can set the following:
• Consume HTTP Parameter Name - allows you to enter the name of the HTTP parameter whose value is to be consumed.
• Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only.
399
Quick Apps for SharePoint
FIELD TYPES
Calculated Format
Consume value from a row provided by another Web
Part
Consume from another session
DESCRIPTION
You can format a value of a field using values from other fields by using the CalculatedFormat attribute. The value of the another field can be referred to using the <%fieldName%> field replacement expression. You must use the encoded form of the < and > characters, which are < and >, respectively unless you type in the value in the Display Fields editor in the List Form Editor, where the Editor will encode the characters automatically for you.
The row consumer field gets its value from the row that is consumed by this List Form. To create a row consumer field, you must connect the List Form with another web part that implements the IRowProvider interface (such as the qSISelector).
You can set the following:
• Consume Row Display Field Name - allows you to define the field name in the row from where the value comes.
• Consume Row Display Format - allows you to define the string format for the values. This attribute takes precedence over the
Consume Row Display Field Name attribute. The format of the
Consume Row Display Format is the same as the format used in the Calculated Format attribute. If you select NewEntity type as Form type, leave this field blank unless it is in simple text format.
• Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only
Session consumer field gets its value from a row that is stored in the session object.
If you require values from multiple providers, use the Session
Consumer field type instead of Row Consumer field type because the List Form can only be connected to one row provider.
You can set the following:
• Session Name - enter the name of the session
• Consume Session Display Field Name - allows you to defines the field name in the session from where the value comes.
• Consume Session Display Format - allows you to define the string format for the values. This attribute takes precedence over the Consume Session Display Field Name attribute. The format of the Consume Session Display Format is the same as the format used in the Calculated Format attribute.
• Allow Edit - select this check box to edit the field value in the form; otherwise, it is read-only
400
qSIListForm
Form Component Behavior
This section is used to control the conditional behavior of the different components in the form, such as a field, a group of fields or a tab. There are four different conditional behaviors that can be specified: Show When, Hide When,
Enabled When, and Disabled When. For fields, there are three additional conditional behaviors that can be specified: Valid When, Invalid When, and
Required When.
You must configure Display Fields before configuring Form Component Behavior.
This property is an XML string in this format:
<FormComponentBehavior>
<Component Type="Field/Group/Container"
ID="ComponentID">
<ShowWhen>
[Condition specified in CAML Filter format]
</ShowWhen>
<HideWhen>
[Condition specified in CAML Filter format]
</HideWhen>
<EnabledWhen>
[Condition specified in CAML Filter format]
</EnabledWhen>
<DisabledWhen>
[Condition specified in CAML Filter format]
</DisabledWhen>
<InvalidWhen Message=”Custom Message when condition is true”>
[Condition specified in CAML Filter format]
</InvalidWhen>
<ValidWhen Message=”Custom Message when condition is true”>
[Condition specified in CAML Filter format]
</ValidWhen>
<RequiredWhen Message=”Custom Message when condition is true”>
[Condition specified in CAML Filter format]
</RequiredWhen>
</Component>
<Componet ...>
<Component ...>
</FormComponentBehavior>
401
Quick Apps for SharePoint
Definition
You can define one or more form component definitions.
DEFINITION
Type
ID
DESCRIPTION
Defines the type of the component that is assigned the dynamic behavior.
The choices are: Field, Group, or Container (that is, tab).
Defines the ID or name of the component whose behavior is defined to be dynamic. When the Type is set to Field, this ID refers to the Name of a field that is defined in the Display Fields property. When the Type is set to
Group, this ID refers to the Group Name attribute of one or more fields defined in the Display Fields property. When the Type is set to Container, this ID refers to the ID of a container that is defined in the Form Layout property.
Definition Properties
To see details for a form component, you can configure the following properties:
PROPERTY
Show When
Hide When
Enabled When
Disabled When
Required When
Valid When
DESCRIPTION
Defines the conditions of when the form component should be shown.
Defines the conditions of when the form component should be hidden.
This conditional behavior takes precedence over the Show When conditional behavior. Therefore, if Hide When and Show When are defined and both evaluate to true, the component is hidden.
Defines the conditions of when the form component should be enabled.
Defines the conditions of when the form component should be disabled.
This conditional behavior takes precedence over the Enabled When conditional behavior. Therefore, if Enabled When and Disabled When are defined and both evaluate to true, the component is disabled.
Defines the conditions of when the form component should be required.
This conditional behavior is for fields only. A custom message can be specified. It is displayed when the Required When condition is satisfied.
The message is displayed by default in red after the input control on the form. However, you can specify any text or HTML code as the Message attribute.
Defines the conditions of when the form component should be valid. This conditional behavior is for fields only. A custom message can be specified.
It is displayed when the Valid When condition is satisfied. The message is displayed by default in red after the input control on the form. However you can specify any text or HTML code as the Message attribute.
402
qSIListForm
PROPERTY
Invalid When
DESCRIPTION
Defines the conditions of when the form component should be invalid.
This conditional behavior is for fields only. This conditional behavior takes precedence over the Valid When conditional behavior. Therefore, if Valid
When and Invalid When are defined and both evaluate to true, the field is invalid. A custom message can be specified. It is displayed when the
Invalid When condition is satisfied. The message is displayed by default in red after the input control on the form. However you can specify any text or HTML code as the Message attribute.
For fields of type text, numeric or date/time, regular expression matching can be used for validation. Use the “Matching” operator in the conditional behavior element.
The following are some examples of how to use this property:
1.
Show the Resolved Date and Resolved By fields when the Status field is changed to "Resolved". By specifying both fields’ GroupName attribute in the Display Fields property to “ResolvedFieldsGroup”, it is defined that both fields belong to the same group.
<FormComponentBehavior>
<Component Type="Group" ID="ResolvedFieldsGroup">
<ShowWhen>
<Eq><FieldRef Name="Status"/><Value
Type="Choice">Resolved</Value></Eq>
</ShowWhen>
</Component>
</FormComponentBehavior>
2.
Enable the "Amount Paid" field when the Invoice Status field is changed to "Paid".
<FormComponentBehavior>
<Component Type="Field" ID="Amount Paid">
<EnabledWhen>
<Eq><FieldRef Name="Invoice Status"/><Value
Type="Choice">Paid</Value></Eq>
</EnabledWhen>
</Component>
</FormComponentBehavior>
3.
Hide the Reason field when the Project Status field is not "Behind"
<FormComponentBehavior>
<Component Type="Field" ID="Reason">
<HideWhen>
<Neq><FieldRef Name="Project Status"/><Value
Type="Choice">Behind</Value></Neq>
</HideWhen>
</Component>
</FormComponentBehavior>
403
Quick Apps for SharePoint
4.
Show error message if field, Assigned To, is blank when Status is “In
Process”
<FormComponentBehavior>
<Component Type="Field" ID="Assigned To">
<InvalidWhen Message="Assigned To Must be filled if
Status is In Process">
<And>
<IsNull>
<FieldRef Name="AssignedTo" />
</IsNull>
<Eq>
<FieldRef Name="Status" />
<Value Type="Choice">In
Progress</Value>
</Eq>
</And>
</InvalidWhen>
</Component>
</FormComponentBehavior>
5.
Field % Complete must be between 0 and 100
<FormComponentBehavior>
<Component Type="Field" ID="% Complete">
<ValidWhen Message="% Complete must be between 0 and 100">
<And>
<Geq>
<FieldRef Name="PercentComplete" />
<Value Type="Number">0</Value>
</Geq>
<Leq>
<FieldRef Name="PercentComplete" />
<Value Type="Number">1</Value>
</Leq>
</And>
</ValidWhen>
</Component>
</FormComponentBehavior>
404
qSIListForm
Control Appearance Tab
To configure the rich text editor toolbar to show/hide specific buttons, you need to edit the configuration file of the Telerik rich text editor. This file can be found at:
• for SharePoint 2010: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\EnhancedRichTe xtToolsFile.xml.
• for SharePoint 2013: C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\EnhancedRichTe xtToolsFile.xml.
It is an XML file where you can comment out the tools using XML comment tags
(For example: <!--<tool name="Undo" />--> to hide the undo button).
ELEMENT
Rich Text Editor Skin Name
Drop-Down Skin Name
DESCRIPTION
Allows you to select the skin name for the rich text editor. The rich text editor appears in the form when the Type attribute of the Field element in the Display Fields property is set to RichText. If you have a custom skin, you can add it to the following folder for
SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Note:
Clear your browser cache frequently while working with custom skins. In IE, CSS cache can be cleared by clicking the
Clear
Cache
button in the CSS tab of Developer Tools, located under the
Tools menu of the browser.
Allows you to specify the skin name for the drop-down control for the choice field. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
405
Quick Apps for SharePoint
Toolbar Appearance Tab
The Toolbar Appearance tab contains the following:
ELEMENT
Toolbar Skin Name
Toolbar Location
DESCRIPTION
Allows you to enter the skin name for the toolbar.
Allows you to define where a toolbar for the list form should be displayed. The choices are Top or None. Select None to not display the regular toolbar. Only the Ribbon buttons are displayed in this case.
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
406
qSIListForm
ELEMENT
Indicates Required
Field Text Resource
ID
DESCRIPTION
If supporting a multi-lingual site, you may want to display a required field depending on the current culture. This property defines the identifier in the
Resource List that is used as the required field. The TitleResourceID and the current cultural setting (identified with the Culture HTTP parameter) is used to retrieve the string in the Resource List.
qSIListForm Procedures
You can perform the following procedures using qSIListForm:
•
Configuring qSIListForm
To configure qSIListForm
1.
Add qSIListForm to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
. For more
information on each element, see “qSIListForm Tabs” on page 391 .
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
407
Quick Apps for SharePoint
408
qSIListView
•
Overview
•
qSIListView Tabs
•
qSIListView Procedures
22
Quick Apps for SharePoint
Overview
qSIListView displays data from your external system in a grid, and allows you to:
• customize the look and feel by using Skin.
• divide the data into multiple pages to limit their size and render pages faster. This feature is called Paging. There are two Paging Modes available: Numeric Pager and Next Previous. If the number of rows in a table is more than the specified Page Size, the data is divided into multiple pages and a Pager is displayed at the bottom of the listview to enable the user to navigate to different pages
• retrieve the data from your external system one page at a time using custom paging. In order to use this feature, your external system must provide a method to retrieve one page of data by using the page size and page index parameters. If your external system does not support custom paging, you can still page your date as described in the previous point.
•
(such as AddDays) and time expression (such as [TODAY]) to filter out data based on a moving time window. This feature is called Data
Aging.
• define the initial static sort expression using the Sort Fields property.
The listview can sort the data based on multiple fields.
• sort the data in the listview by clicking the grid headers. Clicking the header repeatedly will change the sort direction for that field from ascending, descending and neutral (no filter). You can sort the data in the listview using multiple fields.
• define multiple levels of grouping on the data using the Grouped attribute in the Display Fields property. You can also display the sum or item counts in the group header.
• show or hide the listview based on the site group membership of the currently logged in user by using the Show User Groups and Hide User
Groups properties.
• display the data in virtually any format that can be achieved with
JavaScript and HTML. With this feature, you can create many types of custom reports on the data. The JavaScript and HTML for a custom display is defined in the Results Header, Results Body and the Results
Footer properties.
• consume a filter from another web part that implement IWebPartRow or IWebPartParameter interface.
410
qSIListView
• consume a row from another web part that implement IWebPartRow interface. The row that the listview consumed can be passed into the operation to retrieve the data as a parameter or can be used in the custom action.
• display, create, and edit data in your external systems. Out of the box, this Web Part supports the DAO Provider for:
• Web Services
• SQL Server
• Oracle
• Domino Server using XML over HTTP
• Salesforce
• K2Server (for SharePoint 2010 only)
To better understand SI web parts, read the System Integration Developer Guide.
If you would like to learn more, click here to watch the training video.
qSIListView Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qSIListView contains the following tabs:
•
•
•
•
•
•
•
•
411
Quick Apps for SharePoint
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
Display Tab
When you open ezEdit from qSIListView, the Display tab opens by default. The
Default tab contains the following.
ELEMENT
Catalog
Display Fields
Searched Fields
Expand Filter panel on
Load
Turn On List Searcher
Mode
DESCRIPTION
.
See “Display Fields” on page 395
.
See “Searched Fields” on page 419
.
Allows you to automatically open the Filter panel by default so that the user can perform a search quickly. When set to true, the Filter panel opens when the web part is loaded for the first time.
Allows the user to perform a search before the listview display any data.
412
qSIListView
Filter Criteria Usage
Panel Button Location
Actions
Show Context Menu
Method
Complex Filter
Sort Fields
Allow you to pass the filter criteria to the DAO provider layer. There are three options in this property:
• PassToDAOProvider — The filter criteria is passed to the DAO
Provider. When you select this, the filter criteria will not be used to filter the data that is returned by the external system (because the
SI List View assumes that the data has been filtered by the external system).
• FilterData — The filter criteria is used to filter the data that is returned by the external system.
• PassToDAOProviderAndFilterData — The filter criteria is passed to the DAO Provider and is used to filter the data that is being returned by the external system.
When you select PassToDAOProvider or
PassToDAOProviderAndFilterData, you can use the filter criteria as parameter values in the operations in the Catalog property. In order to do so, you specify the parameter source as Input and the source name as:
• FieldName.Value — allows you to retrieve the value that is entered by the user in the Filter panel for a specific field.
• FieldName.MaxValue — allows you to retrieve the maximum value that is entered by the user in the Filter panel for the field that has
Between operator, such as DateTime field.
• FieldName.Operator - allows you to retrieve the operator that is specified by the user for a specific field.
There is a possibility that your back-end only handles "Equals" operator.
In that case, you can use the FixedOperator="Equals" attribute in the
Searched Fields property so that the user can only use the Equals operator.
Determines the location of the Go, Reset and Close buttons in the Filter panel. This property also determines the location of the Go and Close buttons in the replace panel.
.
Allows you to define how the context menu displays. There are three options in this property:
• RightClick — Opens the context menu by right-clicking the row in the listview. This is the default option.
• ShowContextMenuColumn — Shows the context menu column. The context menu column shows a drop-down arrow image which will open the context menu when clicked.
• RightClickAndShowContextMenuColumn — Opens the context menu either by right-clicking the row or by using the context menu column.
Allows you to use the Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML
Filter is applied.
Note:
The Complex Filter is provided here only for backward compatibility reason. In the past, Complex filter was used to support date functions.
See “Complex Filter Help” on page 475 on more information about
Complex Filter.
Allows you to define the field that is used to sort the value in the drop-down menu. The field name is case sensitive.
413
Quick Apps for SharePoint
Search Session Name
Enable AJAX
Display Message from
DAO Provider
The listview stores the last used filter criteria in a session variable whose name specified in this property. If specified, the next time you revisit the page, the Filter panel is initialized with the last used filter criteria and you can just click the Go button to apply the filter.
Note:
Do not confuse this property with the SetSessioName attribute in the Catalog property. The SetSessionName attribute is used to store the record that is being clicked by the user. The field value from the item that is stored in the session variable can then be consumed by another webpart, such as the qListForm. It is a good practice to keep the value of the two session names different.
Allows you to enable AJAX for the listview. AJAX enables the listview to carry out some operations within the grid without refreshing the whole page. For example, when you sort a column by clicking its column header or change the page by clicking the pager, the listview only refreshes the data in the grid without causing the whole page to post back. However, there are times when AJAX causes some issues. In this case, you must disable the AJAX capability of the listview.
The following are some known situations where you need to disable
AJAX:
• In some versions of Internet Explorer 6, the data grid will fail to carry out the AJAX operation. If your user base reports this issue, you can disable the AJAX to fix it.
• If you use javascript's document.write() method in the Results Body property of the Custom Display, the text that is generated using document.write() will not be rendered after the AJAX operation.
This is true even if you do not call the document.write() directly within the Results Body but rather through another javascript function that calls document.write().
Allows you to display messages, such as informational messages or warnings at the top of a web part. For more information on DAO providers, see the System Integration Developer Guide.
See “Custom Message Display” on page 332
.
Custom Message
Display
Show User Groups
Hide User Groups
Allows you to list SharePoint groups whose members can view the web part. Separate groups with commas.
Allows you to list SharePoint groups whose members cannot view the web part. Separate site group names with commas (for example,
Administrators, Readers).
If a user is a member of a group that is defined in both Show User
Groups and Hide User Groups, the user cannot view the web part.
Display Fields
This property defines what fields should be displayed in the ListView and how the fields are populated.
414
qSIListView
Data Index/Data Member
The Data Index allows you to define the index of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables. If the data table does not have any meaningful name, use the Data Index propert
Y.
The Data Member allows you to define the name of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables and those tables do not have any meaningful name. If the data table has meaningful name, you can refer to it by using the Data Member property.
If neither the Data Member or the Data Index is specified, the first data table in the data set is used.
Fields
You can add the following values for the fields to be displayed.
VALUES
Field Name
Title
Description
DESCRIPTION
Displays the field name.
Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
Allows you to set the field description. It can be a plain string or an encoded
HTML string. The Description is added below the field value.
Field Properties
You can further define properties for the fields to be displayed by configuring the following:
PROPERTY
Field Name
Title
Title Resource ID
DESCRIPTION
Displays the field name.
Allows you to change the displayed title for the field. The value can be a plain string or an encoded HTML string. Change the displayed title, for example, when the title is too long or to make the title more descriptive.
If supporting a multi-lingual site, you may want to display a different Title for the field depending on the current culture. This property defines the identifier in the Resource List that is used as the title of the field. The TitleResourceID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier is not found, the default Title is used.
415
Quick Apps for SharePoint
PROPERTY
Horizontal Align
Vertical Align
Hidden
Width
Item Style
Item CSS Style
Fixed Value
DESCRIPTION
Allows you to set the horizontal alignment.
Allows you to set the vertical alignment.
Allows you to hide the field. If the field is hidden, the qSIListView will not modify that field at all. If you hide the field using the Hidden attribute, the field is processed according to the way it is defined, but it does not display.
Allows you to set the width of the control in pixels.
Note:
Some controls, such as the Rich Text Editor, have minimum width and it will not honor the specified width if it is smaller than its minimum width.
Allows you to define a distinct style for the column. You should define the style as you would define the style in CSS file.
Allows you to define a distinct style for the column and you already have defined the style in an external CSS file.
This attribute takes precedence over the Item Style attribute.
Allows you to enter the text that is displayed as a value for this field. This is useful when you want static text such as Edit displayed in a field. You can then make this text a hyperlink using either the LinkTo or LinkToSource attributes. For example:
<Field Name="EditColumn" FixedValue="Edit"
LinkTo="Lists/ListName/EditForm.aspx?ID=<%ID%>" />
To display an icon instead of a text, you can do the following (it assumes that you have pencil.gif in the images folder in your site:
<Field Name="EditColumn" FixedValue="<img src="images/edit.gif" border=0>"
LinkTo="Lists/ListName/EditForm.aspx?ID=<%ID%>" />
416
qSIListView
PROPERTY
Calculate Value
DESCRIPTION
Recognizes the field replacement expression <%Field%> to refer to a field.
The listview replaces the field replacement expression with the value of the field for each row of data. You must use the encoded form of the < and > characters, which are < and >, respectively, unless you type in the value in the Display Fields editor in the List View Editor, where the Editor will encode the characters automatically for you.
When using this attribute, you must use the Name of a field that does not exist in the list. It is because the listview constructs this field dynamically instead of using an existing field in the list. If you use the name of an existing field, you will get an error that the field already exists.
You can use this attribute for several purposes:
• Display the values from multiple fields in one grid column. For example, to display a full name, you can concatenate the first name and last name as follows:
<Field Name="CalculatedFullName" Title="Full
Name" CalculatedValue="<%First Name%>
<%Last Name%>" />
• Format the display of a certain column in the grid. For example, you can display the Status of your project with different colors depending on its value. In order to do this, you can write a JavaScript function and then call that JavaScript function using this attribute.
<Field Name="CalculatedProjectStatus"
Title="Status"
CalculatedValue="<script>FormatProjectSta tus('<%Status%>');</script>" />
• The above example assumes you have a JavaScript method called
DisplayProjectStatus defined on your page or in a JavaScript file that is included in your page. That JavaScript method looks like:
<script language="javascript"> function FormatProjectStatus(status)
{
var displayedStatus = status;
if (status = 'Behind')
{
displayedStatus = '<font color="red">' + status + '</font>';
}
return displayedStatus;
}
</script>
You can format the value of the field in virtually any way you want. For example, you can replace the text value with different images to give the user a pleasant look in the presentation.
Note:
You can only call one JavaScript function in the CalculatedValue attribute and the JavaScript function must return a string.
417
Quick Apps for SharePoint
PROPERTY
Link To
Link To Source
Open Link In
HTML Encode
Display Format
DESCRIPTION
The listview turns the field into a hyperlinked column to the specified URL.
The URL can be an absolute or relative URL. The LinkTo can use the <%field name%> field replacement expression. Yu must use the encoded form of the
<
and
>
characters, which are < and >, respectively unless you type in the value in the Display Fields editor in the List View Editor, where the Editor will encode the characters automatically for you.
Every field that you refer to in the field replacement expression must be specified in the Display Fields property. If you do not want to show that field to the user, you can use the Hidden attribute to hide the field. If you use a relative URL, the URL is appended to the URL of the current page.
Here is an example on how to make the Title field a hyperlink column to the edit form of the Tasks list:
<Field Name="ProjectName"
LinkTo="ProjectDetail.aspx?ID=<%Projec tID%>&Source=default.aspx" />
The listview will make the field value a hyperlink to the URL specified in the
Source HTTP parameter of the current request. For this option to work, the current page URL must look like: http://.....?Source=....
The LinkToSource is useful when you want to make the URL in the link dynamic. In that case, you can pass in the URL for the link into the HTTP parameter of your page. For example, say that we have a page where the user can select a particular contact from the Contacts list. This page might be useful for several cases in your application and you cannot hard code the URL because you may want the user to be redirected to different URL depending where they are in the application. In that case, you can specify the URL for the hyperlink in the URL of the page.
Allows you to define how the Link To Field opens.
Note:
For Internet Explorer 9, the "NewWindow" option requires the user to set the following: Internet Options | General |Tabs | Settings > When a pop-up is encountered > 'Always open pop-ups in a new window'.
Allows the value in the field to be encoded first prior to being displayed. You need to set this to true if this field contains values that are surrounded by < and >, such as <abc>. Without the encoding, the value will not be displayed properly.
Specifies how the field value is formatted when displayed. For more detail
about the syntax of the DisplayFormat attribute, see “Display Format Help” on page 439 .
The Field element can contain one or more Aggregate elements if its Grouped attribute is set to true. The following are the attributes of the Aggregate element:
• Text — The text that will precede the aggregated value when it is displayed.
• Aggregate Function — These are the choices for the aggregate function:
Sum, Min, Max, Last, First, Count.
• Field Name — The name of the field where the aggregation is performed.
• Format String — This attribute defines how the aggregated value is displayed. See the syntax of the format string in the DisplayFormat attribute.
418
qSIListView
PROPERTY
Grouped
DESCRIPTION
Allows the data to be grouped by this field. You can set the Grouped attribute of multiple fields to true if you want to have a subgroup.
• Group Sort Direction — This attribute determines whether the values in the header of the grouped field must be displayed in ascending or descending order. The options are asc for ascending order or desc for descending order. The default value is asc.
• Group Expanded — If set to true, the group is initially expanded.
Otherwise, it is collapsed. If not specified, the default value is true.
When you select Grouped, you can add aggregate elements.
• Text — allows you set the text that precedes the aggregated value when displayed
• Aggregate Value — allows you to choose an aggregate function
• Field Name — allows you to enter the name of the field where the aggregation will happen
• Format String — defines how the aggregated value is displayed
Searched Fields
This property defines which fields are displayed in the Filter panel. If defined, the calendar view will display Filter button in the toolbar. To disable the search feature in the calendar view, you can leave this property blank. If defined, the calendar view will display Filter or Search menu items under the Actions button in the toolbar. To disable the search feature in the calendar view, you can leave this property blank.
This property is an XML string in the following format:
<Fields>
<Field Name="fieldName" [optional attributes]/>
<!-- To search a cross site lookup field, use one of the following two formats -->
<Field Name="fieldName" DisplayFieldName="fieldName"
SortField="fieldName" [optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName" ListName="listName"/>
</Field>
<Field Name="fieldName" DisplayFormat="fieldName" SortField="fieldName"
[optional attributes]>
<List SiteUrl="siteUrl" SiteName="siteName" ListName="listName"/>
</Field>
</Fields>
You can further edit fields using the following elements:
ELEMENT
Name
Type
Title
DESCRIPTION
Indicates the element you are editing.
Allows you to select a type of field.
Displays title for the field. The value can be a plain string or an encoded HTML string.
419
Quick Apps for SharePoint
ELEMENT
Default Value
Default Operator
Fixed Operator
Column Count
Date Time Format
Enable Multi Choice
DESCRIPTION
Defines the default value for the field.
You can define a text, a number or a date. A date value must be specified in ISO 8601 format: YYYY-MM-DDThh:mm:ssZ, for example: midnight of February 14, 2002 is
2002-02-14T00:00:00Z.
Defines the default operator for the field.
Defines the operator for the field. If specified, the drop-down menu to select the operator for this field is turned off.
Defines the number of columns for the options in a multi-choice field or in a choice-and-lookup field if the Enable Multi Choice attribute is set to True. This is useful in case your choice or lookup fields have too many choices and you want to break the choices into several columns to minimize the vertical scrolling in your form.
Available if you select DateTime as a type.
Available if you select Choice as a type. Allows you to select multiple options for the choice-and-lookup field. Therefore, the user can specify a condition like "A or B". This attribute is ignored by other field types.
To search a cross-site lookup field, you must specify one or more
List elements inside the Field element. The cross-site lookup field is displayed as two drop downs.
420
ELEMENT
Choice Population Type
qSIListView
DESCRIPTION
Allows you to define how you want to define the options in your
Choice field. It is a drop-down list with the following options:
Manually or Using Operation in the Catalog. For more information, see the below paragraphs.
If you select Choice as the field type, you can define the options in your choice field.
You can hardcode the options directly under the Field element.
Select the ChoicePopulationType of ‘Manually’ to do this. Here is an example:
<Field Name="EmployeeStatus" Type="Choice">
<Option Text="Active" Value="1" />
<Option Text="Retired" Value="2" />
</Field>
If the Value attribute is not specified, the Text is used as the value.
You can specify an action that will retrieve the options from your external system. Select the ChoicePopulationType of ‘Using
Operation in the Catalog’ to do this. The syntax is:
<Field Name="fieldName" Type="Choice">
<Lookup Operation="EntityName.OperationName"
DataMember="tableName"
DataTextField="textFieldName" DataValueField="valueFieldName"
/>
</Field>
– OR –
<Field Name="fieldName" Type="Choice">
<Lookup Operation="EntityName.OperationName"
DataIndex="index"
DataTextField="textFieldName" DataValueField="valueFieldName"
/>
</Field>
• The Operation defines the operation that is used to retrieve the options from the external system. The syntax for the operation is EntityName.OperationName. Both the entity and the operation must already be defined in the Catalog property.
• The DataMember defines the data table name that contains the options in case the operation returns multiple tables. If external system returns multiple data tables without name, you can use the DataIndex attribute to refer to the table. The index is a number and it starts with 0 (not 1).
• The DataTextField defines the column in the data table whose value is displayed in the drop-down menu.
• The DataValueField defines the column in the data table that contains the real value that should be saved back to the external system.
421
Quick Apps for SharePoint
Grid Appearance Tab
The Grid Appearance Tab contains the following:
ELEMENT
Skin Name
Selection Column Type
Allows Custom Paging
Paging Mode
Page Size
DESCRIPTION
Allows you to select the skin name for the grid in the listview. If you have a custom skin, you can add it to the following folder for SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32
012\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32
012\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Allows you to set a column type:
• None: Use None if you want to click the row to select it or press Ctrl or Shift and click the row to select multiple rows.
• MultiRowSelector: Use this option if want the listview to display a check box as the first column. To select a row, select the check box for that row. To select multiple rows, select the check box for each row to be selected.
• SingleRowSelector: Use this option if want the listview to display a check box as the first column. To select a row, select the check box for that row.
Defines whether or not your default operation supports custom paging. Custom paging feature enables your operation to retrieve the data from your external system one page at a time. If you set this property to true, your operation should take the PageSize, PageIndex and SortFields parameters.
If your default operation does not support custom paging, you should set this property to false. In the absence of custom paging, the SI List View will automatically page the data for you if the number of rows in your data table is larger than the number in the Page Size property.
If you deal with a large number of data in the external system, we recommend that you use custom paging to improve the response time of the listview.
Allows you to select the type of pager that is displayed at the bottom of the listview if the items must be divided into multiple pages.
Allows you to set the maximum number of rows that is displayed in one page. If the number of rows is larger than the
Page Size, the data is divided into several pages. You can navigate the pages using the Pager displayed at the bottom of the listview.
422
qSIListView
ELEMENT
Header Style
Header CSS Class
Pager Style
Pager CSS Class
Item Style
Item CSS Class
Alternating Item Style
Alternating Item CSS Class
Selected Item Style
Selected Item CSS Class
Main View Appearance Field
Name
DESCRIPTION
Allows you to enter the style for the header. You can define the style as you would in a CSS class.
Example: font-family: verdana; color: black; background-color:
#FFCC99; height: 20px;
Allows you to enter the CSS class name for the grid's header. If this property is specified, it will override the style defined in the
Header Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the pager. You can define the style as you would in a CSS class; for example, font-family: verdana; color: black; background-color: #FFCC99; height:
20px;
Allows you to enter the CSS class name for the pager. If this property is specified, it will override the style defined in the
Pager Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the item in the odd number row (1, 3, 5, and so on). You can define the style as you would in a CSS class; for example, color: red; font-weight: bold
Allows you to enter the CSS class name for the item in the odd-numbered row (1, 3, 5, and so on.). If this property is specified, it will override the style defined in the Item Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the item in the even-numbered row (2, 4, 6, and so on). You can define the style as you would in a CSS class; for example, font-family: verdana; color: yellow; font-weight: bold;
Allows you to enter the CSS class name for the item in the even number row (2, 4, 6, and so on). If this property is specified, it will override the style defined in the Alternating Item Style property. You must define the class specified here in an external CSS file.
Allows you to enter the style for the selected item in the grid.
You can define the style as you would in a CSS class; for example, backgroundcolor: orange !important; color: blue
!important;
You can add "!important" after the color name so that this color will override the selected item style provided by the skin.
Allows you to enter the CSS class name for the selected item in grid. If this property is specified, it will override the style defined in the Selected Item Style property. You must define the class specified here in an external CSS file.
Allows you to define the name of the field whose values will determine the color of the row in the main view. The value of this field is compared against the FieldValue and
FieldValueRange in the Color Appearance property.
423
Quick Apps for SharePoint
ELEMENT
Color Appearance
DESCRIPTION
Allows you to define the color of the rows in the main view, child view, and group header. This property is an XML string with the following format:
<Appearance>
<MainViewAppearance>
<RowAppearance FieldValue="value1"
BackgroundColor="color1" FontColor="color2" />
<RowAppearance FieldValueRange="number - number"
BackgroundColor="color3" FontColor="color4" />
</MainViewAppearance>
<ChildViewAppearance>
<RowAppearance FieldValue="value1"
BackgroundColor="color1" FontColor="color2" />
<RowAppearance FieldValueRange="number - number"
BackgroundColor="color3" FontColor="color4" />
</ChildViewAppearance>
<GroupeHeaderAppearance>
<RowAppearance FieldValue="value1"
BackgroundColor="color1" FontColor="color2" />
<RowAppearance FieldValueRange="number - number"
BackgroundColor="color3" FontColor="color4" />
</GroupHeaderAppearance>
</Appearance>
You must specify those elements in that sequence. For example, if you specify ChildViewAppearance before the
MainViewAppearance you will get an error that the XML is not valid.
To add color for the group header, you must enable grouping for displayed fields before specifying field value, background color and font color.
Select the Edit button, then click Add Row Appearance to enter values in the following:
• Field Value — value for the field
• Field Value Range — a range of values for the field
• Background Color — the background color of the row for the specified value in the Field Value attribute. The color can be specified as a well-known color such as white, black, cyan, lightGray, as a RGB value such as 255,
255,255, or you can specify it as #FFFFFF, #CCDDEE.
• Font Color - the font color of the row for the specified value in the Field Value attribute. The color can be specified as a well-known color such as white, black, cyan, light gray, as a RGB value such as 255, 255,255, or you can specify it as #FFFFFF, #CCDDEE. The Font Color attribute is ignored if you specify a URL in the LinkTo attribute or set the LinkToSource or LinkToTargetURL attributes to true.
424
qSIListView
Toolbar Appearance Tab
The Toolbar Appearance Tab contains the following:
ELEMENT
Toolbar Skin Name
Show Export Button
Show Print Button
DESCRIPTION
Allows you to enter the skin name for the toolbar.
Allows you to show the Export button under the Actions button in the listview's toolbar. When the user clicks the
Export button, the export settings panel is shown. The user can select the following:
• Export type: PDF, Excel, Word or CSV
• Ignore Paging: if this is checked, the listview will export the entire data instead of just the data in the current page
• Paper Size: if the user selects PDF for the export type, the user can select the paper size
Note:
There are some known issues when exporting the data:
• When exporting the data to PDF and the Color
Appearance property is set, some of the data may not be visible because the background appears black.
• When exporting to Word and Excel and there are some fields that are grouped, the + and - icon to expand/collapse the group header is not exported.
Allows you to show the Print button in the toolbar.
Custom Display Tab
The custom display properties lets the page designer customize the display of the data using HTML and JavaScript. The custom display appears after the default display (if the Display Fields property is defined).
Three properties define the custom display. The example in each property illustrates how to display the FullName field of the search results in an HTML table.
ELEMENT
Results Header
DESCRIPTION
Allows you to set the value of this property that is rendered once before the Results Body. This property is a good place to include any JavaScript file, defining any JavaScript function, or define any
HTML elements for the header.
Example: These are the customers that match your search criteria.<br><table><tr><th>Full Name</th></tr>
425
Quick Apps for SharePoint
Results Body
Results Footer
Allows you to set the value of this property that is repeated once for every row in the search results. You can use the <%field name%> field replacement expression to refer to the value of a certain field.
Example: <tr><td><%FullName%></td>
Allows you to set the value of this property that is rendered once after the Results Body.
Example: </table>
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
Action Button Text
Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string. You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list.
The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting
(identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default is used.
By default, the text for the Action toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Action toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
426
ELEMENT
Filter Button Text
Resource ID
Export Button Text
Resource ID
Print Button Text
Resource ID
qSIListView
DESCRIPTION
By default, the text for the Filter toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Filter toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Export toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Export toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
By default, the text for the Print toolbar button is retrieved from the resource file that is included in the product. However, we may not have the resource file in the culture that you want to use. In this case, you can simply define the text for the Print toolbar button in the Resource List and specify its Resource ID here. This Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource List. If the string with the given identifier and culture is not found, the default text from the invariant resource file is used.
427
Quick Apps for SharePoint
qSIListView Procedures
You can perform the following procedures using qSIListView:
•
Configuring qSIListView
To configure qSIListView
1.
Add qSIListView to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
. For more
information on each element, see “qSIListView Tabs” on page 411
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
428
qSISelector
•
Overview
•
qSISelector Tabs
•
qSISelector Procedures
23
Quick Apps for SharePoint
Overview
qSISelector displays data from a SharePoint list in a drop-down control. This web part remembers the last item selected, even after you leave the page.
Using qSISelector, you can:
• manage multiple projects in one workspace. You can place a selector that displays the project information on every page in your application and use that selector to filter the data in the qListView or any other view on the page. Because the selector remembers the last item selected even as you move from page to page, you only see the data for the same project until you switch to another project.
• place a selector above a qListForm to select a certain item and then feed that item to the list form because the qSISelector is a row provider.
• display, create, and edit data in your external systems. Out of the box, this Web Part supports the DAO Provider for:
• Web Services
• SQL Server
• Oracle
• Domino Server using XML over HTTP
• Salesforce
• K2Server (for SharePoint 2010 only)
If you would like to learn more, click here to watch the training video
.
To better understand SI web parts, read the System Integration Developer Guide.
qSISelector supports multiple languages. You can define a different Title for different languages using the Resource List and the Title Resource ID properties.
The culture for the page can be defined by appending the Culture HTTP parameter to the page URL. For example: http://hostname/sites/sitename/default.aspx?Culture=en-US qSISelector implements the following web part connection interfaces:
430
qSISelector
• IWebPartRow interface, which provides a row to another web part, such as qSIListView.
The IWebPartRow implementation is labeled with Send Row To in the web part
Connection menu. This interface cannot be connected with the obsolete IRowConsumer or IFilterConsumer implementation. Do not connect this new interface with the old interface that is marked obsolete.
• IWebPartRow interface, which enables the selector to consume a row from another web part that implements IWebPartRow interface. The value from the consumed row can be used in the operator for a certain operation in the Actions property.
The IWebPartRow consumer implementation is labeled with Get Row From in the web part Connection menu. This interface cannot be connected with the obsolete
IFilterProvider or IRowProvider implementation. Do not connect this new interface with the old interface that is marked obsolete.
qSISelector Tabs
You can configure this web part through its tabs that are accessible through ezEdit. qSISelector contains the following tabs:
•
•
•
•
•
Persistent Selector Appearance Tab
•
•
Information for the Appearance Tab, Layout Tab, Advanced Tab, and Ribbon Appearance
Tab can be found in
431
Quick Apps for SharePoint
Display Tab
When you open ezEdit in qSISelector, the Display tab opens by default. The
Default tab contains the following:
ELEMENT
Catalog
Data Member
Data Index
Primary Key Field
Name
Display Field Name
Display Format
Display Fields
Eliminate Duplicate
Values
DESCRIPTION
.
Allows you to define the index of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables and those tables do not have any meaningful name. If the data table has meaningful name, you can refer to it by using the Data Member property.
If neither the Data Member or the Data Index property is specified, the first data table in the data set is used.
Allows you to define the name of the data table that contains the data to be displayed. This is useful when the operation that retrieves the data from external system returns multiple data tables. If the data table does not have any meaningful name, use the Data Index property.
Allows you to define the field name in the returned data table that is used as the primary key. The primary key field must have a unique value for every row in the data table. The qSISelector will use the value in the primary key field to differentiate one row in the data table from another.
Allows to enter the name of the field that you want to display in the selector.If you want to display information from multiple fields, use the
Display Format properties. The Display Field Name property is ignored if the Display Format property is defined.
Allows you to define the format of the items that are displayed in the selector. You can use field replacement expression (<%field name %>) to refer to a field name.
Allows you to define the fields that are displayed in the drop-down menu of the web part.If defined, the choices in the drop-down menu are displayed in a grid.
This property is an XML string in this format:
<Fields>
<Field Name="fieldName" Width="width" />
<Field Name="fieldName" Width="width" />
</Fields>
You can configure the following:
• Name — The name of the field. The field name is case sensitive.
• Title - The title of the field.
• Width — The display width of the field. The value can be in pixel (for example: 200px) or percent (for example: 30%).
Allows you to define whether or not you want to eliminate duplicate values in the drop-down menu. This is useful in case you want to use the selector as a filter to another Web Part.
432
qSISelector
ELEMENT
Refresh Page When
Selection Changed
Complex Filter
Sort Field
Sort In Ascending
Order
Show Empty Selection
Empty Selection Item
Name
Empty Drop-Down
Item Name
Display Message from
DAO Provider
Custom Message
Display
DESCRIPTION
Allows you to determine whether the page should be refreshed when the user selects another item in the selector. By default, the value is false, which means that the page is only posted back. There are several scenarios that would require you to set this property to true. For instance, when you connect this selector with a qSIListForm and the qSIListForm is in edit mode. This means that you are editing the item that is currently selected in the selector. In Edit mode, the qSIListForm only retrieves the data when the page is loaded the first time. When you select another item in the selector, the data in the qSIListForm will not be updated. To overcome this issue, you can set the Refresh Page When
Selection Changed property to true. Therefore, every time the selection is changed, the page is refreshed and the qSIListForm will reload the new data.
Allows you enter Complex Filter expression to define a static filter for the data. The complex filter is applied to the data after the CAML Filter is
applied. For more information, see “Complex Filter Help” on page 475 .
Allows you to enter a value that is used to sort the entries in the qSISelector. This property accepts a single field name.
Allows you to sort the entries in the ascending order. Deselect this check box if you want the entries in descending order. This field is ignored if the Sort Field property is not defined.
Allows you to display the value of Empty Selection Item Name property as the first item.
You should check this property if you want the user to be able to select nothing. Selecting nothing returns the entire unfiltered list. Another case is when the qSISelector acts as a filter to another web part and you want the ability to pass an empty filter. This means the other web part will display all its data unfiltered.
Allows you to display a specified value as the first item in the Selector when the Show Empty Selection is checked. The default is - Select One
-.
Allows you to display specified text in the drop-down when it contains no list items. The default is <Empty>.
Allows you to display messages, such as informational messages or warnings at the top of a web part.
See “Custom Message Display” on page 332
433
Quick Apps for SharePoint
Persistent Selector Appearance Tab
The Persistent Selector Appearance Tab contains the following:
ELEMENT
Skin Name
Persistent Selector Width
Drop-Down Width
Drop-Down Height
DESCRIPTION
Allows you to select the skin name for the grid in the listview. If you have a custom skin, you can add it to the following folder for
SharePoint 2010:C:\Program Files\Common Files\Microsoft
Shared\Web Server
Extensions\14\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins or for SharePoint 2013: C:\Program Files\Common
Files\Microsoft Shared\Web Server
Extensions\15\TEMPLATE\LAYOUTS\QuestSoftware\Telerik\Q32012
\Skins.
When creating a custom skin, you can refer to the Sample Skin folder in the install directory.
Allows you to specify the width of the input part for the selector.
Allows you to specify the width of the drop-down menu for the selector in pixels. If you specify the width for each field in the
Display Fields property in pixels, the value of this property is usually the total width of all fields.
Allows you to specify the height of the drop-down menu for the selector.
434
qSISelector
Localization Tab
The Localization Tab contains the following:
ELEMENT
Resource List
Title Resource ID
DESCRIPTION
Allows you to support a multi-lingual site. In a multi-lingual site, there are some settings, such as the web part, whose value can change depending on the current culture setting. The Resource List property defines the list that contains the string values for different cultures. The resource list must contain 3 columns:
• Resource ID — This field contains the identifier to refer to the string.
You can have multiple strings with the same Resource ID as long as their Culture value is different.
• Culture — This field contains the culture for the string. For the default culture, leave the Culture field blank.
• Value — This field contains the value for the string.
The Resource List property is an XML string in this format:
<Lists>
<List SiteUrl="siteUrl" ListName="listName" />
</Lists>
The Lists element can contain only one List element. The following are the attributes for the List element:
• SiteUrl — The URL to the site that contains the resource list. The URL can be absolute (http://...) or relative to the current page URL. This attribute is mandatory.
• ListName — The name of the resource List. The list name is case sensitive.
Allows you to support a multi-lingual site. The property defines the identifier of the string in the Resource List that is used as the text of the web part. The Resource ID and the current cultural setting (identified with the Culture HTTP parameter) are used to retrieve the string in the Resource
List. If the string with the given identifier and culture is not found, the default is used.
435
Quick Apps for SharePoint
qSISelector Procedures
You can perform the following procedures using qSISelector:
•
Configuring qSISelector
To configure qSISelector
1.
Add qSISelector to your page.
2.
Open
ezEdit
.
The Display tab opens by default.
3.
Configure each element as needed and click
OK
.
4.
If needed, configure the elements in the other tabs.
5.
When done configuring each tab, click
OK
.
436
Ribbon Group Help
•
Ribbon Groups
A
Quick Apps for SharePoint
Ribbon Groups
The Ribbon group is delivered for each web part that supports the SharePoint and SharePoint Foundation Server Ribbon UI.
The contextual group contains the “Commands” contextual tab for the web part on the page, which in turn, contains different Ribbon groups. When you select a web part, you can access such functions as ezEdit and Help.
To hide the Ribbon, enable the corresponding property in the Configuration Editor.
When multiple web parts are added to the page, different Ribbon tabs are added in the order of the web part appearance on the page. Each tab’s name defaults to the Title property of the web part.
The display name of the tab can be changed using the web part property, Ribbon
Appearance. This property allows you to customize the display name for the tab.
If this property is filled out, it overrides the web part's Title property. If both of these properties are empty, the default name, “Commands”, is used.
The web part’s ribbon may consists of one or more of the following groups:
GROUP
Manage Group
Actions Group
Custom Actions
Group
Setting & Help Group
DESCRIPTION
Contains the buttons: “Save and Close”, “Edit Item”, “Edit Series”, and
“Cancel” depending on the context. For example, if you are working with a form of type EditListItem, the group will contain the “Save and Close” button. If the form type is DisplayListItem or DisplayDocument, and you are working with a Calendar list, the button is “Edit Series”. The text for
Save and Cancel buttons can be changed by using the Toolbar
Appearance tab.
Contains a set of action buttons seen in the regular toolbar, The Ribbon organizes the actions into different groups. In general, any button shown in the toolbar and not in the “Manage” or “Custom Actions” groups is found in the “Actions” group. This includes “Alert Me”, “Manage
Permissions”, or “Manage Copies”.
Contains a set of custom actions defined in the Custom Actions properties.
Contains buttons from the web part context menu: “ezEdit”, “Help” and
“About”.
438
Display Format Help
•
Display Format
B
Quick Apps for SharePoint
Display Format
This attribute specifies how the field value is formatted when displayed.
The syntax for the Display Format string is as follow:
{0:FormatString}
. The following are the value of the Display Format attribute grouped by the type of the value to be formatted.
For basic number formatting:
FORMAT
{0:c}
{0:d}
{0:e}
{0:n}
TYPE
OUTPUT (IF
INPUT IS
DOUBLE VALUE
2.34)
Currency
Decimal (whole number)
Scientific
Number with commas for thousands
Hexadecimal
$2.34
N/A
2.340000e+000
2.34
N/A {0:x}
For custom number formatting:
OUTPUT (IF
INPUT IS
INTEGER VALUE
12400)
$12,400
12400
1.240000e+004
12,400 cf90
SPECIFIER
,
%
0
#
.
NOTE EXAMPLE
Zero placeholder
Digit placeholder
Decimal point
Thousands separator
Percent (Multiplies by
100 and add % sign)
{0:00.00}
{0:##.####}
{0:0.0}
{0:0,0}
{0:0%}
OUTPUT (IF
INPUT IS
12400.25)
12400.250
12400.25
12400.3
12,400
1240025%
For custom number formatting, you can combine different specifiers. For example: {0:0,0%} will output 1,240,025%.
440
For date formatting:
FORMAT
{0:d}
{0:D}
{0:t}
{0:T}
{0:f}
{0:F}
{0:g}
{0:G}
{0:M}
{0:r}
{0:s}
{0:u}
{0:U}
{0:Y}
TYPE
Short date
Long date
Short time
Long time full date and time
Fule date and time (long)
Default date and time
Default date and time (long)
Month and day
RFC1123 date string
Sortable date string
Universal sortable, local time
Universal GMT
Month and year
Display Format Help
OUTPUT (IF INPUT IS
NOVEMBER 14, 2007
10:34:23 PM)
11/14/2007
November 14, 2007
10:34 PM
10:34:23 PM
November 14, 2007 10:34 PM
November 14, 2007 10:34:23
PM
11/14/2007 10:34 PM
11/14/2007 10:34:23 PM
November 14
Wed, 14Nov2007 10:24:23
GMT
2007-14-11T22:34:23
2007-14-11 22:34:23 PM
November 14, 2007 10:34:23
PM
November, 2007
441
SPECIFIER
zzz
:
/ mm
MM
MMM
MMMM ss tt yy yyyy zz gg hh
HH dd ddd ddd f,ff,...
Quick Apps for SharePoint
For custom date formatting:
NOTE EXAMPLE
Day
Day name
Full day name
Second fraction
Era
2 digit hour
2 digit hour in 24 hour format
Minute 00-59
Month 01-12
Month abbreviation
Full month name
Seconds 00-59
AM or PM
Year, 2 digits
Year
Timezone offsets, 2 digits
Full timezone offsets
Separator
Separator
{0:00.0}
{0:##.####}
{0:0.0}
{0:fff}
{0:gg}
{0:hh}
{0:HH}
{0:mm}
{0:MM}
{0:MMM}
{0:MMMM}
{0:ss}
{0:tt}
{0:yy}
{0:yyyy}
{0:zz}
{0:zzz}
{0:hh:mm:ss}
{0:dd/MM/yyyy
34
11
Nov
November
23
PM
07
2007
-05
-05:00
10:34:23
14/11/2007
OUTPUT (IF
INPUT IS
NOVEMBER 14,
2007 10:34:23
PM)
14
Wed
Wednesday
230
A.D.
10
22
442
Custom Action Help
•
Overview
•
Custom Action
C
Quick Apps for SharePoint
Overview
The Custom Action capability enables you to write a custom code that can be
,
or
code, you can:
• write a complex custom validation and abort the action if the data is invalid.
• copy the item to another list or library before the item is saved in a
•
initialize one or more fields in the qListForm when the list form is
initialized. Refer to the Form Initialization Actions property of the
qListForm and qSIListForm on how to call this kind of custom action.
Custom Action
To write your own custom action, ensure:
• A Class Library project is created using Microsoft Visual Studio
• Microsoft SharePoint Server is installed and running properly
• Quick Apps for SharePoint is installed and running properly in your
SharePoint environment
• You have a strong name key file to sign your assembly
Your custom action classes must implement either the WA.Core.ICustomAction interface or the WA.Core.ICustomActionEx
interface
.
ICustomActionEx Interface
The ICustomActionEx interface is located in WA.Core.DLL that is installed in the
Global Assembly Cache (GAC) when you install the Quick Apps for SharePoint.
The following is the signature of the WA.Core.ICustomActionEx interface: public interface ICustomActionEx
{
ActionResult Perform(CustomActionContext context,
CustomActionCancelEventArgs evt);
}
444
Custom Action Help
Parameters
The following table lists the parameters of the Perform method.
PARAMETER
CustomActionContext
CustomActionCancelEv entArgs
DESCRIPTION
Allows you to:
• Access the HTTPContext object using HTTPContext property. The
HTTPContext object allows you to access the Request and
Response objects to do various things.
• Access the collection of items where this action is to be performed.
This collection contains Microsoft.SharePoint.PListItem objects (for qListView and qListForm) or System.Data.DataRow objects (for qSIListView, qSIListForm and qSIChartView). The following statements are true for the second parameters:
-This parameter is never null and it will contain zero or more
SPListItem or DataRow objects.
-When your custom code is called from the qListForm's toolbar button or qListView's context menu item, the collection will contain one SPListItem object, which is the item that is being right-clicked in the listview or displayed in the list form.
-When your custom code is called from the qListView's toolbar button, it may contain zero or more SPListItem objects, which are the items that are selected in the listview.
-When your custom code is called from the qSIListForm's toolbar button or qSIListView's context menu item, the collection will contain one DataRow object, which is the row that is being right-clicked in the listview or displayed in the list form.
-When your custom code is called from the qSIListView's toolbar button, it may contain zero or more DataRow objects, which are the rows that are selected in the listview.
-When your custom code is called from the qSIChartView's toolbar button, it contains all the rows that are being used in the chart view
Is used to tell the web part about the outcome of the action. The
Perform method may return an object of ActionResult class. This
ActionResult is stored by the framework and can be accessed by another action that is executed after this action. If your action does not need to return anything, you can return null.
It allows you to:
• Cancel the operation by setting the Cancel property to true.
• Set a custom error message by setting the Message property.
• Access the web part that invokes this action by using the Source property. You may analyze the property of the web part to do different things in your code.
Any exception thrown within the Perform method is caught by the web part. Afterwards, the web part will set the event's Cancel property to true and set its error message with the exception's Message property.
445
Quick Apps for SharePoint
Example
The following is a simple implementation that demonstrates how to retrieve
SPListItem object(s) from the passed in parameter, process the parameters, and how to notify the web parts about the outcome of the custom action.
Below is an example of a custom action class. This class verifies that if this item has high priority, it must be assigned to somebody. Otherwise, it will cancel the operation.
using System; using System.Web; using System.Collections; using System.Collections.Generic; using System.Text; using System.ComponentModel; using Microsoft.SharePoint; using WA.Core; namespace MyCompany.DevStudio
{
/// <summary>
/// A sample custom action that you can use to validate a Task in the Tasks list.
///
/// In this case, the sample custom action ensures that a high priority task must be assigned to somebody.
/// If not, the sample custom action will cancel the action and generates an error message.
/// </summary> public class SampleCustomActionEx : ICustomActionEx
{
/// <summary>
/// The Perform method is called by the webpart when the action item (such
/// as toolbar button or context menu item) is clicked.
/// </summary>
/// <param name="context">The CustomActionContext object that contains the HTTP Request and HTTP Context.
/// If the custom action is invoked from an SI Web
Part, it will also contain a collection of DataRows
/// where the action is performed. If the custom action is invoked from a non-SI Web Part, it will contain
/// a collection of SPListItem object.</param>
/// <param name="evt">The event argument that can be used to cancel the action and
/// to carry the error message back to the Web
Part.</param>
446
Custom Action Help
/// <returns></returns> public ActionResult Perform(CustomActionContext context, CustomActionCancelEventArgs evt)
{
ActionResult actionResult = new
ActionResult(); if (context.Items == null || context.Items.Count == 0)
{ evt.Cancel = true;
// you may construct a simple message for popup message or html text if message is shown as inline evt.Message = "There is no item to validate."; return actionResult;
}
// This sample custom action is meant to be used by a qListView or qListForm
// that points to a Task list. Therefore, the items contains SPListItem objects.
SPListItem item = null;
IEnumerator enumerator = context.Items.GetEnumerator(); while (enumerator.MoveNext())
{ item = enumerator.Current as SPListItem; if (item != null)
{
{ if (item["Priority"] != null) string priority = item["Priority"].ToString(); if ("(1) High".Equals(priority))
{ if (item["Assigned To"] == null || string.IsNullOrEmpty(item["As signed To"].ToString()))
{ evt.Cancel = true; evt.Message = "A high priority task must be assigned to a user";
}
}
}
}
}
/* The following code shows you how you can store the result from this action to be used by another action
* in the chain of actions of the ActionItem.
The lines are commented out because they are not really used
447
Quick Apps for SharePoint
* in this action. It is for illustration purpose only.
*
* You have two ways to store the data. First, you can store the data as RawData in the actionResult. Here is an example: actionResult.RawData = someData;
* You can also store the data as key-value pairs in the OutParameters of the actionResult. Here is an example:
* actionResult.OutParameters["Name"] = someData;
*/
/* The following code shows you how you can use the result from another action. The lines are
* commented out because they are not really used in this action. It is for illustration purpose only.
*
* You can access the RawData that comes from another action the following name.
* ActionName - this is the name of the action that stores the result.
* RawData - use this specifier to get the RawData
* object rawData = context.GetActionResult("ActionName.RawData");
* You can also access the key-value pairs in the OutParameters by using the following specifier:
* ActionName - this is the name of the action that stores the result.
* OutParameter - use this specifier to get to the OutParameters key-value pairs
* Name - the key for the value in the
OutParameters key-value pairs object val = context.GetActionResult("ActionName.OutParameter.Name");
*/ return actionResult;
}
}
}
Here is another example of a custom action class. This custom action class can be used to initialize a qListForm.
using System; using System.Web; using System.Collections; using System.Collections.Generic;
448
Custom Action Help
using System.Text; using System.ComponentModel; using Microsoft.SharePoint; using Microsoft.SharePoint.WebControls; using Microsoft.SharePoint.Utilities; using Microsoft.SharePoint.Administration; using Microsoft.SharePoint.WebPartPages; using System.IO; using System.Net.Mail; using System.Security.Principal; using System.Runtime.InteropServices; using System.Threading; using WA.Core; namespace MyCompany.DevStudio
{
/// <summary>
/// A sample custom action that you can use to validate a Task in the Tasks list.
///
/// In this case, the sample custom action ensures that a high priority task must be assigned to somebody.
/// If not, the sample custom action will cancel the action and generates an error message.
/// </summary> public class InitializeFormAction : ICustomActionEx
{
/// <summary>
/// The Perform method is called by the webpart when the fields in the list form are initialized.
/// </summary>
/// <param name="context">The CustomActionContext object that contains the HTTP Request and HTTP Context.
/// If the custom action is invoked from an qSIListForm, it will also contain a collection of Hashtable
/// where the action is performed. If the custom action is invoked from a qListForm, it will contain
/// a collection of SPListItem object.</param>
/// <param name="evt">The event argument that can be used to cancel the action and
/// to carry the error message back to the Web
Part.</param>
/// <returns></returns> public ActionResult Perform(CustomActionContext context, CustomActionCancelEventArgs evt)
{
ActionResult actionResult = new
ActionResult(); if (context.Items == null || context.Items.Count == 0)
449
Quick Apps for SharePoint
{
} return actionResult;
// This sample custom action is meant to be used by a qListForm
// that points to a Task list. Therefore, the items contains SPListItem objects.
SPListItem item = null;
IEnumerator enumerator = context.Items.GetEnumerator(); while (enumerator.MoveNext())
{ item = enumerator.Current as SPListItem; if (item != null)
{
// Initialize the title with a value item["Title"] = "New Task";
}
} return actionResult;
}
}
}
Microsoft Visual Studio.Net 2010/2012 project must contain references to the following two
DLLs:
• C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Microsoft.SharePoint\v4.0_15.0.0.0__
71e9bce111e9429c\Microsoft.SharePoint.dll
• C:\Windows\Microsoft.NET\assembly\GAC_MSIL\WA.Core\v4.0_4.0.0.0__2b4b09f1c57c
8f0b\WA.Core.dll
ICustomAction Interface (Deprecated)
This interface is deprecated starting from version 5.0. Use the “ICustomActionEx
instead.
The ICustomAction interface is located in WA.Core.DLL that is installed in the
Global Assembly Cache (GAC) when you install Quick Apps for SharePoint.
The following is the signature of the WA.Core.ICustomAction interface: public interface ICustomAction
{ void Perform(HttpContext context,
ICollection listItems,
CustomActionCancelEventArgs evt);
}
450
Custom Action Help
Parameters
The following table lists the parameters of the Perform method.
PARAMETER
HttpContext a collection of
Microsoft.SharePoint.PListItem objects (for qListView and qListForm) or a collection of
System.Data.DataRow objects (for qSIListView, qSIListForm and qSIChartView)
CustomActionCancelEventArgs
DESCRIPTION
Allows you to access the Request and Response object
Allows the following:
• This parameter is never null and it will contain zero or more SPListItem or DataRow objects.
• When your custom code is called from the qListForm's toolbar button or qListView's context menu item, the collection will contain one SPListItem object, which is the item that is being right-clicked in the listview or displayed in the list form.
• When your custom code is called from the qListView's toolbar button, it may contain zero or more
SPListItem objects, which are the items that are selected in the listview.
• When your custom code is called from the qSIListForm's toolbar button or qSIListView's context menu item, the collection will contain one DataRow object, which is the row that is being right-clicked in the listview or displayed in the list form.
• When your custom code is called from the qSIListView's toolbar button, it may contain zero or more DataRow objects, which are the rows that are selected in the listview.
• When your custom code is called from the qSIChartView’s toolbar button, it contains all the rows that are being used in the chart view.
Is used to tell the web part about the outcome of the action. This allows you to:
• Cancel the operation
• Set a custom error message
Any exception thrown from the custom action classes is caught by the web part.
Afterwards, the web part will set the event's Cancel property to true and set its error message with the exception’s Message property
.
Example
The following is a simple implementation that demonstrates how to retrieve
SPListItem object(s) from the passed in parameter, process the parameters, and how to notify the web parts about the outcome of the custom action.
451
Quick Apps for SharePoint
Below is an example of a custom action class. This class verifies that if this item has high priority, it must be assigned to somebody. Otherwise, it will cancel the operation.
using System; using System.Web; using System.Collections; using System.Collections.Generic; using System.Text; using System.ComponentModel; using Microsoft.SharePoint; using WA.Core; namespace CustomActionSample
{
public class MyCustomAction : ICustomAction
{
public void Perform(HttpContext context, ICollection
{
if (listItems.Count == 0)
{ evt.Cancel = true;
} evt.Message = "There is no item to validate"; return;
SPListItem item = null;
IEnumerator enumerator = listItems.GetEnumerator(); while (enumerator.MoveNext())
{ item = enumerator.Current as SPListItem; if (item != null)
{
if (item["Priority"] != null)
{ string priority = item["Priority"].ToString(); if ("(1) High".Equals(priority))
{
if (item["Assigned To"] == null || string.IsNullOrEmpty(item["Assigned
To"].ToString()))
{ evt.Cancel = true; evt.Message = "A high priority task must be assigned to a user";
}
}
}
452
Custom Action Help
}
}
}
}
}
Microsoft Visual Studio.Net 2010/2012 project must contain references to the following two
• C:\Windows\Microsoft.NET\assembly\GAC_MSIL\Microsoft.SharePoint\v4.0_15.0.0.0__
71e9bce111e9429c\Microsoft.SharePoint.dll
• C:\Windows\Microsoft.NET\assembly\GAC_MSIL\WA.Core\v4.0_4.0.0.0__2b4b09f1c57c
8f0b\WA.Core.dll
Debugging
In order to debug the code, generate the debug version of the DLL and copy the
DLL and PDB file into the bin folder under the root folder of your SharePoint application. If you cannot find the bin folder, you can create one. Sign your assembly with a strong name key file.
You can set the output folder of your project to the bin folder of your SharePoint application. Therefore, the DLL and PDB files are automatically updated every time you compile your application.
Physical Path
To find the physical path of the root folder of your SharePoint application
1.
Select
Start | Control Panel | Administrative Tools | Internet
Information Services (IIS) Manager
.
2.
Expand the node with your computer name.
3.
Expand the
Web Sites
folder.
4.
Find the node that represents your site. The SharePoint site should contain _layouts, _vti_bin and _wpresources underneath it.
5.
Right-click the node and select
Properties
.
6.
Select
Home Directory
tab.
The value in the Local path tells you the physical path of your root folder.
453
Quick Apps for SharePoint
Trust Level
Once you generate the debug version, you should change the trust level for your web application to Full while debugging the custom action. The trust level is specified in the web.config. Find the trust element in your web.config and change the level to Full.
<trust level="Full" originUrl="" />
Debugging the Code
To debug your code
1.
Open the SharePoint page that contains the listview or list form web parts that contains the custom action.
2.
Open your project's solution using Visual Studio.
3.
Select
Debug | Attach to Process
.
4.
Select w3wp.exe in the process list. If w3wp.exe is not listed, make sure that you check Show processes in all sessions. You may see more than one w3wp.exe listed. If you do, select the one with your user name.
5.
Click
Attach
.
6.
Set some breakpoints in your custom action code.
7.
Invoke your custom action by clicking the custom toolbar button or the custom context menu that you configure in the listview or the list form web part.
454
Custom Action Help
Using the Custom Action Class
When you specify the class name in the action item with type Custom, you must use a fully qualified class name. The Custom Action Editor will automatically show you all the custom action classes that are located in the bin folder of your
SharePoint application.
Figure 1: Custom Action Editor
Deploying Custom Action Class
When it is ready to deploy the solution, build your custom action project in release mode. Sign the assembly with a strong name key file. This ensures the assembly created can be deployed into Global Assembly Cache (GAC).You can deploy your assembly into the GAC by using the gacutil.exe that comes with the
.NET Framework SDK. Here is the command: gacutil /i <DLLName>.
Once the assembly is dropped into the GAC, your class is ready to use.
455
Quick Apps for SharePoint
456
Custom Layout Help
•
Overview
•
Layout Manager
•
Custom Layout Manager Class
D
Quick Apps for SharePoint
Overview
The Custom Layout capability enables you to write your own Layout Manager for the qListForm or qSIListForm.
This document explains the programming interface for writing the custom Layout
Manager and how to deploy your custom Layout Manager into the server.
Layout Manager
A Layout Manager is a part of the list form that determines the layout of the controls on the form. The type of the layout for your form is specified in the Form
Layout property. Out of the box, the list form provides two layout managers:
LAYOUT MANAGER
Default Layout Manger
Tab Layout Manager
DESCRIPTION
Is used if the Form Layout property of the list form is blank. The default layout manager lays out the controls vertically in two columns: the first column is the field title and the second column is the control for the field.
Enables you to group your fields into multiple tabs. You can use the
Tab layout manager by specifying TabLayout in the Type attribute of the FormLayout element in the Form Layout property.
You can create your own Layout Manager:
• When you want to layout the controls in a way that is not provided by the out of the box layout managers. For example, grouping the controls in different sections and having multiple sections in the same row.
• When you want to create a custom control for one or more fields in the form. For example, in Figure 1, the table at the bottom of the form is a custom control created by the custom layout manager. This table contains the list of opening hours for a restaurant for every day during the week.
458
Custom Layout Help
Figure 1: Creating a custom control
You can create your own custom Layout Manager class or use the sample custom
Layout Manager class that is shipped with Quick Apps for SharePoint.
To open the sample code
1.
Select
Start | All Programs | Quest Software | Quick Apps for
SharePoint | Sample Code.
The Sample Code folder opens in Windows Explorer.
2.
Double-click
SampleCode.sln
.
This opens the solution in Microsoft Visual Studio. The sample custom
Layout Manager class can be found in SampleLayoutManager.cs file in the SampleCustomActionsAndCustomLayouts project.
459
Quick Apps for SharePoint
Custom Layout Manager Class
If you want to write your own custom Layout Manager class, ensure the following:
• A Class Library project is created using Microsoft Visual Studio
• Microsoft SharePoint Server is installed and running properly
• Quick Apps for SharePoint is installed and running properly in your
SharePoint environment
• You have a strong name key file to sign your assembly
Programming Interface
Your custom Layout Manager classes must be derived from
WA.Core.LayoutManager.FormLayoutManager class. This class is located in
WA.Core.DLL that is installed in the Global Assembly Cache (GAC) when you install the Quick Apps for SharePoint.
Properties
The following are the properties of the
WA.Core.LayoutManager.FormLayoutManager class:
PROPERTY
FormType
WebPart
FormItem
FormLayout
DESCRIPTION
indicates the type of list form that contains the layout manager class. The type of this property is FormTypeEnum enumeration and the options are New, Edit or
Display. This property is useful when you create custom controls in your layout manager. For example, when the FormType is Display, you may want to make your custom control read only.
references the parent web part, which is either a qListForm or a qSIListForm.
references the item that is being created, edited, or displayed in the form. The type of this property is System.Object. The real type of the FormItem depends on whether the Layout Manager is used in the qListForm or qSIListForm. The qListForm will assign a Microsoft.SharePoint.SPListItem object to the FormItem property. The qSIListForm will assign a System.Collections.Hashtable object to the FormItem property. The Hashtable contains a key value pair of field name and field value. You can use the FormItem to get the values of the fields to populate your custom controls and to save the value from your custom controls back to the form.
indicates an XML string that is entered in the Form Layout property of the qListForm or qSIListForm. You can use this information to find out about the containers that are specified for your layout manager.
460
Custom Layout Help
PROPERTY
ClientSideValid ationErrorHand ler
DESCRIPTION
indicates a read only property to get the name of the Javascript function that is called in the validation error in the client side, such as a required field that is empty, number field outside a specific range. You do this only if you need special handling such as showing the control with the validation error. For example, the
Tab layout manager groups fields in different tabs. The field with the validation error maybe located in the tab that is not currently shown. In that case, the Tab layout manager needs to show the tab that contains the field with the validation error.
Note:
Your layout manager class can override this property.
Methods
The following are the methods of the
WA.Core.LayoutManager.FormLayoutManager class:
461
Quick Apps for SharePoint
METHOD
public abstract void
AddControlToContainer(System.Web.
UI.Control control, string containerID, string fieldDisplayName, string fieldInternalName, Guid fieldID, string fieldDescription, bool isFieldRequired, bool isControlHidden)
DESCRIPTION
Is called by the list form during initialization phase (in the
OnInit method). The list form will create controls for the fields specified in the Display Fields property and then call this method to add the control to the layout manager.
Your layout manager class must override this method. The following are the parameters for this method:
• control – the control to be added
• containerID – the ID of the container where this control should be added. The containerID for the field is specified in the Display Fields property of the list form. If not specified, the containerID is NULL.
• fieldDisplayName – the display name of the field that owns this control. For qListForm, this means the display name for the SharePoint field, which is usually different than the internal name of the field.
• fieldInternalName – the internal name of the field that owns this control. For qListForm, this means the internal name for the SharePoint field, which is usually different than the display name of the field.
For example, the internal name of the “Assigned To” field may be “Assigned _x0020_To”. For qSIListForm, the fieldDisplayName and the fieldInternalName are the same.
• fieldID – the unique identifier for the field. This is a good candidate to use as a unique key to keep track of your fields. For example, when the list form needs to hide the controls for certain fields by using the
HideControl method, it will use the fieldID as parameter.
• fieldDescription – the description for the field. This is the field description that is specified by the user in the Display Fields property of the list form. It’s up to you on how you want to display it in your layout manager. One option is to display the description underneath the control. If not specified, the fieldDescription is NULL.
• isFieldRequired – a boolean flag to indicate whether or not this is required field. You may want to put some visual indicator for required fields such as a ‘*’ in the field title.
• isControlHidden – a boolean field to indicate whether or not the control for the field should be hidden. The user can mark a certain field as a hidden field in the
Display Fields property. If a field is hidden, you still have to add the control into the control hierarchy but you need to hide it in a certain way. For example, you can set the style’s Display attribute to None.
462
Custom Layout Help
METHOD
public abstract void
AddMessageToContainer(string message, string containerID) public abstract void HideControl(Guid fieldID) public abstract void
ShowControl(Guid fieldID) public virtual void
EnableControl(Guid fieldID) public virtual void
DisableControl(Guid fieldID) public virtual void
ShowContainer(Guid fieldID) public virtual void
HideContainer(Guid fieldID) public virtual void
EnableContainer(Guid fieldID) public virtual void
DisableContainer(Guid fieldID)
DESCRIPTION
Is called if the list form needs to display a certain message on the form. For example, if the Email
Notification Section in the qListForm is enabled, the qListForm will call this method to generate this message:
"If you want to send an email notification, please complete the following information.”
The email is sent if you enter one or more email addresses in the To field. You need to display the message in the layout manager when this method is called.
Is called if the list form needs to hide a certain control. For example, when the qListForm is editing a Calendar item, the Start Time and End Time fields needs to be hidden when the user checks the All Day Event and Recurrence fields. You must implement this method for your layout manager to support the Form Component Behavior property of the list form.
Is called if the list form needs to show a certain control.
For example, when the qListForm is editing a Calendar item, the Start Time and End Time fields needs to be shown when the user unchecks either the All Day Event or
Recurrence fields. You must implement this method for your layout manager to support the Form Component
Behavior property of the list form.
Is called if the list form needs to enable a certain control.
You must implement this method for your layout manager to support the Form Component Behavior property of the list form.
Is called if the list form needs to disable a certain control.
You must implement this method for your layout manager to support the Form Component Behavior property of the list form.
Is called if the list form needs to show a certain container in your layout manager. You must implement this method for your layout manager to fully support the Form
Component Behavior property of the list form.
You layout manager class may override this method. The list form will call this method if it needs to hide a certain container in your layout manager. You must implement this method for your layout manager to fully support the
Form Component Behavior property of the list form.
Is called if the list form needs to enable a certain container in your layout manager. You must implement this method for your layout manager to fully support the
Form Component Behavior property of the list form.
Is called if the list form needs to disable a certain container in your layout manager. You must implement this method for your layout manager to fully support the
Form Component Behavior property of the list form.
463
Quick Apps for SharePoint
METHOD
public virtual void
PopulateFormControls() public virtual void
SaveValuesToFormItem()
DESCRIPTION
Overridden if this method creates custom controls for certain fields. You must create the custom controls already in the OnInit method. The list form will call this method during pre-render phase and you can use the
FormItem property to get the values for the fields and populate your custom controls. You do not have to populate the controls that are created by the list form and added by the AddControlToContainer method. Those controls is populated by the list form.
Overridden if this method creates custom controls for certain fields. The list form will call this method after the user clicks the save button in the form. You must write back the value from your custom controls to the
FormItem so that the list form can save the value back to
SharePoint or your external system.
Debugging
In order to debug the code, generate the debug version of the DLL and copy the
DLL and PDB file into the bin folder under the root folder of your SharePoint application. If you cannot find the bin folder, you can create one. Sign your assembly with a strong name key file.
You can set the output folder of your project to the bin folder of your SharePoint application. Therefore, the DLL and PDB files are automatically updated every time you compile your application.
Physical Path
To find the physical path of the root folder of your SharePoint application
1.
Select
Start | Control Panel | Administrative Tools | Internet
Information Services (IIS) Manager
.
2.
Expand the node with your computer name.
3.
Expand the
Web Sites
folder.
4.
Find the node that represents your site. The SharePoint site should contain _layouts, _vti_bin and _wpresources underneath it.
5.
Right-click the node and select
Properties
.
6.
Select
Home Directory
tab.
The value in the Local path tells you the physical path of your root folder.
464
Custom Layout Help
Trust Level
Once you generate the debug version, you should change the trust level for your web application to Full while debugging the custom Layout Manager class. The trust level is specified in the web.config. Find the trust element in your web.config and change the level to Full.
<trust level="Full" originUrl="" />
Using the Custom Layout Manager Class
In order to use your custom Layout Manager class, you should refer to it in the
F orm Layout property of the qListForm or qSIListForm as follows:
<FormLayout Type="CustomLayout" LayoutManagerClassName="Fully qualified class name of the custom Layout Manager" />
When you specify the class name in the LayoutManagerClassName attribute in the
FormLayout element, you must use a fully qualified class name.
For example, in order to use the SampleLayoutManager class that comes in the sample code, specify the following in the Form Layout property:
<FormLayout Type="CustomLayout"
LayoutManagerClassName="MyCompany.DevStudio.SampleLayoutM
anager, MyCompany.DevStudio, Version=1.0.0.0,
Culture=neutral, PublicKeyToken=451cac61f7ec4225" />
Constructing the XML
To use the Form Layout property editor to construct the XML
1.
Make sure that you have compiled your custom layout manager project and put the resulting DLL into the bin folder of your
SharePoint web application.
2.
Create a qSIListForm.
3.
Select
Web Part Menu | Configure
from the SI List Form.
4.
Click
Edit
on the Form Layout property.
5.
Select
CustomLayout
in the
Form Layout Type
drop-down menu.
6.
Select the class name in the drop-down menu under the Layout
Manager Class Name.
7.
Click
OK
.
465
Quick Apps for SharePoint
Debugging the Code
To debug the code in your custom Layout Manager class
1.
Open the SharePoint page that contains the qListForm or qSIListForm that contains the custom Layout Manager.
2.
Open your project's solution using Visual Studio.
3.
Select
Debug | Attach to Process
.
4.
Select
w3wp.exe
in the process list.
If w3wp.exe is not listed, make sure that you check
Show processes in all sessions
. You may see more than one w3wp.exe listed. If you do, select the one with your user name or try it one by one until you find the process that contains the executable for your code.
5.
Click
Attach
.
6.
Set some breakpoints in your custom action code.
7.
Invoke your custom action by clicking the custom toolbar button or the custom context menu that you configure in qListView or qListForm.
Deploying the Custom Layout Manager
Class
When it is ready to deploy the solution, build your custom action project in release mode. Sign the assembly with a strong name key file. This ensures the assembly created can be deployed into Global Assembly Cache (GAC).You can deploy your assembly into the GAC by using the gacutil.exe that comes with the
.NET Framework SDK. Here is the command: gacutil /i <DLLName>.
Once the assembly is dropped into the GAC, your class is ready to use.
466
CAML Filter Help
•
Overview
•
Using CAML Filters
•
Using Dynamic Variables
•
Configuring CAML Filter
E
Quick Apps for SharePoint
Overview
Some web parts use CAML Filter expressions to filter data by providing a way to link multiple conditions in XML format.
These Web Parts are:
• qCalendarView
• qChartView
• qListForm
• qSelector
• qMultiSelector
• qDiscussionView
If the web part supports both CAML Filter and Complex Filter, use the CAML Filter. The
CAML Filter processes data in the SQL Server, so the data is transferred to the Web
Server. The Complex Filter processes data in the Web Server. If you specify both CAML
Filter and Complex Filter, the CAML Filter is processed first.
The Complex Filter remains for backward compatibility reasons.
The operators and field names in the CAML Filter are case sensitive. For the field name, use the internal name of the field.
This is different from the Complex Filter that uses the Display Name.
The Boolean operators <And> and <Or> are supported in CAML Filter. These operators are used to combine two conditions. They must contain exactly two conditions. For example:
<And><Eq>...</Eq><Gt>...</Gt></And>
If you need to link more than two conditions, such as Condition1 And Condition
2 And Condition3, you must nest these operators. For example:
<And><Eq>...</Eq><And><Gt>...</Gt><Lt>...</Lt></And></And>
You can specify conditions for CAML Filter in either of the following ways:
• <IsNull><FieldRef Name="InternalFieldName"/></IsNull>
This returns all entries whose field specified by InternalFieldName does not contain any value.
468
CAML Filter Help
• <IsNotNull><FieldRef Name="InternalFieldName"/></IsNotNull>
This returns all entries whose field specified by InternalFieldName contains values (including empty string value).
• <Operator><FieldRef Name="InternalFieldName"/><Value
Type="TypeName">
ValueToCompare</Value><Operator>
Where:
VALUE
Operator
TypeName
ValueToCompare
IS
One of the following:
• Eq — equals to operator
• Neq — not equals to operator
• Gt — greater than operator
• Geq — greater than or equals to operator
• Lt — less than operator
• Leq — less than or equals to operator
• Contains — a string operator to check whether a string contains the specified value
• BeginsWith — a string operator to check whether a string begins with the specified value
One of the following:
• Text
• Integer
• Float
• DateTime
Note:
When you compare a DateTime value, only the date is being processed. The time part is ignored by SharePoint
One of the following:
• String
• Number
• Date/Time value in the format —
YYYY-MM-DDTHH:MM:SSZ
• Date/Time value in the format :
-<Today OffsetDays="number"/> — today's date with optional number of days to offset the today's date. You can use the OffsetDays attribute to do date range filter.
The OffsetDays attribute value must be a number (both positive and negative numbers))
-<UserID/> — the current user. This value only works if the field is a user lookup field)
469
Quick Apps for SharePoint
Using CAML Filters
CAML filters allow you set the following variables to validate text fields:
VARIABLE
<%Now%>
%FilePath%>
<%CurrentUserName%>
<%CurrentLoginName%>
<%CurrentUserID%>
<%CurrentUserEmail%>
DESCRIPTION
Current time and date
Complete path for a file in a document library
Display name of the current user
Login name of the current user
ID of the current user, for example: 1
Email address of the current user
Variables work if you store either the user name, login name, user ID, or email address in a Single Line of Text field. qListForm and qSIListForm use variables in the Fixed Value or Form Component Behavior sections.
For a field of type Single-line-of-Text or Multi-line Plain Text, the Operator drop-down menu contains the value, Matches, as an operator for comparing the field value to a regular expression.
Examples of common regular expressions:
• Match beginning of a string: ^Test matches any string that starts with
“Test”.
• Match ending of a string: test$ matches any string that ends with
“test”.
• Telephone number: ^\d{3}-\d{3}-\d{4}$ matches any phone number in the format of 555-555-5555.
Using Dynamic Variables
The CAML Filter can also be used with dynamic variables. The Value element in the CAML Filter can come from various sources such as an HTTP Parameter and
Session. You can extend the Value element in the CAML filter in the following ways:
• If you want to hard code the value in the Value element:
<Value Type="Text">Some Text</Value>
470
CAML Filter Help
• If you want to retrieve the value from an HTTP parameter, the Value element should be specified as:
<Value Type="Text" Source="HttpParameter"
SourceName="NameOfHTTPParameter"/>
For example, the URL of the current page is: http://mysite.com/default.aspx?ProductID=ABC.
If the value element is:
<Value Type="Text" Source="HttpParameter"
SourceName="ProductID"/>
It is replaced with the following during runtime:
<Value Type="Text">ABC</Value>
• If you want to retrieve the value from the Session variable, the Value element should be specified as:
<Value Type="Text" Source="Session"
SessionName="SessionName"
SourceName="NameOfHTTPParameter" SiteUrl="url"
ListName="ListName"/>
For example, to store the Product information (ProductID=ABC) in the session using a qSelector and the Session Name in the qSelector is
ProductSession.
If the value element is:
<Value Type="Text" Source="Session"
SessionName="ProductSession" SourceName="ProductID"
SiteUrl="." ListName="Tasks"/>
The above Value element is replaced with the following during runtime:
<Value Type="Text">ABC</Value>
• If you want to compare values of two fields, the Value element should be specified as:
<Value Type="FieldName" Source="Field">Editor</Value>
For example, to compare the
Created By
field to the
Modified By
field:
<Eq>
<FieldRef Name="Author" />
<Value Type="User" Source="Field">Editor</Value>
</Eq>
471
Quick Apps for SharePoint
The following are some examples of the CAML filter:
• All my active tasks that are overdue (AssignedTo is a user lookup field)
<And>
<Eq><FieldRef Name="AssignedTo"/><Value
Type="Integer"><UserID/></Value></Eq>
<And>
<Eq><FieldRef Name="Status"/><Value
Type="Text">Active</Value></Eq>
<Lt><FieldRef Name="DueDate"/><Value
Type="DateTime"><Today/></Value></Lt>
</And>
</And>
• All unassigned tasks that are due in the next seven days (AssignedTo is a user lookup field)
<And>
<IsNull><FieldRef Name="AssignedTo"/></IsNull>
<And>
<Geq><FieldRef Name="DueDate"/><Value
Type="DateTime"><Today/></ Value></Geq>
<Leq><FieldRef Name="DueDate"/><Value
Type="DateTime"><Today OffsetDays="7"/></Value></Leq>
</And
</And>
Configuring CAML Filter
1.
Open ezEdit from any web part that allows you to configure a CAML
Filter.
2.
Click
Edit
button on the CAML Filter section.
3.
Click
Add Condition
.
4.
In the Edit Condition section, select the field you want to filter on in the Field Name drop-down menu.
5.
Select an operator.
472
CAML Filter Help
6.
In the Value Source drop-down menu, enter the source of the value.
If it is a static value, select ‘Fixed Value’. If the value is dynamic, select if it is going to be passed as a Session variable or a HTTP
Parameter.
7.
Enter the value in the Value field.
8.
Click
Apply
to add the condition to your CAML Filter.
473
Quick Apps for SharePoint
474
Complex Filter Help
•
About Complex Filters
F
Quick Apps for SharePoint
About Complex Filters
Some web parts use Complex Filter expressions to filter data. Complex Filter provides a powerful way to concatenate multiple conditions.
If the web part supports both CAML Filter and Complex Filter, use the CAML Filter. The
CAML Filter processes data in the SQL Server, so the data is transferred to the Web
Server. The Complex Filter processes data in the Web Server. If you specify both CAML
Filter and Complex Filter, the CAML Filter is processed first.
The Complex Filter remains for backward compatibility reasons.
The date and time value must be enclosed in # and specified in ISO 8601 format:
YYYY-MM-DDThh:mm:ssZ. For example, midnight of February 14, 2002 is
#2002-02-14T00:00:00Z#.
The operators and field names in the Complex Filter are case sensitive. For the field name, use the display name of the field (include all spaces if there are any).
The following Boolean operators are supported in Complex Filter:
• NOT
—
This is used to negate a condition. For example, to get all employees whose name does not start with M, they syntax is: NOT
Employee Name LIKE 'M%'
• AND and OR
—
This is used to concatenate two conditions. The AND operator takes precedence over the OR. Use parentheses to change the precedence of the operator.
For example, to get all employees in the Accounting or IT department and hired after 1/1/2004: (Department='Accounting' OR
Department='IT') AND Hired Date>#2004-01-01T00:00:00Z#
Specify conditions for Complex Filter is specified in one of following ways:
1.
FieldName IS NULL
This will return all entries whose field specified by FieldName does not contain any value.
Some entries contain an empty string value ("") and their display is indistinguishable from the entries with a NULL value. If you want to return such entries, use FieldName='' as the filter expression.
2.
FieldName IS DBNULL
476
Complex Filter Help
This will return all entries whose field specified by FieldName contains
DBNull value. It is tricky to determine whether a field is empty, contains null value or contains DBNull value. It all depends on the field type and the type of back end system that you are dealing with.
Therefore, try each one ("fieldName IS NULL", "fieldName IS
DBNULL" or "fieldName=''") in order to identify which one is the appropriate option for your needs.
3.
FieldName IS NOT NULL
This will return all entries whose field specified by FieldName contains values (including empty string value).
4.
FieldName comparison-operator FieldExpression
Comparison operator is one of these: =, <> (not equal), <, >, <=,
>=, LIKE
FieldExpression can be one of the following:
• String
—
A string is enclosed with single quote; for example
'Accounting'. A string can contain wild-card character % or * when used in conjunction with the LIKE operator. For example: 'M%', 'M*'.
A wild-card character is not allowed in the middle of a string.
Therefore, this expression is illegal: 'Te*xt'
• Numbers
—
Numbers are not enclosed. For example: 20, 20.5, 0.5. If you enclose a number with a single quote, it is treated as string.
• Dates
—
For example: February 5, 2005 11:50 PM is
#2005-02-05T23:50:00Z#.
• [ME]
—
This expression is replaced with the name of the currently logged-in user.
• [TODAY]
—
This expression is replaced with midnight of today's date.
• [NOW]
—
This expression is replaced with the current date and time.
• Date function
—
The following date functions are supported:
AddSeconds, AddMinutes, AddHours, AddDays, AddMonths and
AddYears. Their syntax is DateFunction(dateValue, number). For example: AddDays([TODAY], 7) adds 7 days to today's date
The following are some examples of the complex filter:
1.
All my current task that are due within 7 days
PerformedBy=[ME] AND DueDate>=[TODAY] AND
DueDate<=AddDays([TODAY], 7)
2.
All unassigned tasks that are due within 3 days
PerformedBy IS NULL AND DueDate>=[TODAY] AND
DueDate<=AddDays([TODAY], 3)
3.
All overdue tasks
DueDate<[TODAY]
477
Quick Apps for SharePoint
478
My First App
•
Overview
•
Using My First App
G
Quick Apps for SharePoint
Overview
My First App allows you to create a basic SharePoint application. You can add, edit, and view items in a SharePoint list, and then, if desired, plot the data from the list in a chart.
Before you begin, ensure that the SharePoint site contains the list you want to use. If a list does not already exist, create one.
You need to be a site owner in order to use My First App.
Using My First App
To use My First App
1.
From any SharePoint site where you want to build your first app, click
Site Actions | Site Settings
.
2.
From Quick Apps for SharePoint, click
My First App
.
3.
Click
Start
.
4.
Pick a SharePoint list, and click
Next
.
5.
Select a chart type, enter a chart name, and select fields for X-axis and Y-axis, and a function to compile the Y-axis data.
If you do not want to build a chart, keep the default "No Chart".
6.
Click
Next
.
7.
Select a target location and enter a page name for your app
8.
Click
Build
.
When the app is completed, you can either go to your app right away or build another app.
If you want to configure the list and chart, select ezEdit from the
Ribbon tabs.
For information on qChartView, see “qChartView” on page 57
. For information on qListView, see
.
480
Application Templates
•
Installing the Application Templates
•
Adding the CRM template
•
Adding the Help Desk Template
•
Adding the Project Dashboard Template
•
Adding the Project Workspace
H
Quick Apps for SharePoint
Installing the Application
Templates
Quick Apps for SharePoint comes with several application templates. You can use these application templates as a turn-key solution, extend it to your own need, or as an example for your own application.
This diagram shows the structure of the application templates:
The Single Project and Multi Projects sites must be added underneath the Project
Dashboard site. Otherwise, you will see an error in the Panel Menu citing that the list for the menu cannot be found. This is because the lists for the Single
Project's and Multi Project's panel menu are located in the Project Dashboard site.
The Application Site Templates in SharePoint are delivered as SharePoint solution packages: Quest CRM Site.wsp, Quest Help Desk Site.wsp, Quest Multi
Project Site.wsp, Quest Project Dashboard Site.wsp, and Quest Single Project
Site.wsp.
To install the application templates
1.
Copy the solution packages (.wsp files) to a local folder.
2.
Click the Application Templates link on the Quick Apps for SharePoint autorun screen of the installer.
3.
Open the Solutions Gallery.
If you are using SharePoint 2010, select
Site Actions | Site Settings | Solutions
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings |
Solutions
4.
On the SharePoint Ribbon Solutions tab, click
Upload Solution
.
Browse and upload the Site Application Template.
5.
Click
Activate
to activate it if you want the Site Template to appear in the New Site dialog box later.
482
Application Templates
Adding the CRM template
The CRM can be a top-level site or a subsite of another site.
The CRM application template can be used to manage customer data such as companies, contacts, tasks, conversation records, and sales funnel (sales opportunities).
To add the CRM template
1.
Open Sites and workspaces.
If you are using SharePoint 2010, select
Site Actions | Site Settings | Sites and workspaces
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | Sites and workspaces.
2.
Click
Create
.
3.
Complete the site information and select the CRM Site template under the Custom tab.
4.
Click
Create
.
Next, you must configure the administrator group. The member of this group will see the Administration Pages panel in the panel menu.
To configure the administrator group
1.
Open People and groups.
If you are using SharePoint 2010, select
Site Actions | Site Settings | People and groups
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | People and groups.
2.
Click
New
to create Administrators group and assign members to this group.
If you want to create announcements that are displayed in the Home page, login as a member of the Administrators group and select
Administration Pages |
Application Setup
in the panel menu.
Click the
New
button in the Companies listview in the Home page to create company records. When you click Save and View Details, the company record is saved and you will redirected to the Company Detail page where you can enter the Contacts, Tasks, Conversation Records and Sales Funnel (Sales
Opportunities) for that company.
483
Quick Apps for SharePoint
Adding the Help Desk Template
The Help Desk can be a top-level site or a subsite of another site.
The Help Desk application template can be used to manage Help Desk tickets and to look for help desk related information such as links, FAQs, and Knowledge
Base Articles.
To add the Help Desk template
1.
Open Sites and workspaces.
If you are using SharePoint 2010, select
Site Actions | Site Settings | Sites and workspaces
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | Sites and workspaces.
2.
Click
Create
on the toolbar.
3.
Complete the site information and select the Help Desk Site template under the Custom tab.
4.
Click
Create
.
Next, you must configure the group for the help desk users.
To configure the group for help desk users
1.
Open People and groups.
If you are using SharePoint 2010, select
Site Actions | Site Settings | People and groups
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | People and groups.
2.
Create 4 new groups (3 new groups if you have already created an
Administrators group) and assign members to these groups.
• Administrators
—
The members of this group can see the
Administration Pages panel in the panel menu.
• Help Desk Users
—
This is the group for a regular user. Regular users can create a ticket and track their existing tickets. They can also lookup the resources in the site.
• Help Desk Technicians
—
Help Desk Technician can do everything that the Help Desk User can do. Also, they can assign a ticket to themselves or other technician and working on the ticket.
• Help Desk Supervisors
—
Help Desk Supervisor can do everything that the Help Desk Technician can do. Also, they can administer the list of help desk technician and add FAQ, and Knowledge Base articles.
484
Application Templates
If you do not log in as a member of Help Desk Supervisors, open another window and log in as a supervisor.
Select Supervisor | Administrative Page in the menu. At a minimum, you must fill in the Help Desk Technician information and the Supported Products. You can also create other information such as Announcements, Help Desk Links, FAQs, and Knowledge Base Articles in this page.
After the setup is done, anybody can start using the site. The first thing that the user can do is to create a new ticket by clicking the New button in the My New or Unassigned Tickets view in the home page. After a ticket is created, the owner of the ticket can keep track the life cycle of the ticket by clicking the Active
Tickets, Resolved Tickets and Closed Tickets links in the panel menu.
Help Desk Technicians can login to the site and look for newly created tickets using the New or Unassigned Tickets page. The link to navigate to this page is available in the panel menu. Somebody must be a member of the Help Desk
Technicians member to be able to see this menu. Help Desk Technicians can also see any tickets that are assigned to him/her, resolved by him/her or closed tickets that are resolved by him/her by clicking the appropriate links in the panel menu.
Any user can look for information such as FAQs, discussion board, Knowledge
Base Articles, by clicking the links in the panel menu. Only a member of Help
Desk Supervisors group can create FAQs, Knowledge Base Articles, by using the administrative page.
Adding the Project Dashboard
Template
The Project Dashboard can be a top-level site or a subsite of another site.
The Project Dashboard, Single Project, and Multi Projects application templates can be used to manage different aspect of a project, such as Tasks, Issues, and documents.
To add the Project Dashboard template
1.
Open Sites and workspaces.
If you are using SharePoint 2010, select
Site Actions | Site Settings | Sites and workspaces
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | Sites and workspaces.
485
Quick Apps for SharePoint
2.
Click
Create
.
3.
Complete the site information and select the Project Dashboard Site template under the Custom tab.
4.
Click
Create
.
Next, you must configure the administrator group if you have not done so. The member of this group will see the Administration Pages panel in the panel menu.
To configure the administrator group
1.
Open People and groups.
If you are using SharePoint 2010, select
Site Actions | Site Settings | People and groups
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | People and groups.
2.
Create an Administrators group and assign members to this group.
The Project Dashboard site itself does not contain any data. You must create one or more Single Project sites or Multi Project sites as subsites of the Project
Dashboard site.
Adding the Project Workspace
The Project Workspace must be created under the Project Dashboard.
To add the project workspace
1.
Open Sites and workspaces.
If you are using SharePoint 2010, select
Site Actions | Site Settings | Sites and workspaces
.
If you are using SharePoint 2013, from the Settings icon, select
Site Settings | Sites and workspaces.
2.
Click
Create
on the toolbar.
3.
Complete the site information and select either the template Single
Project Site or Multi Project Site under the Custom tab.
4.
Click
Create
.
486
Application Templates
Login as a member of the Administrators group and select
Administration
Pages | Application Setup
in the panel menu. Setup your projects, phases for your projects, and other information pertaining to the projects. For the Single
Project site, you must create only one Project. You can create more than one projects in the Multi Project site.
After the project is setup, any user can login to the project site and start managing the Tasks, Issues and documents related to the project. In the Multi
Project site, the user can switch between one project and another by selecting it in the selector that is located above the listview in each page. The selected project is memorized when the user navigates between pages enabling them to see the data only for the selected project.
The user can also go to the Project Dashboard site to see the aggregated information from all the subsites. For example, a manager can easily monitor the health of all the projects in the home page of the Project Dashboard site.
487
Quick Apps for SharePoint
488
Sample Charts
•
Single Series
•
Multi-Series
•
Scroll
•
Stacked
I
Quick Apps for SharePoint
CHART GROUP
Single Series
CHART TYPE
Area2D
EXAMPLE
Bar2D
Column2D
Column3D
490
CHART GROUP CHART TYPE
Doughnut2D
EXAMPLE
Sample Charts
Doughnut3D
Line
Pie2D
Pie3D
491
Quick Apps for SharePoint
CHART GROUP
Multi-Series
CHART TYPE
MultiSeriesArea
EXAMPLE
MultiSeriesBar2D
MultiSeriesBar3D
492
CHART GROUP CHART TYPE
MultoSeriesColumn2D
EXAMPLE
Sample Charts
MultiSeriesColumn3D
MultiSeriesColumn3DAnd
LineDualYAxis
MultiSeriesColumnAndLine
3D
MultiSeriesCombination2D
493
Quick Apps for SharePoint
CHART GROUP CHART TYPE
MultiSeriesCombination3D
EXAMPLE
MultiSeriesCombination2D
DualYAxis
MultiSeriesLine
MultiSeriesStackedColumn
2D
For more information on this chart type, see
2DLineDual YAxis Charts” on page 121 .
MultiSeriesStackedColumn
2DDualYAxis
For more information on this chart type, see
2DLineDual YAxis Charts” on page 121 .
494
CHART GROUP
Scroll
CHART TYPE
ScrollArea2D
EXAMPLE
Sample Charts
ScrollColumn2D
ScrollCombination2D
ScrollCombination2DDualY
Axis
495
Quick Apps for SharePoint
CHART GROUP CHART TYPE
ScrollLine2D
EXAMPLE
Stacked
ScrollStackedColumn2D
StackedArea2D
StackedBar2D
StackedBar3D
496
CHART GROUP CHART TYPE
StackedColumn2D
EXAMPLE
Sample Charts
StackedColumn3DDualLine
YAxis
497
Quick Apps for SharePoint
498
I
NDEX
Symbols
Numerics
3D Chart Attributes
A
Actions
adding a web part later in
adding billions to default 118
adding more web parts to the same
adding number prefix and suffix 115
Anchors
applying custom defined styles to
automatic number formatting 113
B
Border and Background
C
Calendar Appearance
Catalog
Chart Appearance
Chart Canvas
Chart Palettes
Complex Filter Help 475 complex filter help 475
Configuration
Configuration Wizard configuring advanced settings
configuring basic settings
configuring a web part within
Context Menu Appearance
Control Appearance
controlling decimal precision 112
Custom About Menu Item
deploying the custom action
icustomaction interface
using the custom action class 455
Custom Action class 455 deploying 455
Custom Action Help
Custom Actions
custom actions
499
Quick Apps for SharePoint
custom defined styles in chart
Custom Display
custom layout manager class 460
deploying custom layout manager
using custom layout manager
Custom Layout Help
Custom Layout Manager class 460
D
Data Labels
Data Plot
Data Values
defining links in qChartView 108
defining links in qSIChartView 373
Dependent Lists
deploying the custom action
Deployment
Display Fields
,
Division Lines
500
dynamic variables in CAML Filter 470
E
Email Notification
exploring Web Parts in
External Logo
F
Folder Tree Appearance
Font Properties
Form Component Behavior
Form Layout
Form Type
formatting links in qChartView 108
formatting links in qSIChartView 373
formatting y-axis values decimal in
,
Functional
G
Grid Appearance
I
icustomaction interface
L
Layout
Legend
linking to frames in qChartView 110
linking to frames in
Localization
Localization Appearance
M
N
Number Formatting
number formatting in
adding number prefix and
automatic number formatting 113
controlling decimal precision 112
formatting y-axis values decimal in
setting custom thousand and decimal separator
number formatting in
adding number prefix and
automatic number formatting 378
controlling decimal precision 377
formatting y-axis values decimal in
setting custom thousand and decimal separator
number scaling in qChartView 118 adding billions to default 118
number scaling in qSIChartView 383 adding billions to default 383
O
opening links in a new window in
opening links in a new window in
opening links in a pop-up window in
opening links in a pop-up window in
P
Paddings and Margins
Persistent Selector
Placing a List Form
Programming Interface
Q
qCalendar View
adding billions to default 118
apply custom defined styles to
attributes
501
Quick Apps for SharePoint
defining links 108 formatting links 108
adding number prefix and
automatic number
controlling decimal
formatting y-axis values decimal in manual-div line
setting custom thousand and decimal separator
number scaling 118 adding billions to default 118
opening links in a new window 109
opening links in a pop-up
502
qChartView Attributes
adding more web parts to the same
configuring a web part within
View Setting
View Setting
Configuration Wizard configuring advanced
configuring basic
qListView properties
setting new property values 270
qMultiSelector
adding billions to default 383
applying custom defined styles to
attributes
Custom About Menu
defining links 373 formatting links 373
Localization
Localization
adding number prefix and
automatic number
controlling decimal
formatting y-axis values decimal in manual-div line
setting custom thousand and decimal separator
opening links in a new window 374
opening links in a pop-up
Series Appearance
Series Appearance
Toolbar Appearance
Toolbar Appearance
,
503
Quick Apps for SharePoint
qSIListForm properties
R
S
Searched Fields
searching web parts in
Selector Appearance
Series Appearance
setting custom thousand and decimal
,
setting new property values in
Skin Name
Slide Show Appearance
Smart Labels and Lines
Styles
504
T
Title and Axis Name
Tool Tip
Toolbar Appearance
U
User Permissions
using the custom action class 455
V
Vertical Div Lines
View Appearance
Viewed Lists
Y
Y Axis
Z
Zero Plane
About Quest Software
Established in 1987, Quest Software (Nasdaq: QSFT) provides simple and innovative IT management solutions that enable more than 100,000 global customers to save time and money across physical and virtual environments.
Quest products solve complex IT challenges ranging from database management , data protection , identity and access management , monitoring , user workspace management to Windows management . For more information, visit www.quest.com
.
Contacting Quest Software
Web site [email protected]
Quest Software, Inc.
World Headquarters
5 Polaris Way
Aliso Viejo, CA 92656
USA www.quest.com
Refer to our Web site for regional and international office information.
Contacting Quest Support
Quest Support is available to customers who have a trial version of a Quest product or who have purchased a Quest product and have a valid maintenance contract. Quest Support provides unlimited 24x7 access to support portal. Visit our support portal at http://www.quest.com/support .
From our support portal, you can do the following:
• Retrieve thousands of solutions from our online Knowledgebase
• Download the latest releases and service packs
• Create, update and review Support cases
View the Global Support Guide for a detailed explanation of support programs, online services, contact information, policies and procedures. The guide is available at: http://www.quest.com/support .
505
Quick Apps for SharePoint
Third Party Components
Quick Apps for SharePoint contains some third party components (listed below).
Copies of their licenses may be found on our website at http://www.quest.com/legal/third-party-licenses.aspx.
COMPONENT
async.js n/a
LICENSE OR ACKNOWLEDGEMENT
Caolan McMahon
506
Télécharger
Lien public mis à jour
Le lien public vers votre chat a été mis à jour. Vous pouvez afficher et gérer vos liens de chat après inscription ici.
Lien public du document
Publicité
