1<?xml version="1.0" encoding="utf-8"?> 2<Type Name="HyperLinkField" FullName="System.Web.UI.WebControls.HyperLinkField"> 3 <TypeSignature Language="C#" Value="public class HyperLinkField : System.Web.UI.WebControls.DataControlField" /> 4 <AssemblyInfo> 5 <AssemblyName>System.Web</AssemblyName> 6 <AssemblyVersion>2.0.0.0</AssemblyVersion> 7 </AssemblyInfo> 8 <Base> 9 <BaseTypeName>System.Web.UI.WebControls.DataControlField</BaseTypeName> 10 </Base> 11 <Interfaces /> 12 <Docs> 13 <since version=".NET 2.0" /> 14 <remarks> 15 <attribution license="cc4" from="Microsoft" modified="false" /> 16 <para>The <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class is used by data-bound controls (such as <see cref="T:System.Web.UI.WebControls.GridView" /> and <see cref="T:System.Web.UI.WebControls.DetailsView" />) to display a hyperlink for each record displayed. When the user clicks a hyperlink, he or she is directed to the Web page associated with the hyperlink. The <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object is displayed differently depending on the data-bound control in which it is used. For example, the <see cref="T:System.Web.UI.WebControls.GridView" /> control displays a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object as a column, while the <see cref="T:System.Web.UI.WebControls.DetailsView" /> control displays it as a row.</para> 17 <para>To specify the caption to display for the hyperlinks, use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Text" /> property. Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.NavigateUrl" /> property to specify the URL to navigate to when a hyperlink is clicked. If you want to display the linked content in a specific window or frame, set the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Target" /> property.</para> 18 <block subset="none" type="note"> 19 <para>When the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Text" /> and <see cref="P:System.Web.UI.WebControls.HyperLinkField.NavigateUrl" /> properties are set, all hyperlinks in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object share the same caption and navigation URL. Likewise, the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Target" /> property also applies to all hyperlinks.</para> 20 </block> 21 <para>Alternatively, you can bind the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to fields in a data source. This allows you to display a different caption for each hyperlink in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object and to have each hyperlink navigate to a different location. To bind a field to a caption, set the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property. To create a URL for navigation, set the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property to a comma-separated list of fields to use to create the URL. </para> 22 <para>You can specify a custom format for the captions and navigation URLs by setting the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextFormatString" /> and <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> properties, respectively.</para> 23 <para>You can hide a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object in a data-bound control by setting the <see cref="P:System.Web.UI.WebControls.DataControlField.Visible" /> property to false.</para> 24 <para>You can customize the header and footer sections of a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. To display a caption in the header or footer sections, set the <see cref="P:System.Web.UI.WebControls.DataControlField.HeaderText" /> or <see cref="P:System.Web.UI.WebControls.DataControlField.FooterText" /> properties, respectively. To display an image in the header section instead of text, set the <see cref="P:System.Web.UI.WebControls.DataControlField.HeaderImageUrl" /> property. The header section can be hidden in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object by setting the <see cref="P:System.Web.UI.WebControls.DataControlField.ShowHeader" /> property to false.</para> 25 <block subset="none" type="note"> 26 <para>Some data-bound controls (such as the <see cref="T:System.Web.UI.WebControls.GridView" /> control) can show or hide only the entire header section of the control. These data-bound controls do not support the <see cref="P:System.Web.UI.WebControls.DataControlField.ShowHeader" /> property for an individual bound field. To show or hide the entire header section of a data-bound control, use the control's ShowHeader property (if available).</para> 27 </block> 28 <para>You also can customize the appearance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object (font color, background color, and so on) by setting the style properties for the different parts of the field. The following table lists the different style properties.</para> 29 <list type="table"> 30 <listheader> 31 <item> 32 <term> 33 <para>Style property </para> 34 </term> 35 <description> 36 <para>Description </para> 37 </description> 38 </item> 39 </listheader> 40 <item> 41 <term> 42 <para> 43 <see cref="P:System.Web.UI.WebControls.DataControlField.ControlStyle" /> </para> 44 </term> 45 <description> 46 <para>The style settings for the child Web server controls of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para> 47 </description> 48 </item> 49 <item> 50 <term> 51 <para> 52 <see cref="P:System.Web.UI.WebControls.DataControlField.FooterStyle" /> </para> 53 </term> 54 <description> 55 <para>The style settings for the footer section of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para> 56 </description> 57 </item> 58 <item> 59 <term> 60 <para> 61 <see cref="P:System.Web.UI.WebControls.DataControlField.HeaderStyle" /> </para> 62 </term> 63 <description> 64 <para>The style settings for the header section of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para> 65 </description> 66 </item> 67 <item> 68 <term> 69 <para> 70 <see cref="P:System.Web.UI.WebControls.DataControlField.ItemStyle" /> </para> 71 </term> 72 <description> 73 <para>The style settings for the data items in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para> 74 </description> 75 </item> 76 </list> 77 </remarks> 78 <summary> 79 <attribution license="cc4" from="Microsoft" modified="false" /> 80 <para>Represents a field that is displayed as a hyperlink in a data-bound control.</para> 81 </summary> 82 </Docs> 83 <Members> 84 <Member MemberName=".ctor"> 85 <MemberSignature Language="C#" Value="public HyperLinkField ();" /> 86 <MemberType>Constructor</MemberType> 87 <Parameters /> 88 <Docs> 89 <since version=".NET 2.0" /> 90 <remarks> 91 <attribution license="cc4" from="Microsoft" modified="false" /> 92 <para>Use this constructor to initialize a new instance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class. This constructor is commonly used when adding fields to a dynamically created data-bound control.</para> 93 <para>To dynamically add a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to a data-bound control, create a new <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object, set its properties, and then add it to the data-bound control's field collection. For example, if you are using the <see cref="T:System.Web.UI.WebControls.GridView" /> control, add the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to the <see cref="P:System.Web.UI.WebControls.GridView.Columns" /> collection.</para> 94 <block subset="none" type="note"> 95 <para>Although you can dynamically add fields to a data-bound control, it is strongly recommended that fields be statically declared and then shown or hidden, as appropriate. Statically declaring all your fields reduces the size of the view state for the parent data-bound control.</para> 96 </block> 97 </remarks> 98 <summary> 99 <attribution license="cc4" from="Microsoft" modified="false" /> 100 <para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class.</para> 101 </summary> 102 </Docs> 103 <AssemblyInfo> 104 <AssemblyVersion>2.0.0.0</AssemblyVersion> 105 </AssemblyInfo> 106 </Member> 107 <Member MemberName="CopyProperties"> 108 <MemberSignature Language="C#" Value="protected override void CopyProperties (System.Web.UI.WebControls.DataControlField newField);" /> 109 <MemberType>Method</MemberType> 110 <ReturnValue> 111 <ReturnType>System.Void</ReturnType> 112 </ReturnValue> 113 <Parameters> 114 <Parameter Name="newField" Type="System.Web.UI.WebControls.DataControlField" /> 115 </Parameters> 116 <Docs> 117 <since version=".NET 2.0" /> 118 <remarks> 119 <attribution license="cc4" from="Microsoft" modified="false" /> 120 <para>The <see cref="M:System.Web.UI.WebControls.HyperLinkField.CopyProperties(System.Web.UI.WebControls.DataControlField)" /> method is called by the <see cref="M:System.Web.UI.WebControls.DataControlField.CloneField" /> method to copy the properties of the current <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to another.</para> 121 </remarks> 122 <summary> 123 <attribution license="cc4" from="Microsoft" modified="false" /> 124 <para>Copies the properties of the current <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to the specified object.</para> 125 </summary> 126 <param name="newField"> 127 <attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.DataControlField" />-derived object that receives the copy.</param> 128 </Docs> 129 <AssemblyInfo> 130 <AssemblyVersion>2.0.0.0</AssemblyVersion> 131 </AssemblyInfo> 132 </Member> 133 <Member MemberName="CreateField"> 134 <MemberSignature Language="C#" Value="protected override System.Web.UI.WebControls.DataControlField CreateField ();" /> 135 <MemberType>Method</MemberType> 136 <ReturnValue> 137 <ReturnType>System.Web.UI.WebControls.DataControlField</ReturnType> 138 </ReturnValue> 139 <Parameters /> 140 <Docs> 141 <since version=".NET 2.0" /> 142 <remarks> 143 <attribution license="cc4" from="Microsoft" modified="false" /> 144 <para>The <see cref="M:System.Web.UI.WebControls.HyperLinkField.CreateField" /> method is called by the <see cref="M:System.Web.UI.WebControls.DataControlField.CloneField" /> method to create a new instance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class. </para> 145 </remarks> 146 <summary> 147 <attribution license="cc4" from="Microsoft" modified="false" /> 148 <para>Returns a new instance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class.</para> 149 </summary> 150 <returns> 151 <attribution license="cc4" from="Microsoft" modified="false" /> 152 <para>A new instance of <see cref="T:System.Web.UI.WebControls.HyperLinkField" />.</para> 153 </returns> 154 </Docs> 155 <AssemblyInfo> 156 <AssemblyVersion>2.0.0.0</AssemblyVersion> 157 </AssemblyInfo> 158 </Member> 159 <Member MemberName="DataNavigateUrlFields"> 160 <MemberSignature Language="C#" Value="public virtual string[] DataNavigateUrlFields { set; get; }" /> 161 <MemberType>Property</MemberType> 162 <Attributes> 163 <Attribute> 164 <AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName> 165 </Attribute> 166 <Attribute> 167 <AttributeName>System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.StringArrayConverter))</AttributeName> 168 </Attribute> 169 <Attribute> 170 <AttributeName>System.ComponentModel.Editor("System.Web.UI.Design.WebControls.DataFieldEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName> 171 </Attribute> 172 </Attributes> 173 <ReturnValue> 174 <ReturnType>System.String[]</ReturnType> 175 </ReturnValue> 176 <Docs> 177 <value>To be added.</value> 178 <since version=".NET 2.0" /> 179 <remarks> 180 <attribution license="cc4" from="Microsoft" modified="false" /> 181 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property when the data source contains multiple fields that must be combined to create the hyperlinks for the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. The fields specified in the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property are combined with the format string in the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> property to construct the hyperlinks in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para> 182 <block subset="none" type="note"> 183 <para>When you set the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property with declarative code in an .aspx file, use a comma-separated list of field names.</para> 184 </block> 185 <para>Instead of using this property to bind the URLs of the hyperlinks to a field, you can use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.NavigateUrl" /> property to set the hyperlinks' URL to a static value. With this option, each hyperlink shares the same URL.</para> 186 <block subset="none" type="note"> 187 <para>If the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> and the <see cref="P:System.Web.UI.WebControls.HyperLinkField.NavigateUrl" /> properties are both set, the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property takes precedence.</para> 188 </block> 189 </remarks> 190 <summary> 191 <attribution license="cc4" from="Microsoft" modified="false" /> 192 <para>Gets or sets the names of the fields from the data source used to construct the URLs for the hyperlinks in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para> 193 </summary> 194 </Docs> 195 <AssemblyInfo> 196 <AssemblyVersion>2.0.0.0</AssemblyVersion> 197 </AssemblyInfo> 198 </Member> 199 <Member MemberName="DataNavigateUrlFormatString"> 200 <MemberSignature Language="C#" Value="public virtual string DataNavigateUrlFormatString { set; get; }" /> 201 <MemberType>Property</MemberType> 202 <Attributes> 203 <Attribute> 204 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 205 </Attribute> 206 </Attributes> 207 <ReturnValue> 208 <ReturnType>System.String</ReturnType> 209 </ReturnValue> 210 <Docs> 211 <value>To be added.</value> 212 <since version=".NET 2.0" /> 213 <remarks> 214 <attribution license="cc4" from="Microsoft" modified="false" /> 215 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> property to specify a custom format for the URLs of the hyperlinks in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. If the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> property is not set, the hyperlinks' URLs do not get any special formatting.</para> 216 <block subset="none" type="note"> 217 <para>The format string is applied only when the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property is set.</para> 218 </block> 219 <para>The format string can be any literal string and usually includes a placeholder for the field's value. For example, in the format string "Item Value: {0}", the {0} placeholder is replaced with the field's value in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. The rest of the format string is displayed as literal text.</para> 220 <block subset="none" type="note"> 221 <para>If the format string does not include a placeholder, the field's value from the data source is not included in the final display text.</para> 222 </block> 223 <para>The placeholder consists of two parts, separated by a colon and wrapped in braces, in the form {<paramref name="A" />:<paramref name="Bxx" />}. The value before the colon (<paramref name="A" /> in the general example) specifies the field value's index in a zero-based list of parameters.</para> 224 <block subset="none" type="note"> 225 <para>This parameter is part of the formatting syntax. Because there is only one field value in each cell, this value can only be set to 0.</para> 226 </block> 227 <para>The colon and the values after the colon are optional. The character after the colon (<paramref name="B" /> in the general example) specifies the format in which to display the value. The following table lists the common formats.</para> 228 <list type="table"> 229 <listheader> 230 <item> 231 <term> 232 <para>Format character </para> 233 </term> 234 <description> 235 <para>Description </para> 236 </description> 237 </item> 238 </listheader> 239 <item> 240 <term> 241 <para>C </para> 242 </term> 243 <description> 244 <para>Displays numeric values in currency format. </para> 245 </description> 246 </item> 247 <item> 248 <term> 249 <para>D </para> 250 </term> 251 <description> 252 <para>Displays numeric values in decimal format. </para> 253 </description> 254 </item> 255 <item> 256 <term> 257 <para>E </para> 258 </term> 259 <description> 260 <para>Displays numeric values in scientific (exponential) format. </para> 261 </description> 262 </item> 263 <item> 264 <term> 265 <para>F </para> 266 </term> 267 <description> 268 <para>Displays numeric values in fixed format. </para> 269 </description> 270 </item> 271 <item> 272 <term> 273 <para>G </para> 274 </term> 275 <description> 276 <para>Displays numeric values in general format. </para> 277 </description> 278 </item> 279 <item> 280 <term> 281 <para>N </para> 282 </term> 283 <description> 284 <para>Displays numeric values in number format. </para> 285 </description> 286 </item> 287 <item> 288 <term> 289 <para>X </para> 290 </term> 291 <description> 292 <para>Displays numeric values in hexadecimal format. </para> 293 </description> 294 </item> 295 </list> 296 <block subset="none" type="note"> 297 <para>The format characters are not case-sensitive, except for X, which displays the hexadecimal characters in the case specified.</para> 298 </block> 299 <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. For example, the format string "{0:F2}" displays a fixed-point number with two decimal places.</para> 300 <para>For more information on formatting strings, see <format type="text/html"><a href="0D1364DA-5B30-4D42-8E6B-03378343343F">Formatting Overview</a></format>.</para> 301 </remarks> 302 <summary> 303 <attribution license="cc4" from="Microsoft" modified="false" /> 304 <para>Gets or sets the string that specifies the format in which the URLs for the hyperlinks in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object are rendered.</para> 305 </summary> 306 </Docs> 307 <AssemblyInfo> 308 <AssemblyVersion>2.0.0.0</AssemblyVersion> 309 </AssemblyInfo> 310 </Member> 311 <Member MemberName="DataTextField"> 312 <MemberSignature Language="C#" Value="public virtual string DataTextField { set; get; }" /> 313 <MemberType>Property</MemberType> 314 <Attributes> 315 <Attribute> 316 <AttributeName>System.ComponentModel.TypeConverter("System.Web.UI.Design.DataSourceViewSchemaConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName> 317 </Attribute> 318 <Attribute> 319 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 320 </Attribute> 321 </Attributes> 322 <ReturnValue> 323 <ReturnType>System.String</ReturnType> 324 </ReturnValue> 325 <Docs> 326 <value>To be added.</value> 327 <since version=".NET 2.0" /> 328 <remarks> 329 <attribution license="cc4" from="Microsoft" modified="false" /> 330 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property to specify the name of the field that contains the text to display for the hyperlink captions in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para> 331 <para>Instead of using this property to bind the hyperlink captions to a field, you can use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Text" /> property to set the hyperlink captions to a static value. With this option, each hyperlink shares the same caption.</para> 332 <block subset="none" type="note"> 333 <para>If the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> and <see cref="P:System.Web.UI.WebControls.HyperLinkField.Text" /> properties are both set, the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property takes precedence.</para> 334 </block> 335 </remarks> 336 <summary> 337 <attribution license="cc4" from="Microsoft" modified="false" /> 338 <para>Gets or sets the name of the field from the data source containing the text to display for the hyperlink captions in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para> 339 </summary> 340 </Docs> 341 <AssemblyInfo> 342 <AssemblyVersion>2.0.0.0</AssemblyVersion> 343 </AssemblyInfo> 344 </Member> 345 <Member MemberName="DataTextFormatString"> 346 <MemberSignature Language="C#" Value="public virtual string DataTextFormatString { set; get; }" /> 347 <MemberType>Property</MemberType> 348 <Attributes> 349 <Attribute> 350 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 351 </Attribute> 352 </Attributes> 353 <ReturnValue> 354 <ReturnType>System.String</ReturnType> 355 </ReturnValue> 356 <Docs> 357 <value>To be added.</value> 358 <since version=".NET 2.0" /> 359 <remarks> 360 <attribution license="cc4" from="Microsoft" modified="false" /> 361 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextFormatString" /> property to specify a custom display format for the captions displayed in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. If the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextFormatString" /> property is not set, the field's value is displayed without any special formatting.</para> 362 <block subset="none" type="note"> 363 <para>The format string is applied only when the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property is set.</para> 364 </block> 365 <para>The format string can be any literal string and usually includes a placeholder for the field's value. For example, in the format string "Item Value: {0}", the {0} placeholder is replaced with the field's value when it is displayed in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. The rest of the format string is displayed as literal text.</para> 366 <block subset="none" type="note"> 367 <para>If the format string does not include a placeholder, the field's value from the data source is not included in the final display text.</para> 368 </block> 369 <para>The placeholder consists of two parts, separated by a colon and wrapped in braces, in the form {<paramref name="A" />:<paramref name="Bxx" />}. The value before the colon (<paramref name="A" /> in the general example) specifies the field value's index in a zero-based list of parameters.</para> 370 <block subset="none" type="note"> 371 <para>This parameter is part of the formatting syntax. Because there is only one field value in each cell, this value can only be set to 0.</para> 372 </block> 373 <para>The colon and the values after the colon are optional. The character after the colon (<paramref name="B" /> in the general example) specifies the format in which to display the value. The following table lists the common formats.</para> 374 <list type="table"> 375 <listheader> 376 <item> 377 <term> 378 <para>Format character </para> 379 </term> 380 <description> 381 <para>Description </para> 382 </description> 383 </item> 384 </listheader> 385 <item> 386 <term> 387 <para>C </para> 388 </term> 389 <description> 390 <para>Displays numeric values in currency format. </para> 391 </description> 392 </item> 393 <item> 394 <term> 395 <para>D </para> 396 </term> 397 <description> 398 <para>Displays numeric values in decimal format. </para> 399 </description> 400 </item> 401 <item> 402 <term> 403 <para>E </para> 404 </term> 405 <description> 406 <para>Displays numeric values in scientific (exponential) format. </para> 407 </description> 408 </item> 409 <item> 410 <term> 411 <para>F </para> 412 </term> 413 <description> 414 <para>Displays numeric values in fixed format. </para> 415 </description> 416 </item> 417 <item> 418 <term> 419 <para>G </para> 420 </term> 421 <description> 422 <para>Displays numeric values in general format. </para> 423 </description> 424 </item> 425 <item> 426 <term> 427 <para>N </para> 428 </term> 429 <description> 430 <para>Displays numeric values in number format. </para> 431 </description> 432 </item> 433 <item> 434 <term> 435 <para>X </para> 436 </term> 437 <description> 438 <para>Displays numeric values in hexadecimal format. </para> 439 </description> 440 </item> 441 </list> 442 <block subset="none" type="note"> 443 <para>The format characters are not case-sensitive, except for X, which displays the hexadecimal characters in the case specified.</para> 444 </block> 445 <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. For example, the format string "{0:F2}" displays a fixed-point number with two decimal places.</para> 446 <para>For more information on formatting strings, see <format type="text/html"><a href="0D1364DA-5B30-4D42-8E6B-03378343343F">Formatting Overview</a></format>.</para> 447 </remarks> 448 <summary> 449 <attribution license="cc4" from="Microsoft" modified="false" /> 450 <para>Get or sets the string that specifies the format in which the hyperlink captions in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object are displayed.</para> 451 </summary> 452 </Docs> 453 <AssemblyInfo> 454 <AssemblyVersion>2.0.0.0</AssemblyVersion> 455 </AssemblyInfo> 456 </Member> 457 <Member MemberName="FormatDataNavigateUrlValue"> 458 <MemberSignature Language="C#" Value="protected virtual string FormatDataNavigateUrlValue (object[] dataUrlValues);" /> 459 <MemberType>Method</MemberType> 460 <ReturnValue> 461 <ReturnType>System.String</ReturnType> 462 </ReturnValue> 463 <Parameters> 464 <Parameter Name="dataUrlValues" Type="System.Object[]" /> 465 </Parameters> 466 <Docs> 467 <since version=".NET 2.0" /> 468 <remarks> 469 <attribution license="cc4" from="Microsoft" modified="false" /> 470 <para>The <see cref="M:System.Web.UI.WebControls.HyperLinkField.FormatDataNavigateUrlValue(System.Object[])" /> method is a helper method used to format the URL of a hyperlink in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object with the format string specified by the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> property.</para> 471 </remarks> 472 <summary> 473 <attribution license="cc4" from="Microsoft" modified="false" /> 474 <para>Formats the navigation URL using the format string specified by the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> property.</para> 475 </summary> 476 <returns> 477 <attribution license="cc4" from="Microsoft" modified="false" /> 478 <para>The formatted URL value.</para> 479 </returns> 480 <param name="dataUrlValues"> 481 <attribution license="cc4" from="Microsoft" modified="false" />An array of values to combine with the format string.</param> 482 </Docs> 483 <AssemblyInfo> 484 <AssemblyVersion>2.0.0.0</AssemblyVersion> 485 </AssemblyInfo> 486 </Member> 487 <Member MemberName="FormatDataTextValue"> 488 <MemberSignature Language="C#" Value="protected virtual string FormatDataTextValue (object dataTextValue);" /> 489 <MemberType>Method</MemberType> 490 <ReturnValue> 491 <ReturnType>System.String</ReturnType> 492 </ReturnValue> 493 <Parameters> 494 <Parameter Name="dataTextValue" Type="System.Object" /> 495 </Parameters> 496 <Docs> 497 <since version=".NET 2.0" /> 498 <remarks> 499 <attribution license="cc4" from="Microsoft" modified="false" /> 500 <para>The <see cref="M:System.Web.UI.WebControls.HyperLinkField.FormatDataTextValue(System.Object)" /> method is a helper method used to format the caption text of a hyperlink in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object with the format string specified by the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextFormatString" /> property.</para> 501 <block subset="none" type="note"> 502 <para>This method is used primarily by control developers.</para> 503 </block> 504 </remarks> 505 <summary> 506 <attribution license="cc4" from="Microsoft" modified="false" /> 507 <para>Formats the caption text using the format string specified by the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextFormatString" /> property.</para> 508 </summary> 509 <returns> 510 <attribution license="cc4" from="Microsoft" modified="false" /> 511 <para>The formatted text value.</para> 512 </returns> 513 <param name="dataTextValue"> 514 <attribution license="cc4" from="Microsoft" modified="false" />The text value to format. </param> 515 </Docs> 516 <AssemblyInfo> 517 <AssemblyVersion>2.0.0.0</AssemblyVersion> 518 </AssemblyInfo> 519 </Member> 520 <Member MemberName="Initialize"> 521 <MemberSignature Language="C#" Value="public override bool Initialize (bool sortingEnabled, System.Web.UI.Control control);" /> 522 <MemberType>Method</MemberType> 523 <ReturnValue> 524 <ReturnType>System.Boolean</ReturnType> 525 </ReturnValue> 526 <Parameters> 527 <Parameter Name="sortingEnabled" Type="System.Boolean" /> 528 <Parameter Name="control" Type="System.Web.UI.Control" /> 529 </Parameters> 530 <Docs> 531 <param name="sortingEnabled">To be added.</param> 532 <remarks>To be added.</remarks> 533 <since version=".NET 2.0" /> 534 <summary> 535 <attribution license="cc4" from="Microsoft" modified="false" /> 536 <para>Initializes the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para> 537 </summary> 538 <returns> 539 <attribution license="cc4" from="Microsoft" modified="false" /> 540 <para>Always returns false.</para> 541 </returns> 542 <param name="control"> 543 <attribution license="cc4" from="Microsoft" modified="false" />The data control that acts as the parent for the <see cref="T:System.Web.UI.WebControls.HyperLinkField" />.</param> 544 </Docs> 545 <AssemblyInfo> 546 <AssemblyVersion>2.0.0.0</AssemblyVersion> 547 </AssemblyInfo> 548 </Member> 549 <Member MemberName="InitializeCell"> 550 <MemberSignature Language="C#" Value="public override void InitializeCell (System.Web.UI.WebControls.DataControlFieldCell cell, System.Web.UI.WebControls.DataControlCellType cellType, System.Web.UI.WebControls.DataControlRowState rowState, int rowIndex);" /> 551 <MemberType>Method</MemberType> 552 <ReturnValue> 553 <ReturnType>System.Void</ReturnType> 554 </ReturnValue> 555 <Parameters> 556 <Parameter Name="cell" Type="System.Web.UI.WebControls.DataControlFieldCell" /> 557 <Parameter Name="cellType" Type="System.Web.UI.WebControls.DataControlCellType" /> 558 <Parameter Name="rowState" Type="System.Web.UI.WebControls.DataControlRowState" /> 559 <Parameter Name="rowIndex" Type="System.Int32" /> 560 </Parameters> 561 <Docs> 562 <since version=".NET 2.0" /> 563 <remarks> 564 <attribution license="cc4" from="Microsoft" modified="false" /> 565 <para>The <see cref="M:System.Web.UI.WebControls.HyperLinkField.InitializeCell(System.Web.UI.WebControls.DataControlFieldCell,System.Web.UI.WebControls.DataControlCellType,System.Web.UI.WebControls.DataControlRowState,System.Int32)" /> method is called by the data-bound control that contains the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to initialize a <see cref="T:System.Web.UI.WebControls.HyperLink" /> control with the text and URL of the link.</para> 566 </remarks> 567 <summary> 568 <attribution license="cc4" from="Microsoft" modified="false" /> 569 <para>Initializes a cell in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para> 570 </summary> 571 <param name="cell"> 572 <attribution license="cc4" from="Microsoft" modified="false" />A <see cref="T:System.Web.UI.WebControls.DataControlFieldCell" /> that contains the text or controls of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" />.</param> 573 <param name="cellType"> 574 <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.UI.WebControls.DataControlCellType" /> values.</param> 575 <param name="rowState"> 576 <attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.UI.WebControls.DataControlRowState" /> values that specifies the state of the row containing the <see cref="T:System.Web.UI.WebControls.HyperLinkField" />.</param> 577 <param name="rowIndex"> 578 <attribution license="cc4" from="Microsoft" modified="false" />The index of the row in the table.</param> 579 </Docs> 580 <AssemblyInfo> 581 <AssemblyVersion>2.0.0.0</AssemblyVersion> 582 </AssemblyInfo> 583 </Member> 584 <Member MemberName="NavigateUrl"> 585 <MemberSignature Language="C#" Value="public virtual string NavigateUrl { set; get; }" /> 586 <MemberType>Property</MemberType> 587 <Attributes> 588 <Attribute> 589 <AttributeName>System.Web.UI.UrlProperty</AttributeName> 590 </Attribute> 591 <Attribute> 592 <AttributeName>System.ComponentModel.Editor("System.Web.UI.Design.UrlEditor, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a", "System.Drawing.Design.UITypeEditor, System.Drawing, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName> 593 </Attribute> 594 <Attribute> 595 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 596 </Attribute> 597 </Attributes> 598 <ReturnValue> 599 <ReturnType>System.String</ReturnType> 600 </ReturnValue> 601 <Docs> 602 <value>To be added.</value> 603 <since version=".NET 2.0" /> 604 <remarks> 605 <attribution license="cc4" from="Microsoft" modified="false" /> 606 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.NavigateUrl" /> property to specify the URL to navigate to when a hyperlink in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object is clicked. When this property is set, each hyperlink shares the same navigation URL.</para> 607 <para>Instead of using this property to set the URL for the hyperlinks, you can use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property to bind the URLs of the hyperlinks to a field in a data source. This allows you to have a different URL for each hyperlink.</para> 608 <block subset="none" type="note"> 609 <para>If the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> and <see cref="P:System.Web.UI.WebControls.HyperLinkField.NavigateUrl" /> properties are both set, the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property takes precedence.</para> 610 </block> 611 </remarks> 612 <summary> 613 <attribution license="cc4" from="Microsoft" modified="false" /> 614 <para>Gets or sets the URL to navigate to when a hyperlink in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object is clicked.</para> 615 </summary> 616 </Docs> 617 <AssemblyInfo> 618 <AssemblyVersion>2.0.0.0</AssemblyVersion> 619 </AssemblyInfo> 620 </Member> 621 <Member MemberName="Target"> 622 <MemberSignature Language="C#" Value="public virtual string Target { set; get; }" /> 623 <MemberType>Property</MemberType> 624 <Attributes> 625 <Attribute> 626 <AttributeName>System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.TargetConverter))</AttributeName> 627 </Attribute> 628 <Attribute> 629 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 630 </Attribute> 631 </Attributes> 632 <ReturnValue> 633 <ReturnType>System.String</ReturnType> 634 </ReturnValue> 635 <Docs> 636 <value>To be added.</value> 637 <since version=".NET 2.0" /> 638 <remarks> 639 <attribution license="cc4" from="Microsoft" modified="false" /> 640 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Target" /> property to specify the window or frame in which to display the Web content linked to a hyperlink when that hyperlink is clicked.</para> 641 <para>Values must begin with a letter in the range of A through Z (case-insensitive), except for the special values listed in the following table, each of which begins with an underscore.</para> 642 <list type="table"> 643 <listheader> 644 <item> 645 <term> 646 <para>Value</para> 647 </term> 648 <description> 649 <para>Description</para> 650 </description> 651 </item> 652 </listheader> 653 <item> 654 <term> 655 <para>_blank</para> 656 </term> 657 <description> 658 <para>Renders the content in a new window without frames. </para> 659 </description> 660 </item> 661 <item> 662 <term> 663 <para>_parent</para> 664 </term> 665 <description> 666 <para>Renders the content in the immediate frameset parent. </para> 667 </description> 668 </item> 669 <item> 670 <term> 671 <para>_search</para> 672 </term> 673 <description> 674 <para>Renders the content in the search pane.</para> 675 </description> 676 </item> 677 <item> 678 <term> 679 <para>_self</para> 680 </term> 681 <description> 682 <para>Renders the content in the frame with focus. </para> 683 </description> 684 </item> 685 <item> 686 <term> 687 <para>_top</para> 688 </term> 689 <description> 690 <para>Renders the content in the full window without frames. </para> 691 </description> 692 </item> 693 </list> 694 <block subset="none" type="note"> 695 <para>Check your browser documentation to determine whether the _search value is supported. For example, Microsoft Internet Explorer 5.0 and later versions support the _search target value.</para> 696 </block> 697 <block subset="none" type="note"> 698 <para>The <see cref="P:System.Web.UI.WebControls.HyperLinkField.Target" /> property is rendered as a target attribute. The target attribute on anchor elements is not allowed in the XHTML 1.1 document type definition. Do not set the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Target" /> property if the rendered output for the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object must be XHTML 1.1-compliant. For more information, refer to the topic <format type="text/html"><a href="1b78d416-66bb-43a5-ac77-c703aab55b97">ASP.NET and XHTML Compliance</a></format>. </para> 699 <para>When creating accessible Web pages, it is strongly recommended you avoid using the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Target" /> property to target another window. For more information, see <format type="text/html"><a href="9b5f3e05-e88d-4248-a5f4-9e64850fa0ae">ASP.NET Accessibility</a></format>.</para> 700 </block> 701 </remarks> 702 <summary> 703 <attribution license="cc4" from="Microsoft" modified="false" /> 704 <para>Gets or sets the target window or frame in which to display the Web page linked to when a hyperlink in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object is clicked.</para> 705 </summary> 706 </Docs> 707 <AssemblyInfo> 708 <AssemblyVersion>2.0.0.0</AssemblyVersion> 709 </AssemblyInfo> 710 </Member> 711 <Member MemberName="Text"> 712 <MemberSignature Language="C#" Value="public virtual string Text { set; get; }" /> 713 <MemberType>Property</MemberType> 714 <Attributes> 715 <Attribute> 716 <AttributeName>System.ComponentModel.DefaultValue("")</AttributeName> 717 </Attribute> 718 <Attribute> 719 <AttributeName>System.ComponentModel.Localizable(true)</AttributeName> 720 </Attribute> 721 </Attributes> 722 <ReturnValue> 723 <ReturnType>System.String</ReturnType> 724 </ReturnValue> 725 <Docs> 726 <value>To be added.</value> 727 <since version=".NET 2.0" /> 728 <remarks> 729 <attribution license="cc4" from="Microsoft" modified="false" /> 730 <para>Use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.Text" /> property to specify the caption to display for the hyperlinks in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. When this property is set, each hyperlink shares the same caption.</para> 731 <para>Instead of using this property to set the hyperlink captions, you can use the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property to bind the hyperlink captions to a field in a data source. This allows you to display a different caption for each hyperlink.</para> 732 <block subset="none" type="note"> 733 <para>If the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> and <see cref="P:System.Web.UI.WebControls.HyperLinkField.Text" /> properties are both set, the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property takes precedence.</para> 734 </block> 735 <para>The value of this property, when set, can be saved automatically to a resource file by using a designer tool. For more information, see <see cref="T:System.ComponentModel.LocalizableAttribute" /> and <format type="text/html"><a href="8ef3838e-9d05-4236-9dd0-ceecff9df80d">ASP.NET Globalization and Localization</a></format>.</para> 736 </remarks> 737 <summary> 738 <attribution license="cc4" from="Microsoft" modified="false" /> 739 <para>Gets or sets the text to display for each hyperlink in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para> 740 </summary> 741 </Docs> 742 <AssemblyInfo> 743 <AssemblyVersion>2.0.0.0</AssemblyVersion> 744 </AssemblyInfo> 745 </Member> 746 <Member MemberName="ValidateSupportsCallback"> 747 <MemberSignature Language="C#" Value="public override void ValidateSupportsCallback ();" /> 748 <MemberType>Method</MemberType> 749 <ReturnValue> 750 <ReturnType>System.Void</ReturnType> 751 </ReturnValue> 752 <Parameters /> 753 <Docs> 754 <since version=".NET 2.0" /> 755 <remarks> 756 <attribution license="cc4" from="Microsoft" modified="false" /> 757 <para>The <see cref="M:System.Web.UI.WebControls.HyperLinkField.ValidateSupportsCallback" /> method overrides the default <see cref="M:System.Web.UI.WebControls.DataControlField.ValidateSupportsCallback" /> method to indicate that controls contained in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object support callbacks.</para> 758 </remarks> 759 <summary> 760 <attribution license="cc4" from="Microsoft" modified="false" /> 761 <para>Indicates that the controls contained by the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object support callbacks.</para> 762 </summary> 763 </Docs> 764 <AssemblyInfo> 765 <AssemblyVersion>2.0.0.0</AssemblyVersion> 766 </AssemblyInfo> 767 </Member> 768 </Members> 769</Type>