Partilhar via

Classe ModelingDocData

  • Artigo

Representa um documento no repositório.

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

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 ModelingDocData _
    Inherits DocData _
    Implements IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

[CLSCompliantAttribute(false)]
public abstract class ModelingDocData : DocData, 
    IVsTextBufferProvider, IServiceProvider, IVsHasRelatedSaveItems

O tipo ModelingDocData expõe os membros a seguir.

Construtores

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

Superior

Propriedades

  Nome Descrição
Propriedade pública Cookie Obtém o cookie que identifica o documento na tabela de documentos em execução. (Herdado de DocData.)
Propriedade pública DocViews Obtém a coleção de exibições de documentos que estão abertos para o documento. (Herdado de DocData.)
Propriedade pública Encoding Obtém ou define a codificação que persiste no documento. (Herdado de DocData.)
Propriedade pública ErrorListProvider Obtém o provedor de lista de erro para o documento.
Propriedade pública FileName Obtém o nome de arquivo do documento. (Herdado de DocData.)
Propriedade protegida FormatList Obtém uma lista de formatos. (Herdado de DocData.)
Propriedade pública HasErrorListItems Obtém a lista de erros e verifica se os erros e avisos do documento aparecem na janela Error List.
Propriedade pública Hierarchy Obtém a hierarquia do projeto ao qual pertence o documento. (Herdado de DocData.)
Propriedade protegida InLoad Obtém o documento e verifica se ele está sendo carregado na janela de modelagem.
Propriedade protegida InReload Obtém o documento e verifica se ele é recarregado para a janela de modelagem.
Propriedade protegida IsBackupFileObsolete (Herdado de DocData.)
Propriedade pública IsLoaded Obtém o documento e verifica se ele é carregado. (Herdado de DocData.)
Propriedade pública ItemId Obtém a ID de Item que é atribuído ao documento. (Herdado de DocData.)
Propriedade pública ModelingDocStore Obtém o armazenamento de designer de modelagem que é atribuído ao documento.
Propriedade protegida PartitionMapper
Propriedade protegida RelatedDocList
Propriedade pública RootElement Obtém o elemento raiz do documento.
Propriedade protegida SerializedModel
Propriedade protegida ServiceProvider Obtém o provedor de serviços a partir do shell. (Herdado de DocData.)
Propriedade pública Store Obtém o armazenamento de designer de modelagem à qual este documento é atribuído.
Propriedade pública UndoManager Obtém o UndoManager classe, que você pode usar para desfazer e refazer operações no armazenamento de designer de modelagem. (Substitui DocData.UndoManager.)
Propriedade protegida UndoManagerIsShared Obtém o UndoManager de classe e verifica se ele é compartilhado entre documentos. (Substitui DocData.UndoManagerIsShared.)
Propriedade pública VSUndoManager Obtém o UndoManager interface. (Herdado de DocData.)

Superior

Métodos

  Nome Descrição
