Compartilhar via

Método CodeModel.AddInterface

  • Artigo

Cria uma nova construção de código de interface e insere o código no local correto.

Namespace:  EnvDTE
Assembly:  EnvDTE (em EnvDTE.dll)

Sintaxe

'Declaração
Function AddInterface ( _
    Name As String, _
    Location As Object, _
    Position As Object, _
    Bases As Object, _
    Access As vsCMAccess _
) As CodeInterface

CodeInterface AddInterface(
    string Name,
    Object Location,
    Object Position,
    Object Bases,
    vsCMAccess Access
)

CodeInterface^ AddInterface(
    String^ Name, 
    Object^ Location, 
    Object^ Position, 
    Object^ Bases, 
    vsCMAccess Access
)

abstract AddInterface : 
        Name:string * 
        Location:Object * 
        Position:Object * 
        Bases:Object * 
        Access:vsCMAccess -> CodeInterface 

function AddInterface(
    Name : String, 
    Location : Object, 
    Position : Object, 
    Bases : Object, 
    Access : vsCMAccess
) : CodeInterface

Parâmetros

  • Name
    Tipo: System.String
    Obrigatório.O nome da interface a ser adicionada.
  • Location
    Tipo: System.Object
    Obrigatório.O nome de arquivo e caminho para a nova definição de interface.Dependendo do idioma, o nome do arquivo é relativo ou absoluto para o arquivo de projeto.O arquivo é adicionado ao projeto, se já não é um item de projeto.Se o arquivo não pode ser criado e adicionado ao projeto, em seguida, AddInterface falhar.
  • Position
    Tipo: System.Object
    Opcional.Padrão = 0.O elemento de código após o qual você deseja adicionar o novo elemento.Se o valor for um CodeElement, e em seguida, o novo elemento é adicionado imediatamente após ele.
    Se o valor é um tipo de dados longos, em seguida, AddInterface indica o elemento após o qual você deseja adicionar o novo elemento.
    Porque coleções começam sua contagem em 1, passando de 0 indica que o novo elemento deve ser colocado no início da coleção.Um valor de-1 significa que o que o elemento deve ser colocado no final.
  • Bases
    Tipo: System.Object
    Opcional.Valor padrão é Nothing.Uma variante que mantém um SafeArray de nomes de tipo totalmente qualificado ou CodeInterface objetos do qual deriva a nova interface.

Valor de retorno

Tipo: EnvDTE.CodeInterface
A CodeInterface object.

Comentários

Visual C++ nativo nativa requer separados por dois-pontos (::) format para seus nomes de tipo totalmente qualificado.Todos os outros idiomas oferecem suporte o formato separado por período.

A correção dos argumentos é determinada pelo idioma atrás o modelo de código.

ObservaçãoObservação

Os valores de elementos de modelo de código, como classes, estruturas, funções, atributos, delegados e assim por diante podem ser não-determinísticos depois de fazer determinados tipos de edições, o que significa que seus valores não confie sempre permanecer o mesmo.Para obter mais informações, consulte a seção valores de elemento de modelo de código podem ser alterada de Descobrindo o código usando o modelo de código (Visual Basic).

Exemplos

Sub AddInterfaceExample(ByVal dte As DTE2)

    ' Before running this example, open a code document from a project.
    Try
        Dim projItem As ProjectItem = dte.ActiveDocument.ProjectItem
        Dim cm As CodeModel = projItem.ContainingProject.CodeModel

        ' Initialize the base interfaces array.
        Dim bases() As Object = { _
            ConvertFullName(cm, "System.IDisposable"), _
            ConvertFullName(cm, "System.IComparable") _
        }

        ' Create a new class.
        cm.AddInterface("TestInterface", projItem.Name, , bases)
    Catch ex As Exception
        MsgBox(ex.Message)
    End Try

End Sub

Function ConvertFullName(ByVal cm As CodeModel, _
    ByVal fullName As String) As String

    ' Convert a .NET type name into a C++ type name.
    If (cm.Language = CodeModelLanguageConstants.vsCMLanguageVC) Or _
        (cm.Language = CodeModelLanguageConstants.vsCMLanguageMC) Then
        Return fullName.Replace(".", "::")
    Else
        Return fullName
    End If

End Function

public void AddInterfaceExample(DTE2 dte)
{
    // Before running this example, open a code document from
    // a project.
    try
    {
        ProjectItem projItem = dte.ActiveDocument.ProjectItem;
        CodeModel cm = projItem.ContainingProject.CodeModel;

        // Initialize the base interfaces array.
        object[] bases = {
            ConvertFullName(cm, "System.IDisposable"), 
            ConvertFullName(cm, "System.IComparable")
        };

        // Create a new class.
        cm.AddInterface("TestInterface", projItem.Name, -1, bases, 
            vsCMAccess.vsCMAccessPublic);
    }
    catch (Exception ex)
    {
        MessageBox.Show(ex.Message);
    }
}

string ConvertFullName(CodeModel cm, string fullName)
{
    // Convert a .NET type name into a C++ type name.
    if ((cm.Language == CodeModelLanguageConstants.vsCMLanguageVC) || 
        (cm.Language == CodeModelLanguageConstants.vsCMLanguageMC))
        return fullName.Replace(".", "::");
    else
        return fullName;
}

Segurança do .NET Framework

Consulte também

Referência

CodeModel Interface

Namespace EnvDTE

Outros recursos

Como: compilar e executar os exemplos de código de modelo de objeto de automação

Descobrindo o código usando o modelo de código (Visual Basic)

Descobrindo o código usando o modelo de código (Visual C#)