ProgIdAttribute Classe

Definição

Namespace:

System.Runtime.InteropServices

Assembly:

System.Runtime.InteropServices.dll

Origem:

ProgIdAttribute.cs

Permite que o usuário especifique o ProgID de uma classe.

public ref class ProgIdAttribute sealed : Attribute

[System.AttributeUsage(System.AttributeTargets.Class, Inherited=false)]
public sealed class ProgIdAttribute : Attribute

[<System.AttributeUsage(System.AttributeTargets.Class, Inherited=false)>]
type ProgIdAttribute = class
    inherit Attribute

Public NotInheritable Class ProgIdAttribute
Inherits Attribute

Herança

Object

Attribute

ProgIdAttribute

Atributos

AttributeUsageAttribute

Exemplos

O exemplo a seguir demonstra como aplicar ProgIdAttribute em uma classe . Em seguida, o aplicativo obtém todos os atributos de MyClasse imprime a Value propriedade de ProgIdAttribute.

[ClassInterface(ClassInterfaceType::AutoDispatch)]
[ProgId("InteropSample.MyClass")]
public ref class MyClass
{
public:
   MyClass(){}

};

int main()
{
   try
   {
      AttributeCollection^ attributes;
      attributes = TypeDescriptor::GetAttributes( MyClass::typeid );
      ProgIdAttribute^ progIdAttributeObj = dynamic_cast<ProgIdAttribute^>(attributes[ ProgIdAttribute::typeid ]);
      Console::WriteLine( "ProgIdAttribute's value is set to : {0}", progIdAttributeObj->Value );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "Exception : {0}", e->Message );
   }
}

[ClassInterface(ClassInterfaceType.AutoDispatch)]
[ProgId("InteropSample.MyClass")]
public class MyClass
{
    public MyClass() {}
}

class TestApplication
{
   public static void Main()
   {
      try
      {
         AttributeCollection attributes;
         attributes = TypeDescriptor.GetAttributes(typeof(MyClass));
         ProgIdAttribute progIdAttributeObj = (ProgIdAttribute)attributes[typeof(ProgIdAttribute)];
         Console.WriteLine("ProgIdAttribute's value is set to : " + progIdAttributeObj.Value);
      }
      catch(Exception e)
      {
         Console.WriteLine("Exception : " + e.Message);
      }
   }
}

   <ClassInterface(ClassInterfaceType.AutoDispatch), ProgId("InteropSample.MyClass")>  _
   Public Class [MyClass]
      
      Public Sub New()
      End Sub
   End Class

   Class TestApplication
      
      Public Shared Sub Main()
         Try
            Dim attributes As AttributeCollection
            attributes = TypeDescriptor.GetAttributes(GetType([MyClass]))
            Dim progIdAttributeObj As ProgIdAttribute = CType(attributes(GetType(ProgIdAttribute)), ProgIdAttribute)
            Console.WriteLine(("ProgIdAttribute's value is set to : " + progIdAttributeObj.Value))
         Catch e As Exception
            Console.WriteLine(("Exception : " + e.Message.ToString()))
         End Try
      End Sub
   End Class
End Namespace 'InteropSample

Comentários

Você pode aplicar esse atributo a classes.

ProgIDs são gerados automaticamente para uma classe combinando o namespace com o nome do tipo. No entanto, isso pode produzir um ProgID inválido, pois os ProgIDs são limitados a 39 caracteres e não podem conter nenhuma pontuação além de um período. Nesse caso, um ProgID pode ser atribuído manualmente à classe usando ProgIdAttribute.

Construtores

ProgIdAttribute(String)

Inicializa uma nova instância do ProgIdAttribute com a ProgID especificada.

Propriedades

TypeId	Quando implementado em uma classe derivada, obtém um identificador exclusivo para este Attribute. (Herdado de Attribute)
Value	Obtém a ProgID da classe.

Métodos

Equals(Object)	Retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
GetHashCode()	Retorna o código hash para a instância. (Herdado de Attribute)
GetType()	Obtém o Type da instância atual. (Herdado de Object)
IsDefaultAttribute()	Quando substituído em uma classe derivada, indica se o valor dessa instância é o valor padrão para a classe derivada. (Herdado de Attribute)
Match(Object)	Quando substituído em uma classe derivada, retorna um valor que indica se essa instância é igual a um objeto especificado. (Herdado de Attribute)
MemberwiseClone()	Cria uma cópia superficial do Object atual. (Herdado de Object)
ToString()	Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object)