SharePoint 2010 Web Parts in Action

SharePoint 2010 WebParts......Page 1
brief contents......Page 8
contents......Page 10
preface......Page 18
acknowledgments......Page 19
How this book is organized......Page 21
Software requirements......Page 22
About the author......Page 23
about the cover illustration......Page 24
about Web Parts......Page 25
Fun Facts......Page 26
Introducing SharePoint 2010 Web Parts......Page 28
Introducing SharePoint 2010 Web Parts......Page 30
1.1 What is a Web Part?......Page 32
1.2 Why use Web Parts?......Page 34
1.3.1 Web Part page......Page 36
1.3.3 Web Part zones......Page 37
1.4 Types of Web Parts......Page 39
1.4.1 ASP.NET 2 Web Parts......Page 40
1.4.2 SharePoint Web Parts......Page 41
1.4.3 Changes in the Web Part infrastructure for SharePoint 2010......Page 42
1.5 Hello World example......Page 43
1.6 SharePoint 2010 pages......Page 44
1.6.2 Site Pages......Page 45
1.7 Summary......Page 49
Using and configuring Web Parts in SharePoint 2010......Page 51
2.1.1 The new SharePoint user interface and the Ribbon......Page 52
2.1.2 Other interface improvements......Page 53
2.2 The Web Part Gallery......Page 54
2.2.1 What is the Web Part Gallery?......Page 55
2.2.3 Editing Web Parts in the gallery......Page 56
2.2.5 Permissions on Web Parts in the gallery......Page 57
2.3.1 SharePoint Foundation 2010......Page 58
2.3.2 SharePoint Server 2010......Page 60
2.4.1 Creating a page using the web interface......Page 65
2.4.2 Adding Web Parts using the web interface......Page 66
2.4.3 Filtering a Web Part using Web Part connections......Page 68
2.5 Customizing and personalizing pages......Page 69
2.5.2 Personal view......Page 70
2.5.4 Maintenance view......Page 71
2.6 SharePoint Designer 2010......Page 72
2.6.1 Adding Web Parts to a page......Page 73
2.6.3 Configuring Web Parts using SharePoint Designer 2010......Page 74
2.6.5 Editing pages and adding zones......Page 75
2.7 Exporting and importing Web Parts......Page 76
2.7.2 Importing a Web Part......Page 77
2.8 Summary......Page 78
Developing SharePoint 2010 Web Parts......Page 80
Building Web Parts with Visual Studio 2010......Page 82
3.1 Requirements for your development environment......Page 83
3.2 Developing for SharePoint 2010 in Visual Studio 2010......Page 84
3.3 Building your first Visual Web Part......Page 86
3.3.1 The Visual Web Part template......Page 87
3.3.2 The SharePoint Customization wizard......Page 88
3.3.3 Explore the SharePoint Project Items......Page 89
3.3.4 Adding functionality to your Visual Web Part......Page 92
3.3.5 Build and deploy the Visual Web Part......Page 94
3.3.6 Take your Web Part for a test drive......Page 96
3.4 Traditional Web Part projects......Page 97
3.4.2 Adding the Web Part to the project......Page 98
3.4.3 Adding controls to the Web Part......Page 100
3.4.5 Testing and debugging your Web Part......Page 101
3.5.2 Upgrading from other project types......Page 102
3.6 SharePoint Project settings in Visual Studio......Page 103
3.7 SharePoint Server Explorer in Visual Studio......Page 104
3.9 Summary......Page 105
Building the user interface......Page 106
4.1.1 Adding controls to the Web Part......Page 107
4.1.2 The event flow for a Web Part......Page 108
4.1.3 Working with view state......Page 112
4.1.4 Using validators......Page 114
4.1.5 Custom controls and user controls......Page 116
4.2.1 Default SharePoint controls in Visual Studio......Page 119
4.2.2 Standard SharePoint controls......Page 120
4.3.1 CSS in SharePoint......Page 124
4.3.2 Custom style sheets......Page 126
4.3.3 SharePoint themes......Page 129
4.3.4 Web compliancy......Page 131
4.3.5 Web Part icons......Page 132
4.4 Web Part verbs......Page 133
4.4.1 Adding verbs to a Web Part......Page 134
4.4.2 Event flow when using Web Part verbs......Page 135
4.5 Summary......Page 136
Making Web Parts customizable......Page 137
5.1.1 Adding a property......Page 138
5.1.2 Customizing the property......Page 141
5.1.3 Custom categories......Page 142
5.1.4 Default values on properties......Page 143
5.1.6 Properties in Visual Web Parts......Page 146
5.1.7 Personalization......Page 147
5.1.9 Static Web Parts......Page 148
5.1.11 Error handling in Web Part properties......Page 149
5.2.1 Appearance properties......Page 150
5.2.3 Advanced properties......Page 151
5.3 Custom Editor Parts......Page 153
5.3.1 Create a custom Editor Part......Page 154
5.3.2 Add the custom Editor Part to the Web Part......Page 155
5.3.3 Validating properties......Page 157
5.3.4 Property dependencies......Page 158
5.3.5 Visual appearance of the Editor Part interface......Page 160
5.4 Advanced properties......Page 162
5.4.1 Define the property......Page 163
5.4.3 Create a type converter......Page 164
5.5.1 The AuthorizationFilter property......Page 167
5.5.2 Create a runtime filter......Page 168
5.5.3 Create the user filter control......Page 170
5.5.4 Register the runtime filter......Page 172
5.5.5 Use the filter......Page 173
5.6 Summary......Page 174
Web Part resources and localization......Page 175
6.1.1 Using the SharePoint root folders......Page 176
6.1.2 Using class resources......Page 178
6.1.3 Embedded resources......Page 180
6.1.4 Resources in SharePoint libraries......Page 182
6.1.5 URL Expression Builder in SharePoint 2010 Server......Page 183
6.2.1 Localization methods......Page 184
6.2.2 Localizing code......Page 186
6.2.3 Localizing Visual Web Part user controls......Page 187
6.2.4 Localizing the Feature......Page 188
6.2.5 Localizing the Web Parts control description file......Page 189
6.2.6 Localizing Web Part properties......Page 190
6.2.7 Localizing using satellite assemblies......Page 192
6.2.8 Localizing style sheets, scripts, and images......Page 194
6.2.9 Other localization considerations......Page 196
6.3 Summary......Page 197
Packaging, deployment, and security......Page 198
7.1.1 Windows SharePoint package files......Page 199
7.1.2 SharePoint Features......Page 200
7.1.3 Safe controls and the RequiresDesignerPermission attribute......Page 205
7.2.1 Solution deployment using PowerShell......Page 207
7.2.2 Feature activation and deactivation......Page 210
7.3 Sandboxed solutions......Page 211
7.3.1 What is sandboxing?......Page 212
7.3.2 Configuring the sandbox......Page 213
7.3.4 Full-trust proxies......Page 214
7.4.1 Building solutions for web application deployment......Page 217
7.4.3 Custom CAS policies......Page 219
7.5 Upgrading solutions......Page 221
7.5.2 Upgrading Features......Page 222
7.5.3 Assembly redirection......Page 224
7.5.4 Upgrading Web Parts......Page 225
7.6 Summary......Page 227
Tools for troubleshooting and logging......Page 228
8.1 Logging and error handling in SharePoint 2010......Page 229
8.1.1 Introducing the correlation id......Page 230
8.1.2 SharePoint trace logs......Page 231
8.1.3 Searching the trace logs......Page 232
8.1.4 Custom logging to trace logs......Page 233
8.1.5 Error handling in sandboxed solutions......Page 234
8.2.1 Attaching to processes......Page 235
8.2.2 Debugging sandboxed solutions......Page 236
8.3.1 Enabling the Developer Dashboard......Page 237
8.3.2 Using the Developer Dashboard......Page 238
8.3.3 Using monitored scopes......Page 239
8.3.4 Logging using scoped performance monitors......Page 240
8.4 Custom error handling......Page 242
8.5 Other debugging tools......Page 244
8.5.1 ASP.NET tracing......Page 245
8.5.3 Fiddler web proxy......Page 246
8.6 Summary......Page 247
Programming and caching for performance......Page 248
9.1.3 Scalability......Page 249
9.2 Programming for performance in SharePoint......Page 250
9.2.1 Proper handling of SharePoint objects......Page 251
9.2.2 Make smarter queries to SharePoint......Page 252
9.2.3 Asynchronous operations......Page 254
9.2.4 Improve performance of resources......Page 257
9.3 Caching techniques......Page 259
9.3.1 ASP.NET caching......Page 260
9.3.2 Caching objects and structures......Page 262
9.3.3 Caching resources......Page 265
9.4 Summary......Page 268
Dynamic interfaces in Web Parts......Page 269
10.1.1 Working with Microsoft ASP.NET AJAX Extensions......Page 270
10.1.2 JavaScripts in Web Parts......Page 273
10.1.3 Working with jQuery......Page 275
10.2.1 Notification messages and the status bar......Page 278
10.2.2 The dialog framework......Page 281
10.3.1 Adding controls to the Ribbon......Page 285
10.3.2 Making a Web Part context aware......Page 290
10.4 Summary......Page 300
The Client Object Model and Silverlight Web Parts......Page 301
11.1.1 What is the ECMAScript Client Object Model?......Page 302
11.1.2 Working with the Client Object Model and Web Parts......Page 303
11.2.1 SharePoint Silverlight Web Part......Page 306
11.2.2 Building a Silverlight SharePoint application......Page 307
11.2.3 Input parameters to the Silverlight Web Part......Page 310
11.2.4 Packaging the Silverlight Web Part......Page 311
11.2.5 Preconfiguring the Silverlight Web Part......Page 313
11.2.6 Custom Silverlight Web Part......Page 314
11.2.7 Enabling custom Silverlight Web Part interaction with SharePoint......Page 316
11.3 Summary......Page 317
Making Web Parts mobile......Page 318
12.1.1 Using the mobile SharePoint 2010 interface......Page 319
12.1.2 Page, form, and Web Part support......Page 320
12.1.4 Supported devices......Page 321
12.1.5 Browser definition files......Page 322
12.2 Mobile Web Part adapters......Page 323
12.2.1 Create a mobile adapter......Page 324
12.2.2 Register a mobile adapter......Page 326
12.3 Mobile controls......Page 332
12.4 Summary......Page 334
Design patterns and testability......Page 336
13.1.1 What are design patterns?......Page 337
13.1.2 Loose coupling......Page 338
13.1.3 Dependency injection......Page 339
13.2.1 The Passive View pattern......Page 340
13.2.3 MVP and Web Parts......Page 342
13.3 SharePoint Service Locator......Page 347
13.3.2 Use the SharePoint Service Locator......Page 348
13.4.1 Unit-testing......Page 353
13.4.2 Creating a test project......Page 354
13.4.3 Mock objects......Page 355
13.4.4 Test the Web Part......Page 356
13.5 Summary......Page 359
Dashboards and connections......Page 360
Connecting Web Parts......Page 362
14.1 Introducing Web Part connections......Page 363
14.2.1 Connecting using the web interface......Page 364
14.2.2 Connecting using SharePoint Designer......Page 365
14.2.3 Connection permissions......Page 366
14.3.1 Connect using custom interfaces......Page 367
14.3.2 Connect using standard connections......Page 373
14.3.3 Ajax and Web Part connections......Page 379
14.4.1 Default filter Web Parts......Page 381
14.4.2 Web Part transformers......Page 382
14.4.3 The ITransformableFilterValues interface......Page 384
14.5 Summary......Page 385
Building pages and dashboards......Page 386
15.1.1 Pages and Web Part zones......Page 387
15.1.2 The Web Part Manager......Page 392
15.2.1 Deploying using a Feature......Page 394
15.2.2 Deploying using a Feature receiver......Page 397
15.2.3 Static dashboards......Page 399
15.2.4 Dashboards with a sandboxed Web Part......Page 401
15.2.5 Deploying using a site definition......Page 403
15.3 Summary......Page 404
appendix: Out-of-the-box Web Parts in SharePoint 2010......Page 406
A.1 SharePoint Foundation 2010 Web Parts......Page 407
A.2 SharePoint 2010 Server Standard Web Parts......Page 412
A.3 SharePoint Server 2010 Enterprise Web Parts......Page 426
A......Page 436
C......Page 437
D......Page 438
F......Page 439
I......Page 440
L......Page 441
O......Page 442
R......Page 443
S......Page 444
U......Page 446
W......Page 447
Z......Page 448