Compartilhar via

File membros

  • Artigo

Representa um arquivo em um site do SharePoint que pode ser uma Página de Web Parts, um item em uma biblioteca de documentos, ou um arquivo em uma pasta.

O tipo File expõe os membros a seguir

Construtores

  Nome Descrição
Método público File Inicializa uma nova instância do objeto File .

Início

Propriedades

  Nome Descrição
Propriedade pública Author Obtém um valor que especifica o usuário que adicionou o arquivo.
Propriedade pública CheckedOutByUser Obtém um valor que retorna o usuário que fez o check-out do arquivo.
Propriedade pública CheckInComment Obtém um valor que retorna o comentário usado quando um documento está marcado em uma biblioteca de documentos.
Propriedade pública CheckOutType Obtém um valor que especifica o tipo de check-out associado ao arquivo.
Propriedade pública ContentTag Retorna uma versão interna de conteúdo, usada para validar igualdade de documentos para propósitos de leitura.
Propriedade pública Context Retorna o contexto que está associado ao objeto de cliente. (Herdado de ClientObject.)
Propriedade pública CustomizedPageStatus Obtém um valor que especifica o status de personalização do arquivo.
Propriedade pública EffectiveInformationRightsManagementSettings
Propriedade pública ETag Obtém um valor que especifica o valor de ETag.
Propriedade pública Exists Obtém um valor que especifica se o arquivo existe.
Propriedade pública InformationRightsManagementSettings
Propriedade pública IrmEnabled
Propriedade pública Length Obtém o tamanho do arquivo em bytes, excluindo o tamanho de quaisquer Web Parts usadas no arquivo.
Propriedade pública Level Obtém um valor que especifica o nível de publicação e o nível de arquivo.
Propriedade pública LinkingUrl
Propriedade pública ListId
Propriedade pública ListItemAllFields Obtém o valor que especifica os valores do campo de item de lista para o item de lista correspondente ao arquivo.
Propriedade pública LockedByUser Obtém um valor que retorna o usuário que possui o bloqueio atual no arquivo.
Propriedade pública MajorVersion Obtém um valor que especifica a versão principal do arquivo.
Propriedade pública MinorVersion Obtém um valor que especifica a versão secundária do arquivo.
Propriedade pública ModifiedBy Obtém um valor que retorna o usuário que modificou o arquivo pela última vez.
Propriedade pública Name Obtém o nome do arquivo incluindo a extensão.
Propriedade protegida ObjectData Obtém os dados do objeto para o objeto atual do cliente. (Herdado de ClientObject.)
Propriedade pública ObjectVersion Obtém uma cadeia de caracteres que indica a versão do objeto atual do cliente. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Propriedade pública Path Controla como um objeto de cliente é criado na classe ClientRuntimeContext para que o objeto poderá ser recriado no servidor. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Propriedade pública Properties
Propriedade pública ServerObjectIsNull Obtém o objeto de servidor e retorna null se o objeto de servidor é nulo. (Herdado de ClientObject.)
Propriedade pública ServerRelativeUrl Obtém a URL relativa do arquivo com base na URL para o servidor.
Propriedade pública SiteId
Propriedade pública Tag Obtém ou define os dados que está associados ao objeto de cliente. (Herdado de ClientObject.)
Propriedade pública TimeCreated Obtém um valor que especifica a data em que o arquivo foi criado.
Propriedade pública TimeLastModified Obtém um valor que especifica quando o arquivo foi modificado pela última vez.
Propriedade pública Title Obtém um valor que especifica o nome de exibição do arquivo.
Propriedade pública TypedObject Obtém o objeto com as informações de tipo correto retornadas do servidor. (Herdado de ClientObject.)
Propriedade pública UIVersion Obtém um valor que especifica o identificador de versão do arquivo específico para a implementação.
Propriedade pública UIVersionLabel Obtém um valor que especifica o identificador de versão do arquivo específico para a implementação.
Propriedade pública UniqueId
Propriedade pública VersionEvents
Propriedade pública Versions Obtém um valor que retorna uma coleção de objetos de versão de arquivo que representam as versões do arquivo.
Propriedade pública WebId

Início

Métodos

  Nome Descrição
