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