Partager via

File - Membres

  • Article

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.

Le type File expose les membres suivants.

Constructeurs

  Nom Description
Méthode publique File Initializes a new instance of the File object.

Haut

Propriétés

  Nom Description
Propriété publique Author Gets a value that specifies the user who added the file.
Propriété publique CheckedOutByUser Gets a value that returns the user who has checked out the file.
Propriété publique CheckInComment Gets a value that returns the comment used when a document is checked into a document library.
Propriété publique CheckOutType Gets a value that specifies the type of check out associated with the file.
Propriété publique ContentTag Returns internal version of content, used to validate document equality for read purposes.
Propriété publique Context Retourne le contexte associé à l'objet client. (Hérité de ClientObject)
Propriété publique CustomizedPageStatus Gets a value that specifies the customization status of the file.
Propriété publique EffectiveInformationRightsManagementSettings
Propriété publique ETag Gets a value that specifies the ETag value.
Propriété publique Exists Gets a value that specifies whether the file exists.
Propriété publique InformationRightsManagementSettings
Propriété publique IrmEnabled
Propriété publique Length Gets the size of the file in bytes, excluding the size of any Web Parts that are used in the file.
Propriété publique Level Gets a value that specifies the publishing level of the file.
Propriété publique LinkingUrl
Propriété publique ListId
Propriété publique ListItemAllFields Gets a value that specifies the list item field values for the list item corresponding to the file.
Propriété publique LockedByUser Gets a value that returns the user that owns the current lock on the file.
Propriété publique MajorVersion Gets a value that specifies the major version of the file.
Propriété publique MinorVersion Gets a value that specifies the minor version of the file.
Propriété publique ModifiedBy Gets a value that returns the user who last modified the file.
Propriété publique Name Gets the name of the file including the extension.
Propriété protégée ObjectData Obtient les données d'objet pour l'objet de client en cours. (Hérité de ClientObject)
Propriété publique ObjectVersion Obtient une chaîne qui indique la version de l'objet client actuel. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Propriété publique Path Effectue le suivi de façon dont un objet client est créé dans la classe ClientRuntimeContext afin que l'objet peut être recréé sur le serveur. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Propriété publique Properties
Propriété publique ServerObjectIsNull Obtient l'objet serveur et renvoie la valeur null si l'objet serveur est null. (Hérité de ClientObject)
Propriété publique ServerRelativeUrl Gets the relative URL of the file based on the URL for the server.
Propriété publique SiteId
Propriété publique Tag Obtient ou définit les données associées à l'objet client. (Hérité de ClientObject)
Propriété publique TimeCreated Gets a value that specifies when the file was created.
Propriété publique TimeLastModified Gets a value that specifies when the file was last modified.
Propriété publique Title Gets a value that specifies the display name of the file.
Propriété publique TypedObject Renvoie l'objet contenant les informations de type correct renvoyées par le serveur. (Hérité de ClientObject)
Propriété publique UIVersion Gets a value that specifies the implementation-specific version identifier of the file.
Propriété publique UIVersionLabel Gets a value that specifies the implementation-specific version identifier of the file.
Propriété publique UniqueId
Propriété publique VersionEvents
Propriété publique Versions Gets a value that returns a collection of file version objects that represent the versions of the file.
Propriété publique WebId

Haut

Méthodes

  Nom Description
