Ajouter une partie Web afin que nous puissions la récupérer plus tard via CSOM?

Question

Comment ajouter une partie Web sur la page de telle sorte que nous puissions la trouver ultérieurement (à l'aide de CSOM) - pouvons-nous en quelque sorte stocker des informations d'identifiant sur la partie Web?Dites que l'utilisateur pourrait modifier le titre et la description (afin qu'ils ne puissent pas être utilisés comme identificateurs).

ou devons-nous utiliser des services Web (ASMX) ..

Modifier

apparaît ASMX est nécessaire. Vadim propose une solution JavaScript ci-dessous. Ici aussi simple code côté serveur (client utilise _vti_bin / webpartpages.asmx)

XElement resultElement = client.GetWebPartProperties2("/SitePages/DevHome.aspx", Storage.Shared, SPWebServiceBehavior.Version3);

var webParts = new List<Dictionary<string,string>>();
foreach (XNode webPartNode in resultElement.Nodes())
{
  var properties = new Dictionary<string,string>();
  XElement element = webPartNode as XElement;
  foreach (XNode propertyNode in element.Nodes())
  {
    XElement propertyElement = propertyNode as XElement;
    if (propertyElement != null)
    {
      properties.Add(propertyElement.Name.LocalName, propertyElement.Value);
    }
  }
  webParts.Add(properties);
}

Edit2 Comme ali points ci-dessous, nous pourrions utiliser le GUID de la partie Web comme identifiant: nous l'obtiendrions lors de la création de la partie Web, de la stocker sur un emplacement externe et de l'utiliser plus tard.Cependant, dans ce cas, nous ne pouvons pas utiliser / stocker cet identifiant mais il faut fournir la nôtre.Ainsi, la seule possibilité restante semble être asmx.

Answer 1

WebPartPagesWebService exposes GetWebPartProperties2 Method that could be used to retrieve information about web parts (eg, WebPartID) on page

For example, the code below demonstrates how to get Web Parts Ids:

function getWebPartProperties(pageUrl,completeFn,errorFn)
{
    var soapEnv =
        '<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">  \
            <soap:Body>  \
                <GetWebPartProperties2 xmlns="http://microsoft.com/sharepoint/webpartpages">  \
                    <pageUrl>' + pageUrl + '</pageUrl>   \
                    <storage>Shared</storage>   \
                    <behavior>Version3</behavior>   \
                </GetWebPartProperties2>  \
            </soap:Body>   \
        </soap:Envelope>';

    $.ajax({
        url: _spPageContextInfo.webAbsoluteUrl + "/_vti_bin/WebPartPages.asmx",
        type: "POST",
        dataType: "xml",
        data: soapEnv,
        complete: completeFn,
        error: errorFn,
        contentType: "text/xml; charset=\"utf-8\""
    });
}                


$(function() {
    getWebPartProperties('/SitePages/DevHome.aspx',
        function(xhr,textStatus){
            $(xhr.responseXML).find("WebPart").each(function() {
                var wpId = $(this).attr("ID");

                //Manipulate web part by Id via CSOM here... 

            });

        },
        function(xhr,textStatus,errorThrown){
            console.log(errorThrown);
        });
});

Answer 2

Using the WebPartManager one could retrieve all web parts in a page, see example by http://blogs.technet.com/b/speschka/archive/2009/11/01/using-the-sharepoint-2010-client-object-model-part-6.aspx

In terms of web service access, there is of course a SOAP web service the Web Part pages web service (http://msdn.microsoft.com/en-us/library/ms774569(v=office.12).aspx) which allows manipulating web parts in a page.

Each web part has an Unique Identifier automatically added by SharePoint anyway, so you don't need to add another one. Your best choice here is still the WebPartManager (Shared or Personal).

Answer 3

//get the connection
ClientContext ctx = new ClientContext("http://foo");


//get the home page
File home = ctx.Web.GetFileByServerRelativeUrl("/SitePages/home.aspx");


//get the web part manager
LimitedWebPartManager wpm = home.GetLimitedWebPartManager(PersonalizationScope.Shared);

//load the web part definitions
ctx.Load(wpm.WebParts);
ctx.ExecuteQuery();

//get the web part definition
WebPartDefinition wpd = wpm.WebParts.GetById(MyWebPartId);

//set the title
wpd.WebPart.Title = "My Web Part Title";

the above does what your asking for as c. marius has pointed out, as for a unique ID, its already set. wpd.WebPart.ID will show the id.... if you return that value within a lable or textbox than youll see the unique ID that is auto generated! Title and description are not unique!

http://msdn.microsoft.com/EN-US/library/microsoft.sharepoint.client.webparts.webpartdefinition_members.aspx

if you want to search by title:

//get the connection
ClientContext ctx = new ClientContext("http://foo");


//get the home page
File home = ctx.Web.GetFileByServerRelativeUrl("/SitePages/home.aspx");


//get the web part manager
LimitedWebPartManager wpm = home.GetLimitedWebPartManager(PersonalizationScope.Shared);

//load the web part definitions
ctx.Load(wpm.WebParts);
ctx.ExecuteQuery();

foreach ( WebPart wp in wpm.WebParts)
{
       //get the web part definition
       WebPartDefinition wpd = wp;

      //get the title
      string title = wpd.WebPart.Title;

      //get the ID
      string id = wpd.WebPart.ID;

      //get a specific webpart with a specific title
      if (wpd.WebPart.Title == "HOME")
      {
         //return ID
         string id = wpd.WebPart.ID;
      }

}