WebPart.ExportMode プロパティ

リファレンス

定義

名前空間:: System.Web.UI.WebControls.WebParts

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

WebPart コントロールのプロパティの全部または一部をエクスポートできるか、またはまったくエクスポートできないかを示す値を取得または設定します。

public:
 virtual property System::Web::UI::WebControls::WebParts::WebPartExportMode ExportMode { System::Web::UI::WebControls::WebParts::WebPartExportMode get(); void set(System::Web::UI::WebControls::WebParts::WebPartExportMode value); };

[System.Web.UI.Themeable(false)]
[System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)]
public virtual System.Web.UI.WebControls.WebParts.WebPartExportMode ExportMode { get; set; }

[<System.Web.UI.Themeable(false)>]
[<System.Web.UI.WebControls.WebParts.Personalizable(System.Web.UI.WebControls.WebParts.PersonalizationScope.Shared)>]
member this.ExportMode : System.Web.UI.WebControls.WebParts.WebPartExportMode with get, set

Public Overridable Property ExportMode As WebPartExportMode

プロパティ値

WebPartExportMode

WebPartExportMode 値のいずれか 1 つ。既定値は、None です。

属性: ThemeableAttribute PersonalizableAttribute

例外

ArgumentOutOfRangeException

指定された値が WebPartExportMode 値ではありません。

InvalidOperationException

コントロールは既に読み込まれ、コントロールのパーソナル化スコープが User スコープに設定されています。

例

次のコード例では、プロパティの使用方法を ExportMode 示します。エクスポートコードの例を機能させるには、「解説」セクションで示されているように、属性 enableExport="true" を要素に <webParts> 追加して、Web.config ファイルも更新する必要があることに注意してください。

この例の最初の部分には、という名前 TextDisplayWebPartのコントロールのコードが含まれています。このコントロールは、プロパティをエクスポートできるようにプロパティに属性TextDisplayWebPart.ContentTextを追加Personalizableする点を除き、クラスの概要のWebPart「例」セクションにあるカスタムコントロールと同じです。属性宣言にはパラメーターの true 値が含まれていることに isSensitive 注意してください。つまり、プロパティはエクスポート目的で機密データとしてマークされます。コード例を実行するには、このソースコードをコンパイルする必要があります。明示的にコンパイルし、結果のアセンブリを Web サイトの Bin フォルダーまたはグローバルアセンブリキャッシュに配置できます。または、ソースコードをサイトの App_Code フォルダーに配置して、実行時に動的にコンパイルすることもできます。このコード例では、ソースコードをアセンブリにコンパイルし、Web アプリケーションの Bin サブフォルダーに配置し、Web ページでディレクティブを使用 Register してアセンブリを参照することを前提としています。両方のコンパイル方法を示すチュートリアルについては、「チュートリアル: カスタム Web サーバーコントロールの開発と使用」を参照してください。

using System;
using System.Security.Permissions;
using System.Web;
using System.Web.UI.WebControls;
using System.Web.UI.WebControls.WebParts;

