Partilhar via

Classe DocData

  • Artigo

Quando substituído em uma classe derivada, representa um documento na memória.

Esta API não compatível com CLS. 

Hierarquia de herança

System.Object
  System.MarshalByRefObject
    Microsoft.VisualStudio.Modeling.Shell.DocData
      Microsoft.VisualStudio.Modeling.Shell.ModelingDocData
      Microsoft.VisualStudio.Modeling.Shell.SubordinateDocData

Namespace:  Microsoft.VisualStudio.Modeling.Shell
Assembly:  Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0 (em Microsoft.VisualStudio.Modeling.Sdk.Shell.12.0.dll)

Sintaxe

'Declaração
<CLSCompliantAttribute(False)> _
Public MustInherit Class DocData _
    Inherits MarshalByRefObject _
    Implements IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl,  _
    IPersistFileFormat, IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData,  _
    IVsFileBackup, IServiceProvider

[CLSCompliantAttribute(false)]
public abstract class DocData : MarshalByRefObject, 
    IVsPersistDocData2, IVsPersistDocData, IVsFileChangeEvents, IVsDocDataFileChangeControl, IPersistFileFormat, 
    IPersist, IDisposable, IVsSaveOptionsDlg, IVsUserData, IVsFileBackup, 
    IServiceProvider

O tipo DocData expõe os membros a seguir.

Construtores

  Nome Descrição
Método protegido DocData Inicializa uma nova instância da classe DocData.

Superior

Propriedades

  Nome Descrição
Propriedade pública Cookie Obtém o cookie que identifica o documento na tabela em execução documentos.
Propriedade pública DocViews Obtém a coleção de modos de documento que estão abertas para o documento.
Propriedade pública Encoding Obtém ou define a codificação que persiste o documento.
Propriedade pública FileName Obtém o nome de arquivo do documento.
Propriedade protegida FormatList Obtém uma lista dos formatos.
Propriedade pública Hierarchy Obtém a hierarquia de projeto ao qual pertence o documento.
Propriedade protegida IsBackupFileObsolete
Propriedade pública IsLoaded Obtém o documento e verifique se ele seja carregado.
Propriedade pública ItemId Obtém o ID de item que é atribuído ao documento.
Propriedade protegida ServiceProvider Obtém o provedor de serviços de shell.
Propriedade pública UndoManager Obtém a interface de UndoManager para o documento.
Propriedade protegida UndoManagerIsShared Obtém o documento e verifique se mais de um documento está compartilhando a mesma interface de UndoManager .
Propriedade pública VSUndoManager Obtém a interface de UndoManager .

Superior

Métodos

  Nome Descrição
