SPFile methods

  • Article

The SPFile type exposes the following members.

Methods

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

Top

See also

Reference

SPFile class

Microsoft.SharePoint namespace