Méthode publique Approve Approves the file submitted for content approval with the specified comment.
Méthode publique CancelUpload Stops the chunk upload session without saving the uploaded data. If the file doesn’t already exist in the library, the partially updated file will be deleted. Use this in response to user action (as in a request to cancel an upload) or an error or exception.
Méthode publique CheckIn Checks the file in to a document library based on the check-in type.
Méthode publique CheckOut Checks out the file from a document library based on the check out type.
Méthode protégée CheckUninitializedProperty Vérifie si la propriété de type de valeur spécifiée d'une ClientObject a été initialisée. (Hérité de ClientObject)
Méthode publique ContinueUpload Continues the chunk upload session with an additional fragment. The current file content is not changed.
Méthode publique CopyTo Copies the file to the destination URL. Server must overwrite an existing file of the same name if bOverwrite is true.
Méthode publique CustomFromJson Renvoie une valeur booléenne qui indique si le code personnalisé a été utilisé pour remplir un objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Méthode publique DeleteObject Deletes the file object.
Méthode publique Deny Denies approval for a file that was submitted for content approval.
Méthode publique ExecuteCobaltRequest
Méthode publique FinishUpload Uploads the last file fragment and commits the file. The current file content is changed when this method completes.
Méthode publique FromJson Indique si le code personnalisé a été utilisé pour remplir un objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Méthode publiqueMembre statique GetContentVerFromTag Reserved for internal use only. This method exposes the internal ContentVersion value inside of a ContentTag.
Méthode publique GetImagePreviewUrl
Méthode publique GetLimitedWebPartManager Specifies the control set used to access, modify, or add Web Parts associated with this Web Part Page and view.
Méthode publique GetPreAuthorizedAccessUrl
Méthode publique GetWOPIFrameUrl
Méthode protégée InitNonPropertyFieldFromJson Initialise un champ non propriété de l'objet client basé sur des données JavaScript Object Notation (JSON) à partir du serveur. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Méthode protégée InitOnePropertyFromJson (Remplace ClientObject.InitOnePropertyFromJson(String, JsonReader))
Méthode publique IsObjectPropertyInstantiated Indique si la propriété spécifiée de l'objet client instanciation. (Hérité de ClientObject)
Méthode publique IsPropertyAvailable Renvoie une valeur booléenne qui indique si la propriété scalaire spécifiée a été récupérée ou définir. (Hérité de ClientObject)
Méthode protégée LoadExpandoFields Rétablit les propriétés étendues associées à l'objet client en cas de substitution dans une classe dérivée. (Hérité de ClientObject)
Méthode publique MoveTo Moves the file to the specified destination URL.
Méthode publiqueMembre statique OpenBinaryDirect(ClientContext, String) Downloads the specified file from a SharePoint site without requiring an ExecuteQuery() method call.
Méthode publiqueMembre statique OpenBinaryDirect(ClientContext, String, EventHandler<OpenBinarySucceededEventArgs>, EventHandler<OpenBinaryFailedEventArgs>)
Méthode publique OpenBinaryStream Opens the file as a stream.
Méthode publique Publish Submits the file for content approval with the specified comment.
Méthode publique Recycle Moves the file to the Recycle Bin and returns the identifier of the new Recycle Bin item.
Méthode publique RefreshLoad Recharge toutes les propriétés scalaires associées à l'objet client en cas de substitution dans une classe dérivée. (Hérité de ClientObject)
Méthode protégée RemoveFromParentCollection Supprime l'objet client en cours de la collection d'objets client parent. (Hérité de ClientObject)
Méthode publique Retrieve() Récupère toutes les propriétés scalaires associées à l'objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Méthode publique Retrieve([]) Extrait les propriétés scalaires spécifiées associées à l'objet. Ce membre est réservé à une utilisation interne et n’est pas destiné à être utilisé directement à partir de votre code. (Hérité de ClientObject)
Méthode publique SaveBinary Saves the specified file into a document library.
Méthode publiqueMembre statique SaveBinaryDirect(ClientContext, String, Stream, Boolean) Uploads the specified file to a SharePoint site without requiring an ExecuteQuery() method call.
Méthode publiqueMembre statique SaveBinaryDirect(ClientContext, String, Stream, String) Uploads the specified file to a SharePoint site with the specified Etag without requiring an ExecuteQuery() method call.
Méthode publique StartUpload Starts a new chunk upload session and uploads the first fragment. The current file content is not changed when this method completes. The method is idempotent (and therefore does not change the result) as long as you use the same values for uploadId and stream.The upload session ends either when you use the CancelUpload(Guid) method or when you successfully complete the upload session by passing the rest of the file contents through the ContinueUpload(Guid, Int64, Stream) and FinishUpload(Guid, Int64, Stream) methods.For example, you can pass a 35 MB file by dividing it into three 10 MB streams and one 5 MB stream and uploading them this way (using the resulting offset values of 10, 20 and 30 MB):StartUpload(GUID, stream1)
ContinueUpload(GUID, 10 MB, stream2)
ContinueUpload(GUID, 20 MB, stream3)
FinishUpload(GUID, 30 MB, stream4)The StartUpload(Guid, Stream) and ContinueUpload(Guid, Int64, Stream) methods return the size of the running total of uploaded data in bytes, so you can pass those return values to subsequent uses of ContinueUpload(Guid, Int64, Stream) and FinishUpload(Guid, Int64, Stream)
Méthode publique ToString (Hérité de Object)
Méthode publique UndoCheckOut Reverts an existing checkout for the file.
Méthode publique UnPublish Removes the file from content approval or unpublish a major version.
Méthode publique Update
Méthode protégée UpdateClientObjectPropertyType Met à jour la valeur de la propriété objet client pour que le type correct en utilisant les informations de type renvoyées par le serveur. (Hérité de ClientObject)

Haut

Voir aussi

Référence

File classe

Microsoft.SharePoint.Client - Espace de noms