Compartilhar 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.11.0 (em Microsoft.VisualStudio.Modeling.Sdk.Shell.11.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 de documentos em execução.
Propriedade pública DocViews Obtém a coleção de exibições de documentos que estão abertos para o documento.
Propriedade pública Encoding Obtém ou define a codificação que persiste no documento.
Propriedade pública FileName Obtém o nome de arquivo do documento.
Propriedade protegida FormatList Obtém uma lista de formatos.
Propriedade pública Hierarchy Obtém a hierarquia do projeto ao qual pertence o documento.
Propriedade protegida IsBackupFileObsolete
Propriedade pública IsLoaded Obtém o documento e verifica se ele é carregado.
Propriedade pública ItemId Obtém a ID de Item que é atribuído ao documento.
Propriedade protegida ServiceProvider Obtém o provedor de serviços a partir do shell.
Propriedade pública UndoManager Obtém o UndoManager interface para o documento.
Propriedade protegida UndoManagerIsShared Obtém o documento e verifica se a mais de um documento está compartilhando o mesmo UndoManager interface.
Propriedade pública VSUndoManager Obtém o UndoManager interface.

Superior

Métodos

  Nome Descrição
Método protegido BackupFile Faça com que um único arquivo backup deste documento.Retorna se o documento é esperado o recarregamento sem perda de dados.
Método protegido CanSave Verifica se o usuário pode cancelar o salvamento operação.
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 Ainda não implementado.
Método protegido Dispose Libera os recursos não gerenciados usados pela 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 os clientes que um ou mais documentos alterados.
Método protegido Finalize Permite que um objeto tentar liberar recursos e realizar outras operações de limpeza antes de ser recuperados pela coleta de lixo. (Herdado de Object.)
Método público FlushUndoManager Limpa o UndoManager.
Método público GetClassID Obtém a GUID da 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 dos documentos de um buffer.
Método público GetFormatList Obtém a lista de formatos de documentos com suporte.
Método público GetGuidEditorType Obtém a GUID da fábrica de editor que criou o IVsPersistDocData objeto.
Método público GetHashCode Serve como uma função de hash para um tipo específico. (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 Retorne o serviço solicitado.
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 foram apresentadas ao carregar o documento.
Método protegido HandleSaveDocDataException Gerencia todas as exceções que foram apresentadas quando estava salvando o documento.
Método público IgnoreFileChanges Determina se as alterações no 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 de salvamento a mais recente.
Método público IsDocDataDirty Verifica se o documento foi alterado desde que a operação de salvamento a mais recente.
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 seu nome de arquivo.
Método protegido LoadDocData(String, Boolean) Carrega o documento usando seu nome de arquivo.
Método público MarkDocumentChangedForBackup Marcar o documento foi alterado e, portanto, um novo backup devem ser criados
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 Ouvintes de alertas que o documento foi fechado.
Método protegido OnDocumentClosing Ouvintes de alertas que o documento será fechado.
Método protegido OnDocumentLoaded Ouvintes de alertas que o documento é carregado.
Método protegido OnDocumentLoading Ouvintes de alertas que o documento será carregado.
Método protegido OnDocumentReadOnlyChanged Ouvintes de alertas que o estado somente leitura do documento foi alterado.
Método protegido OnDocumentReloaded Ouvintes de alertas que o documento foi recarregado.
Método protegido OnDocumentReloading Ouvintes de alertas que o documento será recarregado.
Método protegido OnDocumentSaved Ouvintes de alertas que o documento foi salvo.
Método protegido OnDocumentSaving Ouvintes de alertas que o documento será salvo.
Método protegido OnFileNameChanged Ouvintes de alertas que mudou o nome do arquivo do documento.
Método protegido OnHierarchyChanged Alerta ouvintes que a ID de Item que é atribuído ao documento foi alterado.
Método público OnRegisterDocData Atribui o documento a uma hierarquia de cookie e o projeto.
Método público OpenView Abre um modo de exibição específico para o documento.
Método público QueryEditFile() Ouvintes de alertas que um documento está prestes a ser editado.Ouvintes poderá votar contra a edição.
Método público QueryEditFile(String, tagVSQueryEditFlags) Ouvintes de alertas que um documento está prestes a ser editado.Ouvintes poderá votar contra a edição.
Método público QuerySaveFile() Ouvintes de alertas que um arquivo está prestes a ser salvo.Ouvintes pode
Método público QuerySaveFile(String, tagVSQuerySaveFlags) Ouvintes de alertas 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 redefine sua posição na hierarquia.
Método protegido ResumeFileChangeNotification Retoma a distribuição de notificações de alteração do documento 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 Ouvintes de alertas que o documento foi salvo.
Método público SaveDocData Salva o documento para um local específico.
Método protegido SaveDocDataToFile Salva o documento para um local específico.
Método protegido SaveSubordinateFile Salve o documento especificado que seja subordinado a este documento, por exemplo, um arquivo de diagrama.
Método público SetData Define o documento para um buffer.
Método público SetDocDataDirty Define o documento IsDirty sinalizador.
Método público SetDocDataReadOnly Define o sinalizador de somente leitura do documento.
Método protegido SetFileName Inicializa ou altera o nome do arquivo para o documento.
Método protegido SetHierarchyInfo Inicializa ou altera a hierarquia do projeto para o documento.
Método público SetUntitledDocPath Ainda não implementado.
Método público ShowSaveOptionsDlg Mostra uma caixa de diálogo a partir do qual o usuário pode especificar opções adicionais para formatos.
Método protegido SuspendFileChangeNotification Suspende a distribuição de notificações de alteração do documento 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 é fechado.
Evento público DocumentLoaded Ocorre depois que o documento foi carregado na janela de modelagem.
Evento público DocumentLoading Ocorre antes que o documento é carregado na janela de modelagem.
Evento público DocumentReadOnlyChanged Ocorre quando o sinalizador de 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 é recarregado.
Evento público DocumentSaved Ocorre depois que o documento for salvo.
Evento público DocumentSaving Ocorre antes que o documento for salvo.
Evento público FileNameChanged Ocorre quando muda de nome de arquivo do documento.
Evento público HierarchyChanged Ocorre quando a hierarquia do documento ou o ID de Item é alterada.

Superior

Implementações explícitas da interface

  Nome Descrição
Implementação explícita da interfaceMétodo particular IVsFileBackup.BackupFile Faça com que um único arquivo backup deste documento.
Implementação explícita da interfaceMétodo particular IDisposable.Dispose Libera todos os recursos utilizados pela instância atual da DocData classe.
Implementação explícita da interfaceMétodo particular IPersistFileFormat.GetClassID Obtém a ID de classe da fábrica de editor que criou o documento.
Implementação explícita da interfaceMétodo particular IVsFileBackup.IsBackupFileObsolete Obtenha se o arquivo de backup está atualizado.

Superior

Comentários

Essa classe também escuta para alterar os eventos para documentos externos e pode solicitar que o 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