Compartir a través de

Miembros File

  • Artículo

Representa un archivo de un sitio web de SharePoint que puede ser una página de elementos web, un elemento de una biblioteca de documentos o un archivo de una carpeta.

El tipo File expone los siguientes miembros.

Constructores

  Nombre Descripción
Método público File Inicializa una nueva instancia del objeto File .

Arriba

Propiedades

  Nombre Descripción
Propiedad pública Author Obtiene un valor que especifica el usuario que agregó el archivo.
Propiedad pública CheckedOutByUser Obtiene un valor que devuelve el usuario que desprotegió el archivo.
Propiedad pública CheckInComment Obtiene un valor que devuelve el comentario utilizado cuando se activa un documento en una biblioteca de documentos.
Propiedad pública CheckOutType Obtiene un valor que especifica el tipo de desprotección asociado al archivo.
Propiedad pública ContentTag Devuelve la versión interna del contenido, que se usa para validar la igualdad de documentos con propósitos de lectura.
Propiedad pública Context Devuelve el contexto que está asociado con el objeto de cliente. (Heredado desde ClientObject).
Propiedad pública CustomizedPageStatus Obtiene un valor que especifica el estado de personalización del archivo.
Propiedad pública EffectiveInformationRightsManagementSettings
Propiedad pública ETag Obtiene un valor que especifica el valor de ETag.
Propiedad pública Exists Obtiene un valor que especifica si existe el archivo.
Propiedad pública InformationRightsManagementSettings
Propiedad pública IrmEnabled
Propiedad pública Length Obtiene el tamaño del archivo en bytes, excluyendo el tamaño de los elementos web que se usan en el archivo.
Propiedad pública Level Obtiene un valor que especifica el nivel de publicación del archivo.
Propiedad pública LinkingUrl
Propiedad pública ListId
Propiedad pública ListItemAllFields Obtiene un valor que especifica los valores de campo de elemento de lista para el elemento de lista correspondiente al archivo.
Propiedad pública LockedByUser Obtiene un valor que devuelve el usuario propietario del bloqueo actual en el archivo.
Propiedad pública MajorVersion Obtiene un valor que especifica la versión principal del archivo.
Propiedad pública MinorVersion Obtiene un valor que especifica la versión secundaria del archivo.
Propiedad pública ModifiedBy Obtiene un valor que devuelve el usuario que modificó el archivo por última vez.
Propiedad pública Name Obtiene el nombre del archivo que incluye la extensión.
Propiedad protegida ObjectData Obtiene los datos de objeto para el objeto de cliente actual. (Heredado desde ClientObject).
Propiedad pública ObjectVersion Obtiene una cadena que indica la versión del objeto de cliente actual. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Propiedad pública Path Realiza un seguimiento de cómo se crea un objeto de cliente en la clase ClientRuntimeContext para que el objeto puede reconstruirse en el servidor. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Propiedad pública Properties
Propiedad pública ServerObjectIsNull Obtiene el objeto de servidor y devuelve un valor nulo si el objeto de servidor es nulo. (Heredado desde ClientObject).
Propiedad pública ServerRelativeUrl Obtiene la dirección URL relativa del archivo en función de la dirección URL del servidor.
Propiedad pública SiteId
Propiedad pública Tag Obtiene o establece los datos asociados con el objeto de cliente. (Heredado desde ClientObject).
Propiedad pública TimeCreated Obtiene un valor que especifica cuándo se creó el archivo.
Propiedad pública TimeLastModified Obtiene un valor que especifica cuándo se modificó por última vez el archivo.
Propiedad pública Title Obtiene un valor que especifica el nombre para mostrar del archivo.
Propiedad pública TypedObject Obtiene el objeto con la información de tipo correcta que el servidor ha devuelto. (Heredado desde ClientObject).
Propiedad pública UIVersion Obtiene un valor que especifica el identificador de versión específico de la implementación del archivo.
Propiedad pública UIVersionLabel Obtiene un valor que especifica el identificador de versión específico de la implementación del archivo.
Propiedad pública UniqueId
Propiedad pública VersionEvents
Propiedad pública Versions Obtiene un valor que devuelve una colección de objetos de versión de archivo que representan las versiones del archivo.
Propiedad pública WebId

Arriba

Métodos

  Nombre Descripción
