1<?xml version="1.0" encoding="utf-8"?> 2<Type Name="TableStyle" FullName="System.Web.UI.WebControls.TableStyle"> 3 <TypeSignature Language="C#" Maintainer="auto" Value="public class TableStyle : System.Web.UI.WebControls.Style" /> 4 <AssemblyInfo> 5 <AssemblyName>System.Web</AssemblyName> 6 <AssemblyPublicKey> 7 </AssemblyPublicKey> 8 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 9 <AssemblyVersion>2.0.0.0</AssemblyVersion> 10 </AssemblyInfo> 11 <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> 12 <Base> 13 <BaseTypeName>System.Web.UI.WebControls.Style</BaseTypeName> 14 </Base> 15 <Interfaces> 16 </Interfaces> 17 <Docs> 18 <remarks> 19 <attribution license="cc4" from="Microsoft" modified="false" /> 20 <para>The <see cref="T:System.Web.UI.WebControls.TableStyle" /> class is used to represent the style for a table control. It encapsulates the properties that control the appearance of a table and can be applied to multiple table controls to provide a common appearance.</para> 21 <para>You can specify an image to display in the background of the table by setting the <see cref="P:System.Web.UI.WebControls.TableStyle.BackImageUrl" /> property. The amount of spacing between the cells of a table is controlled by the <see cref="P:System.Web.UI.WebControls.TableStyle.CellSpacing" /> property. The spacing between the contents of a cell and the cell border is specified using the <see cref="P:System.Web.UI.WebControls.TableStyle.CellPadding" /> property. You can specify whether cell borders are displayed by setting the <see cref="P:System.Web.UI.WebControls.TableStyle.GridLines" /> property. The horizontal alignment of the table in relation to other elements on the Web Forms page is indicated by the <see cref="P:System.Web.UI.WebControls.TableStyle.HorizontalAlign" /> property.</para> 22 <block subset="none" type="note"> 23 <para>This class is primarily used by control developers.</para> 24 </block> 25 </remarks> 26 <summary> 27 <attribution license="cc4" from="Microsoft" modified="false" /> 28 <para>Represents the style for the <see cref="T:System.Web.UI.WebControls.Table" /> control and some Web Parts.</para> 29 </summary> 30 </Docs> 31 <Members> 32 <Member MemberName=".ctor"> 33 <MemberSignature Language="C#" Value="public TableStyle ();" /> 34 <MemberType>Constructor</MemberType> 35 <ReturnValue /> 36 <Parameters /> 37 <Docs> 38 <remarks> 39 <attribution license="cc4" from="Microsoft" modified="false" /> 40 <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.TableStyle" /> class using default values.</para> 41 </remarks> 42 <summary> 43 <attribution license="cc4" from="Microsoft" modified="false" /> 44 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.TableStyle" /> class using default values.</para> 45 </summary> 46 </Docs> 47 <AssemblyInfo> 48 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 49 <AssemblyVersion>2.0.0.0</AssemblyVersion> 50 </AssemblyInfo> 51 </Member> 52 <Member MemberName=".ctor"> 53 <MemberSignature Language="C#" Value="public TableStyle (System.Web.UI.StateBag bag);" /> 54 <MemberType>Constructor</MemberType> 55 <ReturnValue /> 56 <Parameters> 57 <Parameter Name="bag" Type="System.Web.UI.StateBag" /> 58 </Parameters> 59 <Docs> 60 <remarks> 61 <attribution license="cc4" from="Microsoft" modified="false" /> 62 <para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.TableStyle" /> class using the specified <see cref="T:System.Web.UI.StateBag" />.</para> 63 </remarks> 64 <summary> 65 <attribution license="cc4" from="Microsoft" modified="false" /> 66 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.TableStyle" /> class with the specified state bag information.</para> 67 </summary> 68 <param name="bag"> 69 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.StateBag" /> that represents the state bag in which to store style information. </param> 70 </Docs> 71 <AssemblyInfo> 72 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 73 <AssemblyVersion>2.0.0.0</AssemblyVersion> 74 </AssemblyInfo> 75 </Member> 76 <Member MemberName="AddAttributesToRender"> 77 <MemberSignature Language="C#" Value="public override void AddAttributesToRender (System.Web.UI.HtmlTextWriter writer, System.Web.UI.WebControls.WebControl owner);" /> 78 <MemberType>Method</MemberType> 79 <ReturnValue> 80 <ReturnType>System.Void</ReturnType> 81 </ReturnValue> 82 <Parameters> 83 <Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" /> 84 <Parameter Name="owner" Type="System.Web.UI.WebControls.WebControl" /> 85 </Parameters> 86 <Docs> 87 <remarks> 88 <attribution license="cc4" from="Microsoft" modified="false" /> 89 <para>This method is primarily used by control developers.</para> 90 </remarks> 91 <summary> 92 <attribution license="cc4" from="Microsoft" modified="false" /> 93 <para>Adds information about the background image, cell spacing, cell padding, gridlines, and alignment to the list of attributes to render.</para> 94 </summary> 95 <param name="writer"> 96 <attribution license="cc4" from="Microsoft" modified="false" />The output stream that renders HTML content to the client. </param> 97 <param name="owner"> 98 <attribution license="cc4" from="Microsoft" modified="false" />The control associated with the style. </param> 99 </Docs> 100 <AssemblyInfo> 101 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 102 <AssemblyVersion>2.0.0.0</AssemblyVersion> 103 </AssemblyInfo> 104 </Member> 105 <Member MemberName="BackImageUrl"> 106 <MemberSignature Language="C#" Value="public virtual string BackImageUrl { set; get; }" /> 107 <MemberType>Property</MemberType> 108 <ReturnValue> 109 <ReturnType>System.String</ReturnType> 110 </ReturnValue> 111 <Parameters /> 112 <Docs> 113 <value>To be added: an object of type 'string'</value> 114 <remarks> 115 <attribution license="cc4" from="Microsoft" modified="false" /> 116 <para>Use the <see cref="P:System.Web.UI.WebControls.TableStyle.BackImageUrl" /> property to specify the URL of an image to display in the background of the table control.</para> 117 <block subset="none" type="note"> 118 <para>The image will be tiled if it is smaller than the table. Similarly, the image is cropped if it is larger than the table.</para> 119 </block> 120 <para>The value of this property is stored in view state.</para> 121 </remarks> 122 <summary> 123 <attribution license="cc4" from="Microsoft" modified="false" /> 124 <para>Gets or sets the URL of an image to display in the background of a table control.</para> 125 </summary> 126 </Docs> 127 <AssemblyInfo> 128 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 129 <AssemblyVersion>2.0.0.0</AssemblyVersion> 130 </AssemblyInfo> 131 <Attributes> 132 <Attribute> 133 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 134 </Attribute> 135 <Attribute> 136 <AttributeName>System.Web.UI.UrlProperty</AttributeName> 137 </Attribute> 138 <Attribute> 139 <AttributeName>System.ComponentModel.NotifyParentProperty(true)</AttributeName> 140 </Attribute> 141 </Attributes> 142 </Member> 143 <Member MemberName="CellPadding"> 144 <MemberSignature Language="C#" Value="public virtual int CellPadding { set; get; }" /> 145 <MemberType>Property</MemberType> 146 <ReturnValue> 147 <ReturnType>System.Int32</ReturnType> 148 </ReturnValue> 149 <Parameters /> 150 <Docs> 151 <value>To be added: an object of type 'int'</value> 152 <remarks> 153 <attribution license="cc4" from="Microsoft" modified="false" /> 154 <para>Use the <see cref="P:System.Web.UI.WebControls.TableStyle.CellPadding" /> property to control the spacing between the contents of a cell and the cell's border. The padding amount specified is added to all four sides of a cell.</para> 155 <para>All cells in the same column of a data listing control share the same cell width. Therefore, if the content of one cell is longer than the content of other cells in the same column, the padding amount is applied to the widest cell. All other cells in the column are also set with this cell width.</para> 156 <para>Similarly, all cells in the same row share the same height. The padding amount is applied to the height of the tallest cell in the row. All other cells in the same row are set with this cell height. Individual cell sizes cannot be specified.</para> 157 <para>The value of this property is stored in view state.</para> 158 </remarks> 159 <summary> 160 <attribution license="cc4" from="Microsoft" modified="false" /> 161 <para>Gets or sets the amount of space between the contents of the cell and the cell's border.</para> 162 </summary> 163 </Docs> 164 <AssemblyInfo> 165 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 166 <AssemblyVersion>2.0.0.0</AssemblyVersion> 167 </AssemblyInfo> 168 <Attributes> 169 <Attribute> 170 <AttributeName>System.ComponentModel.DefaultValue(-1)</AttributeName> 171 </Attribute> 172 <Attribute> 173 <AttributeName>System.ComponentModel.NotifyParentProperty(true)</AttributeName> 174 </Attribute> 175 </Attributes> 176 </Member> 177 <Member MemberName="CellSpacing"> 178 <MemberSignature Language="C#" Value="public virtual int CellSpacing { set; get; }" /> 179 <MemberType>Property</MemberType> 180 <ReturnValue> 181 <ReturnType>System.Int32</ReturnType> 182 </ReturnValue> 183 <Parameters /> 184 <Docs> 185 <value>To be added: an object of type 'int'</value> 186 <remarks> 187 <attribution license="cc4" from="Microsoft" modified="false" /> 188 <para>Use the <see cref="P:System.Web.UI.WebControls.TableStyle.CellSpacing" /> property to control the spacing between adjacent cells in a data listing control. This spacing is applied both vertically and horizontally. The cell spacing is uniform for the entire data list control. Individual cell spacing between each row or column cannot be specified.</para> 189 <block subset="none" type="note"> 190 <para>If you set this property to a value greater than 0 and set the <see cref="P:System.Web.UI.WebControls.TableStyle.GridLines" /> property to a value that displays the cell borders, a gap is displayed between the borders of adjacent cells. In this situation, the <see cref="P:System.Web.UI.WebControls.TableStyle.CellSpacing" /> property controls the size of the gap.</para> 191 </block> 192 <para>The value of this property is stored in view state.</para> 193 </remarks> 194 <summary> 195 <attribution license="cc4" from="Microsoft" modified="false" /> 196 <para>Gets or sets the distance between table cells.</para> 197 </summary> 198 </Docs> 199 <AssemblyInfo> 200 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 201 <AssemblyVersion>2.0.0.0</AssemblyVersion> 202 </AssemblyInfo> 203 <Attributes> 204 <Attribute> 205 <AttributeName>System.ComponentModel.DefaultValue(-1)</AttributeName> 206 </Attribute> 207 <Attribute> 208 <AttributeName>System.ComponentModel.NotifyParentProperty(true)</AttributeName> 209 </Attribute> 210 </Attributes> 211 </Member> 212 <Member MemberName="CopyFrom"> 213 <MemberSignature Language="C#" Value="public override void CopyFrom (System.Web.UI.WebControls.Style s);" /> 214 <MemberType>Method</MemberType> 215 <ReturnValue> 216 <ReturnType>System.Void</ReturnType> 217 </ReturnValue> 218 <Parameters> 219 <Parameter Name="s" Type="System.Web.UI.WebControls.Style" /> 220 </Parameters> 221 <Docs> 222 <remarks>To be added</remarks> 223 <summary> 224 <attribution license="cc4" from="Microsoft" modified="false" /> 225 <para>Copies non-blank elements from the specified style, overwriting existing style elements if necessary.</para> 226 </summary> 227 <param name="s"> 228 <attribution license="cc4" from="Microsoft" modified="false" />The style to copy. </param> 229 </Docs> 230 <AssemblyInfo> 231 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 232 <AssemblyVersion>2.0.0.0</AssemblyVersion> 233 </AssemblyInfo> 234 </Member> 235 <Member MemberName="FillStyleAttributes"> 236 <MemberSignature Language="C#" Value="protected override void FillStyleAttributes (System.Web.UI.CssStyleCollection attributes, System.Web.UI.IUrlResolutionService urlResolver);" /> 237 <MemberType>Method</MemberType> 238 <AssemblyInfo> 239 <AssemblyVersion>2.0.0.0</AssemblyVersion> 240 </AssemblyInfo> 241 <ReturnValue> 242 <ReturnType>System.Void</ReturnType> 243 </ReturnValue> 244 <Parameters> 245 <Parameter Name="attributes" Type="System.Web.UI.CssStyleCollection" /> 246 <Parameter Name="urlResolver" Type="System.Web.UI.IUrlResolutionService" /> 247 </Parameters> 248 <Docs> 249 <remarks> 250 <attribution license="cc4" from="Microsoft" modified="false" /> 251 <para>Use the <see cref="M:System.Web.UI.WebControls.TableStyle.FillStyleAttributes(System.Web.UI.CssStyleCollection,System.Web.UI.IUrlResolutionService)" /> method to add the style properties of the <see cref="T:System.Web.UI.WebControls.TableStyle" /> object to the specified <see cref="T:System.Web.UI.CssStyleCollection" /> collection.</para> 252 </remarks> 253 <summary> 254 <attribution license="cc4" from="Microsoft" modified="false" /> 255 <para>Adds the style properties of the <see cref="T:System.Web.UI.WebControls.TableStyle" /> object to the specified <see cref="T:System.Web.UI.CssStyleCollection" /> collection.</para> 256 </summary> 257 <param name="attributes"> 258 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.CssStyleCollection" /> to which to add the style properties. </param> 259 <param name="urlResolver"> 260 <attribution license="cc4" from="Microsoft" modified="false" />An object implemented by the <see cref="T:System.Web.UI.IUrlResolutionService" /> that contains the context information for the current location (URL). </param> 261 </Docs> 262 </Member> 263 <Member MemberName="GridLines"> 264 <MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.GridLines GridLines { set; get; }" /> 265 <MemberType>Property</MemberType> 266 <ReturnValue> 267 <ReturnType>System.Web.UI.WebControls.GridLines</ReturnType> 268 </ReturnValue> 269 <Parameters /> 270 <Docs> 271 <value>To be added: an object of type 'GridLines'</value> 272 <remarks> 273 <attribution license="cc4" from="Microsoft" modified="false" /> 274 <para>Use the <see cref="P:System.Web.UI.WebControls.TableStyle.GridLines" /> property to specify whether the border between the cells of the data list control is displayed. This property is set with one of the <see cref="T:System.Web.UI.WebControls.GridLines" /> enumeration values. The following table lists the possible values.</para> 275 <list type="table"> 276 <listheader> 277 <item> 278 <term> 279 <para>Value </para> 280 </term> 281 <description> 282 <para>Description </para> 283 </description> 284 </item> 285 </listheader> 286 <item> 287 <term> 288 <para> 289 <see cref="F:System.Web.UI.WebControls.GridLines.None" /> </para> 290 </term> 291 <description> 292 <para>No cell border is displayed. </para> 293 </description> 294 </item> 295 <item> 296 <term> 297 <para> 298 <see cref="F:System.Web.UI.WebControls.GridLines.Horizontal" /> </para> 299 </term> 300 <description> 301 <para>Only the upper and lower borders of the cells in the data list control are displayed. </para> 302 </description> 303 </item> 304 <item> 305 <term> 306 <para> 307 <see cref="F:System.Web.UI.WebControls.GridLines.Vertical" /> </para> 308 </term> 309 <description> 310 <para>Only the left and right borders of the cells in the data list control are displayed. </para> 311 </description> 312 </item> 313 <item> 314 <term> 315 <para> 316 <see cref="F:System.Web.UI.WebControls.GridLines.Both" /> </para> 317 </term> 318 <description> 319 <para>All borders of the cells in the data list control are displayed. </para> 320 </description> 321 </item> 322 </list> 323 <para>The value of this property is stored in view state.</para> 324 </remarks> 325 <summary> 326 <attribution license="cc4" from="Microsoft" modified="false" /> 327 <para>Gets or sets a value that specifies whether the border between the cells of the table control is displayed.</para> 328 </summary> 329 </Docs> 330 <AssemblyInfo> 331 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 332 <AssemblyVersion>2.0.0.0</AssemblyVersion> 333 </AssemblyInfo> 334 <Attributes> 335 <Attribute> 336 <AttributeName>System.ComponentModel.DefaultValue(System.Web.UI.WebControls.GridLines.None)</AttributeName> 337 </Attribute> 338 <Attribute> 339 <AttributeName>System.ComponentModel.NotifyParentProperty(true)</AttributeName> 340 </Attribute> 341 </Attributes> 342 </Member> 343 <Member MemberName="HorizontalAlign"> 344 <MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.HorizontalAlign HorizontalAlign { set; get; }" /> 345 <MemberType>Property</MemberType> 346 <ReturnValue> 347 <ReturnType>System.Web.UI.WebControls.HorizontalAlign</ReturnType> 348 </ReturnValue> 349 <Parameters /> 350 <Docs> 351 <value>To be added: an object of type 'HorizontalAlign'</value> 352 <remarks> 353 <attribution license="cc4" from="Microsoft" modified="false" /> 354 <para>Use the <see cref="P:System.Web.UI.WebControls.TableStyle.HorizontalAlign" /> property to specify the horizontal alignment of the data list control within its container. This property is set with one of the <see cref="T:System.Web.UI.WebControls.HorizontalAlign" /> enumeration values. The following table lists the possible values.</para> 355 <list type="table"> 356 <listheader> 357 <item> 358 <term> 359 <para>Value </para> 360 </term> 361 <description> 362 <para>Description </para> 363 </description> 364 </item> 365 </listheader> 366 <item> 367 <term> 368 <para> 369 <see cref="F:System.Web.UI.WebControls.HorizontalAlign.NotSet" /> </para> 370 </term> 371 <description> 372 <para>The horizontal alignment is not set. </para> 373 </description> 374 </item> 375 <item> 376 <term> 377 <para> 378 <see cref="F:System.Web.UI.WebControls.HorizontalAlign.Left" /> </para> 379 </term> 380 <description> 381 <para>The table is left justified within its container. </para> 382 </description> 383 </item> 384 <item> 385 <term> 386 <para> 387 <see cref="F:System.Web.UI.WebControls.HorizontalAlign.Center" /> </para> 388 </term> 389 <description> 390 <para>The table is centered within its container. </para> 391 </description> 392 </item> 393 <item> 394 <term> 395 <para> 396 <see cref="F:System.Web.UI.WebControls.HorizontalAlign.Right" /> </para> 397 </term> 398 <description> 399 <para>The table is right justified within its container. </para> 400 </description> 401 </item> 402 </list> 403 <para>The value of this property is stored in view state.</para> 404 </remarks> 405 <summary> 406 <attribution license="cc4" from="Microsoft" modified="false" /> 407 <para>Gets or sets the horizontal alignment of the table within its container.</para> 408 </summary> 409 </Docs> 410 <AssemblyInfo> 411 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 412 <AssemblyVersion>2.0.0.0</AssemblyVersion> 413 </AssemblyInfo> 414 <Attributes> 415 <Attribute> 416 <AttributeName>System.ComponentModel.DefaultValue(System.Web.UI.WebControls.HorizontalAlign.NotSet)</AttributeName> 417 </Attribute> 418 <Attribute> 419 <AttributeName>System.ComponentModel.NotifyParentProperty(true)</AttributeName> 420 </Attribute> 421 </Attributes> 422 </Member> 423 <Member MemberName="MergeWith"> 424 <MemberSignature Language="C#" Value="public override void MergeWith (System.Web.UI.WebControls.Style s);" /> 425 <MemberType>Method</MemberType> 426 <ReturnValue> 427 <ReturnType>System.Void</ReturnType> 428 </ReturnValue> 429 <Parameters> 430 <Parameter Name="s" Type="System.Web.UI.WebControls.Style" /> 431 </Parameters> 432 <Docs> 433 <remarks>To be added</remarks> 434 <summary> 435 <attribution license="cc4" from="Microsoft" modified="false" /> 436 <para>Copies non-blank elements from the specified style, but will not overwrite any existing style elements.</para> 437 </summary> 438 <param name="s"> 439 <attribution license="cc4" from="Microsoft" modified="false" />The style to copy. </param> 440 </Docs> 441 <AssemblyInfo> 442 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 443 <AssemblyVersion>2.0.0.0</AssemblyVersion> 444 </AssemblyInfo> 445 </Member> 446 <Member MemberName="Reset"> 447 <MemberSignature Language="C#" Value="public override void Reset ();" /> 448 <MemberType>Method</MemberType> 449 <ReturnValue> 450 <ReturnType>System.Void</ReturnType> 451 </ReturnValue> 452 <Parameters /> 453 <Docs> 454 <remarks> 455 <attribution license="cc4" from="Microsoft" modified="false" /> 456 <para>Clears any defined style elements, and leaves the style in the default state.</para> 457 </remarks> 458 <summary> 459 <attribution license="cc4" from="Microsoft" modified="false" /> 460 <para>Clears any defined style elements of the style.</para> 461 </summary> 462 </Docs> 463 <AssemblyInfo> 464 <AssemblyVersion>1.0.5000.0</AssemblyVersion> 465 <AssemblyVersion>2.0.0.0</AssemblyVersion> 466 </AssemblyInfo> 467 </Member> 468 </Members> 469</Type>