Método público AddErrorListItem Adiciona um erro ou mensagem de aviso que você pode usar com o documento.
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. (Herdado de DocData.)
Método protegido CanSave Verifica se o usuário pode cancelar o salvamento operação. (Herdado de DocData.)
Método protegido CleanupStores Limpa os armazenamentos de designer de modelagem, antes que o recarregamento de um documento na memória.
Método público ClearErrorListItems Limpa as mensagens de erro e aviso de janela Error List.
Método público Close Fecha o documento. (Herdado de DocData.)
Método protegido CreateModelingDocStore Cria um documento para o armazenamento de designer de modelagem.
Método protegido CreateObject Cria um objeto
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 protegido CreatePartitionMapper Método de fábrica para criar o mapeador de partição responsável para elementos de mapeamento para as partições corretas do armazenamento pertencentes a esta ModelingDocData quando reconstituídos, ElementGroupPrototypes.
Método protegido CreateStore Cria um armazenamento de modelagem.
Método protegido CreateSubordinateDocData Criar uma instância de dados de doc subordinada
Método público DirectoryChanged Ainda não implementado. (Herdado de DocData.)
Método protegido Dispose Libera os recursos não gerenciados usados pela ModelingDocData e, opcionalmente, libera os recursos gerenciados. (Substitui DocData.Dispose(Boolean).)
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. (Herdado de DocData.)
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 classe para o armazenamento. (Substitui DocData.FlushUndoManager().)
Método público GetAllElementsForValidation Obtenha todos os elementos para validação.A implementação base retorna todos os elementos no armazenamento desta DocData.
Método público GetClassID Obtém a GUID da fábrica de editor que criou o documento. (Herdado de DocData.)
Método público GetCurFile Obtém o nome de arquivo do documento. (Herdado de DocData.)
Método público GetData Obtém os dados dos documentos de um buffer. (Herdado de DocData.)
Método protegido GetDomainModels Obtém uma coleção de tipos a serem carregados para o armazenamento.
Método público GetFormatList Obtém a lista de formatos de documentos com suporte. (Herdado de DocData.)
Método público GetGuidEditorType Obtém a GUID da fábrica de editor que criou o IVsPersistDocData objeto. (Herdado de DocData.)
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 GetRelatedSaveTreeItems Implementação padrão de IVsHasRelatedSaveItems.Se outro DocData foi registrado usando a interface IRelatedDocList com essa instância, ele será ser retornado como um RelatedSaveTreeItem.
Método público GetService Atender a serviços locais para o armazenamento e os usuários do provedor de serviços de lojas (Substitui DocData.GetService(Type).)
Método público GetTextBuffer Carrega o modelo serializado em um novo buffer.
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. (Herdado de DocData.)
Método protegido HandleSaveDocDataException Gerencia todas as exceções que foram apresentadas quando estava salvando o documento. (Herdado de DocData.)
Método público HideErrorListItems Oculta todas as mensagens de erro e aviso que estão na janela Error List.
Método público IgnoreFileChanges Determina se as alterações no documento devem ser ignoradas. (Herdado de DocData.)
Método público Initialize() Inicializa o ModelingDocData classe.
Método público Initialize(Store) Inicializa o armazenamento de designer de modelagem para o documento.
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. (Herdado de DocData.)
Método público IsDirty Verifica se o documento foi alterado desde que a operação de salvamento a mais recente. (Herdado de DocData.)
Método público IsDocDataDirty Verifica se o documento foi alterado desde que a operação de salvamento a mais recente. (Herdado de DocData.)
Método público IsDocDataReadOnly Verifica se o documento é somente leitura. (Herdado de DocData.)
Método público IsDocDataReloadable Verifica se o documento pode ser recarregado. (Herdado de DocData.)
Método protegido IsFlushUndoStackRequiredOnLoad Ignore este método para especificar se a pilha de desfazer é a serem liberadas após o carregamento (abrir ou criar) o docdata.
Método protegido Load(String, Boolean) Carrega o documento na memória. (Herdado de DocData.)
Método público Load(String, UInt32, Int32) Carrega o documento na memória. (Herdado de DocData.)
Método público LoadDocData(String) Carrega o documento usando seu nome de arquivo. (Herdado de DocData.)
Método protegido LoadDocData(String, Boolean) Carrega um documento que tem um nome de arquivo específico. (Substitui DocData.LoadDocData(String, Boolean).)
Método público LockTextBuffer Não implementado.
Método público MarkDocumentChangedForBackup Marcar o documento foi alterado e, portanto, um novo backup devem ser criados (Herdado de DocData.)
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 Chamado quando o documento é fechado.Comportamento padrão limpa o conteúdo da lista de erro. (Substitui DocData.OnDocumentClosed(EventArgs).)
Método protegido OnDocumentClosing Ouvintes de alertas que o documento será fechado. (Herdado de DocData.)
Método protegido OnDocumentLoaded Ouvintes de alertas que o documento é carregado. (Herdado de DocData.)
Método protegido OnDocumentLoading Ouvintes de alertas que o documento será carregado. (Herdado de DocData.)
Método protegido OnDocumentReadOnlyChanged Ouvintes de alertas que o estado somente leitura do documento foi alterado. (Herdado de DocData.)
Método protegido OnDocumentReloaded Ouvintes de alertas que o documento foi recarregado. (Herdado de DocData.)
Método protegido OnDocumentReloading Ouvintes de alertas que o documento será recarregado. (Herdado de DocData.)
Método protegido OnDocumentSaved Ouvintes de alertas que o documento foi salvo. (Herdado de DocData.)
Método protegido OnDocumentSaving Ouvintes de alertas que o documento será salvo. (Herdado de DocData.)
Método protegido OnFileNameChanged Ouvintes de alertas que mudou o nome do arquivo do documento. (Herdado de DocData.)
Método protegido OnHierarchyChanged Chamado quando um documento for adicionado ou renomeado. (Substitui DocData.OnHierarchyChanged(EventArgs).)
Método público OnRegisterDocData Atribui o documento a uma hierarquia de cookie e o projeto. (Herdado de DocData.)
Método público OpenView Abre um modo de exibição específico para o documento. (Substitui DocData.OpenView(Guid, Object).)
Método público QueryEditFile() Ouvintes de alertas que um documento está prestes a ser editado.Ouvintes poderá votar contra a edição. (Herdado de DocData.)
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. (Herdado de DocData.)
Método público QuerySaveFile() Ouvintes de alertas que um arquivo está prestes a ser salvo.Ouvintes pode (Herdado de DocData.)
Método público QuerySaveFile(String, tagVSQuerySaveFlags) Ouvintes de alertas que um arquivo está prestes a ser salvo. (Herdado de DocData.)
Método público ReloadDocData Recarrega o documento. (Herdado de DocData.)
Método protegido ReloadDocDataWorker Recarrega o documento. (Herdado de DocData.)
Método público RenameDocData Renomeia um documento e redefine sua posição na hierarquia. (Herdado de DocData.)
Método público ResumeErrorListRefresh Atualiza a janela Error List toda vez que uma mensagem de erro ou aviso é adicionada para o documento.
Método protegido ResumeFileChangeNotification Retoma a distribuição de notificações de alteração do documento para o documento. (Herdado de DocData.)
Método protegido Save(String) Salva o documento. (Herdado de DocData.)
Método público Save(String, Int32, UInt32) Salva o documento. (Herdado de DocData.)
Método público SaveCompleted Ouvintes de alertas que o documento foi salvo. (Herdado de DocData.)
Método público SaveDocData Salva o documento para um local específico. (Herdado de DocData.)
Método protegido SaveDocDataToFile Salva o documento para um local específico. (Herdado de DocData.)
Método protegido SaveSubordinateFile Salve o documento especificado que seja subordinado a este documento, por exemplo, um arquivo de diagrama. (Herdado de DocData.)
Método público SetData Define o documento para um buffer. (Herdado de DocData.)
Método público SetDocDataDirty Define o documento IsDirty sinalizador. (Herdado de DocData.)
Método público SetDocDataReadOnly Define o sinalizador de somente leitura do documento. (Herdado de DocData.)
Método protegido SetFileName Inicializa ou altera o nome do arquivo para o documento. (Herdado de DocData.)
Método protegido SetHierarchyInfo Inicializa ou altera a hierarquia do projeto para o documento. (Herdado de DocData.)
Método protegido SetRootElement Define o elemento raiz.
Método público SetTextBuffer Não implementado.
Método público SetUntitledDocPath Ainda não implementado. (Herdado de DocData.)
Método público ShowErrorListItems Mostra todas as mensagens de erro e aviso na janela Error List.
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. (Herdado de DocData.)
Método público SupportsLogicalView Verifica se o documento suporta o modo de exibição especificado.
Método público SuspendErrorListRefresh Impede que a janela de lista de erros de atualização.
Método protegido SuspendFileChangeNotification Suspende a distribuição de notificações de alteração do documento para o documento. (Herdado de DocData.)
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. (Herdado de DocData.)
Evento público DocumentClosing Ocorre antes que o documento é fechado. (Herdado de DocData.)
Evento público DocumentLoaded Ocorre depois que o documento foi carregado na janela de modelagem. (Herdado de DocData.)
Evento público DocumentLoading Ocorre antes que o documento é carregado na janela de modelagem. (Herdado de DocData.)
Evento público DocumentReadOnlyChanged Ocorre quando o sinalizador de somente leitura para o documento alterado. (Herdado de DocData.)
Evento público DocumentReloaded Ocorre depois que o documento é recarregado. (Herdado de DocData.)
Evento público DocumentReloading Ocorre antes que o documento é recarregado. (Herdado de DocData.)
Evento público DocumentSaved Ocorre depois que o documento for salvo. (Herdado de DocData.)
Evento público DocumentSaving Ocorre antes que o documento for salvo. (Herdado de DocData.)
Evento público FileNameChanged Ocorre quando muda de nome de arquivo do documento. (Herdado de DocData.)
Evento público HierarchyChanged Ocorre quando a hierarquia do documento ou o ID de Item é alterada. (Herdado de DocData.)

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. (Herdado de DocData.)
Implementação explícita da interfaceMétodo particular IDisposable.Dispose Libera todos os recursos utilizados pela instância atual da DocData classe. (Herdado de DocData.)
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. (Herdado de DocData.)
Implementação explícita da interfaceMétodo particular IVsFileBackup.IsBackupFileObsolete Obtenha se o arquivo de backup está atualizado. (Herdado de DocData.)

Superior

Comentários

O documento na memória é amparado por um armazenamento de memória.

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