[Sommaire] [Imprimer]

   1  <?xml version="1.0" encoding="iso-8859-1"?>
   2  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3    <html xmlns="http://www.w3.org/1999/xhtml">
   4          <head>
   5              <!-- template designed by Marco Von Ballmoos -->
   6              <title>Docs For Class IButtonControl</title>
   7              <link rel="stylesheet" href="../media/stylesheet.css" />
   8              <meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
   9          </head>
  10          <body>
  11              <div class="page-body">            
  12  <h2 class="class-name">Interface IButtonControl</h2>
  13  
  14  <a name="sec-description"></a>
  15  <div class="info-box">
  16      <div class="info-box-title">Description</div>
  17      <div class="nav-bar">
  18                      <span class="disabled">Description</span> |
  19                                                              <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
  20                          
  21                      </div>
  22      <div class="info-box-body">
  23                  <!-- ========== Info from phpDoc block ========= -->
  24  <p class="short-description">IButtonControl interface</p>
  25  <p class="description"><p>IButtonControl specifies the common properties and events that must  be implemented by a button control, such as <a href="../System.Web.UI.WebControls/TButton.html">TButton</a>, <a href="../System.Web.UI.WebControls/TLinkButton.html">TLinkButton</a>,  <a href="../System.Web.UI.WebControls/TImageButton.html">TImageButton</a>.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: TControl.php 1528 2006-11-29 01:50:37Z xue $</li>
  29                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  30              </ul>
  31          <p class="notes">
  32              Located in <a class="field" href="_Web_UI_TControl_php.html">/Web/UI/TControl.php</a> (line <span class="field">1966</span>)
  33          </p>
  34          
  35                  
  36          <pre></pre>
  37      
  38              </div>
  39  </div>
  40  
  41  
  42  
  43  
  44      <a name="sec-method-summary"></a>
  45      <div class="info-box">
  46          <div class="info-box-title">Method Summary</span></div>
  47          <div class="nav-bar">
  48              <a href="#sec-description">Description</a> |
  49                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  50          </div>
  51          <div class="info-box-body">            
  52              <div class="method-summary">
  53                                  
  54                  <div class="method-definition">
  55                                              <span class="method-result">boolean</span>
  56                                          <a href="#getCausesValidation" title="details" class="method-name">getCausesValidation</a>
  57                                          ()
  58                                      </div>
  59                                  
  60                  <div class="method-definition">
  61                                              <span class="method-result">string</span>
  62                                          <a href="#getCommandName" title="details" class="method-name">getCommandName</a>
  63                                          ()
  64                                      </div>
  65                                  
  66                  <div class="method-definition">
  67                                              <span class="method-result">string</span>
  68                                          <a href="#getCommandParameter" title="details" class="method-name">getCommandParameter</a>
  69                                          ()
  70                                      </div>
  71                                  
  72                  <div class="method-definition">
  73                                              <span class="method-result">string</span>
  74                                          <a href="#getText" title="details" class="method-name">getText</a>
  75                                          ()
  76                                      </div>
  77                                  
  78                  <div class="method-definition">
  79                                              <span class="method-result">string</span>
  80                                          <a href="#getValidationGroup" title="details" class="method-name">getValidationGroup</a>
  81                                          ()
  82                                      </div>
  83                                  
  84                  <div class="method-definition">
  85                                              <span class="method-result">void</span>
  86                                          <a href="#onClick" title="details" class="method-name">onClick</a>
  87                                              (<span class="var-type"><a href="../System/TEventParameter.html">TEventParameter</a></span>&nbsp;<span class="var-name">$param</span>)
  88                                      </div>
  89                                  
  90                  <div class="method-definition">
  91                                              <span class="method-result">void</span>
  92                                          <a href="#onCommand" title="details" class="method-name">onCommand</a>
  93                                              (<span class="var-type"><a href="../System.Web.UI/TCommandEventParameter.html">TCommandEventParameter</a></span>&nbsp;<span class="var-name">$param</span>)
  94                                      </div>
  95                                  
  96                  <div class="method-definition">
  97                                              <span class="method-result">void</span>
  98                                          <a href="#setCausesValidation" title="details" class="method-name">setCausesValidation</a>
  99                                              (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 100                                      </div>
 101                                  
 102                  <div class="method-definition">
 103                                              <span class="method-result">void</span>
 104                                          <a href="#setCommandName" title="details" class="method-name">setCommandName</a>
 105                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 106                                      </div>
 107                                  
 108                  <div class="method-definition">
 109                                              <span class="method-result">void</span>
 110                                          <a href="#setCommandParameter" title="details" class="method-name">setCommandParameter</a>
 111                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 112                                      </div>
 113                                  
 114                  <div class="method-definition">
 115                                              <span class="method-result">void</span>
 116                                          <a href="#setText" title="details" class="method-name">setText</a>
 117                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 118                                      </div>
 119                                  
 120                  <div class="method-definition">
 121                                              <span class="method-result">void</span>
 122                                          <a href="#setValidationGroup" title="details" class="method-name">setValidationGroup</a>
 123                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 124                                      </div>
 125                              </div>
 126          </div>
 127      </div>        
 128  
 129      
 130      <a name="sec-methods"></a>
 131      <div class="info-box">
 132          <div class="info-box-title">Methods</div>
 133          <div class="nav-bar">
 134              <a href="#sec-description">Description</a> |
 135                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 136                          
 137          </div>
 138          <div class="info-box-body">
 139              <A NAME='method_detail'></A>
 140  <a name="methodgetCausesValidation" id="getCausesValidation"><!-- --></a>
 141  <div class="oddrow">
 142      
 143      <div class="method-header">
 144          <span class="method-title">getCausesValidation</span> (line <span class="line-number">1981</span>)
 145      </div> 
 146      
 147      <!-- ========== Info from phpDoc block ========= -->
 148      <ul class="tags">
 149                  <li><span class="field">return:</span> whether postback event trigger by this button will cause input validation</li>
 150                  <li><span class="field">access:</span> public</li>
 151              </ul>
 152      
 153      <div class="method-signature">
 154          <span class="method-result">boolean</span>
 155          <span class="method-name">
 156              getCausesValidation
 157          </span>
 158                  ()
 159              </div>
 160      
 161          
 162          
 163      </div>
 164  <a name="methodgetCommandName" id="getCommandName"><!-- --></a>
 165  <div class="evenrow">
 166      
 167      <div class="method-header">
 168          <span class="method-title">getCommandName</span> (line <span class="line-number">1991</span>)
 169      </div> 
 170      
 171      <!-- ========== Info from phpDoc block ========= -->
 172      <ul class="tags">
 173                  <li><span class="field">return:</span> the command name associated with the <a href="../System.Web.UI/IButtonControl.html#methodonCommand">OnCommand</a> event.</li>
 174                  <li><span class="field">access:</span> public</li>
 175              </ul>
 176      
 177      <div class="method-signature">
 178          <span class="method-result">string</span>
 179          <span class="method-name">
 180              getCommandName
 181          </span>
 182                  ()
 183              </div>
 184      
 185          
 186          
 187      </div>
 188  <a name="methodgetCommandParameter" id="getCommandParameter"><!-- --></a>
 189  <div class="oddrow">
 190      
 191      <div class="method-header">
 192          <span class="method-title">getCommandParameter</span> (line <span class="line-number">2001</span>)
 193      </div> 
 194      
 195      <!-- ========== Info from phpDoc block ========= -->
 196      <ul class="tags">
 197                  <li><span class="field">return:</span> the parameter associated with the <a href="../System.Web.UI/IButtonControl.html#methodonCommand">OnCommand</a> event</li>
 198                  <li><span class="field">access:</span> public</li>
 199              </ul>
 200      
 201      <div class="method-signature">
 202          <span class="method-result">string</span>
 203          <span class="method-name">
 204              getCommandParameter
 205          </span>
 206                  ()
 207              </div>
 208      
 209          
 210          
 211      </div>
 212  <a name="methodgetText" id="getText"><!-- --></a>
 213  <div class="evenrow">
 214      
 215      <div class="method-header">
 216          <span class="method-title">getText</span> (line <span class="line-number">1971</span>)
 217      </div> 
 218      
 219      <!-- ========== Info from phpDoc block ========= -->
 220      <ul class="tags">
 221                  <li><span class="field">return:</span> caption of the button</li>
 222                  <li><span class="field">access:</span> public</li>
 223              </ul>
 224      
 225      <div class="method-signature">
 226          <span class="method-result">string</span>
 227          <span class="method-name">
 228              getText
 229          </span>
 230                  ()
 231              </div>
 232      
 233          
 234          
 235      </div>
 236  <a name="methodgetValidationGroup" id="getValidationGroup"><!-- --></a>
 237  <div class="oddrow">
 238      
 239      <div class="method-header">
 240          <span class="method-title">getValidationGroup</span> (line <span class="line-number">2011</span>)
 241      </div> 
 242      
 243      <!-- ========== Info from phpDoc block ========= -->
 244      <ul class="tags">
 245                  <li><span class="field">return:</span> the group of validators which the button causes validation upon postback</li>
 246                  <li><span class="field">access:</span> public</li>
 247              </ul>
 248      
 249      <div class="method-signature">
 250          <span class="method-result">string</span>
 251          <span class="method-name">
 252              getValidationGroup
 253          </span>
 254                  ()
 255              </div>
 256      
 257          
 258          
 259      </div>
 260  <a name="methodonClick" id="onClick"><!-- --></a>
 261  <div class="evenrow">
 262      
 263      <div class="method-header">
 264          <span class="method-title">onClick</span> (line <span class="line-number">2022</span>)
 265      </div> 
 266      
 267      <!-- ========== Info from phpDoc block ========= -->
 268  <p class="short-description">Raises <strong>OnClick</strong> event.</p>
 269      <ul class="tags">
 270                  <li><span class="field">access:</span> public</li>
 271              </ul>
 272      
 273      <div class="method-signature">
 274          <span class="method-result">void</span>
 275          <span class="method-name">
 276              onClick
 277          </span>
 278                      (<span class="var-type"><a href="../System/TEventParameter.html">TEventParameter</a></span>&nbsp;<span class="var-name">$param</span>)
 279              </div>
 280      
 281              <ul class="parameters">
 282                      <li>
 283                  <span class="var-type"><a href="../System/TEventParameter.html">TEventParameter</a></span>
 284                  <span class="var-name">$param</span><span class="var-description">: event parameter to be passed to the event handlers</span>            </li>
 285                  </ul>
 286          
 287          
 288      </div>
 289  <a name="methodonCommand" id="onCommand"><!-- --></a>
 290  <div class="oddrow">
 291      
 292      <div class="method-header">
 293          <span class="method-title">onCommand</span> (line <span class="line-number">2028</span>)
 294      </div> 
 295      
 296      <!-- ========== Info from phpDoc block ========= -->
 297  <p class="short-description">Raises <strong>OnCommand</strong> event.</p>
 298      <ul class="tags">
 299                  <li><span class="field">access:</span> public</li>
 300              </ul>
 301      
 302      <div class="method-signature">
 303          <span class="method-result">void</span>
 304          <span class="method-name">
 305              onCommand
 306          </span>
 307                      (<span class="var-type"><a href="../System.Web.UI/TCommandEventParameter.html">TCommandEventParameter</a></span>&nbsp;<span class="var-name">$param</span>)
 308              </div>
 309      
 310              <ul class="parameters">
 311                      <li>
 312                  <span class="var-type"><a href="../System.Web.UI/TCommandEventParameter.html">TCommandEventParameter</a></span>
 313                  <span class="var-name">$param</span><span class="var-description">: event parameter to be passed to the event handlers</span>            </li>
 314                  </ul>
 315          
 316          
 317      </div>
 318  <a name="methodsetCausesValidation" id="setCausesValidation"><!-- --></a>
 319  <div class="evenrow">
 320      
 321      <div class="method-header">
 322          <span class="method-title">setCausesValidation</span> (line <span class="line-number">1986</span>)
 323      </div> 
 324      
 325      <!-- ========== Info from phpDoc block ========= -->
 326      <ul class="tags">
 327                  <li><span class="field">access:</span> public</li>
 328              </ul>
 329      
 330      <div class="method-signature">
 331          <span class="method-result">void</span>
 332          <span class="method-name">
 333              setCausesValidation
 334          </span>
 335                      (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 336              </div>
 337      
 338              <ul class="parameters">
 339                      <li>
 340                  <span class="var-type">boolean</span>
 341                  <span class="var-name">$value</span><span class="var-description">: whether postback event trigger by this button will cause input validation</span>            </li>
 342                  </ul>
 343          
 344          
 345      </div>
 346  <a name="methodsetCommandName" id="setCommandName"><!-- --></a>
 347  <div class="oddrow">
 348      
 349      <div class="method-header">
 350          <span class="method-title">setCommandName</span> (line <span class="line-number">1996</span>)
 351      </div> 
 352      
 353      <!-- ========== Info from phpDoc block ========= -->
 354      <ul class="tags">
 355                  <li><span class="field">access:</span> public</li>
 356              </ul>
 357      
 358      <div class="method-signature">
 359          <span class="method-result">void</span>
 360          <span class="method-name">
 361              setCommandName
 362          </span>
 363                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 364              </div>
 365      
 366              <ul class="parameters">
 367                      <li>
 368                  <span class="var-type">string</span>
 369                  <span class="var-name">$value</span><span class="var-description">: the command name associated with the <a href="../System.Web.UI/IButtonControl.html#methodonCommand">OnCommand</a> event.</span>            </li>
 370                  </ul>
 371          
 372          
 373      </div>
 374  <a name="methodsetCommandParameter" id="setCommandParameter"><!-- --></a>
 375  <div class="evenrow">
 376      
 377      <div class="method-header">
 378          <span class="method-title">setCommandParameter</span> (line <span class="line-number">2006</span>)
 379      </div> 
 380      
 381      <!-- ========== Info from phpDoc block ========= -->
 382      <ul class="tags">
 383                  <li><span class="field">access:</span> public</li>
 384              </ul>
 385      
 386      <div class="method-signature">
 387          <span class="method-result">void</span>
 388          <span class="method-name">
 389              setCommandParameter
 390          </span>
 391                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 392              </div>
 393      
 394              <ul class="parameters">
 395                      <li>
 396                  <span class="var-type">string</span>
 397                  <span class="var-name">$value</span><span class="var-description">: the parameter associated with the <a href="../System.Web.UI/IButtonControl.html#methodonCommand">OnCommand</a> event.</span>            </li>
 398                  </ul>
 399          
 400          
 401      </div>
 402  <a name="methodsetText" id="setText"><!-- --></a>
 403  <div class="oddrow">
 404      
 405      <div class="method-header">
 406          <span class="method-title">setText</span> (line <span class="line-number">1976</span>)
 407      </div> 
 408      
 409      <!-- ========== Info from phpDoc block ========= -->
 410      <ul class="tags">
 411                  <li><span class="field">access:</span> public</li>
 412              </ul>
 413      
 414      <div class="method-signature">
 415          <span class="method-result">void</span>
 416          <span class="method-name">
 417              setText
 418          </span>
 419                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 420              </div>
 421      
 422              <ul class="parameters">
 423                      <li>
 424                  <span class="var-type">string</span>
 425                  <span class="var-name">$value</span><span class="var-description">: caption of the button</span>            </li>
 426                  </ul>
 427          
 428          
 429      </div>
 430  <a name="methodsetValidationGroup" id="setValidationGroup"><!-- --></a>
 431  <div class="evenrow">
 432      
 433      <div class="method-header">
 434          <span class="method-title">setValidationGroup</span> (line <span class="line-number">2016</span>)
 435      </div> 
 436      
 437      <!-- ========== Info from phpDoc block ========= -->
 438      <ul class="tags">
 439                  <li><span class="field">access:</span> public</li>
 440              </ul>
 441      
 442      <div class="method-signature">
 443          <span class="method-result">void</span>
 444          <span class="method-name">
 445              setValidationGroup
 446          </span>
 447                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 448              </div>
 449      
 450              <ul class="parameters">