Quick Apps For SharePoint 6.4 User Guide Appsfor Share Point_6.6_User Point 6.6

User Manual: QuickAppsforSharePoint_6.6_UserGuide

Open the PDF directly: View PDF .
Page Count: 403

Download
Open PDF In Browser	View PDF

AgreeYa QuickApps for SharePoint® 6.6
User Guide

2016 AgreeYa Solutions, 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 AgreeYa Inc.
The information in this document is provided in connection with AgreeYa 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 AgreeYa
products. EXCEPT AS SET FORTH IN THE TERMS AND CONDITIONS AS SPECIFIED IN THE LICENSE AGREEMENT FOR THIS PRODUCT,
AGREEYA 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 AGREEYA 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 AGREEYA
HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. AgreeYa 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. AgreeYa does not make any commitment to update the information
contained in this document.
If you have any questions regarding your potential use of this material, contact:
AgreeYa Solutions, Inc.
605 Coolidge Dr.
Folsom, CA 95630
USA
Refer to our web site (www.agreeya.com) for regional and international office information.
Trademarks
AgreeYa, the AgreeYa logo are trademarks of AgreeYa Solutions, Inc. and/or its affiliates. Microsoft, Internet Explorer,
SharePoint, Windows, Windows Server, SQL Server are either registered trademarks or trademarks of Microsoft Corporation in
the United States and/or other countries. Salesforce and Salesforce.com are trademarks of Salesforce.com. K2, K2BlackPearl
are registered trademarks of Sourcecode Technology Holdings Inc. in the United States and/or other countries. Domino is a
registered trademark of International Business Machines Corporation. Telerik is a registered trademark of Telerik AD in the
United States and either a registered trademark or trademark of Telerik AD in other countries. Oracle and Java are registered
trademarks of Oracle and/or its affiliates. Nintex and its product logos are registered trademarks owned by Nintex USA LLC and
Nintex Pty Ltd. SAP is the trademark(s) or registered trademark(s) of SAP AG in Germany and in several other countries. Google
and Google Chrome is a trademark or registered trademark of Google Inc. Netscape Navigator is a registered trademark of AOL
Inc. Other trademarks and trade names may be used in this document to refer to either the entities claiming the marks and names
or their products. AgreeYa disclaims any proprietary interest in the marks and names of others.
Legend
CAUTION: A CAUTION icon indicates potential damage to hardware or loss of data if instructions are not followed.

WARNING: A WARNING icon indicates a potential for property damage, personal injury, or death.

IMPORTANT NOTE, NOTE, TIP, MOBILE, or VIDEO: An information icon indicates supporting information.
AgreeYa QuickApps for SharePoint User Guide
Updated - January 2016
Software Version - 6.6

Contents
Introducing QuickApps for SharePoint® . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
About this Guide . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
About QuickApps for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
Features of QuickApps for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 8
qCalendarView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .10
qCalendar Pages . . . .
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

. .10
. .11
. .22
. .28
. .32

qCaptionDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .34
qCaptionDisplay Pages
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. .35
. .35
. .35
. .37

qCascadingMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39

qCascadingMenu Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .41
Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .42
Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
qCascadingMenu Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
Configuring qCascadingMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
qChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
qChartView Pages . . .
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....
....

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .47
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85

qChartView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
Configuring qChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
Formatting Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .87
Setting Number Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .90
Setting Number Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94
Using MultiSeriesStackedColumn2D and MultiSeriesStackedColumn2DLineDual
YAxis Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
AgreeYa QuickApps for SharePoint 6.6
User Guide

qDiscussionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
qDiscussionView Pages
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

. .99
. .99
. 109
. 109
. 112

qDiscussionView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Configuring qDiscussionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Sorting the qDiscussionView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Understanding the Complex Category Index List . . . . . . . . . . . . . . . . . . . . . . . . 115
Configuring qDiscussionView with the Complex Category Index List . . . . . . . . . . . . 116
qDynamicLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
qDynamicLayout Pages
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. . . . . . . . . . . . . . . . . . . . . . . . . . 119
. . . . . . . . . . . . . . . . . . . . . . . . . . 119
. . . . . . . . . . . . . . . . . . . . . . . . . . 121
. . . . . . . . . . . . . . . . . . . . . . . . . . 122

qDynamicLayout Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Configuring qDynamicLayout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
qExcelViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 124
qExcelViewer Pages . .
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

.......
.......
.......
.......

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. 124
. 124
. 125
. 127

qExcelViewer Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
Configuring qExcelViewer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128
qHelpLink . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

qHelpLink Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130
Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 131
Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132
qItemDisplay . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .134
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

qItemDisplay Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138
qListForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .140
AgreeYa QuickApps for SharePoint 6.6
User Guide

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
User Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
qListForm Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 142
Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164
Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176
Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179
qListForm Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182
Adding items to a list in SharePoint using qListForm . . . . . . . . . . . . . . . . . . . . . . 182
Creating and Editing Collapsible Sections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183
qListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184
Configuration Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
qListView Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185
Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186
Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200
Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205
Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211
qListView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217
Configuring Basic Settings using the Configuration Wizard . . . . . . . . . . . . . . . . . . 217
Configuring a Basic ListView with Filters using ezEdit . . . . . . . . . . . . . . . . . . . . . 217
qManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219
qManagement Pages .
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. 219
. 219
. 220
. 222

qManagement Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Configuring qManagement . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223
Exploring Web Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Searching Web Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
Setting New Property Values . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224
qMediaView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .226
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226
qMediaView Pages . . .
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. 226
. 227
. 230
. 234

qMultiSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .235
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235
qMultiSelector Pages .
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

AgreeYa QuickApps for SharePoint 6.6
User Guide

. 235
. 235
. 238
. 239
5

qPageRedirector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241
qPageRedirector Pages . . . . . . .
Content Page . . . . . . . . . .
Appearance Page . . . . . . . .
Advanced Page . . . . . . . . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. 242
. 242
. 242
. 244

qPanelMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

qPanelMenu Pages . . .
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....
....

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 249
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251

qPanelMenu Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
Configuring qPanelMenu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252
qSelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .254
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 254
qSelector Pages . . . .
Content Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....

...
...
...
...

....
....
....
....

...
...
...
...

. . . . . . . . . . . . . . . . . . . . . . . . . . 255
. . . . . . . . . . . . . . . . . . . . . . . . . . 255
. . . . . . . . . . . . . . . . . . . . . . . . . . 257
. . . . . . . . . . . . . . . . . . . . . . . . . . 259

qSIChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .261
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

qSIChartView Pages . .
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 262
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 271
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276
. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 305

qSIChartView Procedures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Configuring qSIChartView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Formatting Links . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 307
Setting Number Formatting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 309
Setting Number Scaling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 314
Using MultiSeriesStackedColumn2D and MultiSeriesStackedColumn2DLineDual
YAxis Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 317
qSIListForm . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 318
qSIListForm Pages . . .
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

. 319
. 319
. 327
. 336
. 338

qSIListView . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .340
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 340
AgreeYa QuickApps for SharePoint 6.6
User Guide

qSIListView Pages . . .
Content Page . . .
Behavior Page . . .
Appearance Page .
Advanced Page . .

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

....
....
....
....
....

...
...
...
...
...

. 341
. 341
. 352
. 356
. 360

qSISelector . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .363
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 363

qSISelector Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Content Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 364
Behavior Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Appearance Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 370
Advanced Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 372
Custom Action Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374
Overview

. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 374

Custom Action . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
ICustomActionEx Interface . . . . . . . . . . . . . . . . . . .
ICustomAction Interface (Deprecated) . . . . . . . . . . . .
Debugging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Using the Custom Action Class . . . . . . . . . . . . . . . . .
Deploying Custom Action Class . . . . . . . . . . . . . . . . .

....
....
....
....
....
....

...
...
...
...
...
...

....
....
....
....
....
....

...
...
...
...
...
...

. 374
. 374
. 380
. 383
. 384
. 384

ezLocalizer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .385
Creating a New Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 385
Opening an Existing Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
Finding Values in a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 386
My First App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .387
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Using My First App . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 387
Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .388
Installing the Application Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Adding the CRM template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 388
Adding the Help Desk Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 389
Adding the Project Dashboard Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Adding the Project Workspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 390
Sample Charts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .392
Contacting AgreeYa . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403
Technical support resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 403

AgreeYa QuickApps for SharePoint 6.6
User Guide

Contents

Introducing QuickApps for SharePoint®
•

About this Guide

•

About QuickApps for SharePoint

•

Features of QuickApps for SharePoint

