TagPrefixInfo クラス

定義

タグ関連の情報を含む構成要素を定義します。

public ref class TagPrefixInfo sealed : System::Configuration::ConfigurationElement
public sealed class TagPrefixInfo : System.Configuration.ConfigurationElement
type TagPrefixInfo = class
    inherit ConfigurationElement
Public NotInheritable Class TagPrefixInfo
Inherits ConfigurationElement
継承

この例では、 controls セクションのいくつかの属性に対して宣言的に値を指定する方法を示します。これは、 TagPrefixInfo クラスのメンバーとしてもアクセスできます。

<system.web>
  <pages>
    <controls>
      <!-- Searches all linked assemblies for the namespace -->
      <add tagPrefix="MyTags1" namespace=" MyNameSpace "/>
      <!-- Uses a specified assembly -->
      <add tagPrefix="MyTags2" namespace="MyNameSpace"
        assembly="MyAssembly"/>
      <!-- Uses the specified source for the user control -->
      <add tagprefix="MyTags3" tagname="MyCtrl" src="MyControl.ascx"/>
    </controls>
   </pages>
</system.web>

次のコード例は、 TagPrefixInfo クラスを使用して、プログラムによってタグ プレフィックスの設定を変更する方法を示しています。 このコード例は、 PagesSection クラスに提供されるより大きな例の一部です。

// Get all current Controls in the collection.
for (int i = 0; i < pagesSection.Controls.Count; i++)
{
  Console.WriteLine("Control {0}:", i);
  Console.WriteLine("  TagPrefix = '{0}' ",
      pagesSection.Controls[i].TagPrefix);
  Console.WriteLine("  TagName = '{0}' ",
      pagesSection.Controls[i].TagName);
  Console.WriteLine("  Source = '{0}' ",
      pagesSection.Controls[i].Source);
  Console.WriteLine("  Namespace = '{0}' ",
      pagesSection.Controls[i].Namespace);
  Console.WriteLine("  Assembly = '{0}' ",
      pagesSection.Controls[i].Assembly);
}

// Create a new TagPrefixInfo object.
System.Web.Configuration.TagPrefixInfo tagPrefixInfo =
    new System.Web.Configuration.TagPrefixInfo("MyCtrl", "MyNameSpace", "MyAssembly", "MyControl", "MyControl.ascx");

// Execute the Add Method.
pagesSection.Controls.Add(tagPrefixInfo);

// Add a TagPrefixInfo object using a constructor.
pagesSection.Controls.Add(
    new System.Web.Configuration.TagPrefixInfo(
    "MyCtrl", "MyNameSpace", "MyAssembly", "MyControl",
    "MyControl.ascx"));
' Get all current Controls in the collection.
Dim j As Int32
For j = 0 To pagesSection.Controls.Count - 1
  Console.WriteLine("Control {0}:", j)
  Console.WriteLine("  TagPrefix = '{0}' ", _
   pagesSection.Controls(j).TagPrefix)
  Console.WriteLine("  TagName = '{0}' ", _
   pagesSection.Controls(j).TagName)
  Console.WriteLine("  Source = '{0}' ", _
   pagesSection.Controls(j).Source)
  Console.WriteLine("  Namespace = '{0}' ", _
   pagesSection.Controls(j).Namespace)
  Console.WriteLine("  Assembly = '{0}' ", _
   pagesSection.Controls(j).Assembly)
Next

' Create a new TagPrefixInfo object.
Dim tagPrefixInfo As System.Web.Configuration.TagPrefixInfo = _
 New System.Web.Configuration.TagPrefixInfo("MyCtrl", "MyNameSpace", "MyAssembly", "MyControl", "MyControl.ascx")

' Execute the Add Method.
pagesSection.Controls.Add(tagPrefixInfo)

' Add a TagPrefixInfo object using a constructor.
pagesSection.Controls.Add( _
 New System.Web.Configuration.TagPrefixInfo( _
 "MyCtrl", "MyNameSpace", "MyAssembly", "MyControl", _
 "MyControl.ascx"))

注釈

TagPrefixInfo クラスを使用すると、構成ファイルに格納されているタグ プレフィックス情報にプログラムでアクセスして変更できます。 ASP.NET @Register ディレクティブと同じ機能を提供します。 タグ プレフィックスは、カスタム コントロールとユーザー コントロールが正常に動作するために含める必要があるアセンブリと名前空間に、ASP.NET の "名前空間" を関連付けます。 TagPrefixInfo オブジェクトは、 TagPrefixCollection オブジェクトのメンバーとして格納されます。 TagPrefixCollection クラスを使用すると、構成ファイルの pages セクションの controls サブセクションにプログラムでアクセスして変更できます。

TagPrefixInfo オブジェクトは、 add 要素を使用してコレクションに追加され、 tagPrefix 属性の値と、その他の関連する属性の値を指定します。 その他の必要な情報は、指定したタグ プレフィックスで使用するコントロールの種類によって異なります。

  • ユーザー コントロールの場合は、 TagPrefixTagName、および Source プロパティを定義する必要があります。

  • カスタム コントロールの場合は、 TagPrefixNamespace、および Assembly プロパティを定義する必要があります。 コントロールがアプリケーション コード ディレクトリにある場合、 Assembly プロパティは必要ありません。

同じ tagPrefix 値を使用して、複数のアセンブリまたは名前空間にマップできます。

ソースが指定されている場合、ユーザー コントロール自体がページと同じディレクトリに含まれていない必要があります。 その場合は、ページを読み込もうとしたときに実行時エラーが発生します。

コンストラクター

名前 説明
TagPrefixInfo(String, String, String, String, String)

