[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 TWizardNavigationEventParameter</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">Class TWizardNavigationEventParameter</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">TWizardNavigationEventParameter class.</p>
  25  <p class="description"><p>TWizardNavigationEventParameter represents the parameter for  <a href="../System.Web.UI.WebControls/TWizard.html">TWizard</a>'s navigation events.</p><p>The index of the currently active step can be obtained from  <a href="../System.Web.UI.WebControls/TWizardNavigationEventParameter.html#methodgetCurrentStepIndex">CurrentStepIndex</a>, while the index  of the candidate new step is in <a href="../System.Web.UI.WebControls/TWizardNavigationEventParameter.html#methodgetNextStepIndex">NextStepIndex</a>.  By modifying <a href="../System.Web.UI.WebControls/TWizardNavigationEventParameter.html#methodsetNextStepIndex">NextStepIndex</a>, the new step  can be changed to another one. If there is anything wrong with  the navigation and it is not wanted, set <a href="../System.Web.UI.WebControls/TWizardNavigationEventParameter.html#methodsetCancelNavigation">CancelNavigation</a>  to true.</p></p>
  26      <ul class="tags">
  27                  <li><span class="field">since:</span> 3.0</li>
  28                  <li><span class="field">version:</span> $Id: TWizard.php 1397 2006-09-07 07:55:53Z wei $</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_WebControls_TWizard_php.html">/Web/UI/WebControls/TWizard.php</a> (line <span class="field">1948</span>)
  33          </p>
  34          
  35                  
  36          <pre><a href="../System/TComponent.html">TComponent</a>
  37     |
  38     --<a href="../System/TEventParameter.html">TEventParameter</a>
  39        |
  40        --TWizardNavigationEventParameter</pre>
  41      
  42              </div>
  43  </div>
  44  
  45  
  46  
  47  
  48      <a name="sec-method-summary"></a>
  49      <div class="info-box">
  50          <div class="info-box-title">Method Summary</span></div>
  51          <div class="nav-bar">
  52              <a href="#sec-description">Description</a> |
  53                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  54          </div>
  55          <div class="info-box-body">            
  56              <div class="method-summary">
  57                                  
  58                  <div class="method-definition">
  59                                              <span class="method-result">TWizardNavigationEventParameter</span>
  60                                          <a href="#__construct" title="details" class="method-name">__construct</a>
  61                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$currentStep</span>)
  62                                      </div>
  63                                  
  64                  <div class="method-definition">
  65                                              <span class="method-result">boolean</span>
  66                                          <a href="#getCancelNavigation" title="details" class="method-name">getCancelNavigation</a>
  67                                          ()
  68                                      </div>
  69                                  
  70                  <div class="method-definition">
  71                                              <span class="method-result">integer</span>
  72                                          <a href="#getCurrentStepIndex" title="details" class="method-name">getCurrentStepIndex</a>
  73                                          ()
  74                                      </div>
  75                                  
  76                  <div class="method-definition">
  77                                              <span class="method-result">integer</span>
  78                                          <a href="#getNextStepIndex" title="details" class="method-name">getNextStepIndex</a>
  79                                          ()
  80                                      </div>
  81                                  
  82                  <div class="method-definition">
  83                                              <span class="method-result">void</span>
  84                                          <a href="#setCancelNavigation" title="details" class="method-name">setCancelNavigation</a>
  85                                              (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
  86                                      </div>
  87                                  
  88                  <div class="method-definition">
  89                                              <span class="method-result">void</span>
  90                                          <a href="#setNextStepIndex" title="details" class="method-name">setNextStepIndex</a>
  91                                              (<span class="var-type">integer</span>&nbsp;<span class="var-name">$index</span>)
  92                                      </div>
  93                              </div>
  94          </div>
  95      </div>        
  96  
  97      
  98      <a name="sec-methods"></a>
  99      <div class="info-box">
 100          <div class="info-box-title">Methods</div>
 101          <div class="nav-bar">
 102              <a href="#sec-description">Description</a> |
 103                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 104                          
 105          </div>
 106          <div class="info-box-body">
 107              <A NAME='method_detail'></A>
 108  <a name="method__construct" id="__construct"><!-- --></a>
 109  <div class="oddrow">
 110      
 111      <div class="method-header">
 112          <span class="method-title">Constructor __construct</span> (line <span class="line-number">1958</span>)
 113      </div> 
 114      
 115      <!-- ========== Info from phpDoc block ========= -->
 116  <p class="short-description">Constructor.</p>
 117      <ul class="tags">
 118                  <li><span class="field">access:</span> public</li>
 119              </ul>
 120      
 121      <div class="method-signature">
 122          <span class="method-result">TWizardNavigationEventParameter</span>
 123          <span class="method-name">
 124              __construct
 125          </span>
 126                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$currentStep</span>)
 127              </div>
 128      
 129              <ul class="parameters">
 130                      <li>
 131                  <span class="var-type">integer</span>
 132                  <span class="var-name">$currentStep</span><span class="var-description">: current step index</span>            </li>
 133                  </ul>
 134          
 135          
 136      </div>
 137  <a name="methodgetCancelNavigation" id="getCancelNavigation"><!-- --></a>
 138  <div class="evenrow">
 139      
 140      <div class="method-header">
 141          <span class="method-title">getCancelNavigation</span> (line <span class="line-number">1991</span>)
 142      </div> 
 143      
 144      <!-- ========== Info from phpDoc block ========= -->
 145      <ul class="tags">
 146                  <li><span class="field">return:</span> whether navigation to the next step should be canceled. Default to false.</li>
 147                  <li><span class="field">access:</span> public</li>
 148              </ul>
 149      
 150      <div class="method-signature">
 151          <span class="method-result">boolean</span>
 152          <span class="method-name">
 153              getCancelNavigation
 154          </span>
 155                  ()
 156              </div>
 157      
 158          
 159          
 160      </div>
 161  <a name="methodgetCurrentStepIndex" id="getCurrentStepIndex"><!-- --></a>
 162  <div class="oddrow">
 163      
 164      <div class="method-header">
 165          <span class="method-title">getCurrentStepIndex</span> (line <span class="line-number">1967</span>)
 166      </div> 
 167      
 168      <!-- ========== Info from phpDoc block ========= -->
 169      <ul class="tags">
 170                  <li><span class="field">return:</span> the zero-based index of the currently active step.</li>
 171                  <li><span class="field">access:</span> public</li>
 172              </ul>
 173      
 174      <div class="method-signature">
 175          <span class="method-result">integer</span>
 176          <span class="method-name">
 177              getCurrentStepIndex
 178          </span>
 179                  ()
 180              </div>
 181      
 182          
 183          
 184      </div>
 185  <a name="methodgetNextStepIndex" id="getNextStepIndex"><!-- --></a>
 186  <div class="evenrow">
 187      
 188      <div class="method-header">
 189          <span class="method-title">getNextStepIndex</span> (line <span class="line-number">1975</span>)
 190      </div> 
 191      
 192      <!-- ========== Info from phpDoc block ========= -->
 193      <ul class="tags">
 194                  <li><span class="field">return:</span> the zero-based index of the next step. Default to <a href="../System.Web.UI.WebControls/TWizardNavigationEventParameter.html#methodgetCurrentStepIndex">CurrentStepIndex</a>.</li>
 195                  <li><span class="field">access:</span> public</li>
 196              </ul>
 197      
 198      <div class="method-signature">
 199          <span class="method-result">integer</span>
 200          <span class="method-name">
 201              getNextStepIndex
 202          </span>
 203                  ()
 204              </div>
 205      
 206          
 207          
 208      </div>
 209  <a name="methodsetCancelNavigation" id="setCancelNavigation"><!-- --></a>
 210  <div class="oddrow">
 211      
 212      <div class="method-header">
 213          <span class="method-title">setCancelNavigation</span> (line <span class="line-number">1999</span>)
 214      </div> 
 215      
 216      <!-- ========== Info from phpDoc block ========= -->
 217      <ul class="tags">
 218                  <li><span class="field">access:</span> public</li>
 219              </ul>
 220      
 221      <div class="method-signature">
 222          <span class="method-result">void</span>
 223          <span class="method-name">
 224              setCancelNavigation
 225          </span>
 226                      (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 227              </div>
 228      
 229              <ul class="parameters">
 230                      <li>
 231                  <span class="var-type">boolean</span>
 232                  <span class="var-name">$value</span><span class="var-description">: whether navigation to the next step should be canceled.</span>            </li>
 233                  </ul>
 234          
 235          
 236      </div>
 237  <a name="methodsetNextStepIndex" id="setNextStepIndex"><!-- --></a>
 238  <div class="evenrow">
 239      
 240      <div class="method-header">
 241          <span class="method-title">setNextStepIndex</span> (line <span class="line-number">1983</span>)
 242      </div> 
 243      
 244      <!-- ========== Info from phpDoc block ========= -->
 245      <ul class="tags">
 246                  <li><span class="field">access:</span> public</li>
 247              </ul>
 248      
 249      <div class="method-signature">
 250          <span class="method-result">void</span>
 251          <span class="method-name">
 252              setNextStepIndex
 253          </span>
 254                      (<span class="var-type">integer</span>&nbsp;<span class="var-name">$index</span>)
 255              </div>
 256      
 257              <ul class="parameters">
 258                      <li>
 259                  <span class="var-type">integer</span>
 260                  <span class="var-name">$index</span><span class="var-description">: the zero-based index of the next step.</span>            </li>
 261                  </ul>
 262          
 263          
 264      </div>
 265                              <h4>Inherited Methods</h4>
 266                  <a name='inherited_methods'><!-- --></a>    
 267                                      <!-- =========== Summary =========== -->
 268                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 269                      <blockquote>
 270                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 271                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 272                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 273                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 274                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 275                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 276                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 277                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 278                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 279                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 280                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 281                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 282                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 283                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 284                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 285                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 286                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 287                                              </blockquote>
 288                                          
 289          </div>
 290      </div>
 291  
 292  
 293      <p class="notes" id="credit">
 294          Documentation generated on Mon, 04 Dec 2006 11:27:57 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 295      </p>
 296      </div></body>
 297  </html>