About this Guide
This guide describes how to use the web parts component of QuickApps 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 QuickApps for SharePoint.
Before using this guide, see the QuickApps for SharePoint Quick Start Guide for installing and activating
QuickApps for SharePoint. The same document also introduces the basic operation of QuickApps for SharePoint,
using a simple configuration to externalize documents in a sample SharePoint environment.

About QuickApps for SharePoint
QuickApps 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 QuickApps for SharePoint
QuickApps 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 QuickApps for SharePoint as a site feature. When a new site or site
collection is created, the Admin or Site Designer can activate the QuickApps for SharePoint - Web Parts Library
to enable the web parts for newly added site collections.
This product allows you to:
•

use point-and-click configuration instead of custom code to customize SharePoint solutions up to 80
percent faster

•

meet your most complex business requirements, from interface enhancements to complete solutions,
without needing custom development training or experience

•

use My First App to configure compelling SharePoint list views and charts in a few simple mouse clicks

•

quickly build better SharePoint solutions with easy-to-use web parts featuring built-in video training and
tutorials. Discover best practices and tips and tricks from SharePoint peers and AgreeYa experts in the
collaborative QuickApps community at www.SharePointforAll.com.

•

maximize your SharePoint investment by accelerating SharePoint development cycles in order to save
resources, time and money on costly enhancements

•

empower end users to make their own customizations without risk to the environment, freeing expensive
development resources for more value-added projects
AgreeYa QuickApps for SharePoint 6.6
User Guide

•

accelerate SharePoint application development cycles using ready-made templates to deliver help desk,
project management and CRM applications that are easily supported, maintained, and extended

•

build applications that you can easily maintain and support with no custom coding

•

exceed user expectations and extend applications beyond what’s natively possible with features that
deliver tabular forms to save screen space, dynamically show and hide parts of a form, and establish
parent-child relationships to ensure reliable data entry

•

deliver sophisticated custom solutions that can be upgraded with ease from SharePoint version to version

•

bring data together from all of your enterprise application systems, such as Oracle®, SAP®, SQL Server®
and Salesforce.com®, without the hassle of copying the data manually into SharePoint

•

build dashboards and charts that provide full visibility of your K2® workflows (including real-time
workflow) status. Then build rich SharePoint forms that drive business processes, so users can take
action on K2 workflows from directly within the SharePoint form (for SharePoint 2010 only)

•

create custom actions with out-of-the-box and Nintex® workflows

•

use ribbons. For more information, see Ribbon Groups on page 9.

Ribbon Groups
A 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.
NOTE: 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:
Table 1. Ribbon Groups
Group

Description

Manage Group

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.

Actions Group

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”.

Custom Actions
Group

Contains a set of custom actions defined in the Custom Actions properties.

Setting & Help
Group

Contains buttons from the web part context menu: “ezEdit”, “Help” and “About”.

AgreeYa QuickApps for SharePoint 6.6
User Guide

2
qCalendarView
•

Overview

•

qCalendar Pages

Overview
The qCalendarView aggregates data from one or more SharePoint lists and displays it in calendar form.
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.
TIP: To maintain the same look and feel across all web parts, save the web part as a template, and reimport it into the SharePoint gallery to reuse it.
NOTE: 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.

qCalendar Pages
You can configure this web part through its pages that are accessible through ezEdit. qCalendar contains the
following pages:
•

Content Page

•

Behavior Page

•

Appearance Page

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

•

Advanced Page

Content Page
The Content page allows you to enter the content for your web part. It contains the following:
•

Primary Content

•

Optional Content

•

Search/Filter Panel

•

Filtering

Primary Content
The Primary Content page is default category. You need to configure one or more elements in this page to get
started using this web part.
Primary Content contains the following:
Table 1. Primary Content
Element

Description

Title

Allows you to enter a title for the Web Part, or accept the default. This field is
mandatory.

Viewed Lists

See Viewed Lists on page 11.

ID HTTP Parameter

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 qListForm or qCalendarView, when you
select an item to be displayed or edited.
NOTE: If qCalendar 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
NOTE: Set the same property in the qListForm to the same value.

Begin Date Field
Name

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.

End Date Field Name

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 End 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.

Viewed Lists
The Viewed Lists section defines:
•

the lists whose data is aggregated in the calendar

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

•

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:
Table 2. Viewed Lists
List Attributes

Description

Advanced Mode

Turn on if you want to edit Viewed Lists in XML format. For example:

Site URL

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.

List Name

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.

Include Subsites

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.

Include This Site

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.

Is Rollup List

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.

Rolled Up List Name

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:

Site URL Field Name

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 2. Viewed Lists
List Attributes

Description

Active Field Name

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.

Reset Session Names

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.

Set Session Name

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.

Target URL

When the LinktoTargetUrl attribute of a specific column is selected (in the Primary
Content page), the data in that column becomes a hyperlink to the URL specified in
this attribute.
NOTE: The Target Url can use the <%field name%> field replacement expression. If
you are using Advanced Mode, you must use the encoded form of the < and >
characters, which are < and > respectively.
NOTE: 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.

New Form URL

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).

Edit Form URL

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.

Display Form URL

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Optional Content
You can configure the following optional content:
Table 3. Optional Content
Element

Description

Recurrence Field Name

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).

Display Field Name

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.

Display Format

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.
NOTE: For more information, see Display Format on page 14.

Tooltip Field Name

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.

Tooltip Format

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.

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.
Table 4. Basic Number Formatting
Format

Type

Output (if input is double
value 2.34)

Output (if input is integer value
12400)

{0:c}

Currency

$2.34

$12,400

{0:d}

Decimal (whole
number)

N/A

12400

{0:e}

Scientific

2.340000e+000

1.240000e+004

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 4. Basic Number Formatting
Output (if input is double
value 2.34)

Output (if input is integer value
12400)

Number with
commas for
thousands

2.34

12,400

Hexadecimal

N/A

cf90

Example

Output (if input is 12400.25)

Format

Type

{0:n}

{0:x}

Table 5. Custom Number Formatting
Specifier

Note

Zero placeholder

{0:00.00}

12400.250

Digit placeholder

