SPFile members

Represents a file in a SharePoint Web site that can be a Web Parts page, an item in a document library, or a file in a folder.

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

Methods

	Name	Description
	AddProperty	Adds an item to the list of metadata for the file.
	Approve	Approves the file submitted for content approval with the specified comment.
	CanOpenFile(Boolean)	Indicates whether the current user has permission to view the content of the file, specifying a level of access.
	CanOpenFile(Boolean, String)	Indicates whether the current user has permission to view the content of the file, specifying a level of access and an output variable to receive an ETag.
	CheckIn(String)	Checks in the file to a document library with the specified comment.
	CheckIn(String, SPCheckinType)	Checks in the file to a document library based on the specified comment and type of check in to perform.
	CheckOut()	Checks the file out of a document library.
	CheckOut(Boolean, String)	Checks out the file from a document library by specifying whether to check out the file to the local computer and by specifying that the file should not be checked out if it has been modified after a particular date.
	CheckOut(SPFile.SPCheckOutType, String)	Checks out the file from a document library by specifying the type of checkout and by specifying that the file should not be checked out if it has been modified after a particular date.
	Convert	Obsolete. Transforms the file using the specified transformer.
	ConvertLock	Converts an existing lock on the file to a new type of lock.
	CopyTo(String)	Copies the file to the destination URL but does not overwrite an existing file of the same name.
	CopyTo(String, Boolean)	Copies the file to the destination URL and optionally overwrites an existing file of the same name.
	CreateSharedAccessRequest	Requests shared access for the file.
	Delete	Deletes the file object.
	DeleteAllPersonalizations	Deletes all personalization information from theWeb Parts page, home page, or wiki page for the user with the specified ID.
	DeleteAllPersonalizationsAllUsers	Deletes personalization information for all users from the Web Parts page.
	DeleteCellStoragePartition	Deletes all entries in the specified cell storage partition.
	DeleteProperty	Deletes an item from the list of metadata for the file.
	Deny	Denies approval for a file that was submitted for content approval.
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetConversionState	Obsolete. Returns the transform state of the file to the specified transformer ID.
	GetConvertedFile	Obsolete. Returns the child file that was created from this file using document transforms and the specified transformer.
	GetHashCode	(Inherited from Object.)
	GetHtmlTranslateCacheItem	Returns the contents of the file from the cache for HTML translation, excluding cache items that are older than the date the file was last modified.
	GetHtmlTranslateCacheNameFromStsName	Returns the name of the main file from the cache for HTML translation.
	GetLimitedWebPartManager	Returns the Web Part manager that is associated with the Web Parts page.
	GetListItem	Gets the SPListItem that corresponds to this file, if this file belongs to a document library. Also gets values for specified fields.
	GetProperty	Gets the value from an item in the list of metadata for the file based on the specified key.
	GetType	(Inherited from Object.)
	GetWebPartCollection	Obsolete. Use the GetLimitedWebPartManager method to return an SPLimitedWebPartManager object to manage Web Parts instead. (In Windows SharePoint Services 2.0 the GetWebPartCollection method returned the Web Part collection that is associated with the Web Parts page.)
	Lock	Creates a lock on the file, preventing other users from modifying it.
	MemberwiseClone	(Inherited from Object.)
	MoveTo(String)	Moves the file to the destination URL but does not overwrite an existing file of the same name.
	MoveTo(String, SPMoveOperations)	Moves the file to the specified destination URL based on the type of operation that is specified.
	MoveTo(String, Boolean)	Moves the file to the destination URL and optionally overwrites an existing file of the same name.
	MoveTo(String, SPMoveOperations, Boolean)	Moves the file to the specified destination URL.
	OpenBinary()	Opens the file in binary format.
	OpenBinary(SPOpenBinaryOptions)	Opens the specified file as a byte array and specifies options that control how the file opens.
	OpenBinaryStream()	Opens the file as a stream.
	OpenBinaryStream(SPOpenBinaryOptions)	Opens the specified file as a stream and specifies options that control how the file opens.
	OpenBinaryStream(SPOpenBinaryOptions, String, String)	Opens the file as a stream based on the specified options.
	OpenBinaryStream(SPOpenBinaryOptions, String, SPFileRightsManagementSettings, String, String)
	OpenFileFormatMetaInfoStream
	Publish	Submits the file for content approval with the specified comment.
	Recycle	Sends the file to the recycle bin.
	RefreshLock	Renews an existing lock on the file.
	ReleaseLock	Releases an existing lock that is specified by its identifier (ID).
	RemoveSharedAccessRequest
	ReplaceLink	Replaces all instances in the file of a specified link with a new link.
	RevertContentStream	Returns the file to its original state so that its logic becomes cached in memory (or "ghosted") rather than stored in the database.
	SaveBinary([])	Saves the file in binary format based on the specified byte array.
	SaveBinary(Stream)	Saves the file in binary format based on the specified stream.
	SaveBinary([], Boolean)	Saves the file in binary format based on the specified byte array and a Boolean value that specifies whether to check required fields.
	SaveBinary(Stream, SPFileSaveBinaryParameters)	Saves the file in binary format based on a stream that contains a file and an SPFileSaveBinaryParameters object with additional parameters.
	SaveBinary(Stream, Boolean)	Saves the file in binary format based on the specified stream and a Boolean value that specifies whether to check required fields.
	SaveBinary(Stream, Boolean, Boolean, String, String, Stream, String)	Saves the file and file format metadata based on the specified streams, strings, and optional ETag value.
	SaveBinary(Stream, Boolean, Boolean, String, String, Stream, Boolean, String)	Saves the file and file format metadata based on the specified streams, strings, Boolean value, and optional ETag value.
	SaveFileFormatMetaInfoStream	Saves the stream of metadata that contains file format information for the specified file to the database.
	ScheduleEnd	Sets the date on which a file will be removed from public views of a document library.
	ScheduleStart(DateTime)	Schedules the automatic approval of a document in a moderated library at the specified date and time.
	ScheduleStart(DateTime, Boolean)	Schedules the automatic approval of a document in a moderated library at the specified date and time, and optionally leaves the moderation status of the item unchanged.
	ScheduleStart(DateTime, String)	Schedules automatic approval of a document in a moderated library at the specified date and time with the specified explanation for the approval.
	ScheduleStart(DateTime, Boolean, String)	Schedules the automatic approval of a document in a moderated library at the specified date and time, with the specified approval comment, and optionally changes the moderation status of the list item.
	SendToOfficialFile(String)	Sends the file to a records repository.
	SendToOfficialFile(String, String)	Sends the file to a records repository and specifies the name of a record routing type.
	SendToOfficialFile(String, SPOfficialFileHost, String, SPOfficialFileSubmissionMode, String)	Sends file to a specific URL.
	SendToOfficialFile(String, SPOfficialFileHost, [], String, SPOfficialFileSubmissionMode, String)	Sends file to a specific URL.
	SendToOfficialFile(SPWeb, Uri, [], [], String, Uri, String, SPOfficialFileSubmissionMode, SPFile.CustomFileSubmissionPostProcessing, String)	Sends file to a destination router.
	SetHtmlTranslateCacheItem	Saves the contents of the file into a cache for HTML translation.
	SetProperty	Sets the value of an item in the list of metadata for the file.
	StorageManagementWebPartPageInformation	Obsolete. Returns information about storage management for the Web Parts page.
	TakeOffline	Takes the most current approved or major version of the file offline.
	ToString	Returns the URL for the file based on the site or subsite URL. (Overrides Object.ToString().)
	UndoCheckOut	Undoes the file checkout.
	UnPublish	Removes the file with the specified comment from content approval.
	Update	Updates the database with changes that are made to the file.

Top

See also

Reference

SPFile class

Microsoft.SharePoint namespace