Método público Approve Aprova o arquivo enviado para aprovação de conteúdo com o comentário especificado.
Método público CancelUpload Interrompe o fragmento carregar sessão sem salvar os dados carregados. Se o arquivo não existir na biblioteca, o arquivo atualizado parcialmente será excluído. Use esta resposta a ação do usuário (como em uma solicitação para cancelar um carregamento) ou erro ou exceção.
Método público CheckIn Faz o check-in de um arquivo em uma biblioteca de documentos com base no tipo de check-in.
Método público CheckOut Check out do arquivo de uma biblioteca de documentos com base no check-out de tipo.
Método protegido CheckUninitializedProperty Verifica se a propriedade de tipo de valor especificado de um ClientObject foi inicializada. (Herdado de ClientObject.)
Método público ContinueUpload Continua a sessão de carregamento de partes com um fragmento adicional. O conteúdo do arquivo atual não será alterado.
Método público CopyTo Copia o arquivo para a URL de destino. Servidor deve substituir um arquivo existente de mesmo nome se bOverwrite for verdadeiro.
Método público CustomFromJson Retorna um valor booliano que indica se o código personalizado foi usado para popular um objeto. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Método público DeleteObject Exclui o objeto de arquivo.
Método público Deny Rejeita aprovação para um arquivo que tenha sido enviado para aprovação de conteúdos.
Método público ExecuteCobaltRequest
Método público FinishUpload Carrega o último fragmento de arquivo e confirma o arquivo. O conteúdo do arquivo atual será alterado quando este método for concluído.
Método público FromJson Indica se o código personalizado foi usado para popular um objeto. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Método públicoMembro estático GetContentVerFromTag Reservado para uso interno somente. Este método expõe o valor interno de ContentVersion dentro de um ContentTag.
Método público GetImagePreviewUrl
Método público GetLimitedWebPartManager Especifica a coleção de controles usada para acessar, modificar ou adicionar Web Parts associadas a esta Página de Web Parts e modo de exibição.
Método público GetPreAuthorizedAccessUrl
Método público GetWOPIFrameUrl
Método protegido InitNonPropertyFieldFromJson Inicializa um campo não propriedades do objeto cliente com base em dados de JavaScript Object Notation (JSON) do servidor. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Método protegido InitOnePropertyFromJson (Substitui ClientObject.InitOnePropertyFromJson(String, JsonReader).)
Método público IsObjectPropertyInstantiated Indica se a propriedade especificada do objeto cliente é criada uma instância. (Herdado de ClientObject.)
Método público IsPropertyAvailable Retorna um valor booliano que indica se a propriedade escalar especificada foi recuperada ou definir. (Herdado de ClientObject.)
Método protegido LoadExpandoFields Inicializa as propriedades estendidas associadas ao objeto de cliente quando substituído em uma classe derivada. (Herdado de ClientObject.)
Método público MoveTo Move o arquivo para a URL de destino especificada.
Método públicoMembro estático OpenBinaryDirect(ClientContext, String) Baixa o arquivo especificado de um site do SharePoint sem a necessidade de uma chamada de método ExecuteQuery() .
Método públicoMembro estático OpenBinaryDirect(ClientContext, String, EventHandler<OpenBinarySucceededEventArgs>, EventHandler<OpenBinaryFailedEventArgs>)
Método público OpenBinaryStream Abre o arquivo como um fluxo.
Método público Publish Envia o arquivo para aprovação de conteúdo com o comentário especificado.
Método público Recycle Move o arquivo para a Lixeira e retorna o identificador do novo item de Lixeira.
Método público RefreshLoad Carrega novamente todas as propriedades escalares associadas ao objeto de cliente quando substituído em uma classe derivada. (Herdado de ClientObject.)
Método protegido RemoveFromParentCollection Remove o objeto atual do cliente da coleção de objeto de cliente do pai. (Herdado de ClientObject.)
Método público Retrieve() Recupera todas as propriedades escalares associadas ao objeto. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Método público Retrieve([]) Recupera as propriedades de escalares especificadas associadas ao objeto. This member is reserved for internal use and is not intended to be used directly from your code. (Herdado de ClientObject.)
Método público SaveBinary Salva o arquivo especificado em uma biblioteca de documentos.
Método públicoMembro estático SaveBinaryDirect(ClientContext, String, Stream, Boolean) Carrega o arquivo especificado para um site do SharePoint sem a necessidade de uma chamada de método ExecuteQuery() .
Método públicoMembro estático SaveBinaryDirect(ClientContext, String, Stream, String) Carrega o arquivo especificado para um site do SharePoint com a Etag especificado sem a necessidade de uma chamada de método ExecuteQuery() .
Método público StartUpload Inicia uma nova sessão de carregamento de bloco e carrega o primeiro fragmento. O conteúdo do arquivo atual não é alterado quando este método é concluída. O método é idempotente (e, portanto, não altera o resultado), desde que você use os mesmos valores para uploadId e stream.A sessão de carregamento termina quando você usar o método de CancelUpload(Guid) ou quando você tiver concluído a sessão de carregamento passando o restante do conteúdo do arquivo por meio dos métodos ContinueUpload(Guid, Int64, Stream) e FinishUpload(Guid, Int64, Stream) .Por exemplo, você pode passar um arquivo de 35 MB, dividindo-la em três fluxos de 10 MB e um fluxo de 5 MB e carregando-las dessa maneira (usando os valores de deslocamento resultantes de 10, 20 e 30 MB): StartUpload(GUID, stream1)
ContinueUpload(GUID, 10 MB, stream2)
ContinueUpload(GUID, 20 MB, stream3)
FinishUpload(GUID, 30 MB, stream4) Os métodos StartUpload(Guid, Stream) e ContinueUpload(Guid, Int64, Stream) retornam o tamanho do total em execução de dados carregados em bytes, para que você pode passar esses valores de retorno para usos subsequentes ContinueUpload(Guid, Int64, Stream) e FinishUpload(Guid, Int64, Stream)
Método público ToString (Herdado de Object.)
Método público UndoCheckOut Reverte um check-out existente para o arquivo.
Método público UnPublish Remove o arquivo da aprovação de conteúdo ou cancela a publicação de uma versão principal.
Método público Update
Método protegido UpdateClientObjectPropertyType Atualiza o cliente objeto valor da propriedade para que o tipo correto usando as informações de tipo retornadas do servidor. (Herdado de ClientObject.)

Início

Ver também

Referência

File classe

Microsoft.SharePoint.Client namespace