{0:##.####}

12400.25

Decimal point

{0:0.0}

12400.3

Thousands
separator

{0:0,0}

12,400

Percent (Multiplies
by 100 and add %
sign)

{0:0%}

1240025%

For custom number formatting, you can combine different specifiers. For example: {0:0,0%} will output
1,240,025%.
Table 6. Date Formatting
Format

Type

Output (if input is November 14, 2007 10:34:23 PM)

{0:d}

Short date

11/14/2007

{0:D}

Long date

November 14, 2007

{0:t}

Short time

10:34 PM

{0:T}

Long time

10:34:23 PM

{0:f}

Full date and time

November 14, 2007 10:34 PM

{0:F}

Full date and time (long)

November 14, 2007 10:34:23 PM

{0:g}

Default date and time

11/14/2007 10:34 PM

{0:G}

Default date and time
(long)

11/14/2007 10:34:23 PM

{0:M}

Month and day

November 14

{0:r}

RFC1123 date string

Wed, 14Nov2007 10:24:23 GMT

{0:s}

Sortable date string

2007-14-11T22:34:23

{0:u}

Universal sortable, local
time

2007-14-11 22:34:23 PM

{0:U}

Universal GMT

November 14, 2007 10:34:23 PM

{0:Y}

Month and year

November, 2007

Table 7. Custom Date Formatting
Specifier

Note

Example

Output (if input is November
14, 2007 10:34:23 PM)

Day

{0:00.0}

ddd

Day name

{0:##.####}

Wed

ddd

Full day name

{0:0.0}

Wednesday

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 7. Custom Date Formatting
Specifier

Note

Example

Output (if input is November
14, 2007 10:34:23 PM)

f,ff,...

Second fraction

{0:fff}

230

Era

{0:gg}

A.D.

2 digit hour

{0:hh}

2 digit hour in 24 hour
format

{0:HH}

Minute 00-59

{0:mm}

Month 01-12

{0:MM}

MMM

Month abbreviation

{0:MMM}

Nov

MMMM

Full month name

{0:MMMM}

November

Seconds 00-59

{0:ss}

AM or PM

{0:tt}

Year, 2 digits

{0:yy}

yyyy

Year

{0:yyyy}

2007

Timezone offsets, 2
digits

{0:zz}

-05

zzz

Full timezone offsets

{0:zzz}

-05:00

Separator

{0:hh:mm:ss}

10:34:23

Separator

{0:dd/MM/yyyy

14/11/2007

Search/Filter Panel
The Search/Filter Panel allows you to define the panels for search, filter, and replace in the web part.
The Search/Filter Panel contains the following elements:
Table 8. Search/Filter Panel
Element

Description

Searched Fields

See Searched Fields on page 17.

Show Search All Fields Determines whether the Filter panel should display the control to search all fields in
Control in Search
the list. When set to true, the following control is shown in the Filter panel:
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 (only Lookup to a
Single Text field and Lookup to a Number field are supported), Person or Group
and Hyperlink or Picture. If the list contains a Lookup to Number field, Search
All Fields will not work for negative numbers for that field. 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’

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 8. Search/Filter Panel
Expand Filter panel
on Load

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.

Panel Button Location 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.

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.
You will be able to perform a search by pressing Enter.
NOTE: Pressing Enter will not allow you to perform a search on such fields as external data, people picker,
managed metadata, and a drop-down list. Instead, the default behavior will occur.
NOTE: For the Number type field, the “Contain” operator is not supported for negative numbers, and is
not available for the following fields: Lookup to DateTime field, Lookup to Calculated field, and Lookup to
ID field.
Specify the following field properties:
Table 9. Searched Fields
Field Property

Description

Advanced Mode

Turn on if you want to edit Searched Fields in XML format.

Field Name

Indicates the element you are editing.

Title

Displays title for the field. The value can be a plain string or an encoded HTML
string.

Description

Describes the field. This is useful if you want to give a short instruction or
explanation about the field.

Default Value

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.

Default Operator

Defines the default operator for the field.

Fixed Operator

Defines the operator for the field. If specified, the list to select the operator for
this field is turned off.

Use People Editor

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.

Column Count

Defines the number of columns for the options in a multi-choice field or in a choiceand-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.

Enable Multi Choice

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.

Sort Field

www.agreeya.com

Defines the field that is used to sort the value in the list menu. The field name is
case sensitive.
AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 9. Searched Fields
Field Property

Description

Sort Order

Allows you to sort the values in ascending or descending order.

AutoPostBack

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.

Parent Field

Defines another lookup or cross-site lookup field that is used to filter this field.

Parent Filter Field Name

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.

Filter Field Name

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.

Display Field Name

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.

Display Format

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: If you are using Advanced Mode, 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.
NOTE: For more information, see Display Format on page 14.

Site URL

Indicates the Site URL of the field. You can use an absolute or relative URL.

List Name

Indicates the name of the List. The field name is case sensitive.

Site Name

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.

Filtering
The Filtering page allows you to use CAML filters to dynamically filter records or use Complex Filters to define
static filter for the data.
The Filtering page contains the following:
Table 10. Filtering
Element

Description

CAML Filter

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.
For more information, see CAML Filters on page 19.

Complex Filter

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.
For more information, see Complex Filters on page 21.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

CAML Filters
CAML Filter expressions help filter data by providing a way to link multiple conditions.
Turn Advanced Mode on if you want to edit CAML Filters in XML format.
CAUTION: 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.
NOTE: This is different from the Complex Filter that uses the Display Name.
The Boolean operators and are supported in CAML Filter. These operators are used to combine two
conditions. They must contain exactly two conditions. For example:
......
If you need to link more than two conditions, such as Condition1 And Condition 2 And Condition3, you must nest
these operators. For example:
.........
You can specify conditions for CAML Filter in either of the following ways:
•

This returns all entries whose field specified by InternalFieldName does not contain any value.

•

This returns all entries whose field specified by InternalFieldName contains values (including empty
string value).

•

ValueToCompare
Where:
Value

Operator

One of the following:

www.agreeya.com

•

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

AgreeYa QuickApps for SharePoint 6.6
User Guide

Value

TypeName

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
ValueTo
Compare

One of the following:
•

String

•

Number

•

Date/Time value in the format — YYYY-MM-DDTHH:MM:SSZ

•

Date/Time value in the format :
- — 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))
- — the current user. This value only works if the field is a user
lookup field)

Using CAML Filters
CAML filters allow you set the following variables to validate text fields:
Table 11. CAML Filter variables
Variable

Description

<%Now%>

Current time and date

%FilePath%>

Complete path for a file in a document library

<%CurrentUserName%>

Display name of the current user

<%CurrentLoginName%>

<%CurrentUserID%>

ID of the current user, for example: 1

<%CurrentUserEmail%>

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

NOTE: If you want to use Advanced Mode, you can extend the value element in the CAML filter. Some
examples are:
•

to enter the value in the Value element - Some Text

•

to retrieve the value from an HTTP parameter -
to retrieve the value from the Session variable -
to compare values of two fields - Editor

Complex Filters
Complex Filter provides a powerful way to concatenate multiple conditions.
CAUTION: 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.

FieldName IS DBNULL
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.

FieldName IS NOT NULL
This will return all entries whose field specified by FieldName contains values (including empty string
value).

FieldName comparison-operator FieldExpression
Comparison operator is one of these: =, <> (not equal), <, >, <=, >=, LIKE
FieldExpression can be one of the following:

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

•

String — A string is enclosed with single quote; for example 'Accounting'. A string can contain wildcard 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

•

[ME]

•

[TODAY]

•

[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

—

For example: February 5, 2005 11:50 PM is #2005-02-05T23:50:00Z#.

This expression is replaced with the name of the currently logged-in user.
—

This expression is replaced with midnight of 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)

All unassigned tasks that are due within 3 days
PerformedBy IS NULL AND DueDate>=[TODAY] AND DueDate<=AddDays([TODAY], 3)

All overdue tasks
DueDate<[TODAY]

Behavior Page
The Behavior page allows you to configure behaviors, such as adding buttons or menus, so the user can perform
operations when using the web part.
The Behavior page contains the following:
•

Actions

•

Navigation

•

Views

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.
The Actions page contain the following elements:
Table 12. Actions
Element

Description

Custom Actions

For more information, see Custom Actions on page 22.

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 List Form supports some built-

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

in actions. However, you can write your own custom action using one of the .NET languages, compile it, and call
it by the List Form. See Custom Action Help on page 374 to see how to write your own custom actions.
NOTE: The toolbar button affects all the items that are selected in the List Form. The context menu item
affects only the item that is being right-clicked regardless of how many items are selected in your List
Form.
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 List
Form 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.

•

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.
NOTE: The custom action in the List Form does not support the Save action.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 13. Custom Actions
Element

Description

Advanced Mode Turn on if you want to edit Custom Actions in XML format:

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 13. Custom Actions
Element

Description

IsSeparator

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.

Text

Allows you to enter how the action item is displayed in the toolbar.

Text Resource
ID

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.

Prompt Text

Allows you to prompt the user to click the toolbar button or the context menu item.

Prompt Text
Resource ID

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.

Access Key
(Toolbar Only)

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.

Position

Allows you to set the position of the button in the toolbar. The index starts with 0.

Show User
Groups

Allows you to list SharePoint groups whose members can view the Web Part. Separate groups
with commas.

Hide User
Groups

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

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

When you add an action, you can configure the following:
Element

Description

Name

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.

Type

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 must specify the URL and where
you want the URL to open. You must select from one of the following source
parameters:
•

Input - 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 - the value of the parameter is a list item or row

•

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: .[.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 - 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
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)

www.agreeya.com

•

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 select 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.

AgreeYa QuickApps for SharePoint 6.6
User Guide

Navigation
The Navigation page allows you to configure how and where the user will navigate in the web part. It contains
the following elements:
Table 14. Navigation
Element

Description

LinkTo

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.
NOTE: If you are using Advanced Mode, 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.

LinkToTargetURL

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.

Link To Source

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 Link 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.

Views
The Views page allows you to set views so the user to view the data in a calendar.
The Views page contains the following element:
Table 15. Views
Element

Description

Search Session Name

The calendar will store the search criteria, last selected folder, sort criteria, and
other list view dynamic settings in the session variable with this name.
The calendar 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 calendar.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Appearance Page
The Appearance page allows you to set the overall look and feel of the web part. This page contains the
following:
•

Ribbon

•

Toolbar

•

Legend

•

Calendar

•

Context Menu

•

Layout

•

Other

Ribbon
The Ribbon page allows you to set the display name of the Ribbon.
Table 16. Ribbon
Element

Description

SharePoint Ribbon Tab
Name

Allows you to edit the display name of the Ribbon tab.

Toolbar
The Toolbar page allows you to configure the appearance of the toolbar. It contains the following:
Table 17. Toolbar
Element

Description

Toolbar Skin Name

Allows you to enter the skin name for the toolbar.

Show New Button

Allows you to display the New button.

Show Connect To Outlook
Button

Allows you to display the Connect to Outlook button.

Show Alert Me Button

Allows you to show the Alert Me button in the toolbar.

Legend
The Legend page allows you to configure the appearance of the legend. It contains the following:
Table 18. Legend
Element

