EditorZoneBase.CancelVerb プロパティ

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

EditorZoneBase.CancelVerb プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

エンド ユーザーが編集モードでコントロールに対する編集結果をキャンセルできるようにする WebPartVerb オブジェクトへの参照を取得します。

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

Visual Basic (宣言)

Public Overridable ReadOnly
 Property CancelVerb As WebPartVerb

Visual Basic (使用法)

Dim instance As EditorZoneBase
Dim value As WebPartVerb

value = instance.CancelVerb

C#

public virtual WebPartVerb CancelVerb { get;
 }

C++

public:
virtual property WebPartVerb^ CancelVerb {
    WebPartVerb^ get ();
}

J#

/** @property */
public WebPartVerb get_CancelVerb ()

JScript

public function get CancelVerb
 () : WebPartVerb

プロパティ値
エンド ユーザーがコントロールに対する編集結果をキャンセルできるようにする WebPartVerb。

解説

Cancel 動詞は、EditorZoneBase クラスから派生したコントロールの CancelVerb プロパティによって参照されます。Cancel 動詞は、編集ユーザー インターフェイス (UI) でエンド ユーザーがサーバー コントロールに対して行った編集結果をキャンセルします。既定では、Cancel 動詞は、Button コントロールとして UI に表示されます。ボタンの種類として、イメージ、リンク、または実際のボタンを選択できます。これは、継承された VerbButtonType プロパティをゾーン レベルで設定することにより、(個別のボタンに対してではなく) ゾーン内のすべての動詞ボタンに対して設定できます。

ユーザーが編集結果をキャンセルした場合、EditorPart コントロール内の変更が編集中のサーバー コントロールに適用されることはありません。また、ページは編集表示モードのままになりますが、EditorPart コントロールは非表示になり、編集中であった WebPart コントロールの選択は解除されます。これにより、エンド ユーザーは再度表示モードを変更しなくても、他の WebPart コントロールを選択して編集できるようになります。

Cancel 動詞は、ゾーン レベルのコントロールです。つまり、複数の EditorPart コントロールが存在し、各コントロールが、編集モードになっているサーバー コントロールの 1 つ以上のプロパティを編集する場合があります。Cancel 動詞は、ゾーン内のすべての EditorPart コントロールに対する変更をすべてキャンセルするために汎用的に動作します。

使用例

CancelVerb プロパティへのアクセス方法を次のコード例に示します。宣言を使用した方法とプログラムを使用した方法の 2 とおりの方法を紹介します。例の実行に必要なコード全体については、EditorZoneBase クラスの概要のトピックで「例」を参照してください。

コード例の最初の部分は、Web ページで、宣言を使用して CancelVerb プロパティにアクセスする方法を示しています。この例では、動詞のテキストをカスタマイズしています。

Visual Basic

<aspSample:MyEditorZone ID="EditorZone1" runat="server">
  <ApplyVerb Text="Apply Changes" />
  <CancelVerb Text="Cancel Changes" />
  <OKVerb Text="Finished" />
  <ZoneTemplate>
    <asp:AppearanceEditorPart ID="AppearanceEditorPart1"
 
      runat="server" />
    <asp:LayoutEditorPart ID="LayoutEditorPart1"
 
      runat="server" />
  </ZoneTemplate>
</aspSample:MyEditorZone>

C#

<aspSample:MyEditorZone ID="EditorZone1" runat="server">
  <ApplyVerb Text="Apply Changes" />
  <CancelVerb Text="Cancel Changes" />
  <OKVerb Text="Finished" />
  <ZoneTemplate>
    <asp:AppearanceEditorPart ID="AppearanceEditorPart1" 
      runat="server" />
    <asp:LayoutEditorPart ID="LayoutEditorPart1" 
      runat="server" />
  </ZoneTemplate>
</aspSample:MyEditorZone>

コード例の 2 番目の部分は、CancelVerb プロパティを有効または無効に切り替えるためのトグル ボタンを使用して、プログラムからこのプロパティにアクセスする方法を示しています。

Visual Basic

Sub Button2_Click(ByVal sender As
 Object, ByVal e As EventArgs)
  If EditorZone1.CancelVerb.Enabled Then
    EditorZone1.CancelVerb.Enabled = False
  Else
    EditorZone1.CancelVerb.Enabled = True
  End If
End Sub

C#

void Button2_Click(object sender, EventArgs e)
{
  if (EditorZone1.CancelVerb.Enabled)
    EditorZone1.CancelVerb.Enabled = false;
  else
    EditorZone1.CancelVerb.Enabled = true;
}

ブラウザでページを読み込む場合、ドロップダウン リスト コントロールから [編集モード] を選択して、編集モードに切り替えることができます。コントロールのいずれかのタイトル バーで動詞メニュー (下向きの矢印) をクリックし、[編集] をクリックすることにより、選択されたコントロールを編集できます。EditorZone コントロールおよび編集 UI が表示されている場合、Cancel 動詞を表すボタンを確認できます。次に [Toggle CancelVerb Enabled] ボタンをクリックして、そのコントロールを有効または無効にできます。

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
EditorZoneBase クラス
EditorZoneBase メンバ
System.Web.UI.WebControls.WebParts 名前空間
WebPartVerb
その他の技術情報
ASP.NET Web パーツ ページ