SPFile SPFile 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
Public Class SPFile
Inheritance
SPFileSPFileSPFile
Attributes
Microsoft.SharePoint.Client.ClientCallableTypeAttribute Microsoft.SharePoint.Client.SubsetCallableExcludeInterfaceAttribute Microsoft.SharePoint.Client.SubsetCallableTypeAttribute

Properties

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

Methods

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

Extension Methods

ToJson(Object) ToJson(Object) ToJson(Object)

Applies to