Description

Legend Title

Allows you to enter a title of the legend.

Legend Color Appearance

Allows you to select the list title and color and font color for a list that your
selected in Viewed Lists.

Show Legend

Allows you to show the legend.

Legend Show Mode

Allows you to select where to position the legend.

Legend Show User Groups

Allows you to select the SharePoint members who can view the legend.

Legend Hide User Groups

Allows you to select the SharePoint members who cannot view the legend.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Calendar
The Calendar page contains the following:
Table 19. Calendar
Element

Description

Skin Name

Allows you to enter the skin name for the calendar view.

Calendar Width

Allows you to enter the width of the calendar view in pixels. The default is 700.

Calendar Width Unit Allows you to enter unit of measure for the calendar width.
Calendar Height

Allows you to enter the height of the calendar view in pixels. The default is 500.

Row Height

Allows you to specify the row height for each day/week view and the appointment for
the month view in pixels.

Month View Visible
Appointments Per
Day

Allows you to enter the number of appointments visible per day when in the month
view. The default is 3.

Overflow Behavior

Allows you to o scroll or expand the page when the calendar view is not large enough to
display all the data.

Default Calendar
View

Allows you to set the default view for the Calendar web part. This can be either Day,
Week or Month.

Enable Day View

Allows you to switch to view one day at a time in the Calendar web part

Enable Week View

Allows you to switch to view one week at a time in the Calendar web part.

Enable Month View

Allows you to switch to view one month at a time in the Calendar web part.

First Day of Week

Allows you to determine the first day that is displayed in the week view and month
view. The default value is Sunday.

Last Day of Week

Allows you to determine the last day that is displayed in the week view and month view.
The default value is Saturday.

Allow Delete

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 19. Calendar
Element

Description

Appearance Field
Name

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:

Color Appearance

•

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

Allows you to determine the color of the appointment for a certain value in the field
specified by the Appearance Field Name. Turn on Advanced Mode if you want to edit
Color Appearance in XML:

For example:

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 wellknown 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.

Context Menu
The Context Menu page contains the following:

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 20. Context Menu
Element

Description

Enable Context Menu

Allows you to show the context menu.

Context Menu Skin Name

Allows you to set he skin name for the context menu.

Show View Properties

Allows you to show the View Properties menu item in the context menu.

Show Edit Properties

Allows you to show the Edit Properties menu item in the context menu.

Show Manage Permissions

Allows you to show the Manage Permissions menu item in the context menu.

Show Alert Me

Allows you to show the Alert Me menu item in the context menu.

Show Workflows

Allows you to show the Workflows Properties menu item in the context
menu.

Layout
The Layout page allows you to set the overall layout of the web part. It contains the following:
Table 21. Layout
Element

Description

Width

Allows you to set the web part to a fixed width

Height

Allows you to set the web part to a fixed height

Chrome State

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.

Chrome Type

Allows you to select the kind of border to display around the web part.

Hidden

Select this check box if you want the web part hidden

Direction

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

Other
The Other page allows you to set the appearance of other elements in the web part. It contains the following:
Table 22. Other
Element

Description

Allow Minimize

Select this check box if you want the web part minimized

Allow Close

Select this check box if you want the web part removed from the page

Allow Hide

Select this check box if you want the web part hidden

Allow Zone Change

Select this check box if you want the web part moved to a different zone

Allow Connections

Select this check box if you want the web part to participate in connections to
other web parts

Allow Editing in Personal View

Select this check box if you want the web part modified in a personal view

Export Mode

Allows you to select the level of data that can be exported for this web part

Title URL

Allows you to add the title of a URL as extra information about the web part

Description

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.

Help URL

Allows you to enter the location of a file containing Help information about
the web part.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 22. Other
Element

Description

Help Mode

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)

Catalog Icon Image URL

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.

Title Icon Image URL

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.

Import Error Message

Allows you to specify a message that appears if there is a problem importing
the web part

Advanced Page
The Advanced page allows you to set advanced features of the web part, such as the following:
•

Security

•

Resources

Security
The Security page allows you to set which users are allowed to view the web part. It contains the following:
Table 23. Security
Element

Description

Show User
Groups

Allows you to list SharePoint groups whose members can view the Web Part. Separate groups
with commas.

Hide User
Groups

Target
Audiences

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.

Resources
The Resources page allows you to enable Localization in the web part using resource lists.

Localization
Localization contains the following elements.
NOTE: While this feature is still available to use, we recommend using ezLocalizer. For more information,
see ezLocalizer on page 385.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 24. Localization
Element

Description

Resource List

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 Lists element can contain only one List element. The following are the attributes
for the List element:

Title Resource ID

•

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.

View Properties Context Allows you to set the text for the View Properties context menu.
Menu Text Resource ID
Edit Properties Context
Menu Text Resource ID

Allows you to set the text for the Edit Properties context menu.

Manage Permissions
Context Menu Text
Resource ID

Allows you to set the text for the Manage Permissions context menu.

Alert Me Context Menu
Text Resource ID

Allows you to set the text for the Alert Me context menu.

Workflows Context
Menu Text Resource ID

Allows you to set the text for the Workflows context menu.

New Button Text
Resource ID

Allows you to enter a text resource ID for the New button.

Connect to Outlook
Allows you to enter a text resource ID for the Connect to Outlook button.
Button Text Resource ID
Alert Me Button Text
Resource ID

Allows you to enter a text resource ID for the Alert Me button.

Filter Button Text
Resource ID

Allows you to enter a text resource ID for the Filter button.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

3
qCaptionDisplay
•

Overview

•

qCaptionDisplay Pages

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.
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:
This field is mandatory. It is a single-line text field that contains the identifier for the

•

Caption ID
caption.

•

Caption

•

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:

—

This field is mandatory. This is a multiple-line text field that contains the message.

Table 1. Culture
Caption ID

Culture

sites.mysite.default.aspx
sites.mysite.default.aspx

Caption
Welcome to my site

id-ID

Selamat datang ke situs saya

NOTE: Make sure that the Allow rich HTML text in the Caption field is set to No.
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.
NOTE: The Caption field can contain plain text or a piece HTML.
You can create the source by selecting AgreeYa Caption Display List (under Custom Lists in SharePoint). 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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

qCaptionDisplay Pages
You can configure this web part through its tabs that are accessible through ezEdit. qCaptionDisplay contains
the following tabs:
•

Content Page

•

Appearance Page

•

Advanced Page

Content Page
The Content page allows you to enter the content for your web part. It contains the following:
•

Primary Content

Description

Title

Allows you to enter a title for the Web Part. This field is mandatory.

Site URL

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.

List Name

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.

Caption ID

Allows you to enter the identifier that locates the message in the list.

Caption ID Field Name

Allows you to enter the name of the field containing the caption ID. The default
value is User Caption ID.

Caption Field Name

Allows you to enter the name of the field containing the message. The default value
is Caption.

Culture Field Name

Allows you to enter the name of the field containing the Culture. The default value is
User Culture.

Appearance Page
The Appearance page allows you to set the overall look and feel of the web part. This page contains the
following:
•

Ribbon

•

Layout

•

Other

Ribbon
The Ribbon page allows you to set the display name of the Ribbon.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 3. Ribbon
Element

Description

SharePoint Ribbon Tab
Name

Allows you to edit the display name of the Ribbon tab.

Layout
The Layout page allows you to set the overall layout of the web part. It contains the following:
Table 4. Layout
Element

Description

Width

Allows you to set the web part to a fixed width

Height

Allows you to set the web part to a fixed height

Chrome State

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.

Chrome Type

Allows you to select the kind of border to display around the web part.

Hidden

Select this check box if you want the web part hidden

Direction

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

Other
The Other page allows you to set the appearance of other elements in the web part. It contains the following:
Table 5. Other
Element

Description

Allow Minimize

Select this check box if you want the web part minimized

Allow Close

Select this check box if you want the web part removed from the page

Allow Hide

Select this check box if you want the web part hidden

Allow Zone Change

Select this check box if you want the web part moved to a different zone

Allow Connections

Select this check box if you want the web part to participate in connections to
other web parts

Allow Editing in Personal View

Select this check box if you want the web part modified in a personal view

Export Mode

Allows you to select the level of data that can be exported for this web part

Title URL

Allows you to add the title of a URL as extra information about the web part

Description

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.

Help URL

Allows you to enter the location of a file containing Help information about
the web part.

Help Mode

Catalog Icon Image URL

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 5. Other
Element

Description

Title Icon Image URL

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.

Import Error Message

Allows you to specify a message that appears if there is a problem importing
the web part

