Jo Shields a575963da9 Imported Upstream version 3.6.0
Former-commit-id: da6be194a6b1221998fc28233f2503bd61dd9d14
2014-08-13 10:39:27 +01:00

331 lines
16 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<Type Name="BoundColumn" FullName="System.Web.UI.WebControls.BoundColumn">
<TypeSignature Language="C#" Maintainer="auto" Value="public class BoundColumn : System.Web.UI.WebControls.DataGridColumn" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the &lt;link location="node:gtk-sharp/programming/threads"&gt;Gtk# Thread Programming&lt;/link&gt; for details.</ThreadSafetyStatement>
<Base>
<BaseTypeName>System.Web.UI.WebControls.DataGridColumn</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> column type in a <see cref="T:System.Web.UI.WebControls.DataGrid" /> control to display the contents of a field in the data source. The values are listed in a single column. The field is linked to the <see cref="T:System.Web.UI.WebControls.BoundColumn" />, so any updates in the data source will reflect in the corresponding cells of the <see cref="T:System.Web.UI.WebControls.DataGrid" /> control.</para>
<block subset="none" type="note">
<para>This column type is the default for the <see cref="T:System.Web.UI.WebControls.DataGrid" /> control.</para>
</block>
<para>To control appearance of this column, use the style properties of the <see cref="T:System.Web.UI.WebControls.DataGrid" /> control.</para>
<block subset="none" type="note">
<para>Text is not HTML encoded before it is displayed in the <see cref="T:System.Web.UI.WebControls.BoundColumn" />. This makes it possible to embed script within HTML tags in the text. If the values for this column come from user input, be sure to validate the values to reduce security vulnerabilities.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A column type for the <see cref="T:System.Web.UI.WebControls.DataGrid" /> control that is bound to a field in a data source. </para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public BoundColumn ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use this constructor to create and initialize a new instance of the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> class.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DataField">
<MemberSignature Language="C#" Value="public virtual string DataField { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Web.UI.WebControls.BoundColumn.DataField" /> property to specify the field to bind to the <see cref="T:System.Web.UI.WebControls.BoundColumn" />.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the field name from the data source to bind to the <see cref="T:System.Web.UI.WebControls.BoundColumn" />.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="DataFormatString">
<MemberSignature Language="C#" Value="public virtual string DataFormatString { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'string'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Web.UI.WebControls.BoundColumn.DataFormatString" /> property to provide a custom format for the items in the column.</para>
<para>The data format string consists of two parts, separated by a colon, in the form { <paramref name="A" /> : <paramref name="Bxx" /> }. For example, the formatting string {0:F2} displays a fixed-point number with two decimal places.</para>
<block subset="none" type="note">
<para>The entire string must be enclosed in braces to indicate that it is a format string and not a literal string. Any text outside the braces is displayed as literal text.</para>
</block>
<para>The value before the colon (<paramref name="A" /> in the general example) specifies the parameter index in a zero-based list of parameters.</para>
<block subset="none" type="note">
<para>This value can only be set to 0 because there is only one value in each cell.</para>
</block>
<para>The character after the colon (<paramref name="B" /> in the general example) specifies the format to display the value in. The following table lists the common formats.</para>
<list type="table">
<listheader>
<item>
<term>
<para>Format character </para>
</term>
<description>
<para>Description </para>
</description>
</item>
</listheader>
<item>
<term>
<para>C </para>
</term>
<description>
<para>Displays numeric values in currency format. </para>
</description>
</item>
<item>
<term>
<para>D </para>
</term>
<description>
<para>Displays numeric values in decimal format. </para>
</description>
</item>
<item>
<term>
<para>E </para>
</term>
<description>
<para>Displays numeric values in scientific (exponential) format. </para>
</description>
</item>
<item>
<term>
<para>F </para>
</term>
<description>
<para>Displays numeric values in fixed format. </para>
</description>
</item>
<item>
<term>
<para>G </para>
</term>
<description>
<para>Displays numeric values in general format. </para>
</description>
</item>
<item>
<term>
<para>N </para>
</term>
<description>
<para>Displays numeric values in number format. </para>
</description>
</item>
<item>
<term>
<para>X </para>
</term>
<description>
<para>Displays numeric values in hexadecimal format. </para>
</description>
</item>
</list>
<block subset="none" type="note">
<para>The format character is not case-sensitive, except for X, which displays the hexadecimal characters in the case specified.</para>
</block>
<para>The value after the format character (<paramref name="xx" /> in the general example) specifies the number of significant digits or decimal places to display.</para>
<para>For more information on formatting strings, see <format type="text/html"><a href="0D1364DA-5B30-4D42-8E6B-03378343343F">[&lt;topic://cpconformattingoverview&gt;]</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the string that specifies the display format for items in the column.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="FormatDataValue">
<MemberSignature Language="C#" Value="protected virtual string FormatDataValue (object dataValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataValue" Type="System.Object" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Web.UI.WebControls.BoundColumn.FormatDataValue(System.Object)" /> method to convert the specified value to the format indicated by the <see cref="P:System.Web.UI.WebControls.BoundColumn.DataFormatString" /> property.</para>
<block subset="none" type="note">
<para>This method returns the string equivalent of the value if the <see cref="P:System.Web.UI.WebControls.BoundColumn.DataFormatString" /> property is not set.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Converts the specified value to the format indicated by the <see cref="P:System.Web.UI.WebControls.BoundColumn.DataFormatString" /> property.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The specified value converted to the format indicated by the <see cref="P:System.Web.UI.WebControls.BoundColumn.DataFormatString" /> property.</para>
</returns>
<param name="dataValue">
<attribution license="cc4" from="Microsoft" modified="false" />The value to format. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public override void Initialize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="M:System.Web.UI.WebControls.BoundColumn.Initialize" /> method to reset the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> to its initial state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Resets the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> to its initial state.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeCell">
<MemberSignature Language="C#" Value="public override void InitializeCell (System.Web.UI.WebControls.TableCell cell, int columnIndex, System.Web.UI.WebControls.ListItemType itemType);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="System.Web.UI.WebControls.TableCell" />
<Parameter Name="columnIndex" Type="System.Int32" />
<Parameter Name="itemType" Type="System.Web.UI.WebControls.ListItemType" />
</Parameters>
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The <see cref="M:System.Web.UI.WebControls.BoundColumn.InitializeCell(System.Web.UI.WebControls.TableCell,System.Int32,System.Web.UI.WebControls.ListItemType)" /> method resets the specified cell in the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> to its initial state.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Resets the specified cell in the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> to its initial state.</para>
</summary>
<param name="cell">
<attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.TableCell" /> object that represents the cell to reset. </param>
<param name="columnIndex">
<attribution license="cc4" from="Microsoft" modified="false" />The column number where the cell is located. </param>
<param name="itemType">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.UI.WebControls.ListItemType" /> values. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ReadOnly">
<MemberSignature Language="C#" Value="public virtual bool ReadOnly { set; get; }" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<value>To be added: an object of type 'bool'</value>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="P:System.Web.UI.WebControls.BoundColumn.ReadOnly" /> property to specify whether the items in the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> can be edited. This property can also be used to programmatically determine whether the column is read-only.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets a value that indicates whether the items in the <see cref="T:System.Web.UI.WebControls.BoundColumn" /> can be edited.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(false)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="thisExpr">
<MemberSignature Language="C#" Value="public static readonly string thisExpr;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Use the <see cref="F:System.Web.UI.WebControls.BoundColumn.thisExpr" /> field to represent the "!" string.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents the string "!". This field is read-only.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>