C#のType.GetDefaultMembers()メソッドとは？構文と使い方を解説

C#のType.GetDefaultMembers()メソッドは、現在のTypeに対して定義されているメンバーの中から、DefaultMemberAttributeが設定されたメンバーを検索するために使用されます。

リフレクションを利用して、型に既定のメンバーとして指定されたプロパティやメソッドを動的に取得したい場合に役立つメソッドです。

構文

public virtual System.Reflection.MemberInfo[] GetDefaultMembers ();

戻り値は、検索条件に一致するメンバー情報を格納した MemberInfo 型の配列です。該当するメンバーが存在しない場合は、空の配列が返されます。

それでは、Type.GetDefaultMembers()メソッドを実装した具体的な例を見ていきましょう。

サンプルコード1

using System;
using System.Reflection;
[DefaultMemberAttribute("subject")] public class Demo {
   public static void Main(){
      Type t = typeof(Demo);
      MemberInfo[] member = t.GetDefaultMembers();
      if (member.Length != 0){
         for (int i = 0; i < member.Length; i++)
         Console.WriteLine("{0}", member[i]);
      }
      else {
         Console.WriteLine("Default Member isn't there!");
      }
   }
   public void Name(String str) {}
   public String subject{
      get{
         return "Mathematics";
      }
   }
}

出力

このプログラムを実行すると、次のような出力が得られます。

System.String subject

この例では、Demo クラスに対して [DefaultMemberAttribute("subject")] を設定しているため、GetDefaultMembers() メソッドによって文字列型のプロパティ「subject」が取得されています。

続いて、別の例でも同じメソッドを試してみましょう。今度は整数型のプロパティを既定のメンバーとして指定します。

サンプルコード2

using System;
using System.Reflection;
[DefaultMemberAttribute("rank")] public class Demo {
   public static void Main(){
      Type t = typeof(Demo);
      MemberInfo[] member = t.GetDefaultMembers();
      if (member.Length != 0){
         for (int i = 0; i < member.Length; i++)
         Console.WriteLine("{0}", member[i]);
      }
      else {
         Console.WriteLine("Default Member isn't there!");
      }
   }
   public void Name(String str) {}
   public int rank{
      get{
         return 5;
      }
   }
}

出力

このプログラムを実行すると、次のような出力が得られます。

Int32 rank

このように、DefaultMemberAttribute で指定したメンバーの型や名前に関わらず、Type.GetDefaultMembers() メソッドを使えば、そのメンバー情報を MemberInfo 配列として簡単に取得できます。既定のメンバーが設定されていない場合は空の配列が返されるため、実行時に条件分岐を行うことで安全に処理できます。