RunInstallerAttribute クラス

定義

アセンブリのインストール時に、Visual Studio の Custom Action Installer または Installutil.exe (インストーラー ツール) が起動されるかどうかを指定します。Specifies whether the Visual Studio Custom Action Installer or the Installutil.exe (Installer Tool) should be invoked when the assembly is installed.

public ref class RunInstallerAttribute : Attribute
[System.AttributeUsage(System.AttributeTargets.Class)]
public class RunInstallerAttribute : Attribute
type RunInstallerAttribute = class
    inherit Attribute
Public Class RunInstallerAttribute
Inherits Attribute
継承
RunInstallerAttribute
属性

次の例では、MyProjectInstallerに対してインストーラーを実行する必要があることを指定します。The following example specifies that the installer should be run for MyProjectInstaller.

[RunInstallerAttribute(true)]
ref class MyProjectInstaller: public Installer{
   // Insert code here.
};
[RunInstallerAttribute(true)]
 public class MyProjectInstaller : Installer {
    // Insert code here.
 }
<RunInstallerAttribute(True)> _
Public Class MyProjectInstaller
    Inherits Installer

    ' Insert code here.
End Class

次の例では、MyProjectInstallerのインスタンスを作成します。The next example creates an instance of MyProjectInstaller. 次に、クラスの属性を取得し、RunInstallerAttributeを抽出して、インストーラーを実行するかどうかを出力します。Then it gets the attributes for the class, extracts the RunInstallerAttribute, and prints whether to run the installer.

int main()
{
   // Creates a new installer.
   MyProjectInstaller^ myNewProjectInstaller = gcnew MyProjectInstaller;

   // Gets the attributes for the collection.
   AttributeCollection^ attributes = TypeDescriptor::GetAttributes( myNewProjectInstaller );

   /* Prints whether to run the installer by retrieving the 
       * RunInstallerAttribute from the AttributeCollection. */
   RunInstallerAttribute^ myAttribute = dynamic_cast<RunInstallerAttribute^>(attributes[ RunInstallerAttribute::typeid ]);
   Console::WriteLine( "Run the installer? {0}", myAttribute->RunInstaller );
   return 0;
}
public static int Main() {
    // Creates a new installer.
    MyProjectInstaller myNewProjectInstaller = new MyProjectInstaller();
 
    // Gets the attributes for the collection.
    AttributeCollection attributes = TypeDescriptor.GetAttributes(myNewProjectInstaller);
 
    /* Prints whether to run the installer by retrieving the 
     * RunInstallerAttribute from the AttributeCollection. */
    RunInstallerAttribute myAttribute = 
       (RunInstallerAttribute)attributes[typeof(RunInstallerAttribute)];
    Console.WriteLine("Run the installer? " + myAttribute.RunInstaller.ToString());
  
    return 0;
 }
Public Shared Function Main() As Integer
    ' Creates a new installer.
    Dim myNewProjectInstaller As New MyProjectInstaller()
    
    ' Gets the attributes for the collection.
    Dim attributes As AttributeCollection = TypeDescriptor.GetAttributes(myNewProjectInstaller)
    
    ' Prints whether to run the installer by retrieving the
    ' RunInstallerAttribute from the AttributeCollection. 
    Dim myAttribute As RunInstallerAttribute = _
        CType(attributes(GetType(RunInstallerAttribute)), RunInstallerAttribute)

    Console.WriteLine(("Run the installer? " & myAttribute.RunInstaller.ToString()))
    Return 0
End Function 'Main

注釈

Installer から継承するクラスが trueに設定された RunInstallerAttribute でマークされている場合は、アセンブリのインストール時に Visual Studio のカスタムアクションインストーラーまたは Installutil.exe が呼び出されます。If a class that inherits from Installer is marked with the RunInstallerAttribute set to true, Visual Studio's Custom Action Installer or the InstallUtil.exe will be invoked when the assembly is installed. RunInstallerAttributefalse に設定してマークされたメンバーは、インストーラーを呼び出しません。Members marked with the RunInstallerAttribute set to false will not invoke an installer. 既定では、 trueです。The default is true.

