ImageButton.CommandArgument-Eigenschaft

Artikel
08/20/2007

Ruft ein optionales Argument ab, das zusätzliche Informationen zur CommandName-Eigenschaft bereitstellt, oder legt dieses fest.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

Syntax

'Declaration
<ThemeableAttribute(False)> _
<BindableAttribute(True)> _
Public Property CommandArgument As String
'Usage
Dim instance As ImageButton
Dim value As String

value = instance.CommandArgument

instance.CommandArgument = value

[ThemeableAttribute(false)] 
[BindableAttribute(true)] 
public string CommandArgument { get; set; }

[ThemeableAttribute(false)] 
[BindableAttribute(true)] 
public:
virtual property String^ CommandArgument {
    String^ get () sealed;
    void set (String^ value) sealed;
}

/** @property */
public final String get_CommandArgument ()

/** @property */
public final void set_CommandArgument (String value)

public final function get CommandArgument () : String

public final function set CommandArgument (value : String)

Eigenschaftenwert

Ein optionales Argument, das die CommandName-Eigenschaft ergänzt.

Hinweise

In manchen Fällen sind mehrere ImageButton-Steuerelemente miteinander verknüpft und verwenden für die CommandName-Eigenschaft denselben Wert (z. B. Sort). Ergänzen Sie mit dieser Eigenschaft die CommandName-Eigenschaft mit zusätzlichen Informationen über den auszuführenden Befehl, z. B. Ascending. Die Werte der CommandName-Eigenschaft und der CommandArgument-Eigenschaft werden i. d. R. im OnCommand-Ereignishandler verwendet, um die beim Klicken auf das ImageButton-Steuerelement auszuführende Aktion zu bestimmen.

Diese Eigenschaft kann nicht durch Designs oder Stylesheetdesigns festgelegt werden. Weitere Informationen finden Sie unter ThemeableAttribute und Übersicht über ASP.NET-Designs und ASP.NET-Skins.

Beispiel

Das folgende Beispiel veranschaulicht, wie mithilfe der CommandArgument-Eigenschaft einem ImageButton-Steuerelement ein Befehlsargument zugeordnet wird.

Hinweis

Im folgenden Codebeispiel wird das Einzeldatei-Codemodell verwendet. Das Beispiel funktioniert möglicherweise nicht, wenn es direkt in eine CodeBehind-Datei kopiert wird. Dieses Codebeispiel muss in eine leere Textdatei mit einer ASPX-Erweiterung kopiert werden. Weitere Informationen zum Web Forms-Codemodell finden Sie unter Codemodell für ASP.NET-Webseiten.

<%@ Page Language="VB" AutoEventWireup="True" %>
<html>
<head>

   <script language="VB" runat="server">

      Sub ImageButton_Command(sender As Object, e As CommandEventArgs) 
         If (e.CommandName = "Sort") And (e.CommandArgument = "Ascending") Then
            Label1.Text = "You clicked the Sort Ascending Button"
         Else
            Label1.Text = "You clicked the Sort Descending Button"
         End If
      End Sub

   </script>

</head>

<body>

   <form runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br><br>

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort Ascending"
           ImageUrl="images/pict.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Ascending"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Sort Descending"
           ImageUrl="images/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Descending"/>

      <br><br>
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>

<%@ Page Language="C#" AutoEventWireup="True" %>
<html>
<head>

   <script language="C#" runat="server">

      void ImageButton_Command(object sender, CommandEventArgs e) 
      {
         if (e.CommandName == "Sort" && e.CommandArgument == "Ascending")
            Label1.Text = "You clicked the Sort Ascending Button";
         else
            Label1.Text = "You clicked the Sort Descending Button";
      }

   </script>

</head>

<body>

   <form runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br><br>

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort Ascending"
           ImageUrl="images/pict.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Ascending"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Sort Descending"
           ImageUrl="image/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Descending"/>

      <br><br>
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>

<%@ Page Language="JScript" AutoEventWireup="True" %>
<html>
<head>

   <script language="JSCRIPT" runat="server">

      function ImageButton_Command(sender : Object, e : CommandEventArgs){
         if(e.CommandName == "Sort" && e.CommandArgument == "Ascending")
            Label1.Text = "You clicked the Sort Ascending Button"
         else
            Label1.Text = "You clicked the Sort Descending Button"
      }

   </script>

</head>

<body>

   <form runat="server">

      <h3>ImageButton CommandName Sample</h3>

      Click an image.<br><br>

      <asp:ImageButton id="imagebutton1" runat="server"
           AlternateText="Sort Ascending"
           ImageUrl="images/pict.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Ascending"/>

      <asp:ImageButton id="imagebutton2" runat="server"
           AlternateText="Sort Descending"
           ImageUrl="images/pict2.jpg"
           OnCommand="ImageButton_Command"
           CommandName="Sort"
           CommandArgument="Descending"/>

      <br><br>
    
      <asp:label id="Label1" runat="server"/>

   </form>

</body>
</html>

Plattformen

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

.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.

Versionsinformationen

.NET Framework

Unterstützt in: 2.0, 1.1, 1.0

Siehe auch

Referenz

ImageButton-Klasse
ImageButton-Member
System.Web.UI.WebControls-Namespace
CommandName
OnCommand
Button-Klasse
Image-Klasse

Weitere Ressourcen

Deklarative Syntax des ImageButton-Webserversteuerelements
Übersicht über die Button-Webserversteuerelemente

Freigeben über