EditorZoneBase.ApplyVerb Property

Reference

Definition

Namespace:: System.Web.UI.WebControls.WebParts

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Gets a reference to a WebPartVerb object that enables end users to apply editing changes to a control in edit mode.

public:
 virtual property System::Web::UI::WebControls::WebParts::WebPartVerb ^ ApplyVerb { System::Web::UI::WebControls::WebParts::WebPartVerb ^ get(); };

[System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)]
public virtual System.Web.UI.WebControls.WebParts.WebPartVerb ApplyVerb { get; }

[<System.Web.UI.PersistenceMode(System.Web.UI.PersistenceMode.InnerProperty)>]
member this.ApplyVerb : System.Web.UI.WebControls.WebParts.WebPartVerb

Public Overridable ReadOnly Property ApplyVerb As WebPartVerb

Property Value

WebPartVerb

A WebPartVerb that enables end users to apply changes to a control.

Attributes: PersistenceModeAttribute

Examples

The following code example demonstrates how to access the ApplyVerb property both declaratively and programmatically. For the full code required to run the example, see the Example section of the EditorZoneBase class overview topic.

The first part of the code example shows how to access the ApplyVerb property declaratively in a Web page. This example customizes the text for the verb.

<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>

<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>

The second part of the example shows how to access the ApplyVerb property programmatically, by using a toggle button to enable or disable it.

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

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

When you load the page in a browser, you can select Edit Mode in the drop-down list control to switch to edit mode. You can click the verbs menu (the down arrow) in the title bar of one of the controls, and click Edit to edit the selected control. When the EditorZone control and editing UI are visible, you can see the button that represents the apply verb, and click the Toggle ApplyVerb Enabled button to enable or disable it.

Remarks

The apply verb is referenced by the ApplyVerb property on a control derived from the EditorZoneBase class. The apply verb saves editing changes that an end user has made in the editing user interface (UI) to a server control that is currently being edited. By default, the apply verb appears in the UI as a Button control. The type of button can be an image, a link, or an actual button; you can set this for all verb buttons in a zone (not for individual buttons) by setting the inherited VerbButtonType property at the zone level.

The apply verb is a zone-level control, which means that although there might be several EditorPart controls, each editing one or more properties for the server control that is in edit mode, the apply verb works universally to apply all changes from all the EditorPart controls in the zone to the server control.

Applies to

Jaa