Advanced Page
The Advanced page allows you to set advanced features of the web part, such as the following:
•

Security

•

Resources

Security
The Security page allows you to set which users are allowed to view the web part. It contains the following:
Table 6. Security
Element

Description

Show User
Groups

Allows you to list SharePoint groups whose members can view the Web Part. Separate groups
with commas.

Hide User
Groups

Target
Audiences

Resources
The Resources page allows you to enable Localization in the web part using resource lists.

Localization
Localization contains the following elements.
NOTE: While this feature is still available to use, we recommend using ezLocalizer. For more information,
see ezLocalizer on page 385.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 7. Localization
Element

Description

Resource List

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 Lists element can contain only one List element. The following are the attributes
for the List element:

Title Resource ID

www.agreeya.com

•

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.

AgreeYa QuickApps for SharePoint 6.6
User Guide

4
qCascadingMenu
•

Overview

•

qCascadingMenu Pages

•

qCascadingMenu Procedures

Overview
The qCascadingMenu lets you create complex menus that occupy minimum screen real estate.
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 AgreeYa 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 45. This automatically creates a list which contains the
following columns by default:
Table 1. List Columns
Column

Description

Text

Provide the text for the menu item.

Menu ID

Provides the ID for the menu item.

Parent Menu ID Provides the ID of the menu item that is the parent of this menu item.
Target Url

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.

Target

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.

Icon Url

Provides the URL to the icon for the menu item.

Access Key

Indicates the shortcut key to activate the menu item. You can activate the menu item by
pressing ALT+Access Key Character.

Culture

Indicates the culture for this menu item

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

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 40. For more
information on how to configure the qCascadingMenu Web Part, see Configuring qCascadingMenu on page 45.

qCascadingMenu Pages
You can configure this Web Part through its tabs that are accessible through ezEdit. qCascadingMenu contains
the following tabs:
•

Content Page

•

Behavior Page

•

Appearance Page

•

Advanced Page

Content Page
The Content page allows you to enter the content for your web part. It contains the following:
•

Primary Content

Description

Title

Allows you to enter a title for the Web Part, or accept the default. This field is
mandatory.

Configuration

See Configuration on page 40.

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.
You can define the following in the Configuration section:

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 3. Configuration
Field

Description

Advanced Mode

Turn on Advanced Mode if you want to edit Configuration in XML format:

Site URL

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.

List Name

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.

Filter Expression

Allows you to filter the data. The Complex Filter Expression to filter the data. For
more information, see Complex Filters on page 21.

Text Field Name

Allows you to set the field that contains the text for the menu item.

Menu ID Field Name

Allows you to set the name of the field that contains the menu ID for the menu item.

Parent Menu ID Field
Name

Allows you to set the name of the field that contains the parent ID for the menu item.

Target URL Field
Name

Allows you to set the name of the field that contains the indicator of where to open
the target URL.

Target Field Name

Allows you to set the name of the field that contains the indicator of where to open
the target page.

Icon URL Field Name

Allows you to set the name of the field that contains the icon URL for the menu item.

Culture Field Name

Allows you to set the name of the field that contains the culture for the menu item.

Access Key Field
Name

Allows you to set the name of the field that contains the access key for the menu item.

Show User Groups

Allows you to show groups where the user is a member of one of the SharePoint groups
listed. Separate site group names with commas.

Hide User Groups

Allows you to hide groups where the user is member of one of the SharePoint groups
listed. Separate site group names with commas.

Check User Access

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)

Behavior Page
The Behavior page allows you to configure behaviors, such as adding buttons or menus, so the user can perform
operations when using the web part.
The Behavior Page contains the following:
•

Navigation

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Navigation
The Navigation page allows you to configure how and where the user will navigate in the web part. It contains
the following elements:
Table 4. Navigation
Element

Description

Target URL Relative to
Master Page URL

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.

Appearance Page
The Appearance page allows you to set the overall look and feel of the web part. This page contains the
following:
•

Ribbon

•

Layout

•

Other

Ribbon
The Ribbon page allows you to set the display name of the Ribbon.
Table 5. Ribbon
Element

Description

SharePoint Ribbon Tab
Name

Allows you to edit the display name of the Ribbon tab.

Menu
The Menu page allows you to configure the appearance of the menu. It contains the following:
Table 6. Menu
Element

Description

Skin Name

Allows you to enter the skin name for the menu.

Menu Flow

Allows you to select if you want the menu flow horizontal or vertical.

Vertical Flow Width

Allows you to set the width if your menu flow is vertical.

Layout
The Layout page allows you to set the overall layout of the web part. It contains the following:
Table 7. Layout
Element

Description

Width

Allows you to set the web part to a fixed width

Height

Allows you to set the web part to a fixed height

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 7. Layout
Element

Description

Chrome State

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.

Chrome Type

Allows you to select the kind of border to display around the web part.

Hidden

Select this check box if you want the web part hidden

Direction

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

Other
The Other page allows you to set the appearance of other elements in the web part. It contains the following:
Table 8. Other
Element

Description

Allow Minimize

Select this check box if you want the web part minimized

Allow Close

Select this check box if you want the web part removed from the page

Allow Hide

Select this check box if you want the web part hidden

Allow Zone Change

Select this check box if you want the web part moved to a different zone

Allow Connections

Select this check box if you want the web part to participate in connections to
other web parts

Allow Editing in Personal View

Select this check box if you want the web part modified in a personal view

Export Mode

Allows you to select the level of data that can be exported for this web part

Title URL

Allows you to add the title of a URL as extra information about the web part

Description

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.

Help URL

Allows you to enter the location of a file containing Help information about
the web part.

Help Mode

Catalog Icon Image URL

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.

Title Icon Image URL

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.

Import Error Message

Allows you to specify a message that appears if there is a problem importing
the web part

Advanced Page
The Advanced page allows you to set advanced features of the web part, such as the following:
•

Security

•

Resources

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Security
The Security page allows you to set which users are allowed to view the web part. It contains the following:
Table 9. Security
Element

Description

Target
Audiences

Resources
The Resources page allows you to enable Localization in the web part using resource lists.

Localization
Localization contains the following elements.
NOTE: While this feature is still available to use, we recommend using ezLocalizer. For more information,
see ezLocalizer on page 385.
Table 10. Localization
Element

Description

Resource List

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 Lists element can contain only one List element. The following are the attributes
for the List element:

Title Resource ID

www.agreeya.com

•

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.

AgreeYa QuickApps for SharePoint 6.6
User Guide

qCascadingMenu Procedures
You can perform the following procedures using qCascadingMenu:
•

Configuring qCascadingMenu

Configuring qCascadingMenu
To configure qCascadingMenu
1

Create a source list from AgreeYa Menu List in SharePoint. The source list for the cascading menu will
contain the following fields:
•

Text - This field is mandatory. This is a single line of text field that provides the text for the menu
item.

•

Menu Id - This field is mandatory. This is a single line of text field that provides the ID for the
menu item.

•

Parent Menu Id - This field is mandatory. This is a single line of text field that provides the parent
ID for the menu item.

•

Target Url - This field is optional. This is a single line of text field that provides the target URL for
the menu item. Please note that this is not a Hyperlink field because Hyperlink field does not let
you use a relative URL.

•

Target - This field is optional. This is a single line of text field that indicates where to open the
target page.

•

Icon Url - This field is optional. This is a single line of text field that provides the URL to the icon
for the menu item.

•

Access Key - This field is optional. This is a single line of text field (one character) that indicates
the shortcut key to activate the menu item. You can activate the menu item by pressing
ALT+Access Key Character.

•

Culture - This field is optional. This is a single line of text field that indicates the culture for this
menu item.

Create a top-level menu. Click New Item to add information to your source list.

Create an entry in the list with blank Parent Menu Id, for example:
Table 11. Example of cascading menu list that contains two different cultures and invariants
Parent
Menu Id

Target Url

Target

Icon Url

Access
Culture
Key

Text

Menu Id

Public Web
Sites

Web Sites
untuk Publik

Microsoft®

01.01

http://www.microsoft.
com

_blank

search.gif M

Microsoft

01.01

http://www.microsoft.
com

_blank

search.gif M

Google®

01.02

http://www.google.com _blank

search.gif G

http://www.google.com _blank

search.gif G

Google

01.02

Other Places

01.03

Situs Lain

01.03

CNN

01.03.01 01.03

www.agreeya.com

http://www.cnn.com

id-ID

id-ID
id-ID

C
AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 11. Example of cascading menu list that contains two different cultures and invariants
CNN

01.03.01 01.03

http://www.cnn.com

ABC News