渡された値を使用して、 TagPrefixInfo クラスの新しいインスタンスを初期化します。

プロパティ

名前 説明
Assembly

コントロールの実装を含むアセンブリの名前を取得または設定します。

CurrentConfiguration

現在のConfiguration インスタンスが属している構成階層を表す最上位ConfigurationElement インスタンスへの参照を取得します。

(継承元 ConfigurationElement)
ElementInformation

ElementInformation オブジェクトのカスタマイズ不可能な情報と機能を含むConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
ElementProperty

ConfigurationElementProperty オブジェクト自体を表すConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
EvaluationContext

ContextInformation オブジェクトの ConfigurationElement オブジェクトを取得します。

(継承元 ConfigurationElement)
HasContext

CurrentConfiguration プロパティがnullされているかどうかを示す値を取得します。

(継承元 ConfigurationElement)
Item[ConfigurationProperty]

この構成要素のプロパティまたは属性を取得または設定します。

(継承元 ConfigurationElement)
Item[String]

この構成要素のプロパティ、属性、または子要素を取得または設定します。

(継承元 ConfigurationElement)
LockAllAttributesExcept

ロックされた属性のコレクションを取得します。

(継承元 ConfigurationElement)
LockAllElementsExcept

ロックされた要素のコレクションを取得します。

(継承元 ConfigurationElement)
LockAttributes

ロックされた属性のコレクションを取得します。

(継承元 ConfigurationElement)
LockElements

ロックされた要素のコレクションを取得します。

(継承元 ConfigurationElement)
LockItem

要素がロックされているかどうかを示す値を取得または設定します。

(継承元 ConfigurationElement)
Namespace

コントロールが存在する名前空間を取得または設定します。

Properties

プロパティのコレクションを取得します。

(継承元 ConfigurationElement)
Source

ユーザー コントロールを含むファイルの名前とパスを取得または設定します。

TagName

ユーザー コントロールの名前を取得または設定します。

TagPrefix

ソース ファイルまたは名前空間とアセンブリに関連付けられているタグ プレフィックスを取得または設定します。

メソッド

名前 説明
DeserializeElement(XmlReader, Boolean)

構成ファイルから XML を読み取ります。

(継承元 ConfigurationElement)
Equals(Object)

このインスタンスを別のオブジェクトと比較します。

GetHashCode()

現在のインスタンスのハッシュ値を返します。

GetTransformedAssemblyString(String)

指定したアセンブリ名の変換されたバージョンを返します。

(継承元 ConfigurationElement)
GetTransformedTypeString(String)

指定した型名の変換されたバージョンを返します。

(継承元 ConfigurationElement)
GetType()

現在のインスタンスの Type を取得します。

(継承元 Object)
Init()

ConfigurationElement オブジェクトを初期状態に設定します。

(継承元 ConfigurationElement)
InitializeDefault()

ConfigurationElement オブジェクトの既定の値セットを初期化するために使用します。

(継承元 ConfigurationElement)
IsModified()

この構成要素が、派生クラスで実装されたときに、最後に保存または読み込まれた後に変更されたかどうかを示します。

(継承元 ConfigurationElement)
IsReadOnly()

ConfigurationElement オブジェクトが読み取り専用かどうかを示す値を取得します。

(継承元 ConfigurationElement)
ListErrors(IList)

この ConfigurationElement オブジェクトおよびすべてのサブ要素の無効なプロパティ エラーを、渡されたリストに追加します。

(継承元 ConfigurationElement)
MemberwiseClone()

現在の Objectの簡易コピーを作成します。

(継承元 Object)
OnDeserializeUnrecognizedAttribute(String, String)

逆シリアル化中に不明な属性が検出されたかどうかを示す値を取得します。

(継承元 ConfigurationElement)
OnDeserializeUnrecognizedElement(String, XmlReader)

逆シリアル化中に不明な要素が検出されたかどうかを示す値を取得します。

(継承元 ConfigurationElement)
OnRequiredPropertyNotFound(String)

必要なプロパティが見つからない場合に例外をスローします。

(継承元 ConfigurationElement)
PostDeserialize()

逆シリアル化後に呼び出されます。

(継承元 ConfigurationElement)
PreSerialize(XmlWriter)

シリアル化の前に呼び出されます。

(継承元 ConfigurationElement)
Reset(ConfigurationElement)

ロックやプロパティ コレクションなど、 ConfigurationElement オブジェクトの内部状態をリセットします。

(継承元 ConfigurationElement)
ResetModified()

派生クラスで実装されたときに IsModified() メソッドの値を false にリセットします。

(継承元 ConfigurationElement)
SerializeElement(XmlWriter, Boolean)

派生クラスで実装されている場合、この構成要素の内容を構成ファイルに書き込みます。

(継承元 ConfigurationElement)
SerializeToXmlElement(XmlWriter, String)

派生クラスで実装されるときに、この構成要素の外部タグを構成ファイルに書き込みます。

(継承元 ConfigurationElement)
SetPropertyValue(ConfigurationProperty, Object, Boolean)

プロパティを指定した値に設定します。

(継承元 ConfigurationElement)
SetReadOnly()

IsReadOnly() オブジェクトとすべてのサブ要素のConfigurationElement プロパティを設定します。

(継承元 ConfigurationElement)
ToString()

現在のオブジェクトを表す文字列を返します。

(継承元 Object)
Unmerge(ConfigurationElement, ConfigurationElement, ConfigurationSaveMode)

ConfigurationElement オブジェクトを変更して、保存すべきでないすべての値を削除します。

(継承元 ConfigurationElement)

適用対象

こちらもご覧ください