Método público Approve Aprueba el archivo enviado para la aprobación de su contenido con el comentario especificado.
Método público CancelUpload Deja el campo cargar sesión sin guardar los datos cargados. Si el archivo no existe en la biblioteca, se eliminará el archivo actualizado parcialmente. Use esta opción en respuesta a la acción del usuario (como en una solicitud para cancelar una carga) o un error o una excepción.
Método público CheckIn Protege el archivo en una biblioteca de documentos en función del tipo de protección.
Método público CheckOut Desprotege el archivo desde una biblioteca de documentos basado en el tipo de desprotección.
Método protegido CheckUninitializedProperty Comprueba si se ha inicializado la propiedad de tipo de valor especificado de un ClientObject . (Heredado desde ClientObject).
Método público ContinueUpload Continúa la sesión de carga de fragmentos con un fragmento adicional. El contenido del archivo actual no se modifica.
Método público CopyTo Copia el archivo en la dirección URL de destino. Servidor debe sobrescribir un archivo existente del mismo nombre si bOverwrite es true.
Método público CustomFromJson Devuelve un valor Boolean que indica si se utiliza código personalizado para rellenar un objeto. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Método público DeleteObject Elimina el objeto de archivo.
Método público Deny Deniega la aprobación para un archivo que se envió para aprobación de contenido.
Método público ExecuteCobaltRequest
Método público FinishUpload Carga el último fragmento de archivo y confirma el archivo. El contenido del archivo actual se modifica cuando este método se completa.
Método público FromJson Indica si se utilizó código personalizado para rellenar un objeto. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Método públicoMiembro estático GetContentVerFromTag Reservado solo para uso interno. Este método expone el valor ContentVersion interno dentro de una ContentTag.
Método público GetImagePreviewUrl
Método público GetLimitedWebPartManager Especifica el conjunto de controles usado para obtener acceso a los elementos web asociados con esta vista y página de elementos web, modificarlos o agregar elementos nuevos.
Método público GetPreAuthorizedAccessUrl
Método público GetWOPIFrameUrl
Método protegido InitNonPropertyFieldFromJson Inicializa un campo no propiedad del objeto de cliente basado en datos de Notación de objetos de JavaScript (JSON) desde el servidor. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Método protegido InitOnePropertyFromJson (Reemplaza a ClientObject.InitOnePropertyFromJson(String, JsonReader)).
Método público IsObjectPropertyInstantiated Indica si se crea una instancia de la propiedad especificada del objeto de cliente. (Heredado desde ClientObject).
Método público IsPropertyAvailable Devuelve un valor booleano que indica si se ha recuperado o establecido la propiedad escalar especificada. (Heredado desde ClientObject).
Método protegido LoadExpandoFields Inicializa las propiedades extendidas asociadas con el objeto de cliente cuando se reemplaza en una clase derivada. (Heredado desde ClientObject).
Método público MoveTo Mueve el archivo a la dirección URL de destino especificada.
Método públicoMiembro estático OpenBinaryDirect(ClientContext, String) Descarga el archivo especificado desde un sitio de SharePoint sin necesidad de una llamada al método de ExecuteQuery() .
Método públicoMiembro estático OpenBinaryDirect(ClientContext, String, EventHandler<OpenBinarySucceededEventArgs>, EventHandler<OpenBinaryFailedEventArgs>)
Método público OpenBinaryStream Abre el archivo como secuencia.
Método público Publish Envía el archivo para la aprobación de su contenido con el comentario especificado.
Método público Recycle Mueve el archivo a la papelera de reciclaje y devuelve el identificador del elemento de papelera de reciclaje nuevo.
Método público RefreshLoad Recarga todas las propiedades escalares asociadas con el objeto de cliente cuando se reemplaza en una clase derivada. (Heredado desde ClientObject).
Método protegido RemoveFromParentCollection Quita el objeto de cliente actual de la colección de objetos de cliente primarios. (Heredado desde ClientObject).
Método público Retrieve() Recupera todas las propiedades escalares asociadas con el objeto. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Método público Retrieve([]) Recupera las propiedades escalares especificadas asociadas con el objeto. Este miembro está reservado para uso interno y no debe usarse directamente desde el código. (Heredado desde ClientObject).
Método público SaveBinary Guarda el archivo especificado en una biblioteca de documentos.
Método públicoMiembro estático SaveBinaryDirect(ClientContext, String, Stream, Boolean) Carga el archivo especificado en un sitio de SharePoint sin necesidad de una llamada al método de ExecuteQuery() .
Método públicoMiembro estático SaveBinaryDirect(ClientContext, String, Stream, String) Carga el archivo especificado en un sitio de SharePoint con el valor Etag especificado sin necesidad de una llamada al método de ExecuteQuery() .
Método público StartUpload Inicia una nueva sesión de carga de fragmentos y carga el primer fragmento. El contenido del archivo actual no cambia cuando se complete este método. El método es idempotente (y por tanto no cambia el resultado) mientras usa los mismos valores para uploadId y stream.La sesión de carga finaliza cuando use el método CancelUpload(Guid) o tras completar la sesión de carga pasando el resto del contenido del archivo mediante los métodos ContinueUpload(Guid, Int64, Stream) y FinishUpload(Guid, Int64, Stream) .Por ejemplo, puede pasar un archivo de 35 MB dividiéndolo en tres secuencias de 10 MB y una secuencia de 5 MB, y cargándolo de esta manera (con los valores de desplazamiento resultantes de 10, 20 y 30 MB): StartUpload(GUID, stream1)
ContinueUpload(GUID, 10 MB, stream2)
ContinueUpload(GUID, 20 MB, stream3)
FinishUpload(GUID, 30 MB, stream4) Los métodos StartUpload(Guid, Stream) y ContinueUpload(Guid, Int64, Stream) devolverán el tamaño del total de ejecución de datos cargados en bytes, por lo que puede pasar los valores devueltos para usos posteriores de ContinueUpload(Guid, Int64, Stream) y FinishUpload(Guid, Int64, Stream)
Método público ToString (Heredado desde Object).
Método público UndoCheckOut Revierte una desprotección existente del archivo.
Método público UnPublish Quita el archivo de la aprobación de contenido o cancela la publicación de una versión principal.
Método público Update
Método protegido UpdateClientObjectPropertyType Actualiza el valor de la propiedad de objeto de cliente para que tenga el tipo correcto mediante la información de tipo devuelta desde el servidor. (Heredado desde ClientObject).

Arriba

Vea también

Referencia

clase File

Espacio de nombres Microsoft.SharePoint.Client