This topic has not yet been rated - Rate this topic

SPFile.Properties property

SharePoint 2013

Gets metadata for the file.

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

public Hashtable Properties { get; }

Property value

Type: System.Collections.Hashtable
A System.Collections.Hashtable object that contains the metadata.

Remarks

Note
Storing large amounts of data in this property will seriously degrade performance. Do not store more than one kilobyte (1k) of user data in this property.

The Windows SharePoint Services 3.0 object model supports updating file metadata. You can use an indexer on this property to set a value. For example, to set the value of the MyDate property for a given file to the current date and time, use the indexer and call the Update method, as follows:

[Visual Basic]

oFile("MyDate") = DateTime.Now

oFile.Update()

[C#]

oFile["MyDate"] = DateTime.Now;

oFile.Update();

Examples

The following code example iterates through the collection of files in a document library and displays the properties and values for each file.

This example requires using directives (Imports in Visual Basic) for the Microsoft.SharePoint and Microsoft.SharePoint.Utilities namespaces.

SPSite oSiteCollection = SPContext.Current.Site;
using(SPWeb oWebsite = oSiteCollection.AllWebs["Site_Name"])
{
    SPFolder oFolder = oWebsite.Folders["Shared Documents"];
    SPFileCollection collFiles = folder.Files;

    foreach (SPFile oFile in collFiles)
    {
        System.Collections.Hashtable collHashes = file.Properties;
        System.Collections.ICollection collKeys = hash.Keys;

        foreach (object oKey in collKeys)
        {
            Response.Write(SPEncode.HtmlEncode(oKey.ToString()) 
            + " :: " + 
            SPEncode.HtmlEncode(hash[oKey.ToString()].ToString())
            + "<BR>");
        }
    }
}

The previous example displays metadata similar to the following:

vti_author :: User_Name
vti_cachedtitle :: New Page 1
vti_metatags :: HTTP-EQUIV=Content-Language en-us GENERATOR Microsoft\ 
    FrontPage\ 5.0 ProgId FrontPage.Editor.Document 
    HTTP-EQUIV=Content-Type text/html;\ charset=windows-1252
vti_progid :: FrontPage.Editor.Document
vti_cachedbodystyle :: 
vti_modifiedby :: User_Name
vti_charset :: windows-1252
vti_sourcecontrolcheckincomment :: Comment
vti_nexttolasttimemodified :: 5/6/2003 8:16:58 PM
vti_filesize :: 6439
vti_docstoretype :: 0
vti_language :: en-us
vti_generator :: Microsoft FrontPage 5.0
vti_timelastmodified :: 5/6/2003 8:59:25 PM
vti_title :: File_Title
vti_docstoreversion :: 2
vti_sourcecontrolcookie :: fp_internal
vti_sourcecontrolversion :: V2
vti_cachedneedsrewrite :: false
vti_timecreated :: 5/6/2003 8:16:58 PM
vti_cachedcustomprops :: vti_title
vti_cachedhastheme :: false

Note
Certain objects implement the IDisposable interface, and you must avoid retaining these objects in memory after they are no longer needed. For information about good coding practices, see Disposing Objects.

Reference

SPFile class

SPFile members

Microsoft.SharePoint namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Additions

ADD