Showing posts with label CAML. Show all posts
Showing posts with label CAML. Show all posts
Friday, 29 November 2013
Get items from 3lists with CAML query
SharePoint and List Joins with CAML
This came to me as an issue when I started migrating one project from SharePoint 2010 to SharePoint 2013. The code uses LINQ to SharePoint and it was not written in a clever way. We decide to use CAML queries and optimize the code.
The scenario: Create gridview that gathers information from three(or more) lists.
The problem: How to create the CAML query joins and projected fields correctly.
Explanation:
Option 1: Get generated CAML query from LINQ to SharePoint code
This doesn’t work. I wrote the LINQ to SharePoint code connected the three lists. When I executed the code the following error was thrown – “The query uses unsupported elements, such as references to more than one list, or the projection of a complete entity by using EntityRef/EntitySet.” Here is some explanation about it and why this can’t be used.
Option 2: Write the query yourself
I found this article in MSDN. Read it !
The second part in it is exactly my scenario. But it takes me a lot of time to understand how exactly to write this in server-side code. So here is a working code of the described scenario:
And yes, this works but what if we want to get more columns. Here is same scenario but more complicated.
I have added new colums and added new projected fields in the query.
The following code get all the additional data:
Some important points:
1. Only the Order’s list columns can be used with their real internal names.
2. The other columns are all projected and there are limitaton of the column's type. For example the 'Contact Person' column in my scenario can't be a Lookup or Person and Group.
3. The type of the projected field is always ‘Lookup’
4. ShowField is the value of the internal names of the fields
5. The ListAlias and List in the Join statement are not the real names(or Urls) of the list. The next Join statement is equal to the above one:
End.
Thursday, 28 November 2013
Retrieving list data using CAML to display in gridview
Question: What is retrieving list data using CAML?
In simple terms "It enables retrieve list data using SPQuery with CAML based notation".
Step 1: Open SharePoint 2010 Central Administration and navigate to a specific site.
Step 2: Open up Visual Studio 2012 and try to "SharePoint Visual Web Part" project, as in:
Step 1: Open SharePoint 2010 Central Administration and navigate to a specific site.
Step 2: Open up Visual Studio 2012 and try to "SharePoint Visual Web Part" project, as in:
Step 3: Select "Deploy as a farm solution" as in the following and click the "Finish" button.
Step 4: The complete code of visualwebpart1usercontrol.ascx looks like this:
<%@ Assembly Name="$SharePoint.Project.AssemblyFullName$" %>
<%@ Assembly Name="Microsoft.Web.CommandUI, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="SharePoint" Namespace="Microsoft.SharePoint.WebControls"
Assembly="Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="Utilities" Namespace="Microsoft.SharePoint.Utilities" Assembly="Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Register TagPrefix="asp" Namespace="System.Web.UI" Assembly="System.Web.Extensions, Version=3.5.0.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35" %>
<%@ Import Namespace="Microsoft.SharePoint" %>
<%@ Register TagPrefix="WebPartPages" Namespace="Microsoft.SharePoint.WebPartPages"
Assembly="Microsoft.SharePoint, Version=14.0.0.0, Culture=neutral, PublicKeyToken=71e9bce111e9429c" %>
<%@ Control Language="C#" AutoEventWireup="true" CodeBehind="VisualWebPart1.ascx.cs"
Inherits="RetrieveListDataUsingCAML.VisualWebPart1.VisualWebPart1" %>
<div>
<table style="font-family: Verdana; text-align: center;">
<tr>
<td colspan="2">
<asp:label id="Label1" runat="server" text="Select List Data Using CAML - SharePoint 2010 via Visual Studio 2012"
font-bold="true" forecolor="Maroon" font-size="Large"></asp:label>
</td>
</tr>
<tr>
<td colspan="2">
<asp:button id="Button1" runat="server" text="Retrieve List Data - CAML" forecolor="Orange"
font-bold="true" backcolor="Black" onclick="Button1_Click" width="261px" />
</td>
</tr>
<tr>
<td colspan="2">
<asp:label id="Label4" runat="server" font-bold="true"></asp:label>
</td>
</tr>
<tr>
<td align="center">
<br />
<br />
<asp:gridview id="GridView1" runat="server" backcolor="LightGoldenrodYellow" bordercolor="Tan"
borderwidth="1px" cellpadding="2" enablemodelvalidation="True" forecolor="Black"
gridlines="None" autogeneratecolumns="False"><AlternatingRowStyle BackColor="PaleGoldenrod"/><FooterStyle BackColor="Tan" /><HeaderStyle BackColor="Tan" Font-Bold="True" /><PagerStyleBackColor="PaleGoldenrod" ForeColor="DarkSlateBlue" HorizontalAlign="Center" /><SelectedRowStyleBackColor="DarkSlateBlue" ForeColor="GhostWhite" /><Columns><asp:BoundField DataField="ID"HeaderText="Student Id" ReadOnly="true" SortExpression="ID" /><asp:BoundField DataField="Title"HeaderText="First Name" ReadOnly="true" /><asp:BoundField DataField="LastName" HeaderText="Last Name"ReadOnly="true" /><asp:BoundField DataField="Age" HeaderText="Age" ReadOnly="true" /></Columns></asp:gridview>
</td>
</tr>
</table>
</div>
Step 5: The complete code of visualwebpart1usercontrol.ascx.cs looks like this:
using Microsoft.SharePoint;
using System;
using System.ComponentModel;
using System.Web.UI.WebControls.WebParts;namespace RetrieveListDataUsingCAML.VisualWebPart1
{
[ToolboxItemAttribute(false)]
public partial class VisualWebPart1 : WebPart
{// Uncomment the following SecurityPermission attribute only when doing Performance Profiling using
// the Instrumentation method, and then remove the SecurityPermission attribute when the code is ready
// for production. Because the SecurityPermission attribute bypasses the security check for callers of
// your constructor, it's not recommended for production purposes.
// [System.Security.Permissions.SecurityPermission(System.Security.Permissions.SecurityAction.Assert, UnmanagedCode = true)]
public VisualWebPart1()
{
}
protected override void OnInit(EventArgs e)
{
base.OnInit(e);
InitializeControl();
}
protected void Page_Load(object sender, EventArgs e)
{
}
protected void Button1_Click(object sender, EventArgs e)
{
SPWeb web = SPContext.Current.Web;
SPList list = web.Lists["Student"];
SPQuery query = new SPQuery();
query.ViewFields = "<FieldRef Name='ID'/>" +"<FieldRef Name='Title'/>" + "<FieldRef Name='LastName'/>" +"<FieldRef Name='Age'/>";
SPListItemCollection item = list.GetItems(query);
GridView1.DataSource = item.GetDataTable();
GridView1.DataBind();
}
}
}
Step 6: Deploy the solution file and add the new webpart to a SharePoint site.
Step 7: The output of the application looks like this:
Step 8: The list data output of the application looks like this:
Subscribe to:
Posts (Atom)