SPWeb.Properties property

Gets a SPPropertyBag object with the metadata for the website.

Namespace:  Microsoft.SharePoint
Assembly:  Microsoft.SharePoint (in Microsoft.SharePoint.dll)

Syntax

'Declaration
Public ReadOnly Property Properties As SPPropertyBag
    Get
'Usage
Dim instance As SPWeb
Dim value As SPPropertyBag

value = instance.Properties
public SPPropertyBag Properties { get; }

Property value

Type: Microsoft.SharePoint.Utilities.SPPropertyBag
An SPPropertyBag object that contains the properties settings.

Remarks

This property returns only a subset of the metadata for a website. To get all the metadata, use the AllProperties property.

Examples

The following example is a console application that accesses the Properties property, iterates through the collection, and prints each key/value pair to the console.

using System;
using System.Collections;
using Microsoft.SharePoint;
using Microsoft.SharePoint.Utilities;

namespace Test
{
    class Program
    {
        static void Main(string[] args)
        {
            using (SPSite site = new SPSite("http://localhost"))
            {
                using (SPWeb web = site.OpenWeb())
                {
                    SPPropertyBag props = web.Properties;
                    foreach (DictionaryEntry de in props)
                    {
                        Console.WriteLine("Key = {0}, Value = {1}", de.Key, de.Value);
                    }
                }
            }
            Console.ReadLine();
        }
    }
}
Imports System
Imports System.Collections
Imports Microsoft.SharePoint
Imports Microsoft.SharePoint.Utilities

Namespace Test
    Friend Class Program
        Shared Sub Main(ByVal args() As String)
            Using site As New SPSite("http://localhost")
                Using web As SPWeb = site.OpenWeb()
                    Dim props As SPPropertyBag = web.Properties
                    For Each de As DictionaryEntry In props
                        Console.WriteLine("Key = {0}, Value = {1}", de.Key, de.Value)
                    Next de
                End Using
            End Using
            Console.ReadLine()
        End Sub
    End Class
End Namespace

The output that this application prints to the console varies with the website, but it might look like the following:

Key = vti_associatemembergroup, Value = 5
Key = vti_extenderversion, Value = 14.0.0.4016
Key = vti_associatevisitorgroup, Value = 4
Key = vti_associategroups, Value = 5;4;3
Key = vti_createdassociategroups, Value = 3;4;5
Key = vti_siteusagetotalbandwidth, Value = 547
Key = vti_siteusagetotalvisits, Value = 9
Key = vti_associateownergroup, Value = 3
Key = vti_defaultlanguage, Value = en-us

See also

Reference

SPWeb class

SPWeb members

Microsoft.SharePoint namespace