01.03.02 01.03

http://www.abcnews.
com

ABC News

01.03.02 01.03

http://www.abcnews.
com

id-ID

The cascading menu can also read any type of list that contains at least the first four fields: Text, Menu
Id, Parent Menu Id and Target Url.
NOTE: If the name of the fields is not specified, you must define the field name mapping in the
Configuration property.
4

Add qCascadingMenu to your site collection page.

Open ezEdit.
The Primary Content page opens by default.

From the Configuration section, select the source list created in SharePoint, and click OK.

Click Edit next to the list name.

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.

If needed, configure the elements in the other tabs.

10 When done configuring each tab, click OK.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

5
qChartView
•

Overview

•

qChartView Pages

•

qChartView Procedures

Overview
qChartView aggregates data from one or more SharePoint lists and displays it in different chart types.
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 Pages
You can configure this web part through its tabs that are accessible through ezEdit. qChartView contains the
following tabs:
•

Content Page

•

Behavior Page

•

Appearance Page

•

Advanced Page

Content Page
When you open ezEdit in qChartView, the Content page opens by default. It contains the following:
•

Primary Content

•

Filtering

•

Search/Filter Panel

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Description

Title

Allows you to add a title for the web part.

Viewed Lists

See Viewed Lists on page 48 for more information

Chart Type

Allows you to select the type of chart used to display the data. For examples of each chart
type, see Sample Charts on page 392.
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.

Configuration

See Configuration on page 49 for more information.

Viewed Lists
This property defines the lists whose data is aggregated in the Chart View.
The following are the elements for the Viewed Lists attribute.
Table 2. Viewed Lists
Element

Description

Advanced Mode

Turn on if you want to edit Viewed Lists in XML format:

Site URL

List Name

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.

Include Subsites

Allows you to search all subsites for a list whose name specified in the ListName, and
aggregate the information from those list.

To denote the current list, you can use a single dot (.) as the list name.

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.
Include This Site

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.

Is Rollup List

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 2. Viewed Lists
Element

Description

Rolled Up List Name

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.

Site URL Field Name

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.

Active Field Name

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.

Configuration
This property defines how the data should be grouped in the X Axis and the data series for the chart.
The Configuration element should contain only one X-Axis and one Series element. Each Series element may
contain one or more Items element.
The Configuration section contains the following:
Table 3. Configuration
Element

Description

Advanced Mode

Turn on if you want to edit Configuration in XML format:

Query All Fields

www.agreeya.com

Controls how Web Parts behave in relation to the Chart View Lookup Threshold in
SharePoint Resource Throttling. The options are:
•

Default — uses the level set in the Configuration Editor. If you have
selected Query All Fields check box in the Configuration Editor, the Web
Part will query only those fields that are not included in the Chart View
Lookup Threshold. If the Query All Fields check box is cleared, the Web
Part will query all fields.

•

On — If the Web Part level is On, the Web Part queries all fields in lists,
except Lookup fields.

•

Off — If the Web Part level is Off, the Web Part queries all fields in lists,
including Lookup fields.

•

Explicit — If the Web Part level is Explicit, the Web Part queries only those
fields selected in the Display Fields. This option renders the best
performance for your Web Part.

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 3. Configuration
Element

Description

Field Name

Specifies the name of the field that corresponds to the x axis data. This attribute
is mandatory. The field name is case sensitive.

Case Sensitive Calculations 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.
Display Only Those X-Axis
Values That Contain Data

Select this check box if you want to display only X-axis values that contain data.
If this check box is not selected, all X-axis values are displayed on the chart.
NOTE: This is applicable only if you have selected Choice (menu to choose from)
as the Column type for your Field Name property.

Sort By

Allows you to select how you want to group the data on the chart, either by field
name or data series number. The value of this property does not have to be the
same as the value in the Field Name attribute.

Sort Order

Specifies how the values in the column specified by the Sort By should be
ordered, either ascending or descending.

If you want to add a data series, configure the following:
Table 4. Data Series
Element

Description

Field Name (for Data
Series)

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.

Aggregate Function

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.

Series Name

Allows the series name to be displayed in the legend as the title in case of
multiple data series.

Chart Series Type

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.

Filter Expression

Defines the filter that is applied for the data in this series. The filter is defined
using the Complex Filter. For more information, see Complex Filters on page 21.

Filter Field Name

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.

Drill Down Chart URL

Determines the URL of the page that contains the drill down chart for this data
series.

Show Values

Allows you to determine whether to show the values for this dataset.
NOTE: This attributes is only applicable for a multi-series chart.

Include in Legend

Allows you to determine whether to include the series name of this dataset in the
legend.
NOTE: This attribute is only applicable for a multi series chart.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 4. Data Series
Parent Y Axis

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.
NOTE: This attribute is only applicable for a chart with a dual y axis.

Hide

Allows you to sort a data series that will not be displayed on the chart.
NOTE: This option is only valid for multi-series charts only.

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.
If you are using Advanced Mode, here is the XML:

The following shows the resulting chart

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Figure 1. Example of Configuration Property chart

Description

CAML Filter

Int/Tinyint/Smallint/float and 'Begins With' & 'Contains'

•

Bit (Boolean) and 'Contains'

•

Money and 'Contains'

For more information, see CAML Filters on page 19.
Complex Filter

Search/Filter Panel
The Search/Filter Panel allows you to define the panels for search, filter, and replace in the web part.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

The Search/Filter Panel contains the following elements:
Table 6. Search/Filter Panel
Element

Description

Searched Fields

See Searched Fields on page 53.

Turn On List View Link Allows you to link this chart view with qListView. When selected, the chart view will
Mode
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.
Turn On List Searcher
Mode

Allows you to perform a search before the chart view displays any data.

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 (only Lookup to a
Single Text field and Lookup to a Number field are supported), Person or Group
and Hyperlink or Picture. If the list contains a Lookup to Number field, Search
All Fields will not work for negative numbers for that field. 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’

Expand Filter panel
on Load

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.

Panel Button Location 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.

Searched Fields
This property defines what fields are displayed in the Search Filter panel.
You will be able to perform a search by pressing Enter.
NOTE: Pressing Enter will not allow you to perform a search on such fields as external data, people picker,
managed metadata, and a drop-down list. Instead, the default behavior will occur.
NOTE: For the Number type field, the “Contain” operator is not supported for negative numbers, and is
not available for the following fields: Lookup to DateTime field, Lookup to Calculated field, and Lookup to
ID field.
You can further edit fields using the following elements:

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 7. Searched Fields
Element

Description

Advanced Mode Turn on if you want to edit Searched Fields in XML format:

Field Name

Indicates the element you are editing.

Title

Displays title for the field. The value can be a plain string or an encoded HTML string.

Description

Describes the field. This is useful if you want to give a short instruction or explanation about
the field.

Default Value

Default
Operator

Defines the default operator for the field.

Fixed Operator

Defines the operator for the field. If specified, the list to select the operator for this field is
turned off.

Use People
Editor

Enables you to enter any user information that is in your directory service.

Column Count

Defines the number of columns for the options in a multi-choice field or in a choice-andlookup 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.

Enable Multi
Choice

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.

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.

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.
Sort Field

Defines the field that is used to sort the value in the list. The field name is case sensitive.

Sort Order

Allows you to sort the values in ascending or descending order.

AutoPostBack

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.

Parent Field

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.

Parent Filter
Field Name

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.

Filter Field
Name

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 7. Searched Fields
Element

Description

Display Field
Name

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.

Display Format

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: If you are using Advanced Mode, 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.
NOTE: For more information, see Display Format on page 14.

Site URL

Indicates the Site URL of the field. You can use an absolute or relative URL.

List Name

Indicates the name of the List. The field name is case sensitive.

Site Name

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.

Views

Views
Table 8. Views
Element

Description

Search Session Name 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.

Appearance Page
The Appearance page allows you to set the overall look and feel of the web part. This page contains the
following:
•

Ribbon

•

Chart

•

Toolbar

•

Layout

•

Other

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Ribbon
The Ribbon page allows you to set the display name of the Ribbon.
Table 9. Ribbon
Element

Description

SharePoint Ribbon Tab
Name

Allows you to edit the display name of the Ribbon tab.

Chart
The Chart Page allows you to define characteristics of your charts.
Chart Appearance contains the following elements
Table 10. Chart Appearance
Element

Description

Chart Width

Allows you to specify the width of the chart in pixels.

Chart Height

Allows you to specify the height of the chart in pixels.

Chart Attributes

For more information, see Chart Attributes on page 56.

Trend Lines

For more information, see Trend Lines on page 75.

Style

