RunInstallerAttribute

.NET Framework クラス ライブラリ リファレンス

RunInstallerAttribute クラス

アセンブリのインストール時に、Visual Studio の Custom Action Installer または インストーラ ツール (Installutil.exe) が起動されるかどうかを指定します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Class)> _
Public Class RunInstallerAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As RunInstallerAttribute

C#

[AttributeUsageAttribute(AttributeTargets.Class)] 
public class RunInstallerAttribute : Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Class)] 
public ref class RunInstallerAttribute : public
 Attribute

J#

/** @attribute AttributeUsageAttribute(AttributeTargets.Class) */ 
public class RunInstallerAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Class) 
public class RunInstallerAttribute extends
 Attribute

解説

Installer から継承するクラスが、RunInstallerAttribute に true を 設定してマークされている場合は、アセンブリのインストール時に、Visual Studio の Custom Action Installer または InstallUtil.exe が起動されます。RunInstallerAttribute に false を設定してマークされたメンバは、インストーラを起動しません。既定値は false です。

メモ
true の RunInstallerAttribute を使用してプロパティをマークすると、この属性の値は定数メンバ Yes に設定されます。RunInstallerAttribute に false を設定してマークされたプロパティの場合、値は No になります。したがって、コード内でこの属性の値を確認する場合は、属性を RunInstallerAttribute.Yes または RunInstallerAttribute.No として指定する必要があります。

詳細については、属性の概要、属性を使用したメタデータの拡張 の各トピックを参照してください。

使用例

MyProjectInstaller に対してインストーラを実行する必要があることを指定する例を次に示します。

Visual Basic

<RunInstallerAttribute(True)> _
Public Class MyProjectInstaller
    Inherits Installer

    ' Insert code here.
End Class 'MyProjectInstaller

C#

[RunInstallerAttribute(true)]
 public class MyProjectInstaller : Installer
 {
    // Insert code here.
 }

C++

[RunInstallerAttribute(true)]
ref class MyProjectInstaller: public Installer{
   // Insert code here.
};

J#

/** @attribute RunInstallerAttribute(true)
 */
public static class MyProjectInstaller
 extends Installer
{
    // Insert code here.
} //MyProjectInstaller

MyProjectInstaller のインスタンスを作成する例を次に示します。そのクラスの属性を取得し、RunInstallerAttribute を抽出してから、インストーラを実行するかどうかを出力します。

Visual Basic

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

C#

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

C++

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

J#

public static void main(String[]
 args)
{
    // 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.get_Item(
        RunInstallerAttribute.class.ToType())));

    Console.WriteLine(("Run the installer? " 
        + System.Convert.ToString(myAttribute.get_RunInstaller())));
} //main

継承階層

System.Object
   System.Attribute
    System.ComponentModel.RunInstallerAttribute

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
RunInstallerAttribute メンバ
System.ComponentModel 名前空間
Attribute
Installer

RunInstallerAttribute コンストラクタ

RunInstallerAttribute クラスの新しいインスタンスを初期化します。

名前空間: System.ComponentModel
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub New ( _
    runInstaller As Boolean _
)

Visual Basic (使用法)

Dim runInstaller As Boolean

Dim instance As New RunInstallerAttribute(runInstaller)

C#

public RunInstallerAttribute (
    bool runInstaller
)

C++

public:
RunInstallerAttribute (
    bool runInstaller
)

J#

public RunInstallerAttribute (
    boolean runInstaller
)

JScript

public function RunInstallerAttribute (
    runInstaller : boolean
)

パラメータ

runInstaller

アセンブリのインストール中にインストーラを起動する場合は true。それ以外の場合は false。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
RunInstallerAttribute クラス
RunInstallerAttribute メンバ
System.ComponentModel 名前空間

RunInstallerAttribute フィールド

パブリック フィールド

	名前	説明
	Default	既定の可視性である No を指定します。static フィールドは読み取り専用です。
	No	アセンブリのインストール時に、Visual Studio の Custom Action Installer または インストーラ ツール (Installutil.exe) が起動されないことを指定します。static フィールドは読み取り専用です。
	Yes	アセンブリのインストール時に、Visual Studio の Custom Action Installer または インストーラ ツール (Installutil.exe) が起動されることを指定します。static フィールドは読み取り専用です。

参照

関連項目

RunInstallerAttribute クラス
System.ComponentModel 名前空間
Attribute
Installer

RunInstallerAttribute プロパティ

パブリック プロパティ

	名前	説明
	RunInstaller	アセンブリのインストール中にインストーラを起動するかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。 ( Attribute から継承されます。)

参照

関連項目

RunInstallerAttribute クラス
System.ComponentModel 名前空間
Attribute
Installer

RunInstallerAttribute メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 指定した RunInstallerAttributeの値が、現在の RunInstallerAttribute と等しいかどうかを判断します。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 ( Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 ( Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 現在の RunInstallerAttribute のハッシュ コードを生成します。
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	IsDefaultAttribute	オーバーライドされます。 この属性が既定値かどうかを判断します。
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 ( Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 ( Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

RunInstallerAttribute クラス
System.ComponentModel 名前空間
Attribute
Installer

RunInstallerAttribute メンバ

アセンブリのインストール時に、Visual Studio の Custom Action Installer または インストーラ ツール (Installutil.exe) が起動されるかどうかを指定します。

RunInstallerAttribute データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	RunInstallerAttribute	RunInstallerAttribute クラスの新しいインスタンスを初期化します。

パブリック フィールド

	名前	説明
	Default	既定の可視性である No を指定します。static フィールドは読み取り専用です。
	No	アセンブリのインストール時に、Visual Studio の Custom Action Installer または インストーラ ツール (Installutil.exe) が起動されないことを指定します。static フィールドは読み取り専用です。
	Yes	アセンブリのインストール時に、Visual Studio の Custom Action Installer または インストーラ ツール (Installutil.exe) が起動されることを指定します。static フィールドは読み取り専用です。

パブリック プロパティ

	名前	説明
	RunInstaller	アセンブリのインストール中にインストーラを起動するかどうかを示す値を取得します。
	TypeId	派生クラスに実装されている場合は、この Attribute の一意の識別子を取得します。(Attribute から継承されます。)

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 オーバーライドされます。 指定した RunInstallerAttributeの値が、現在の RunInstallerAttribute と等しいかどうかを判断します。
	GetCustomAttribute	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用された指定した型のカスタム属性を取得します。 (Attribute から継承されます。)
	GetCustomAttributes	オーバーロードされます。 アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されたカスタム属性の配列を取得します。 (Attribute から継承されます。)
	GetHashCode	オーバーライドされます。 現在の RunInstallerAttribute のハッシュ コードを生成します。
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	IsDefaultAttribute	オーバーライドされます。 この属性が既定値かどうかを判断します。
	IsDefined	オーバーロードされます。 指定した型のカスタム属性が、アセンブリ、モジュール、型のメンバ、またはメソッド パラメータに適用されているかどうかを判断します。 (Attribute から継承されます。)
	Match	派生クラス内でオーバーライドされたときに、指定したオブジェクトとこのインスタンスが等しいかどうかを示す値を返します。 (Attribute から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

RunInstallerAttribute クラス
System.ComponentModel 名前空間
Attribute
Installer