SPFile Class

Definition

public ref class SPFile
[Microsoft.SharePoint.Client.ClientCallableType(DeleteMethodClientName="DeleteObject", FactoryType=typeof(Microsoft.SharePoint.SPObjectFactory), Name="File", ObjectIdentityPropertyName="CanonicalId", ObjectUrlPathPropertyName="Microsoft.SharePoint.SPObjectUrlPath.GetUrlPath", ReadStreamMethodClientName="OpenBinaryStream", SampleUrl="{apiroot}/web/folders/getbyurl({folderrelativeurl})/files/getbyurl({filerelativeurl})", ServerTypeId="{df28be1e-74b5-4b21-b73a-2bbac0a23d8a}", WriteStreamMethodClientName="SaveBinaryStream")]
[Microsoft.SharePoint.Client.SubsetCallableExcludeInterface(Microsoft.SharePoint.Client.SubsetCallableExcludeMemberType.InternalInterface, ExcludeInterface=typeof(Microsoft.SharePoint.Utilities.ISPShareableByLinkObject))]
[Microsoft.SharePoint.Client.SubsetCallableType]
public class SPFile
type SPFile = class
Public Class SPFile
Inheritance
SPFile
Attributes

Properties

Author
BackwardLinks
CharSetName
CheckedOutBy
CheckedOutByUser
CheckedOutDate
CheckInComment
CheckOutExpires
CheckOutStatus
CheckOutType
CustomizedPageStatus
DocumentLibrary
EffectiveAuditMask
EffectiveRawPermissions
ETag
EventReceivers
Exists
ForwardLinks
GeneratingConverterId
Generator
IconUrl
InDocumentLibrary
IsConvertedFile
IsIRMed
IsSharedAccessRequested
Item
Length
LengthByUser
Level
ListItemAllFields
LockedByUser
LockedDate
LockExpires
LockId
LockType
MajorVersion
MinorVersion
ModifiedBy
Name
ParentFolder
ProgID
Properties
RequiresCheckout
ServerRedirected
ServerRelativeUrl
SourceFile
SourceLeafName
SourceUIVersion
TimeCreated
TimeLastModified
Title
TotalLength
UIVersion
UIVersionLabel
UniqueId
Url
Versions
Web

Methods

AddProperty(Object, Object)
Approve(String)
CanOpenFile(Boolean)
CanOpenFile(Boolean, String)
CheckIn(String)
CheckIn(String, SPCheckinType)
CheckOut()
CheckOut(Boolean, String)
CheckOut(SPFile+SPCheckOutType, String)
Convert(Guid, String, String, String, String, Byte, String, Boolean, Boolean, Guid)
ConvertLock(SPFile+SPLockType, SPFile+SPLockType, String, String, TimeSpan)
CopyTo(String)
CopyTo(String, Boolean)
CreateSharedAccessRequest()
Delete()
DeleteAllPersonalizations(Int32)
DeleteAllPersonalizationsAllUsers()
DeleteCellStoragePartition(String)
DeleteProperty(Object)
Deny(String)
GetConversionState(Guid, Guid)
GetConvertedFile(Guid)
GetHtmlTranslateCacheItem(String, Int32)
GetHtmlTranslateCacheNameFromStsName(Int32)
GetLimitedWebPartManager(PersonalizationScope)
GetListItem(String[])
GetProperty(Object)
GetWebPartCollection(Storage)
Lock(SPFile+SPLockType, String, TimeSpan)
MoveTo(String)
MoveTo(String, Boolean)
MoveTo(String, SPMoveOperations)
MoveTo(String, SPMoveOperations, Boolean)
OpenBinary()
OpenBinary(SPOpenBinaryOptions)
OpenBinaryStream()
OpenBinaryStream(SPOpenBinaryOptions)
OpenBinaryStream(SPOpenBinaryOptions, String, SPFileRightsManagementSettings, String, String)
OpenBinaryStream(SPOpenBinaryOptions, String, String)
OpenFileFormatMetaInfoStream(String)
Publish(String)
Recycle()
RefreshLock(String, TimeSpan)
ReleaseLock(String)
RemoveSharedAccessRequest()
ReplaceLink(String, String)
RevertContentStream()
SaveBinary(Byte[])
SaveBinary(Byte[], Boolean)
SaveBinary(Stream)
SaveBinary(Stream, Boolean)
SaveBinary(Stream, Boolean, Boolean, String, String, Stream, Boolean, String)
SaveBinary(Stream, Boolean, Boolean, String, String, Stream, String)
SaveBinary(Stream, SPFileSaveBinaryParameters)
SaveFileFormatMetaInfoStream(Stream, Int32, Int32, Boolean, String)
ScheduleEnd(DateTime)
ScheduleStart(DateTime)
ScheduleStart(DateTime, Boolean)
ScheduleStart(DateTime, Boolean, String)
ScheduleStart(DateTime, String)
SendToOfficialFile(SPWeb, Uri, Byte[], RecordsRepositoryProperty[], String, Uri, String, SPOfficialFileSubmissionMode, SPFile+CustomFileSubmissionPostProcessing, String)
SendToOfficialFile(String)
SendToOfficialFile(String, SPOfficialFileHost, RecordsRepositoryProperty[], String, SPOfficialFileSubmissionMode, String)
SendToOfficialFile(String, SPOfficialFileHost, String, SPOfficialFileSubmissionMode, String)
SendToOfficialFile(String, String)
SetHtmlTranslateCacheItem(String, Int32, Boolean, Byte[])
SetProperty(Object, Object)
StorageManagementWebPartPageInformation(SPSite, Guid, SPSite+StorageManagementSortedOn, SPSite+StorageManagementSortOrder, UInt32)
TakeOffline()
ToString()
UndoCheckOut()
UnPublish(String)
Update()

Applies to