SPFile properties

The SPFile type exposes the following members.

Properties

  Name Description
Public property Author Gets the user who uploaded the document to the server or created the document on the server.
Public property BackwardLinks Gets a collection of link objects that represent the backward links of the file.
Public property CharSetName Gets the name of the character set that is used in the file.
Public property CheckedOutBy Obsolete. This property is obsolete. Use LockedByUser instead.
Public property CheckedOutByUser Gets an object that represents the user who has checked out the file.
Public property CheckedOutDate Gets the date and time that the file was checked out.
Public property CheckInComment Gets the comment that is used when a document is checked into a document library.
Public property CheckOutExpires Obsolete. This property is obsolete. Use LockExpires instead.
Public property CheckOutStatus Obsolete. This property is obsolete. Use CheckOutType instead.
Public property CheckOutType Gets a value that indicates how the file is checked out of a document library.
Public property CustomizedPageStatus Gets the customization (also known as "ghost") status of the file object.
Public property DocumentLibrary Gets the parent library of the SPFile.
Public property EffectiveAuditMask Gets the effective audit mask for this object.
Public property EffectiveRawPermissions Gets the effective base permissions for the current user.
Public property ETag Gets an ETag that identifies a version of the file.
Public property EventReceivers Gets the collection of event receiver definitions for the file.
Public property Exists Gets a Boolean value that indicates whether the file exists.
Public property ForwardLinks Gets a collection of link objects that represent the forward links in the file.
Public property GeneratingConverterId Obsolete. Gets the ID of the transformer that is used to create the file, or Guid.Empty if the file is not a child file.
Public property Generator Gets the name of the application that created the .htm or .aspx file.
Public property IconUrl Gets the URL to the icon that is associated with the file.
Public property InDocumentLibrary Gets a Boolean value that indicates whether the file belongs to a document library.
Public property IsConvertedFile Obsolete. Gets a Boolean value that indicates whether the file object was created as part of a document transform.
Public property IsIRMed Gets a Boolean value that indicates whether Information Rights Management is enabled for the file.
Public property IsSharedAccessRequested Gets a Boolean value that indicates whether shared access has been requested for the file.
Public property Item Gets the list item object that corresponds to the file if the file belongs to a document library.
Public property Length Gets the size of the file in bytes, excluding the size of any Web Parts that are used in the file.
Public property LengthByUser Gets a collection of user storage objects that contain information about each user of the Web Parts page, including the user name, user ID, and the number of bytes that the Web Part personalizations consume.
Public property Level Gets the level of publication for the file.
Public property ListItemAllFields Gets the SPListItem object that corresponds to this file, including all its field values, if the file belongs to a document library.
Public property LockedByUser Gets the user who has locked the file.
Public property LockedDate Gets the creation date and time of a file lock.
Public property LockExpires Gets the expiration date and time of a file lock.
Public property LockId Gets the identifier (ID) of the current lock on the file.
Public property LockType Gets a value that describes the type of lock that is on a file.
Public property MajorVersion Gets the major version of the file.
Public property MinorVersion Gets the minor version of the file.
Public property ModifiedBy Gets a user object that represents the user who last modified the file.
Public property Name Gets the name of the file including the extension.
Public property ParentFolder Gets the parent folder of the file.
Public property ProgID Gets a string that identifies the application in which the file was created.
Public property Properties Gets metadata for the file.
Public property RequiresCheckout Gets a Boolean value that specifies if the file is in a document library that requires checkout.
Public property ServerRedirected Gets a Boolean value that indicates whether users who do not have access to view the source file, or who do not have the appropriate client application installed, are redirected to server-side rendering of the file when they click a link to view it.
Public property ServerRelativeUrl Gets the relative URL of the file based on the URL for the server.
Public property SourceFile Obsolete. Gets the parent file object of the file that was created through document transforms.
Public property SourceLeafName Obsolete. Gets the leaf name of the parent document for the file.
Public property SourceUIVersion Obsolete. Gets the version number of the parent document for the file.
Public property TimeCreated Gets a date and time value that indicates when the file was created.
Public property TimeLastModified Gets a date and time value that indicates when the file was last modified.
Public property Title Gets the display name of the file.
Public property TotalLength Gets the size of the file in bytes, including the size of any Web Parts that are used in the file.
Public property UIVersion Gets the version number of the file.
Public property UIVersionLabel Gets the version of the file.
Public property UniqueId Gets the GUID that uniquely identifies the file in the content database.
Public property Url Gets the site-relative URL of the file.
Public property Versions Gets a collection of file version objects that represent the versions of the file.
Public property Web Gets the Web site where the file is located.

Top

See also

Reference

SPFile class

Microsoft.SharePoint namespace