File Members

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 File type exposes the following members.

  Name Description
Public method File
Top

  Name Description
Public property Author Gets a value that specifies the user who added the file.
Public property CheckedOutByUser Gets a value that returns the user who has checked out the file.
Public property CheckInComment Gets a value that returns the comment used when a document is checked into a document library.
Public property CheckOutType Gets a value that specifies the type of check out associated with the file.
Public property Context Returns the context that is associated with the client object. (Inherited from ClientObject.)
Public property CustomizedPageStatus Gets a value that specifies the customization status of the file.
Public property ETag Gets a value that specifies the ETag value.
Public property Exists Gets a value that specifies whether the file exists.
Public property Level Gets a value that specifies the publishing level of the file.
Public property ListItemAllFields Gets a value that specifies the list item field values for the list item corresponding to the file.
Public property LockedByUser Gets a value that returns the user that owns the current lock on the file.
Public property MajorVersion Gets a value that specifies the major version of the file.
Public property MinorVersion Gets a value that specifies the minor version of the file.
Public property ModifiedBy Gets a value that returns the user who last modified the file.
Public property Name Gets the name of the file including the extension.
Protected property ObjectData Gets the object data for the current client object. (Inherited from ClientObject.)
Public property ObjectVersion Gets a string that indicates the version of the current client object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property Path Tracks how a client object is created in the ClientRuntimeContext class, so that the object can be re-created on the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public property ServerObjectIsNull Gets the server object and returns null if the server object is null. (Inherited from ClientObject.)
Public property ServerRelativeUrl Gets the relative URL of the file based on the URL for the server.
Public property Tag Gets or sets data that is associated with the client object. (Inherited from ClientObject.)
Public property TimeCreated Gets a value that specifies when the file was created.
Public property TimeLastModified Gets a value that specifies when the file was last modified.
Public property Title Gets a value that specifies the display name of the file.
Public property UIVersion Gets a value that specifies the implementation-specific version identifier of the file.
Public property UIVersionLabel Gets a value that specifies the implementation-specific version identifier of the file.
Public property Versions Gets a value that returns a collection of file version objects that represent the versions of the file.
Top

  Name Description
Public method CheckIn Checks the file in to a document library based on the check-in type.
Public method CheckOut Checks out the file from a document library based on the check out type.
Protected method CheckUninitializedProperty Checks to determine whether the specified value type property of a ClientObject has been initialized. (Inherited from ClientObject.)
Public method CopyTo Copies the file to the destination URL. Server must overwrite an existing file of the same name if bOverwrite is true.
Public method CustomFromJson Returns a Boolean value that indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method DeleteObject Deletes the file object.
Public method FromJson Indicates whether custom code was used to populate an object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method GetLimitedWebPartManager Specifies the control set used to access, modify, or add Web Parts associated with this Web Part Page and view.
Protected method InitNonPropertyFieldFromJson Initializes a non-property field of the client object based on JSON data from the server. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Protected method InitOnePropertyFromJson (Overrides ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Public method IsObjectPropertyInstantiated Indicates whether the specified property of the client object is instantiated. (Inherited from ClientObject.)
Public method IsPropertyAvailable Returns a Boolean value that indicates whether the specified scalar property has been retrieved or set. (Inherited from ClientObject.)
Protected method LoadExpandoFields When overridden in a derived class, initializes the extended properties associated with the client object. (Inherited from ClientObject.)
Public method MoveTo Moves the file to the specified destination URL.
Public method Static member OpenBinaryDirect(ClientContext, String) Downloads the specified file from a SharePoint site without requiring an ExecuteQuery() method call.
Public method Static member OpenBinaryDirect(ClientContext, String, EventHandler<OpenBinarySucceededEventArgs>, EventHandler<OpenBinaryFailedEventArgs>)
Public method Publish Submits the file for content approval with the specified comment.
Public method Recycle Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.
Public method RefreshLoad Reloads all scalar properties associated with the client object when overridden in a derived class. (Inherited from ClientObject.)
Protected method RemoveFromParentCollection Removes the current client object from the parent client object collection. (Inherited from ClientObject.)
Public method Retrieve() Retrieves all scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method Retrieve([]) Retrieves the specified scalar properties associated with the object. This member is reserved for internal use and is not intended to be used directly from your code. (Inherited from ClientObject.)
Public method SaveBinary Saves the specified file into a document library.
Public method Static member SaveBinaryDirect(ClientContext, String, Stream, Boolean) Uploads the specified file to a SharePoint site without requiring an ExecuteQuery() method call.
Public method Static member SaveBinaryDirect(ClientContext, String, Stream, String) Uploads the specified file to a SharePoint site with the specified Etag without requiring an ExecuteQuery() method call.
Public method ToString (Inherited from Object.)
Public method UndoCheckOut Reverts an existing checkout for the file.
Public method UnPublish Removes the file from content approval or unpublish a major version.
Top
Show: