ProgIdAttribute-Klasse

 

Veröffentlicht: Oktober 2016

Ermöglicht den Benutzer, die ProgID einer Klasse anzugeben.

Namespace:   System.Runtime.InteropServices
Assembly:  mscorlib (in mscorlib.dll)

Vererbungshierarchie

System.Object
  System.Attribute
    System.Runtime.InteropServices.ProgIdAttribute

Syntax

[AttributeUsageAttribute(AttributeTargets.Class, Inherited = false)]
[ComVisibleAttribute(true)]
public sealed class ProgIdAttribute : Attribute

[AttributeUsageAttribute(AttributeTargets::Class, Inherited = false)]
[ComVisibleAttribute(true)]
public ref class ProgIdAttribute sealed : Attribute

[<Sealed>]
[<AttributeUsageAttribute(AttributeTargets.Class, Inherited = false)>]
[<ComVisibleAttribute(true)>]
type ProgIdAttribute = 
    class
        inherit Attribute
    end

<AttributeUsageAttribute(AttributeTargets.Class, Inherited := False)>
<ComVisibleAttribute(True)>
Public NotInheritable Class ProgIdAttribute
    Inherits Attribute

Konstruktoren

	Name	Beschreibung
	ProgIdAttribute(String)	Initialisiert eine neue Instanz der dem ProgIdAttribute mit der angegebenen ProgID.

Eigenschaften

	Name	Beschreibung
	TypeId	Ruft bei Implementierung in einer abgeleiteten Klasse einen eindeutigen Bezeichner für dieses Attribute ab.(Geerbt von „Attribute“.)
	Value	Ruft die ProgID der Klasse.

Methoden

	Name	Beschreibung
	Equals(Object)	Diese API unterstützt die Produkt Infrastruktur und sollte nicht direkt aus dem Code verwendet werden. Gibt einen Wert zurück, der angibt, ob diese Instanz gleich einem angegebenen Objekt ist.(Geerbt von „Attribute“.)
	GetHashCode()	Gibt den Hashcode für diese Instanz zurück.(Geerbt von „Attribute“.)
	GetType()	Ruft den Type der aktuellen Instanz ab.(Geerbt von „Object“.)
	IsDefaultAttribute()	Gibt beim Überschreiben in einer abgeleiteten Klasse an, ob der Wert der Instanz der Standardwert für die abgeleitete Klasse ist.(Geerbt von „Attribute“.)
	Match(Object)	Ruft beim Überschreiben in einer abgeleiteten Klasse gibt einen Wert, der angibt, ob diese Instanz gleich ein angegebenen Objekt ist.(Geerbt von „Attribute“.)
	ToString()	Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.(Geerbt von „Object“.)

Explizite Schnittstellenimplementierungen

	Name	Beschreibung
	_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)	Ordnet eine Reihe von Namen einer entsprechenden Reihe von Dispatchbezeichnern zu.(Geerbt von „Attribute“.)
	_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)	Ruft die Typinformationen für ein Objekt ab, mit deren Hilfe die Typinformationen für eine Schnittstelle abgerufen werden können.(Geerbt von „Attribute“.)
	_Attribute.GetTypeInfoCount(UInt32)	Ruft die Anzahl der Schnittstellen mit Typinformationen ab, die von einem Objekt bereitgestellt werden (0 oder 1).(Geerbt von „Attribute“.)
	_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)	Stellt den Zugriff auf von einem Objekt verfügbar gemachte Eigenschaften und Methoden bereit.(Geerbt von „Attribute“.)

Hinweise

Dieses Attribut kann auf Klassen angewendet werden.

Programm-IDs werden automatisch für eine Klasse generiert, durch die Kombination des Namespaces mit dem Typnamen. Dies kann jedoch eine ungültige ProgID führen, wie ProgIDs sind beschränkt auf 39 Zeichen und kann keine anderen Satzzeichen als einen Punkt enthalten. In diesem Fall eine ProgID kann manuell zugewiesen werden, die Klasse mit ProgIdAttribute.

Beispiele

Im folgenden Beispiel wird veranschaulicht, wie gelten ProgIdAttribute für eine Klasse. Klicken Sie dann die Anwendung erhält alle Attribute des MyClass, und gibt die Value -Eigenschaft des ProgIdAttribute.

[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 'NewNew
   End Class '[MyClass]

   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 'Main
   End Class 'TestApplication
End Namespace 'InteropSample 

[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 );
   }
}

Versionsinformationen

.NET Framework
Verfügbar seit 1.1

Threadsicherheit

Alle öffentlichen statischen Member ( Shared in Visual Basic) dieses Typs sind threadsicher. Die Threadsicherheit für Instanzmember ist nicht garantiert.

Siehe auch

System.Runtime.InteropServices-Namespace

Zurück zum Anfang