SPWebPartCollection.Add - Méthode (ListViewWebPart)
Remarque : cette API est désormais obsolète.
Obsolète. Ajoute le composant affichage de liste spécifié à la collection.
Espace de noms : Microsoft.SharePoint
Assembly : Microsoft.SharePoint (dans Microsoft.SharePoint.dll)
Syntaxe
'Déclaration
<ObsoleteAttribute("Use SPLimitedWebPartManager instead.")> _
Public Function Add ( _
listWebPart As ListViewWebPart _
) As Guid
'Utilisation
Dim instance As SPWebPartCollection
Dim listWebPart As ListViewWebPart
Dim returnValue As Guid
returnValue = instance.Add(listWebPart)
[ObsoleteAttribute("Use SPLimitedWebPartManager instead.")]
public Guid Add(
ListViewWebPart listWebPart
)
Paramètres
listWebPart
Type : Microsoft.SharePoint.WebPartPages.ListViewWebPartUn objet dedeMicrosoft.SharePoint.WebPartPages.ListViewWebPartqui représente le nouveau composant WebPart.
Valeur renvoyée
Type : System.Guid
GUID qui identifie le composant WebPart.
Exemples
L'exemple de code suivant ajoute un composant WebPart Affichage de liste à la collection de WebParts qui sont affichés sur la page d'accueil du site actuel.
Les propriétés ListName et ViewGuid requièrent un GUID qui est représenté sous la forme d'une chaîne, qui utilise des caractères majuscules, et qui est placée entre accolades ({}).
Cet exemple requiert les directives using (Imports dans Visual Basic) pour les espaces de noms Microsoft.SharePoint et de Microsoft.SharePoint.WebPartPages .
Dim site As SPWeb = SPContext.Current.Web
Dim list As SPList = site.Lists("List_Name")
Dim listViewWebPart As New ListViewWebPart()
listViewWebPart.ZoneID = "Left"
listViewWebPart.ListName = list.ID.ToString("B").ToUpper()
listViewWebPart.ViewGuid = list.Views(0).ID.ToString("B").ToUpper()
Dim webPartCollection As SPWebPartCollection =
site.GetWebPartCollection("default.aspx", Storage.Shared)
Dim guid As System.Guid = webPartCollection.Add(listViewWebPart)
SPWeb oWebsite = SPContext.Current.Web;
SPList oList = oWebsite.Lists["List_Name"];
ListViewWebPart oListViewWebPart = new ListViewWebPart();
oListViewWebPart.ZoneID = "Left";
oListViewWebPart.ListName = oList.ID.ToString("B").ToUpper();
oListViewWebPart.ViewGuid = oList.Views[0].ID.ToString("B").ToUpper();
SPWebPartCollection collWebParts =
oWebsite.GetWebPartCollection("default.aspx", Storage.Shared);
System.Guid guid = collWebParts.Add(oListViewWebPart);