[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 TCheckBoxColumn</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 TCheckBoxColumn</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">TCheckBoxColumn class</p>
  25  <p class="description"><p>TCheckBoxColumn represents a checkbox column that is bound to a field in a data source.  The checked state of the checkboxes are determiend by the bound data at  <a href="../System.Web.UI.WebControls/TCheckBoxColumn.html#methodsetDataField">DataField</a>. If <a href="../System.Web.UI.WebControls/TCheckBoxColumn.html#methodsetReadOnly">ReadOnly</a> is false,  TCheckBoxColumn will display an enabled checkbox provided the cells are  in edit mode. Otherwise, the checkboxes will be disabled to prevent from editting.</p><p>The checkbox control in the TCheckBoxColumn can be accessed by one of  the following two methods:  <pre><ol><code><pre><li> <span class="src-var">$datagridItem</span><span class="src-sym">-&gt;</span><span class="src-id">CheckBoxColumnID</span><span class="src-sym">-&gt;</span><span class="src-id">CheckBox</span></li>
  26  <li> <span class="src-var">$datagridItem</span><span class="src-sym">-&gt;</span><span class="src-id">CheckBoxColumnID</span><span class="src-sym">-&gt;</span><span class="src-id">Controls</span><span class="src-sym">[</span><span class="src-num">0</span><span class="src-sym">]</span></li>
  27  </pre></code></ol></pre>  The second method is possible because the checkbox control created within the  datagrid cell is the first child.</p></p>
  28      <ul class="tags">
  29                  <li><span class="field">since:</span> 3.0</li>
  30                  <li><span class="field">version:</span> $Id: TCheckBoxColumn.php 1397 2006-09-07 07:55:53Z wei $</li>
  31                  <li><span class="field">author:</span> Qiang Xue &lt;<a href="mailto:qiang.xue@gmail.com">qiang.xue@gmail.com</a>&gt;</li>
  32              </ul>
  33          <p class="notes">
  34              Located in <a class="field" href="_Web_UI_WebControls_TCheckBoxColumn_php.html">/Web/UI/WebControls/TCheckBoxColumn.php</a> (line <span class="field">45</span>)
  35          </p>
  36          
  37                  
  38          <pre><a href="../System/TComponent.html">TComponent</a>
  39     |
  40     --<a href="../System/TApplicationComponent.html">TApplicationComponent</a>
  41        |
  42        --<a href="../System.Web.UI.WebControls/TDataGridColumn.html">TDataGridColumn</a>
  43           |
  44           --TCheckBoxColumn</pre>
  45      
  46              </div>
  47  </div>
  48  
  49  
  50  
  51  
  52      <a name="sec-method-summary"></a>
  53      <div class="info-box">
  54          <div class="info-box-title">Method Summary</span></div>
  55          <div class="nav-bar">
  56              <a href="#sec-description">Description</a> |
  57                                                  <span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
  58          </div>
  59          <div class="info-box-body">            
  60              <div class="method-summary">
  61                                  
  62                  <div class="method-definition">
  63                                              <span class="method-result">void</span>
  64                                          <a href="#dataBindColumn" title="details" class="method-name">dataBindColumn</a>
  65                                              (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$sender</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$param</span>)
  66                                      </div>
  67                                  
  68                  <div class="method-definition">
  69                                              <span class="method-result">string</span>
  70                                          <a href="#getDataField" title="details" class="method-name">getDataField</a>
  71                                          ()
  72                                      </div>
  73                                  
  74                  <div class="method-definition">
  75                                              <span class="method-result">boolean</span>
  76                                          <a href="#getReadOnly" title="details" class="method-name">getReadOnly</a>
  77                                          ()
  78                                      </div>
  79                                  
  80                  <div class="method-definition">
  81                                              <span class="method-result">void</span>
  82                                          <a href="#initializeCell" title="details" class="method-name">initializeCell</a>
  83                                              (<span class="var-type"><a href="../System.Web.UI.WebControls/TTableCell.html">TTableCell</a></span>&nbsp;<span class="var-name">$cell</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$columnIndex</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$itemType</span>)
  84                                      </div>
  85                                  
  86                  <div class="method-definition">
  87                                              <span class="method-result">void</span>
  88                                          <a href="#setDataField" title="details" class="method-name">setDataField</a>
  89                                              (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
  90                                      </div>
  91                                  
  92                  <div class="method-definition">
  93                                              <span class="method-result">void</span>
  94                                          <a href="#setReadOnly" title="details" class="method-name">setReadOnly</a>
  95                                              (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
  96                                      </div>
  97                              </div>
  98          </div>
  99      </div>        
 100  
 101      
 102      <a name="sec-methods"></a>
 103      <div class="info-box">
 104          <div class="info-box-title">Methods</div>
 105          <div class="nav-bar">
 106              <a href="#sec-description">Description</a> |
 107                                                                  <a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
 108                          
 109          </div>
 110          <div class="info-box-body">
 111              <A NAME='method_detail'></A>
 112  <a name="methoddataBindColumn" id="dataBindColumn"><!-- --></a>
 113  <div class="evenrow">
 114      
 115      <div class="method-header">
 116          <span class="method-title">dataBindColumn</span> (line <span class="line-number">110</span>)
 117      </div> 
 118      
 119      <!-- ========== Info from phpDoc block ========= -->
 120  <p class="short-description">Databinds a cell in the column.</p>
 121  <p class="description"><p>This method is invoked when datagrid performs databinding.  It populates the content of the cell with the relevant data from data source.</p></p>
 122      <ul class="tags">
 123                  <li><span class="field">access:</span> public</li>
 124              </ul>
 125      
 126      <div class="method-signature">
 127          <span class="method-result">void</span>
 128          <span class="method-name">
 129              dataBindColumn
 130          </span>
 131                      (<span class="var-type">mixed</span>&nbsp;<span class="var-name">$sender</span>, <span class="var-type">mixed</span>&nbsp;<span class="var-name">$param</span>)
 132              </div>
 133      
 134          
 135          
 136      </div>
 137  <a name="methodgetDataField" id="getDataField"><!-- --></a>
 138  <div class="oddrow">
 139      
 140      <div class="method-header">
 141          <span class="method-title">getDataField</span> (line <span class="line-number">50</span>)
 142      </div> 
 143      
 144      <!-- ========== Info from phpDoc block ========= -->
 145      <ul class="tags">
 146                  <li><span class="field">return:</span> the field name from the data source to bind to the column</li>
 147                  <li><span class="field">access:</span> public</li>
 148              </ul>
 149      
 150      <div class="method-signature">
 151          <span class="method-result">string</span>
 152          <span class="method-name">
 153              getDataField
 154          </span>
 155                  ()
 156              </div>
 157      
 158          
 159          
 160      </div>
 161  <a name="methodgetReadOnly" id="getReadOnly"><!-- --></a>
 162  <div class="evenrow">
 163      
 164      <div class="method-header">
 165          <span class="method-title">getReadOnly</span> (line <span class="line-number">66</span>)
 166      </div> 
 167      
 168      <!-- ========== Info from phpDoc block ========= -->
 169      <ul class="tags">
 170                  <li><span class="field">return:</span> whether the items in the column can be edited. Defaults to false.</li>
 171                  <li><span class="field">access:</span> public</li>
 172              </ul>
 173      
 174      <div class="method-signature">
 175          <span class="method-result">boolean</span>
 176          <span class="method-name">
 177              getReadOnly
 178          </span>
 179                  ()
 180              </div>
 181      
 182          
 183          
 184      </div>
 185  <a name="methodinitializeCell" id="initializeCell"><!-- --></a>
 186  <div class="oddrow">
 187      
 188      <div class="method-header">
 189          <span class="method-title">initializeCell</span> (line <span class="line-number">89</span>)
 190      </div> 
 191      
 192      <!-- ========== Info from phpDoc block ========= -->
 193  <p class="short-description">Initializes the specified cell to its initial values.</p>
 194  <p class="description"><p>This method overrides the parent implementation.  It creates a checkbox inside the cell.  If the column is read-only or if the item is not in edit mode,  the checkbox will be set disabled.</p></p>
 195      <ul class="tags">
 196                  <li><span class="field">access:</span> public</li>
 197              </ul>
 198      
 199      <div class="method-signature">
 200          <span class="method-result">void</span>
 201          <span class="method-name">
 202              initializeCell
 203          </span>
 204                      (<span class="var-type"><a href="../System.Web.UI.WebControls/TTableCell.html">TTableCell</a></span>&nbsp;<span class="var-name">$cell</span>, <span class="var-type">integer</span>&nbsp;<span class="var-name">$columnIndex</span>, <span class="var-type">string</span>&nbsp;<span class="var-name">$itemType</span>)
 205              </div>
 206      
 207              <ul class="parameters">
 208                      <li>
 209                  <span class="var-type"><a href="../System.Web.UI.WebControls/TTableCell.html">TTableCell</a></span>
 210                  <span class="var-name">$cell</span><span class="var-description">: the cell to be initialized.</span>            </li>
 211                      <li>
 212                  <span class="var-type">integer</span>
 213                  <span class="var-name">$columnIndex</span><span class="var-description">: the index to the Columns property that the cell resides in.</span>            </li>
 214                      <li>
 215                  <span class="var-type">string</span>
 216                  <span class="var-name">$itemType</span><span class="var-description">: the type of cell (Header,Footer,Item,AlternatingItem,EditItem,SelectedItem)</span>            </li>
 217                  </ul>
 218          
 219              <hr class="separator" />
 220          <div class="notes">Redefinition of:</div>
 221          <dl>
 222              <dt><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodinitializeCell">TDataGridColumn::initializeCell()</a></dt>
 223                          <dd>Initializes the specified cell to its initial values.</dd>
 224                      </dl>
 225          
 226      </div>
 227  <a name="methodsetDataField" id="setDataField"><!-- --></a>
 228  <div class="evenrow">
 229      
 230      <div class="method-header">
 231          <span class="method-title">setDataField</span> (line <span class="line-number">58</span>)
 232      </div> 
 233      
 234      <!-- ========== Info from phpDoc block ========= -->
 235      <ul class="tags">
 236                  <li><span class="field">access:</span> public</li>
 237              </ul>
 238      
 239      <div class="method-signature">
 240          <span class="method-result">void</span>
 241          <span class="method-name">
 242              setDataField
 243          </span>
 244                      (<span class="var-type">string</span>&nbsp;<span class="var-name">$value</span>)
 245              </div>
 246      
 247              <ul class="parameters">
 248                      <li>
 249                  <span class="var-type">string</span>
 250                  <span class="var-name">$value</span><span class="var-description">: the field name from the data source to bind to the column</span>            </li>
 251                  </ul>
 252          
 253          
 254      </div>
 255  <a name="methodsetReadOnly" id="setReadOnly"><!-- --></a>
 256  <div class="oddrow">
 257      
 258      <div class="method-header">
 259          <span class="method-title">setReadOnly</span> (line <span class="line-number">74</span>)
 260      </div> 
 261      
 262      <!-- ========== Info from phpDoc block ========= -->
 263      <ul class="tags">
 264                  <li><span class="field">access:</span> public</li>
 265              </ul>
 266      
 267      <div class="method-signature">
 268          <span class="method-result">void</span>
 269          <span class="method-name">
 270              setReadOnly
 271          </span>
 272                      (<span class="var-type">boolean</span>&nbsp;<span class="var-name">$value</span>)
 273              </div>
 274      
 275              <ul class="parameters">
 276                      <li>
 277                  <span class="var-type">boolean</span>
 278                  <span class="var-name">$value</span><span class="var-description">: whether the items in the column can be edited</span>            </li>
 279                  </ul>
 280          
 281          
 282      </div>
 283                              <h4>Inherited Methods</h4>
 284                  <a name='inherited_methods'><!-- --></a>    
 285                                      <!-- =========== Summary =========== -->
 286                      <p>Inherited From <span class="classname"><a href="../System.Web.UI.WebControls/TDataGridColumn.html">TDataGridColumn</a></span></p>
 287                      <blockquote>
 288                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodformatDataValue">TDataGridColumn::formatDataValue()</a></span><br>
 289                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetDataFieldValue">TDataGridColumn::getDataFieldValue()</a></span><br>
 290                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetFooterStyle">TDataGridColumn::getFooterStyle()</a></span><br>
 291                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetFooterText">TDataGridColumn::getFooterText()</a></span><br>
 292                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetHeaderImageUrl">TDataGridColumn::getHeaderImageUrl()</a></span><br>
 293                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetHeaderStyle">TDataGridColumn::getHeaderStyle()</a></span><br>
 294                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetHeaderText">TDataGridColumn::getHeaderText()</a></span><br>
 295                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetID">TDataGridColumn::getID()</a></span><br>
 296                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetItemStyle">TDataGridColumn::getItemStyle()</a></span><br>
 297                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetOwner">TDataGridColumn::getOwner()</a></span><br>
 298                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetSortExpression">TDataGridColumn::getSortExpression()</a></span><br>
 299                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetViewState">TDataGridColumn::getViewState()</a></span><br>
 300                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodgetVisible">TDataGridColumn::getVisible()</a></span><br>
 301                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodinitialize">TDataGridColumn::initialize()</a></span><br>
 302                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodinitializeCell">TDataGridColumn::initializeCell()</a></span><br>
 303                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodloadState">TDataGridColumn::loadState()</a></span><br>
 304                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsaveState">TDataGridColumn::saveState()</a></span><br>
 305                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetFooterText">TDataGridColumn::setFooterText()</a></span><br>
 306                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetHeaderImageUrl">TDataGridColumn::setHeaderImageUrl()</a></span><br>
 307                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetHeaderText">TDataGridColumn::setHeaderText()</a></span><br>
 308                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetID">TDataGridColumn::setID()</a></span><br>
 309                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetOwner">TDataGridColumn::setOwner()</a></span><br>
 310                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetSortExpression">TDataGridColumn::setSortExpression()</a></span><br>
 311                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetViewState">TDataGridColumn::setViewState()</a></span><br>
 312                                                      <span class="method-name"><a href="../System.Web.UI.WebControls/TDataGridColumn.html#methodsetVisible">TDataGridColumn::setVisible()</a></span><br>
 313                                              </blockquote>
 314                                      <!-- =========== Summary =========== -->
 315                      <p>Inherited From <span class="classname"><a href="../System/TApplicationComponent.html">TApplicationComponent</a></span></p>
 316                      <blockquote>
 317                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetApplication">TApplicationComponent::getApplication()</a></span><br>
 318                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetRequest">TApplicationComponent::getRequest()</a></span><br>
 319                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetResponse">TApplicationComponent::getResponse()</a></span><br>
 320                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetService">TApplicationComponent::getService()</a></span><br>
 321                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetSession">TApplicationComponent::getSession()</a></span><br>
 322                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodgetUser">TApplicationComponent::getUser()</a></span><br>
 323                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishAsset">TApplicationComponent::publishAsset()</a></span><br>
 324                                                      <span class="method-name"><a href="../System/TApplicationComponent.html#methodpublishFilePath">TApplicationComponent::publishFilePath()</a></span><br>
 325                                              </blockquote>
 326                                      <!-- =========== Summary =========== -->
 327                      <p>Inherited From <span class="classname"><a href="../System/TComponent.html">TComponent</a></span></p>
 328                      <blockquote>
 329                                                      <span class="method-name"><a href="../System/TComponent.html#methodaddParsedObject">TComponent::addParsedObject()</a></span><br>
 330                                                      <span class="method-name"><a href="../System/TComponent.html#methodattachEventHandler">TComponent::attachEventHandler()</a></span><br>
 331                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanGetProperty">TComponent::canGetProperty()</a></span><br>
 332                                                      <span class="method-name"><a href="../System/TComponent.html#methodcanSetProperty">TComponent::canSetProperty()</a></span><br>
 333                                                      <span class="method-name"><a href="../System/TComponent.html#methodcreatedOnTemplate">TComponent::createdOnTemplate()</a></span><br>
 334                                                      <span class="method-name"><a href="../System/TComponent.html#methoddetachEventHandler">TComponent::detachEventHandler()</a></span><br>
 335                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateExpression">TComponent::evaluateExpression()</a></span><br>
 336                                                      <span class="method-name"><a href="../System/TComponent.html#methodevaluateStatements">TComponent::evaluateStatements()</a></span><br>
 337                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetEventHandlers">TComponent::getEventHandlers()</a></span><br>
 338                                                      <span class="method-name"><a href="../System/TComponent.html#methodgetSubProperty">TComponent::getSubProperty()</a></span><br>
 339                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEvent">TComponent::hasEvent()</a></span><br>
 340                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasEventHandler">TComponent::hasEventHandler()</a></span><br>
 341                                                      <span class="method-name"><a href="../System/TComponent.html#methodhasProperty">TComponent::hasProperty()</a></span><br>
 342                                                      <span class="method-name"><a href="../System/TComponent.html#methodraiseEvent">TComponent::raiseEvent()</a></span><br>
 343                                                      <span class="method-name"><a href="../System/TComponent.html#methodsetSubProperty">TComponent::setSubProperty()</a></span><br>
 344                                                      <span class="method-name"><a href="../System/TComponent.html#method__get">TComponent::__get()</a></span><br>
 345                                                      <span class="method-name"><a href="../System/TComponent.html#method__set">TComponent::__set()</a></span><br>
 346                                              </blockquote>
 347                                          
 348          </div>
 349      </div>
 350  
 351  
 352      <p class="notes" id="credit">
 353          Documentation generated on Mon, 04 Dec 2006 11:26:03 -0500 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.0RC4</a>
 354      </p>
 355      </div></body>
 356  </html>