For more information, see Styles on page 76.

Series Appearance

For more information, see Series Appearance on page 82.

Chart Attributes
Advanced Mode
Turn on Advanced Mode if you want to edit Chart Attributes in XML format.

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.
Table 11. Title and Axis
Element

Description

Caption

Allows you to add a title.

Sub-caption

Allows you to add a subtitle to your chart.

X-Axis Name

Allows you to set the x-axis name.

Y-Axis Name

Allows you to seta y-axis name.

Rotate 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.

Y Axis Name Width

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.
www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Shown below is a chart with a border around the chart.
Figure 2. Border around chart

Table 12. Border and Background
Element

Description

Show Border

Allows you to show a border around the chart. By default, it is set to true in 2D
charts and false in 3D charts.

Border Color

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.

Border Thickness

Allows you to set the border thickness of the chart (in pixels).

Border Alpha

Allows you to set the border alpha (transparency) of the chart. The range is from 0100.

Background Color

Allows you to fill the background as gradient. If you need to define two (or more)
colors, separate them by a comma.

Background Alpha

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

Background Ratio

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".

Background Angle

Allows you to set the angle of the gradient fill.

Background Image or
SWF URL

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.

Background Image or
SWF Alpha

Allows you to configure the alpha of the background (loaded) image using this
property.

If you specify an absolute URL, the background image will not be shown.

Chart Canvas
Canvas refers to the area in which the chart is plotted.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Figure 3. Canvas

Table 13. Canvas
Element

Description

Canvas Border Color

Allows you set the border color for the Canvas. Use hex color code. To use the
color picker, click on the color swatch square.

Canvas Border Thickness

Allows you set thickness of canvas border (in pixels)

Canvas Border Alpha

Allows you set alpha for canvas border.

Canvas Background Color

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.

Canvas Background Alpha

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.

Canvas Background Ratio

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".

Canvas Background Angle

Allows you to set the angle of the gradient fill (in degrees - 0-360).

Show Canvas Background

Allows you to set the canvas background for a 3D chart (and canvas).

Show Canvas Base

Allows you to set the canvas base for a 3D chart (and canvas).

Canvas Background Depth

Allows you to set the depth of canvas background for a 3D chart (and canvas).

Canvas Base Depth

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 element.
The color must be in hex code format (RRGGBB) without #.

....

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Figure 4. Data Plot

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=''

....

Figure 5. Data Plot with solid fills

Table 14. Data Plot
Element

Description

Plot Gradient Color

Allows you to globally add a gradient color to the entire plot (column, area) of chart
by specifying a color as its attribute.

Plot Fill Angle

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.

Plot Fill Ratio

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.

Plot Fill Alpha

Allows you set the fill alpha for gradient if you've opted to fill the plot (column, area)
as gradient.

Show Plot Border

Allows you to show or hide the plot border. By default, each data plot (column, area,
pie) shows a border.

Plot Border Dashed

Allows you to make the plot border dashed by setting this attribute to true.

Plot Border Dash
Length

Allows you to set the length of each dash.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 14. Data Plot
Element

Description

Plot Border Dash Gap

Allows you to set the gap between each dash.

Use Round Edges

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.

Data Labels
Data labels refer to the names for the data points that appear on the x-axis.
Figure 6. Data Labels

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.
Table 15. Data Labels
Element

Description

Show Labels

Allows you to show the data labels.

Label Display

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.
Slant Labels

Allows you to slant the labels at 45 degrees if you are using the Rotate mode for the Label
Display.

Stagger Lines

Allows you to choose the number of lines to stagger the labels if you are using the Stagger
mode for the Label Display.

Label Step

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Data Values
Data values refer to the plot values such as line, column, and bar displayed beside it.
Figure 7. Data Values

In the chart shown above, the dollar values appearing above the column are the data values.
Table 16. Data Values
Element

Description

Show Values

Allows you to show data values. By default, the data values are shown. To hide them, set
this attribute to false.

Rotate Values

Allows you to rotate the values. By default, the chart will show the data values
horizontally.

Place Values
Inside

Allows you to place the data values inside the columns.

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Figure 8. External Logo

Table 17. External Logo
Element

Description

Logo URL

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.

Logo Position

Allows you to set the position of the logo can be configured using this attribute.

Logo Alpha

Allows you to set the opacity of the logo once it has loaded.

Logo Scale

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.

Logo Link

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 75.

Font Properties
You can specify generic font properties for all the text on the chart using the attributes given below.
Table 18. Font Properties
Element

Description

Base Font Name

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.

Base Font Size

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.

Base Font Color

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.

Outside Canvas Base
Font Name

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 18. Font Properties
Element

Description

Outside Canvas Base
Font Size

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

Outside Canvas Base
Font Color

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

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.
Table 19. Chart Palettes
Element

Description

Palette

Allows you to select the palette number.

Palette Colors

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.
.

Table 20. Y Axix
Element

Description

Y Axis Min Value

Allows you to set the chart limits explicitly.

Y Axis Max Value

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.

Set Adaptive Y Min

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.

Primary Y Axis Min Value 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.
Primary Y Axis Max Value 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.
Secondary Y Axis Min
Value

www.agreeya.com

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.
AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 20. Y Axix
Element

Description

Secondary Y Axis Max
Value

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.

Primary Y Axis Name

Allows you to set the primary y-axis title.

Secondary Y Axis Name

Allows you to set the secondary y-axis title.

Set Adaptive Secondary
Y Min

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.

Primary Y Axis Name
Width

Allows you to set choose a maximum width (in pixels) that is applied to primary yaxis name, if you do not rotate y-axis name.

Secondary Y Axis Name
Width

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.
Figure 9. Division Lines

Table 21. Division Lines
Element

Description

Adjust Division Lines

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 yaxis upper and lower limits using the Y Axis Max Value and Y Axis Min Value
attributes respectively.

Number of Division Lines

Allows you to set the number of divisional lines.

Div Line Effect

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.

Show Y Axis Values

Allows you to show all the y-axis values.

Y Axis Values Step

Allows you to skip every nth Y Axis value.

Division Lines

Allows you to set the color for divisional lines.

Division Lines Thickness

Allows you to set the thickness of divisional lines. The range is from 1 - 5.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 21. Division Lines
Element

Description

Division Lines Alpha

Allows you to set the alpha of divisional lines. The range is from 0 - 100.

Is Dashed

Allows you to set the divisional line to be dashed.

Division Lines Dash Length

Allows you to set the length of each dash.

Division Lines Dash Gap

Allows you to set the gap between each dash.

Show Alternate H Grid
Color

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.

Alternate H Grid Color

Allows you to set the color of the horizontal grid bands.

Alternate H Grid Alpha

Allows you to set the alpha of the horizontal grid bands. The range is from 0 100.

Vertical Div Lines

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.

Number of Vertical Div
Lines

Allows you to set the number of vertical div lines.

Vertical Div Lines Color

Allows you to set the color of the vertical axis division lines.

Vertical Div Lines Thickness Allows you to set the thickness of the vertical axis division lines in pixels.
Vertical Div Lines Alpha

Allows you to set the alpha of vertical axis division lines. The range is from 0 100.

Is Dashed

Allows you to set the vertical axis division lines as dashed.

Vertical Div Lines Dash
Length

Allows you to set the length of each dash.

Vertical Div Lines Dash Gap Allows you to set the gap between each dash..
Show Alternate V Grid
Color

Allows you to set the vertical grid bands alternately between the vertical
divisional lines.

Alternate V Grid Color

Allows you to set the color of the alternate vertical grid bands.

Alternate V Grid Alpha

Allows you to set the alpha (transparency) of the alternate vertical grid bands.

Show V Line Label Border

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.

Zero Plane
Zero plane is a plane which separates the positive and negative numbers on a chart having both of them.
Figure 10. Zero Plane

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 22. Zero Plane
element

description

Show Zero Plane

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.

Zero Plane Color

Allows you set the color of the zero plane.

Zero Plane Alpha

Allows you set the alpha (transparency) of the zero plane. The range is from 0 100.

Zero Plane Thickness

Allows you set the thickness of the zero plane in pixels.

Zero Plane Show Border

Allows you set the whether to show border of zero plane for a 3D chart.

Zero Plane Border Color

Allows you set the border color of zero plane for a 3D chart.

Zero Plane Mesh

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.

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.
Figure 11. Anchors

Table 23. Anchors
Element

Description

Draw Anchors

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.

Anchor Alpha

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’

Anchor Sides

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.

Anchor Radius

Allows you to set the radius (in pixels) of the anchor. The greater the radius, the bigger
the anchor size.

Anchor Border Color