Método protegido BackupFile Faça backup de um único arquivo deste documento.Retorna se o documento é esperado recarregar sem perda de dados.
Método protegido CanSave Verifica se o usuário pode cancelar a operação de salvar.
Método público Close Fecha o documento.
Método público CreateObjRef Segurança crítica. Cria um objeto que contém todas as informações relevantes necessárias para gerar um proxy usado para se comunicar com um objeto remoto. (Herdado de MarshalByRefObject.)
Método público DirectoryChanged Não implementado atualmente.
Método protegido Dispose Libera os recursos não gerenciados usados pelo DocData e opcionalmente libera os recursos gerenciados.
Método público Equals Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object.)
Método público FilesChanged Notifica clientes que um ou vários documentos foram alterados.
Método protegido Finalize Permite que um objeto tente liberar recursos e executar outras operações de limpeza antes que seja recuperado pela coleta de lixo. (Herdado de Object.)
Método público FlushUndoManager Limpa UndoManager.
Método público GetClassID Obtém o GUID de fábrica de editor que criou o documento.
Método público GetCurFile Obtém o nome de arquivo do documento.
Método público GetData Obtém os dados do documento de um buffer.
Método público GetFormatList Obtém a lista de formatos de documento suportados.
Método público GetGuidEditorType Obtém o GUID de fábrica de editor que criou o objeto de IVsPersistDocData .
Método público GetHashCode Serve como a função de hash padrão. (Herdado de Object.)
Método público GetLifetimeService Segurança crítica. Recupera o objeto de serviço Vida útil atual que controla a diretiva vida útil para esta instância. (Herdado de MarshalByRefObject.)
Método público GetService Retornar o serviço aplicativo.
Método público GetType Obtém Type da instância atual. (Herdado de Object.)
Método protegido HandleLoadDocDataException Gerencia todas as exceções que são geradas quando o documento está carregando.
Método protegido HandleSaveDocDataException Gerencia todas as exceções que são geradas quando o documento está salvando.
Método público IgnoreFileChanges Determina se as alterações para o documento devem ser ignoradas.
Método público InitializeLifetimeService Segurança crítica. Obtém um objeto de serviço de tempo de vida para controlar a diretiva vida útil para esta instância. (Herdado de MarshalByRefObject.)
Método público InitNew Inicializa o documento.
Método público IsDirty Verifica se o documento foi alterado desde que a operação a mais recente de salvar.
Método público IsDocDataDirty Verifica se o documento foi alterado desde que a operação a mais recente de salvar.
Método público IsDocDataReadOnly Verifica se o documento é somente leitura.
Método público IsDocDataReloadable Verifica se o documento pode ser recarregado.
Método protegido Load(String, Boolean) Carrega o documento na memória.
Método público Load(String, UInt32, Int32) Carrega o documento na memória.
Método público LoadDocData(String) Carrega o documento usando o nome de arquivo.
Método protegido LoadDocData(String, Boolean) Carrega o documento usando o nome de arquivo.
Método público MarkDocumentChangedForBackup Marcar o documento foi alterado e assim um novo backup deve ser criado
Método protegido MemberwiseClone() Cria uma cópia superficial de Objectatual. (Herdado de Object.)
Método protegido MemberwiseClone(Boolean) Cria uma cópia superficial do atual MarshalByRefObject objeto. (Herdado de MarshalByRefObject.)
Método protegido OnDocumentClosed Alerta ouvintes que o documento foi fechada.
Método protegido OnDocumentClosing Alerta ouvintes que o documento será fechado.
Método protegido OnDocumentLoaded Alerta ouvintes que o documento é carregado.
Método protegido OnDocumentLoading Alerta ouvintes que o documento será carregado.
Método protegido OnDocumentReadOnlyChanged Alerta ouvintes que o estado somente leitura do documento alterado.
Método protegido OnDocumentReloaded Alerta ouvintes que o documento foi recarregado.
Método protegido OnDocumentReloading Alerta ouvintes que o documento será recarregado.
Método protegido OnDocumentSaved Alerta ouvintes que o documento foi salvo.
Método protegido OnDocumentSaving Alerta ouvintes que o documento será salvo.
Método protegido OnFileNameChanged Alerta ouvintes que o nome de arquivo do documento alterado.
Método protegido OnHierarchyChanged Alerta ouvintes que o ID de item que é atribuído ao documento alterado.
Método público OnRegisterDocData Atribui o documento em uma hierarquia de cookie e do projeto.
Método público OpenView Abre um modo de exibição específico para o documento.
Método público QueryEditFile() Alerta ouvintes que um documento está prestes a ser editado.Ouvintes podem votar na edição.
Método público QueryEditFile(String, tagVSQueryEditFlags) Alerta ouvintes que um documento está prestes a ser editado.Ouvintes podem votar na edição.
Método público QuerySaveFile() Alerta ouvintes que um arquivo está prestes a ser salvo.Ouvintes podem
Método público QuerySaveFile(String, tagVSQuerySaveFlags) Alerta ouvintes que um arquivo está prestes a ser salvo.
Método público ReloadDocData Recarrega o documento.
Método protegido ReloadDocDataWorker Recarrega o documento.
Método público RenameDocData Renomeia um documento e reseta sua posição na hierarquia.
Método protegido ResumeFileChangeNotification Continua a distribuição de um documento notificações de alteração para o documento.
Método protegido Save(String) Salva o documento.
Método público Save(String, Int32, UInt32) Salva o documento.
Método público SaveCompleted Alerta ouvintes que o documento foi salvo.
Método público SaveDocData Salva o documento em um local específico.
Método protegido SaveDocDataToFile Salva o documento em um local específico.
Método protegido SaveSubordinateFile Salve o documento especificado que é subordinado ao documento, por exemplo um arquivo de diagrama.
Método público SetData Define o documento a um buffer.
Método público SetDocDataDirty Defina o parâmetro de IsDirty do documento.
Método público SetDocDataReadOnly Define o sinalizador somente leitura do documento.
Método protegido SetFileName Inicializa ou alterar o nome de arquivo para o documento.
Método protegido SetHierarchyInfo Inicializa ou altera a hierarquia de projeto para o documento.
Método público SetUntitledDocPath Atualmente não implementado.
Método público ShowSaveOptionsDlg Mostra uma caixa de diálogo que o usuário pode especificar opções adicionais para formatos de salvar.
Método protegido SuspendFileChangeNotification Suspende a distribuição de um documento notificações de alteração para o documento.
Método público ToString Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object.)

Superior

Eventos

  Nome Descrição
Evento público DocumentClosed Ocorre depois que o documento é fechado.
Evento público DocumentClosing Ocorre antes que o documento está fechado.
Evento público DocumentLoaded Ocorre depois que o documento foi carregado na janela modelando.
Evento público DocumentLoading Ocorre antes que o documento está carregado na janela modelando.
Evento público DocumentReadOnlyChanged Ocorre quando o sinalizador somente leitura para o documento alterado.
Evento público DocumentReloaded Ocorre depois que o documento é recarregado.
Evento público DocumentReloading Ocorre antes que o documento ser recarregado.
Evento público DocumentSaved Ocorre depois que o documento é salvo.
Evento público DocumentSaving Ocorre antes que o documento ser salvo.
Evento público FileNameChanged Ocorrer quando as alterações do documento.
Evento público HierarchyChanged Ocorre quando o ID da hierarquia ou de item do documento altera.

Superior

Implementações explícitas da interface

  Nome Descrição
Implementação explícita da interfaceMétodo particular IVsFileBackup.BackupFile Faça backup de um único arquivo deste documento.
Implementação explícita da interfaceMétodo particular IDisposable.Dispose Libera os recursos usados pela instância atual da classe de DocData .
Implementação explícita da interfaceMétodo particular IPersistFileFormat.GetClassID Obtém a identificação de classe de factory de editor que criou o documento.
Implementação explícita da interfaceMétodo particular IVsFileBackup.IsBackupFileObsolete Obter se o arquivo de backup é atualizado.

Superior

Comentários

Essa classe também escuta para eventos de alteração para documentos externos e pode solicitar ao usuário para recarregar o documento.

Acesso thread-safe

Quaisquer membros estático (Shared no Visual Basic) públicos deste tipo são thread-safe. Não há garantia de que qualquer membro de instância seja thread-safe.

Consulte também

Referência

Namespace Microsoft.VisualStudio.Modeling.Shell