WebPartManager.CloseProviderWarning プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls.WebParts
アセンブリ:
System.Web.dll

接続で他のコントロールに対するプロバイダーとして動作しているコントロールをユーザーが終了すると表示される警告を取得または設定します。

public:
 virtual property System::String ^ CloseProviderWarning { System::String ^ get(); void set(System::String ^ value); };
public virtual string CloseProviderWarning { get; set; }
member this.CloseProviderWarning : string with get, set
Public Overridable Property CloseProviderWarning As String

プロパティ値

String

警告メッセージが含まれた文字列。 既定値は、.NET Framework が提供するカルチャ固有のメッセージです。

例

次のコード例では、 プロパティを使用 CloseProviderWarning してユーザーにカスタム警告を表示する方法を示します。

このコード例には、次の 4 つの部分があります。

  • Web パーツ ページの表示モードを変更できるユーザー コントロール。

  • 2 つのカスタム コントロールとカスタム WebPart インターフェイスを含むソース コード ファイル。

  • 接続できる 2 つのカスタム WebPart コントロールと <asp:webpartmanager> 要素を含む Web ページ。

  • ブラウザーでのこの例の動作の説明。

次のコードには、例の Web ページ部分のみが含まれています。 また、カスタム ユーザー コントロールと、上記のカスタム コントロールのソース コードも必要になります。 クラスの概要の「例」セクションから、これら 2 つの項目を WebPartManager 取得します。

次の Web ページ コードは、 要素の宣言型マークアップの プロパティにカスタム警告メッセージを CloseProviderWarning 割り当てる方法を <asp:webpartmanager> 示しています。

<%@ Page Language="C#" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuCS" 
  Src="DisplayModeMenuCS.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.CS.Controls" 
  Assembly="ConnectionSampleCS" %>

<!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">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server"  
          CloseProviderWarning="You are closing a provider control." />
    <div>
      <uc1:DisplayModeMenuCS ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>

<%@ Page Language="vb" %>
<%@ register TagPrefix="uc1" 
  TagName="DisplayModeMenuVB" 
  Src="DisplayModeMenuVB.ascx" %>
<%@ register tagprefix="aspSample" 
  Namespace="Samples.AspNet.VB.Controls" 
  Assembly="ConnectionSampleVB" %>

<!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">
      <!-- Reference the WebPartManager control. -->
      <asp:WebPartManager ID="WebPartManager1" runat="server"  
          CloseProviderWarning="You are closing a provider control." />
    <div>
      <uc1:DisplayModeMenuVB ID="displaymode1" runat="server" />
      <!-- Reference consumer and provider controls in a zone. -->
      <asp:WebPartZone ID="WebPartZone1" runat="server">
        <ZoneTemplate>
          <aspSample:ZipCodeWebPart ID="zip1" 
            runat="server" 
            Title="Zip Code Control"/>
          <aspSample:WeatherWebPart ID="weather1" 
            runat="server" 
            Title="Weather Control" />
        </ZoneTemplate>
      </asp:WebPartZone>
      <hr />
      <!-- Add a ConnectionsZone so users can connect controls. -->
      <asp:ConnectionsZone ID="ConnectionsZone1" runat="server" />
    </div>
    </form>
</body>
</html>

ブラウザーに Web ページを読み込んだ後、[ 表示モード ] ドロップダウン リスト コントロールをクリックし、[ 接続 ] を選択してページを接続モードに切り替えます。 接続モードでは、 要素を <asp:connectionszone> 使用して、コントロール間の接続を作成できます。 接続モードで、 ZIP コード コントロールのタイトル バーにある下向き矢印をクリックして動詞メニューをアクティブにし、[ 接続] をクリックします。 接続ユーザー インターフェイス (UI) が表示されたら、[ コンシューマーへの接続の作成 ] リンクをクリックします。 ドロップダウン リスト コントロールがあるセルが表示されます。 ドロップダウン リストで [ Weather Control ] を選択し、[ 接続 ] をクリックして 2 つのコントロールの接続を完了します。 [ 閉じる] をクリックし、[ 表示モード ] ドロップダウン リストを使用して、ページを通常のブラウズ モードに戻します。 最後に、 ZIP コード コントロール (この場合はプロバイダー コントロール) の動詞メニューをクリックし、[ 閉じる] を選択します。 プロパティに CloseProviderWarning 割り当てたカスタム メッセージが表示されます。

注釈

ユーザーがコントロールを閉じると WebPart 、通常はメッセージは表示されません。 コントロールを閉じる意味の詳細については、 メソッドを CloseWebPart 参照してください。

ただし、コントロールが別のコントロールに接続され、他のコントロールへのデータプロバイダーとして機能している場合、ユーザーがコントロールを閉じようとすると、既定の警告メッセージが表示されます。 このメッセージは、プロバイダー コントロールが閉じようとしていることをユーザーに伝えます。つまり、コンシューマーが使用するデータがなくなるため、このプロバイダーに接続されているコントロールは存在しません。 CloseProviderWarningプロパティを使用すると、開発者はユーザーに表示される警告メッセージをカスタマイズできます。

ページ開発者がこのプロパティに空または null の文字列値を割り当てた場合、ユーザーがプロバイダーであるコントロールを WebPart 閉じると、警告メッセージ ボックスは表示されません。

適用対象

こちらもご覧ください