SPDocumentLibrary - Classe

Représente une bibliothèque de documents dans Microsoft SharePoint Foundation.

Hiérarchie d’héritage

System.Object
  Microsoft.SharePoint.SPSecurableObject
    Microsoft.SharePoint.SPList
      Microsoft.SharePoint.SPDocumentLibrary
        Microsoft.SharePoint.SPPictureLibrary

Espace de noms :  Microsoft.SharePoint
Assembly :  Microsoft.SharePoint (dans Microsoft.SharePoint.dll)

Syntaxe

'Déclaration
Public Class SPDocumentLibrary _
    Inherits SPList
'Utilisation
Dim instance As SPDocumentLibrary

public class SPDocumentLibrary : SPList

Remarques

Pour obtenir un objet SPDocumentLibrary , casté la liste donnée sous la forme d'une bibliothèque de documents, comme illustré dans l'exemple suivant.

Dim documentLibrary As SPDocumentLibrary = CType(list, SPDocumentLibrary)

SPDocumentLibrary oDocumentLibrary = (SPDocumentLibrary)oList;

Exemples

L'exemple de code suivant parcourt tous les sites et leurs listes et, à l'exclusion des catalogues ou des bibliothèques de formulaires, affiche le nom du site et de liste, ainsi que le nom de fichier pour chaque élément de chaque bibliothèque de documents.

L'exemple suivant suppose l'existence d'une page .aspx qui contient un contrôle Label.

Cet exemple requiert les directives using (Imports dans Visual Basic) pour les espaces de noms Microsoft.SharePoint et Microsoft.SharePoint.Utilities .

Dim siteCollection As SPSite = SPControl.GetContextSite(Context)
Dim sites As SPWebCollection = siteCollection.AllWebs
Dim site As SPWeb

For Each site In sites
    Dim lists As SPListCollection = site.Lists
    Dim list As SPList

    For Each list In lists

        If list.BaseType = SPBaseType.DocumentLibrary Then
            Dim docLibrary As SPDocumentLibrary = 
                CType(list, SPDocumentLibrary)

            If Not docLibrary.IsCatalog Then

                If list.BaseTemplate <> SPListTemplateType.XMLForm Then
                    Dim docLibItems As SPListItemCollection = 
                        docLibrary.Items
                    Dim docLibItem As SPListItem

                    For Each docLibItem In docLibItems
                        Label1.Text += SPEncode.HtmlEncode(site.Name) 
                                & " :: " _
                            & SPEncode.HtmlEncode(list.Title) 
                                & " :: " _
                            & SPEncode.HtmlEncode(docLibItem("Title")) 
                                & "<BR>"
                    Next docLibItem
                End If
            End If
        End If
    Next list
Next site

SPSite oSiteCollection = SPContext.Current.Site;
SPWebCollection collWebsites = oSiteCollection.AllWebs;

foreach (SPWeb oWebsite in collWebsites)
{
    SPListCollection collLists = oWebsite.Lists;

    foreach (SPList oList in collLists)
    {
        if (oList.BaseType == SPBaseType.DocumentLibrary)
        {
            SPDocumentLibrary oDocumentLibrary = (SPDocumentLibrary)oList;

            if (!oDocumentLibrary.IsCatalog && oList.BaseTemplate != 
                SPListTemplateType.XMLForm)
            {
                SPListItemCollection collListItems = oDocumentLibrary.Items;

                foreach (SPListItem oListItem in collListItems)
                {
                    Label1.Text += SPEncode.HtmlEncode(oWebsite.Name) + 
                        " -- " + 
                        SPEncode.HtmlEncode(oList.Title) + " -- " + 
                        SPEncode.HtmlEncode(oListItem["Title"]) + 
                            "<BR>";
                }
            }
        }
    }
    oWebsite.Dispose();
}

Cohérence de thread

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.

Voir aussi

Référence

SPDocumentLibrary - Membres

Microsoft.SharePoint - Espace de noms