注意

RunInstallerAttributetrueに設定してプロパティをマークすると、この属性の値は Yes定数メンバーに設定されます。When you mark a property with the RunInstallerAttribute set to true, the value of this attribute is set to the constant member Yes. RunInstallerAttribute でマークされたプロパティが falseに設定されている場合、値は Noです。For a property marked with the RunInstallerAttribute set to false, the value is No. したがって、コード内でこの属性の値を確認する場合は、属性を RunInstallerAttribute.Yes または RunInstallerAttribute.Noとして指定する必要があります。Therefore, when you want to check the value of this attribute in your code, you must specify the attribute as RunInstallerAttribute.Yes or RunInstallerAttribute.No.

詳細については、「属性」を参照してください。For more information, see Attributes.

コンストラクター

RunInstallerAttribute(Boolean)

RunInstallerAttribute クラスの新しいインスタンスを初期化します。Initializes a new instance of the RunInstallerAttribute class.

フィールド

Default

既定の可視性である No を指定します。Specifies the default visibility, which is No. static フィールドは読み取り専用です。This static field is read-only.

No

アセンブリのインストール時に、Visual Studio の Custom Action Installer または Installutil.exe (インストーラー ツール) を起動しないことを指定します。Specifies that the Visual Studio Custom Action Installer or the Installutil.exe (Installer Tool) should not be invoked when the assembly is installed. static フィールドは読み取り専用です。This static field is read-only.

Yes

アセンブリのインストール時に、Visual Studio の Custom Action Installer または Installutil.exe (インストーラー ツール) を起動することを指定します。Specifies that the Visual Studio Custom Action Installer or the Installutil.exe (Installer Tool) should be invoked when the assembly is installed. static フィールドは読み取り専用です。This static field is read-only.

プロパティ

RunInstaller

アセンブリのインストール中にインストーラーを起動するかどうかを示す値を取得します。Gets a value indicating whether an installer should be invoked during installation of an assembly.

TypeId

派生クラスで実装されると、この Attribute の一意の識別子を取得します。When implemented in a derived class, gets a unique identifier for this Attribute.

(継承元 Attribute)

メソッド

Equals(Object)

指定した RunInstallerAttribute の値が、現在の RunInstallerAttribute と等しいかどうかを判断します。Determines whether the value of the specified RunInstallerAttribute is equivalent to the current RunInstallerAttribute.

GetHashCode()

現在の RunInstallerAttribute のハッシュ コードを生成します。Generates a hash code for the current RunInstallerAttribute.

GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
IsDefaultAttribute()

この属性が既定値かどうかを判断します。Determines if this attribute is the default.

Match(Object)

派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。When overridden in a derived class, returns a value that indicates whether this instance equals a specified object.

(継承元 Attribute)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
ToString()

現在のオブジェクトを表す string を返します。Returns a string that represents the current object.

(継承元 Object)

明示的なインターフェイスの実装

_Attribute.GetIDsOfNames(Guid, IntPtr, UInt32, UInt32, IntPtr)

一連の名前を対応する一連のディスパッチ識別子に割り当てます。Maps a set of names to a corresponding set of dispatch identifiers.

(継承元 Attribute)
_Attribute.GetTypeInfo(UInt32, UInt32, IntPtr)

オブジェクトの型情報を取得します。この情報はインターフェイスの型情報の取得に使用できます。Retrieves the type information for an object, which can be used to get the type information for an interface.

(継承元 Attribute)
_Attribute.GetTypeInfoCount(UInt32)

オブジェクトが提供する型情報インターフェイスの数 (0 または 1) を取得します。Retrieves the number of type information interfaces that an object provides (either 0 or 1).

(継承元 Attribute)
_Attribute.Invoke(UInt32, Guid, UInt32, Int16, IntPtr, IntPtr, IntPtr, IntPtr)

オブジェクトによって公開されたプロパティおよびメソッドへのアクセスを提供します。Provides access to properties and methods exposed by an object.

(継承元 Attribute)

適用対象

こちらもご覧ください