namespace Samples.AspNet.CS.Controls
{
  [AspNetHostingPermission(SecurityAction.Demand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  [AspNetHostingPermission(SecurityAction.InheritanceDemand, 
    Level=AspNetHostingPermissionLevel.Minimal)]
  public class TextDisplayWebPart : WebPart
  {
    private String _contentText = null;
    TextBox input;
    Label DisplayContent;
    const string _subTitle = "Contoso, Ltd";

    public TextDisplayWebPart()
    {
      this.AllowClose = false;
    }

    [
      Personalizable(PersonalizationScope.User, true),
      WebBrowsable()
    ]
    public String ContentText
    {
      get { return _contentText; }
      set { _contentText = value; }
    }

    protected override void CreateChildControls()
    {
      Controls.Clear();
      DisplayContent = new Label();
      DisplayContent.BackColor = 
        System.Drawing.Color.LightBlue;
      DisplayContent.Text = this.ContentText;
      this.Controls.Add(DisplayContent);
      input = new TextBox();
      this.Controls.Add(input);
      Button update = new Button();
      update.Text = "Set Label Content";
      update.Click += new EventHandler(this.submit_Click);
      this.Controls.Add(update);
      ChildControlsCreated = true;
    }

    private void submit_Click(object sender, EventArgs e)
    {
      // Update the label string.
      if (!string.IsNullOrEmpty(input.Text))
      {
        _contentText = input.Text + @"<br />";
        input.Text = String.Empty;
        DisplayContent.Text = this.ContentText;
      }
    }
  }
}

Imports System.Security.Permissions 
Imports System.Web
Imports System.Web.UI.WebControls 
Imports System.Web.UI.WebControls.WebParts

Namespace Samples.AspNet.VB.Controls

<AspNetHostingPermission(SecurityAction.Demand, _ 
  Level := AspNetHostingPermissionLevel.Minimal)> _ 
<AspNetHostingPermission(SecurityAction.InheritanceDemand, _
  Level := AspNetHostingPermissionLevel.Minimal)> _ 
Public Class TextDisplayWebPart 
  Inherits WebPart
  Private _contentText As String = Nothing
  Private input As TextBox
  Private DisplayContent As Label 
  Private Const _subTitle as String = "Contoso, Ltd"
  
  
  Public Sub New()  
    Me.AllowClose = False 
  End Sub 
  
  <Personalizable(PersonalizationScope.User, True), _
   WebBrowsable()>  _ 
  Public Property ContentText() As String 
    Get 
      Return _contentText 
    End Get 
    Set 
      _contentText = value
    End Set 
  End Property
    
  Protected Overrides Sub CreateChildControls() 
    Controls.Clear()
    DisplayContent = New Label()
    DisplayContent.Text = Me.ContentText
    DisplayContent.BackColor = _
      System.Drawing.Color.LightBlue
    Me.Controls.Add(DisplayContent) 
    input = New TextBox() 
    Me.Controls.Add(input)
    Dim update As New Button()
    update.Text = "Set Label Content" 
    AddHandler update.Click, AddressOf Me.submit_Click
    Me.Controls.Add(update) 
    ChildControlsCreated = True 
  
  End Sub 

  Private Sub submit_Click(ByVal sender As Object, _
                           ByVal e As EventArgs)  
    ' Update the label string.
    If input.Text <> String.Empty Then
      _contentText = input.Text & "<br />"
      input.Text = String.Empty 
      DisplayContent.Text = Me.ContentText
    End If
  
  End Sub 
  
End Class 

End Namespace

この例の 2 番目の部分は、ASP.NET Web ページでコントロールを参照 TextDisplayWebPart する方法を示しています。宣言型マークアップでは、プロパティ値がに設定されていることにAll注意してください。つまり、ExportMode機密性の高い値を持つプロパティもエクスポートされます。

<%@ page language="C#" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.CS.Controls" 
             Assembly="TextDisplayWebPartCS"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text WebPart" 
            ExportMode="All" 
            />
        </zonetemplate>
    </asp:webpartzone>
    <br />
  </form>
</body>
</html>

<%@ page language="VB" %>
<%@ register tagprefix="aspSample" 
             Namespace="Samples.AspNet.VB.Controls" 
             Assembly="TextDisplayWebPartVB"%>

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
    "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" >
<head id="Head1" runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
  <form id="Form1" runat="server">
    <asp:webpartmanager id="WebPartManager1" runat="server" />
    <asp:webpartzone
      id="WebPartZone1"
      runat="server"
      title="Zone 1"
      PartChromeType="TitleAndBorder">
        <parttitlestyle font-bold="true" ForeColor="#3300cc" />
        <partstyle
          borderwidth="1px"   
          borderstyle="Solid"  
          bordercolor="#81AAF2" />
        <zonetemplate>
          <aspSample:TextDisplayWebPart 
            runat="server"   
            id="textwebpart" 
            title = "Text WebPart" 
            ExportMode="All" 
            />
        </zonetemplate>
    </asp:webpartzone>
    <br />
  </form>
</body>
</html>

ブラウザーで Web ページを読み込み、コントロールの動詞メニューで WebPart エクスポート動詞をクリックし、指示に従ってコントロールの状態とプロパティデータを含む説明ファイルをエクスポートします。

注釈

既定では、コントロールを WebPart エクスポートできず、その ExportMode プロパティはに None設定されています。コントロールのすべてのプロパティのエクスポートを有効にするには、値を ExportMode に All設定します。機密データを含むプロパティのエクスポートを禁止しながら特定のプロパティのみをエクスポートするには、プロパティ値をに NonSensitiveData設定します。

コントロールのプロパティ値の説明を WebPart エクスポートするには、プロパティのソースコードのメタデータの属性でプロパティをマーク Personalizable する必要もあります。詳細については、「PersonalizableAttribute」を参照してください。

注意

Web パーツコントロールを含む Web アプリケーションのエクスポート機能を有効にするには、アプリケーションの Web.config ファイルで、次のマークアップのように、セクション内<system.web>の要素に属性<webParts>を追加する必要があります。

<webParts enableExport="true">

</webParts>

このプロパティは、テーマまたはスタイルシートテーマによって設定することはできません。詳細については、「テーマとスキン」と「ASP.NET」を参照してくださいThemeableAttribute。

このプロパティのパーソナル化スコープはに Shared 設定され、承認されたユーザーのみが変更できます。詳細については、「および Web パーツのパーソナル化の概要」を参照してくださいPersonalizableAttribute。

適用対象

次の方法で共有

WebPart.ExportMode プロパティ

定義

プロパティ値

例外

例

注釈

適用対象

こちらもご覧ください

その他のリソース