Allows you to set the border color of anchors.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 23. Anchors
Element

Description

Anchor Border
Thickness

Allows you to set the border thickness (in pixels) of the anchors.

Anchor Background
Color

Allows you to set the background color of anchors.

Anchor Background
Alpha

Allows you to set the alpha of anchor background. The range is from 0 - 100.

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

Figure 12. Tool Tip

Table 24. Tool Tip
Element

Description

Show Tool Tip

Allows you to set the tool tip.

Show Tool Tip Shadow

Allows you to show the tool tip shadow.

Tool Tip Border Color

Allows you to customize the border color of the tool tip.

Tool Tip Background Color

Allows you to customize the background color of the tool tip.

Tool Tip Separator Character Allows you to specify a character to separate the name and value displayed in
tool tip.
Series Name in Tool Tip

Allows you to control whether series name will appear in the tool tip. For multiseries and combination charts, qChartView shows the following information in
tool tip (unless tool text is explicitly defined): "Series Name, Category Name,
Data Value".

Show Percent In Tool Tip

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
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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Figure 13. Paddings and Margins

Table 25. Paddings and Margins
Element

Description

Left Margin

Allows you to set the amount of empty space on the left side of your chart. Nothing is
rendered in this space.

Right Margin

Allows you to set the amount of empty space on the right side of your chart. Nothing is
rendered in this space.

Top Margin

Allows you to set the amount of empty space ton the top of your chart. Nothing is
rendered in this space.

Bottom Margin

Allows you to set the amount of empty space on the bottom of your chart. Nothing is
rendered in this space.

Canvas Left Margin

Allows you to set the amount of empty space on the left side of the canvas. Nothing is
rendered in this space.

Canvas Right Margin

Allows you to set the amount of empty space on the right side of the canvas. Nothing is
rendered in this space.

Canvas Top Margin

Allows you to set the amount of empty space t on the top of the canvas. Nothing is
rendered in this space.

Canvas Bottom
Margin

Allows you to set the amount of empty space on the bottom of the canvas. Nothing is
rendered in this space.

Caption Padding

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.

X Label Gap

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.

Y Label Gap

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.

X Axis Name Padding

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).

Y Axis Name Padding

Allows you to set the padding between the y-axis name and values.

Y Axis Values Padding Allows you to set the padding between the left end of the chart canvas and the y-axis
values.
Label Padding

Allows you to set the vertical space between the canvas bottom edge and the data
labels.

Value Padding

Allows you to control the space between your columns/anchors and the value
textboxes.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 25. Paddings and Margins
Element

Description

Canvas Padding

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.

Plot Space Percent

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.

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.
Figure 14. Smart Labels and Lines

Table 26. Smart Labels and Lines
Element

Description

Enable Smart Labels

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.

Smart Line Color

Allows you to set the color of smart label connector lines.

Smart Line Thickness

Allows you to set the thickness (in pixels) of smart label connector lines.

Smart Line Alpha

Allows you to set the alpha (transparency) of smart label connector lines. The range is
0 - 100.

Is Smart Line Slanted

Allows you to set the smart lines (smart label connector lines) in two ways: Slanted or
Straight.

Label Distance

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.

Smart Label Clearance Allows you to set the clearance distance of a label (for sliced-in pies) from adjacent
sliced out pies in pixels.
Skip Overlap Labels

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.

Show Percent Values

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

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. A dynamically generated series will be prefixed in
the legend with the series name if a series name has been configured. The legend does not appear for singleseries charts because there is only one series in the chart.
Figure 15. Legend

The legend below the chart helps identify the series name.
Table 27. Legend
Element

Description

Show Legend

Allows you to show the legend.

Interactive 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.

Legend Caption

Allows you to add a caption for the entire legend by setting the same here.

Legend Marker Circle

Allows you to use square legend keys or circular ones.

Reverse Legend

Allows you to reverse the order of items in legend.

Legend Position

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'.

Allow Drag

Allows you to make the legend dragable. End viewers of the chart can drag the
legend around on the chart.

Legend Background
Color

Allows you to set the background color for the legend.

Legend Background
Alpha

Allows you to set the background alpha (transparency) for the legend. The range is 0
- 100.

Legend Border Color

Allows you to set the border color for the legend.

Legend Border
Thickness

Allows you to set the border thickness, in pixels, for the legend.

Legend Border Alpha

Allows you to set the border alpha for the legend. The range is 0 - 100.

Legend Shadow

Allows you to set a shadow for legend.

Legend Scroll
Background Color

Allows you to set the background color of the scroll bar. If you've too many items on
the legend, a scroll bar appears.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 27. Legend
Element

Description

Legend Scroll Bar Color

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.

Legend Scroll Button
Color

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.
.

Table 28. Number Formatting
Element

Description

Format Number

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.

Format Number Scale

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.

Default Number Scale

Allows you to set the default unit of the numbers that you are providing to the chart.

Number Scale Unit

Allows you to set the unit of each block of the scale.

Number Scale Value

Allows you to set the range of the various blocks that constitute the scale.

Number Prefix

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.

Number Suffix

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.

Decimal Separator

Allows you to specify the character to be used as the decimal separator in a number.

Thousand Separator

Allows you to specify the character to be used as the thousands separator in a
number.

In Decimal Separator

Allows you to input the decimal separator.

In Thousand Separator

Allows you to input the thousand separator.

Decimals

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.

Force Decimals

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).

Y Axis Value Decimals

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.
The various elements of a 3D Combination chart are shown below:

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Figure 16. 3D Charts

Table 29. 3D Charts
Element

Description

Is 2D

Allows you to decide whether initially to draw a 2D view of the chart.

Chart Order

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'.

Chart On Top

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. +

Auto Scaling

Allows you to decide whether or not the chart is allowed to best fit automatically
after a user interaction, for example, rotation.

Allow Scaling

Allows you to set whether to allow zoom-in/zoom-out.
NOTE: Scaling or use of mouse is compatible only with Windows® Operating System.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 29. 3D Charts
Element

Description

Animate 3D

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 . 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 but, enable
animation of the 3D canvas.

Exe Time

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).

Camera Angle
X/Camera Angle Y

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.
Start Angle X/End
Angle X

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/End
Angle Y

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/Light
Angle Y

Light Angle X — Allows you to specify the angular position of the light source (for Xaxis) 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 Yaxis) w.r.t the chart world coordinate system. The range is from 0 to 360 and 0 to -360.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 29. 3D Charts
Element

Description

Intensity

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.

Dynamic Shading

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.

Bright 2D

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.

Allow Rotation

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.

Constrain Vertical
Rotation

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.

Minimum Vertical
Rotation Angle

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.

Maximum Horizontal
Rotation Angle

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.

Z Depth

Allows you to set the depth (3D thickness) of each DATAPLOT object using zDepth
attribute.

Z Gap Plot

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.

YZ Wall Depth

Allows you to set the depth of the YZ wall of 3D chart.

ZX Wall Depth

Allows you to set the depth of the ZX wall of 3D chart.

XY Wall Depth

Allows you to set the depth of the XYwall of 3D chart.

Clustered

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 QuickApps for SharePoint" context menu item to show your label and link it
to your own URL using the below attributes.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

Table 30. Custom About Menu
Element

Description

Show About Menu
Item

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 QuickApps for
SharePoint" when right-clicked.

About Menu Item
Label

Allows you to set a menu item label for the custom context menu item.

About Menu Item Link 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.
Table 31. Functional
Element

Description

Animation

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 . Animate 3D
can override this value. By default, animation is set to true.

Click URL

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:
Table 32. Trend Lines
Element

Description

Advanced Mode

Turn on if you want to edit Trend Lines in XML format.

Start Value

Allows you to set the start value for the trend line

End Value

Allows you to set the ending y-axis value for the trend line

Display Value

Allows you to display a string caption for the trend line by its side

Color

Allows you to set the color of the trend line and its text

Is Trend Zone

Allows you to set the trend as a zone rather than a line

Thickness

Allows you to set the thickness of the trend line

Alpha

Allows you to set the alpha transparency of the trend line

Dashed

Allows you to set the trend line as a dashed line

Dash Length

Allows you to set the length of each dash in pixels

Dash Gap

Allows you to set the gap length between each dash

Value on Right

Allows you to show if the trend line is on the right or left side of the chart

Tool Text

Allows you to show tool text when hovered over a trend line

Parent Y Axis

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.

www.agreeya.com

AgreeYa QuickApps for SharePoint 6.6
User Guide

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.
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:
Table 33. Styles
Element

Description

Advanced
Mode

Turn on if you want to edit Styles in XML format: