WebResourceAttribute クラスとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

WebResourceAttribute クラス

メモ : このクラスは、.NET Framework version 2.0 で新しく追加されたものです。

アセンブリ内の埋め込みリソースを有効にするメタデータ属性を定義します。このクラスは継承できません。

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

Visual Basic (宣言)

<AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple:=True)> _
Public NotInheritable Class
 WebResourceAttribute
    Inherits Attribute

Visual Basic (使用法)

Dim instance As WebResourceAttribute

[AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple=true)]
 
public sealed class WebResourceAttribute :
 Attribute

C++

[AttributeUsageAttribute(AttributeTargets::Assembly, AllowMultiple=true)]
 
public ref class WebResourceAttribute sealed
 : public Attribute

/** @attribute AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple=true)
 */ 
public final class WebResourceAttribute extends
 Attribute

JScript

AttributeUsageAttribute(AttributeTargets.Assembly, AllowMultiple=true)
 
public final class WebResourceAttribute extends
 Attribute

解説

WebResourceAttribute クラスは、アセンブリ宣言で使用される場合のみ有効です。アセンブリ内の指定された埋め込みリソースを Web リソースとして使用できるようにする場合に、このクラスを使用します。

リソースの詳細については、「ASP.NET Web ページのリソースの概要」を参照してください。

使用例

このセクションには、2 つのコード例が含まれています。最初のコード例では、カスタムコントロール MyCustomControl を定義する名前空間に WebResourceAttribute 属性を適用する方法を示しています。2 つ目のコード例では、Web ページで MyCustomControl クラスを使用する方法を示しています。

次のコード例では、カスタムアセンブリに WebResourceAttribute 属性を適用して、イメージ Web リソースと HTML Web リソースを定義する方法を示しています。MyCustomControl クラスは、リソースを使用して、このコントロールに含まれる Image コントロールの ImageUrl プロパティ値を設定し、HTML リソースにリンクする HtmlAnchor コントロールの HRef プロパティを設定する複合コントロールを定義しています。

Visual Basic

Imports Microsoft.VisualBasic
Imports System
Imports System.Web
Imports System.Web.Security
Imports System.Web.UI
Imports System.Web.UI.HtmlControls
Imports System.Web.UI.WebControls

<Assembly: WebResource("image1.gif", "image/jpeg")>
 
<Assembly: WebResource("help.htm", "text/html",
 PerformSubstitution:=True)> 
Namespace Samples.AspNet.VB.Controls

    Public Class MyCustomControl
        Inherits Control

        <System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand,
 Name:="FullTrust")> _
        Protected Overrides Sub
 CreateChildControls()

            ' Create a new Image control.
            Dim _img As New
 Image()
            _img.ImageUrl = Me.Page.ClientScript.GetWebResourceUrl(GetType(MyCustomControl),
 "image1.jpg")
            Me.Controls.Add(_img)

            ' Create a new Label control.
            Dim _lab As New
 Label()
            _lab.Text = "A composite control using the WebResourceAttribute
 class."
            Me.Controls.Add(_lab)

            ' Create a new HtmlAnchor control linking to help.htm.
            Dim a As HtmlAnchor = New
 HtmlAnchor()
            a.HRef = Me.Page.ClientScript.GetWebResourceUrl(GetType(MyCustomControl),
 "help.htm")
            a.InnerText = "help link"
            Me.Controls.Add(New LiteralControl("</br>"))
            Me.Controls.Add(a)

        End Sub
    End Class

End Namespace

using System;
using System.Web;
using System.Web.Security;
using System.Web.UI;
using System.Web.UI.HtmlControls;
using System.Web.UI.WebControls;

[assembly: WebResource("image1.jpg", "image/jpeg")]
[assembly: WebResource("help.htm", "text/html", PerformSubstitution=true)]
namespace Samples.AspNet.CS.Controls
{

    public class MyCustomControl : Control
    {

        [System.Security.Permissions.PermissionSet(System.Security.Permissions.SecurityAction.Demand,
 Name="FullTrust")]
        protected override void CreateChildControls()
        {
            
            // Create a new Image control.
            Image _img = new Image();
            _img.ImageUrl = this.Page.ClientScript.GetWebResourceUrl(typeof(MyCustomControl),
 "image1.jpg");
            this.Controls.Add(_img);

            // Create a new Label control.
            Label _lab = new Label();
            _lab.Text = "A composite control using the WebResourceAttribute
 class.";
            this.Controls.Add(_lab);

            // Create a new HtmlAnchor control linking to help.htm.
            HtmlAnchor a = new HtmlAnchor();
            a.HRef = this.Page.ClientScript.GetWebResourceUrl(typeof(MyCustomControl),
 "help.htm");
            a.InnerText = "help link";
            this.Controls.Add(new LiteralControl("</br>"));
            this.Controls.Add(a);

        }
    }

}

次のコード例では、Web ページで MyCustomControl クラスを使用する方法を示しています。

Visual Basic

<%@ Page Language="VB" %>
<%@ Register TagPrefix="AspNetSamples" Namespace="Samples.AspNet.VB.Controls"
 Assembly="Samples.AspNet.VB.Controls"
 %>
<%@ Import Namespace="System.Reflection"
 %>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML
 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  Protected Sub Page_Load(ByVal
 sender As Object, ByVal
 e As System.EventArgs)

    ' Get the assembly metatdata.
    Dim clsType As Type = GetType(MyCustomControl)
    Dim a As Assembly =
 clsType.Assembly
    
    For Each attr As Attribute
 In Attribute.GetCustomAttributes(a)
      'Check for WebResource attributes.
      If attr.GetType() Is GetType(WebResourceAttribute)
 Then
        Dim wra As WebResourceAttribute = CType(attr,
 WebResourceAttribute)
        Response.Write("Resource in the assembly: "
 & wra.WebResource.ToString() & _
        " with ContentType = " & wra.ContentType.ToString()
 & _
        " and PerformsSubstitution = " & wra.PerformSubstitution.ToString()
 & "</br>")
      End If
    Next attr
    
    
  End Sub
  
</script>

<html  >
<head runat="server">
    <title>WebResourceAttribute Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <AspNetSamples:MyCustomControl ID="MyCustomControl1"
 runat="server">
      </AspNetSamples:MyCustomControl>    
    </div>
    </form>
</body>
</html>

<%@ Page Language="C#" %>
<%@ Register TagPrefix="AspNetSamples" Namespace="Samples.AspNet.CS.Controls"
 Assembly="Samples.AspNet.CS.Controls" %>
<%@ Import Namespace="System.Reflection" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

  protected void Page_Load(object sender, EventArgs
 e)
  {
            
    // Get the assembly metatdata.
    Type clsType = typeof(MyCustomControl);
    Assembly a = clsType.Assembly;

    // Iterate through the attributes for the assembly.
    foreach (Attribute attr in Attribute.GetCustomAttributes(a))
    {
      //Check for WebResource attributes.
      if (attr.GetType() == typeof(WebResourceAttribute))
      {
        WebResourceAttribute wra = (WebResourceAttribute)attr;
        Response.Write("Resource in the assembly: "
 + wra.WebResource.ToString() +
          " with ContentType = " + wra.ContentType.ToString() +
          " and PerformsSubstitution = " + wra.PerformSubstitution.ToString()
 + "</br>");
      }
    }
  }
</script>

<html  >
<head runat="server">
    <title>WebResourceAttribute Example</title>
</head>
<body>
    <form id="form1" runat="server">
    <div>
      <AspNetSamples:MyCustomControl ID="MyCustomControl1" runat="server">
      </AspNetSamples:MyCustomControl>    
    </div>
    </form>
</body>
</html>