Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All
Important This document may not represent best practices for current development, links to downloads and other resources may no longer be valid. Current recommended version can be found here.

SPFile Members

Windows SharePoint Services 3

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

The SPFile type exposes the following members.

  NameDescription
Public property Author Gets an object that represents 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 Gets 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 Gets the date and time that the short-term check-out expires.
Public property CheckOutStatus Gets the status of the check-out, indicating whether the check-out is long-term or short-term.
Public property CustomizedPageStatus Gets the customization (also known as "ghost") status of the file object.
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 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 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 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 Part 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 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 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 Gets the parent file object of the file that was created through document transforms.
Public property SourceLeafName Gets the leaf name of the parent document for the file.
Public property SourceUIVersion 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.
Top

  NameDescription
Public method Approve Approves the file submitted for content approval with the specified comment.
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 based on a Boolean value that indicates whether to check the file out to the local computer, and that indicates the last date that the file was modified.
Public method Convert Transforms the file using the specified transformer.
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 but overwrites an existing file of the same name only if bOverwrite is true.
Public method Delete Deletes the file object.
Public method DeleteAllPersonalizations Deletes all personalization information from the Web Part 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 Part Page.
Public method Deny Rejects a file that was submitted for content approval.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetConversionState Returns the transform state of the file with respect to the specified transformer ID.
Public method GetConvertedFile 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 Part Page.
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 Part Page.)
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 but overwrites an existing file of the same name only if bOverwrite is true.
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 Publish Submits the file for content approval with the specified comment.
Public method Recycle Sends the file to the recycle bin.
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 uncustomized state so that its logic becomes cached in memory (also known as "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, 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 ScheduleEnd Sets the date on which a file will be removed from public views of a document library.
Public method ScheduleStart(DateTime) Schedules automatic approval of a document in a moderated library.
Public method ScheduleStart(DateTime, Boolean) Schedules automatic approval of a document in a moderated library 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 and specifies text for the approval comment.
Public method ScheduleStart(DateTime, Boolean, String) Schedules automatic approval of a document in a moderated library, specifies the text of the approval comment, and optionally changes the list item’s moderation status.
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 SetHtmlTranslateCacheItem Puts the contents of the file into the cache for HTML translation.
Public method Static member StorageManagementWebPartPageInformation Returns information about storage management for the Web Part 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 check-out.
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

Community Additions

ADD
Show:
© 2015 Microsoft