mcs/class/System.Web/System.Web.UI.WebControls/ImageButton.cs

   1 //
   2 // System.Web.UI.WebControls.ImageButton.cs
   3 //
   4 // Authors:
   5 //   Gaurav Vaish (gvaish@iitk.ac.in)
   6 //   Andreas Nahr (ClassDevelopment@A-SoftTech.com)
   7 //
   8 // (C) Gaurav Vaish (2002)
   9 // (C) 2003 Andreas Nahr
  10 //
  11
  12 //
  13 // Permission is hereby granted, free of charge, to any person obtaining
  14 // a copy of this software and associated documentation files (the
  15 // "Software"), to deal in the Software without restriction, including
  16 // without limitation the rights to use, copy, modify, merge, publish,
  17 // distribute, sublicense, and/or sell copies of the Software, and to
  18 // permit persons to whom the Software is furnished to do so, subject to
  19 // the following conditions:
  20 //
  21 // The above copyright notice and this permission notice shall be
  22 // included in all copies or substantial portions of the Software.
  23 //
  24 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  25 // EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  26 // MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  27 // NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
  28 // LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
  29 // OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
  30 // WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
  31 //
  32
  33 using System;
  34 using System.Collections;
  35 using System.Collections.Specialized;
  36 using System.Web;
  37 using System.Web.UI;
  38 using System.ComponentModel;
  39
  40 namespace System.Web.UI.WebControls
  41 {
  42         [DefaultEvent("Click")]
  43         public class ImageButton: Image, IPostBackDataHandler, IPostBackEventHandler
  44         {
  45                 private static readonly object ClickEvent   = new object();
  46                 private static readonly object CommandEvent = new object();
  47
  48                 private int x, y;
  49
  50                 public ImageButton(): base()
  51                 {
  52                 }
  53
  54                 [DefaultValue (true), Bindable (false), WebCategory ("Behavior")]
  55                 [WebSysDescription ("Determines if validation is performed when clicked.")]
  56                 public bool CausesValidation
  57                 {
  58                         get
  59                         {
  60                                 object o = ViewState["CausesValidation"];
  61                                 if(o!=null)
  62                                         return (bool)o;
  63                                 return true;
  64                         }
  65                         set
  66                         {
  67                                 ViewState["CausesValidation"] = value;
  68                         }
  69                 }
  70
  71                 [DefaultValue (""), Bindable (true), WebCategory ("Behavior")]
  72                 [WebSysDescription ("An argument for the Command of this control.")]
  73                 public string CommandArgument
  74                 {
  75                         get
  76                         {
  77                                 object o = ViewState["CommandArgument"];
  78                                 if(o!=null)
  79                                         return (string)o;
  80                                 return String.Empty;
  81                         }
  82                         set
  83                         {
  84                                 ViewState["CommandArgument"] = value;
  85                         }
  86                 }
  87
  88                 [DefaultValue (""), WebCategory ("Behavior")]
  89                 [WebSysDescription ("The name of the Command of this control.")]
  90                 public string CommandName
  91                 {
  92                         get
  93                         {
  94                                 object o = ViewState["CommandName"];
  95                                 if(o!=null)
  96                                         return (string)o;
  97                                 return String.Empty;
  98                         }
  99                         set
 100                         {
 101                                 ViewState["CommandName"] = value;
 102                         }
 103                 }
 104
 105                 [Browsable (false)]
 106                 [DesignerSerializationVisibility (DesignerSerializationVisibility.Hidden)]
 107                 protected override HtmlTextWriterTag TagKey
 108                 {
 109                         get
 110                         {
 111                                 return HtmlTextWriterTag.Input;
 112                         }
 113                 }
 114
 115                 [WebCategory ("Action")]
 116                 [WebSysDescription ("Raised when the LinkButton is clicked.")]
 117                 public event ImageClickEventHandler Click
 118                 {
 119                         add
 120                         {
 121                                 Events.AddHandler(ClickEvent, value);
 122                         }
 123                         remove
 124                         {
 125                                 Events.RemoveHandler(ClickEvent, value);
 126                         }
 127                 }
 128
 129                 [WebCategory ("Action")]
 130                 [WebSysDescription ("Raised when a LinkButton Command is executed.")]
 131                 public event CommandEventHandler Command
 132                 {
 133                         add
 134                         {
 135                                 Events.AddHandler(CommandEvent, value);
 136                         }
 137                         remove
 138                         {
 139                                 Events.RemoveHandler(CommandEvent, value);
 140                         }
 141                 }
 142
 143                 protected override void AddAttributesToRender(HtmlTextWriter writer)
 144                 {
 145                         writer.AddAttribute(HtmlTextWriterAttribute.Type, "image");
 146                         writer.AddAttribute(HtmlTextWriterAttribute.Name, UniqueID);
 147                         if(Page != null && CausesValidation)
 148                         {
 149                                 if(Page.Validators.Count > 0)
 150                                 {
 151                                         writer.AddAttribute(HtmlTextWriterAttribute.Onclick, Utils.GetClientValidatedEvent(Page));
 152                                         writer.AddAttribute("language", "javascript");
 153                                 }
 154                         }
 155                         base.AddAttributesToRender(writer);
 156                 }
 157
 158                 protected virtual void OnClick(ImageClickEventArgs e)
 159                 {
 160                         if(Events != null)
 161                         {
 162                                 ImageClickEventHandler iceh = (ImageClickEventHandler)(Events[ClickEvent]);
 163                                 if(iceh != null)
 164                                         iceh(this, e);
 165                         }
 166                 }
 167
 168                 protected virtual void OnCommand(CommandEventArgs e)
 169                 {
 170                         if(Events != null)
 171                         {
 172                                 CommandEventHandler ceh = (CommandEventHandler)(Events[CommandEvent]);
 173                                 if(ceh != null)
 174                                         ceh(this, e);
 175                                 RaiseBubbleEvent(this, e);
 176                         }
 177                 }
 178
 179                 protected override void OnPreRender(EventArgs e)
 180                 {
 181                         if(Page != null)
 182                         {
 183                                 Page.RegisterRequiresPostBack(this);
 184                         }
 185                 }
 186
 187                 bool IPostBackDataHandler.LoadPostData(string postDataKey, NameValueCollection postCollection)
 188                 {
 189                         string xCoord = postCollection[UniqueID + ".x"];
 190                         string yCoord = postCollection[UniqueID + ".y"];
 191                         string id = postCollection[UniqueID];
 192                         if(xCoord != null && yCoord != null && xCoord.Length > 0 && yCoord.Length > 0)
 193                         {
 194                                 x = Int32.Parse(xCoord);
 195                                 y = Int32.Parse(yCoord);
 196                                 Page.RegisterRequiresRaiseEvent(this);
 197                         } else if (id != null)
 198                         {
 199                                 //
 200                                 // This is a workaround for bug #49819. It appears that the .x and .y
 201                                 // values are not being posted, and only the x value is being posted
 202                                 // with the ctrl's id as the key.
 203                                 //
 204                                 x = Int32.Parse (id);
 205                                 Page.RegisterRequiresRaiseEvent (this);
 206                         }
 207                         return false;
 208                 }
 209
 210                 void IPostBackDataHandler.RaisePostDataChangedEvent()
 211                 {
 212                 }
 213
 214                 void IPostBackEventHandler.RaisePostBackEvent(string eventArgument)
 215                 {
 216                         if(CausesValidation)
 217                                 Page.Validate();
 218                         OnClick(new ImageClickEventArgs(x, y));
 219                         OnCommand(new CommandEventArgs(CommandName, CommandArgument));
 220                 }
 221         }
 222 }