1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
|
<?xml version="1.0" encoding="utf-8"?>
<Type Name="HyperLinkField" FullName="System.Web.UI.WebControls.HyperLinkField">
<TypeSignature Language="C#" Value="public class HyperLinkField : System.Web.UI.WebControls.DataControlField" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.WebControls.DataControlField</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<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>
<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>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<list type="table">
<listheader>
<item>
<term>
<para>Style property </para>
</term>
<description>
<para>Description </para>
</description>
</item>
</listheader>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.DataControlField.ControlStyle" /> </para>
</term>
<description>
<para>The style settings for the child Web server controls of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.DataControlField.FooterStyle" /> </para>
</term>
<description>
<para>The style settings for the footer section of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.DataControlField.HeaderStyle" /> </para>
</term>
<description>
<para>The style settings for the header section of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para>
</description>
</item>
<item>
<term>
<para>
<see cref="P:System.Web.UI.WebControls.DataControlField.ItemStyle" /> </para>
</term>
<description>
<para>The style settings for the data items in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object. </para>
</description>
</item>
</list>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Represents a field that is displayed as a hyperlink in a data-bound control.</para>
</summary>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public HyperLinkField ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<block subset="none" type="note">
<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>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CopyProperties">
<MemberSignature Language="C#" Value="protected override void CopyProperties (System.Web.UI.WebControls.DataControlField newField);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="newField" Type="System.Web.UI.WebControls.DataControlField" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Copies the properties of the current <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object to the specified object.</para>
</summary>
<param name="newField">
<attribution license="cc4" from="Microsoft" modified="false" />The <see cref="T:System.Web.UI.WebControls.DataControlField" />-derived object that receives the copy.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="CreateField">
<MemberSignature Language="C#" Value="protected override System.Web.UI.WebControls.DataControlField CreateField ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.DataControlField</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Returns a new instance of the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> class.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>A new instance of <see cref="T:System.Web.UI.WebControls.HyperLinkField" />.</para>
</returns>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DataNavigateUrlFields">
<MemberSignature Language="C#" Value="public virtual string[] DataNavigateUrlFields { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue(null)</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.StringArrayConverter))</AttributeName>
</Attribute>
<Attribute>
<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>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String[]</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<block subset="none" type="note">
<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>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DataNavigateUrlFormatString">
<MemberSignature Language="C#" Value="public virtual string DataNavigateUrlFormatString { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<block subset="none" type="note">
<para>The format string is applied only when the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFields" /> property is set.</para>
</block>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<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 characters are 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. For example, the format string "{0:F2}" displays a fixed-point number with two decimal places.</para>
<para>For more information on formatting strings, see <format type="text/html"><a href="0D1364DA-5B30-4D42-8E6B-03378343343F">Formatting Overview</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DataTextField">
<MemberSignature Language="C#" Value="public virtual string DataTextField { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter("System.Web.UI.Design.DataSourceViewSchemaConverter, System.Design, Version=2.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<block subset="none" type="note">
<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>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="DataTextFormatString">
<MemberSignature Language="C#" Value="public virtual string DataTextFormatString { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<block subset="none" type="note">
<para>The format string is applied only when the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextField" /> property is set.</para>
</block>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
<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 characters are 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. For example, the format string "{0:F2}" displays a fixed-point number with two decimal places.</para>
<para>For more information on formatting strings, see <format type="text/html"><a href="0D1364DA-5B30-4D42-8E6B-03378343343F">Formatting Overview</a></format>.</para>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FormatDataNavigateUrlValue">
<MemberSignature Language="C#" Value="protected virtual string FormatDataNavigateUrlValue (object[] dataUrlValues);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataUrlValues" Type="System.Object[]" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats the navigation URL using the format string specified by the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataNavigateUrlFormatString" /> property.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The formatted URL value.</para>
</returns>
<param name="dataUrlValues">
<attribution license="cc4" from="Microsoft" modified="false" />An array of values to combine with the format string.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="FormatDataTextValue">
<MemberSignature Language="C#" Value="protected virtual string FormatDataTextValue (object dataTextValue);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dataTextValue" Type="System.Object" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<block subset="none" type="note">
<para>This method is used primarily by control developers.</para>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Formats the caption text using the format string specified by the <see cref="P:System.Web.UI.WebControls.HyperLinkField.DataTextFormatString" /> property.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>The formatted text value.</para>
</returns>
<param name="dataTextValue">
<attribution license="cc4" from="Microsoft" modified="false" />The text value to format. </param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public override bool Initialize (bool sortingEnabled, System.Web.UI.Control control);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="sortingEnabled" Type="System.Boolean" />
<Parameter Name="control" Type="System.Web.UI.Control" />
</Parameters>
<Docs>
<param name="sortingEnabled">To be added.</param>
<remarks>To be added.</remarks>
<since version=".NET 2.0" />
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para>
</summary>
<returns>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Always returns false.</para>
</returns>
<param name="control">
<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>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="InitializeCell">
<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);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cell" Type="System.Web.UI.WebControls.DataControlFieldCell" />
<Parameter Name="cellType" Type="System.Web.UI.WebControls.DataControlCellType" />
<Parameter Name="rowState" Type="System.Web.UI.WebControls.DataControlRowState" />
<Parameter Name="rowIndex" Type="System.Int32" />
</Parameters>
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Initializes a cell in a <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para>
</summary>
<param name="cell">
<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>
<param name="cellType">
<attribution license="cc4" from="Microsoft" modified="false" />One of the <see cref="T:System.Web.UI.WebControls.DataControlCellType" /> values.</param>
<param name="rowState">
<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>
<param name="rowIndex">
<attribution license="cc4" from="Microsoft" modified="false" />The index of the row in the table.</param>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="NavigateUrl">
<MemberSignature Language="C#" Value="public virtual string NavigateUrl { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Web.UI.UrlProperty</AttributeName>
</Attribute>
<Attribute>
<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>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<block subset="none" type="note">
<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>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Target">
<MemberSignature Language="C#" Value="public virtual string Target { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.TargetConverter))</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<list type="table">
<listheader>
<item>
<term>
<para>Value</para>
</term>
<description>
<para>Description</para>
</description>
</item>
</listheader>
<item>
<term>
<para>_blank</para>
</term>
<description>
<para>Renders the content in a new window without frames. </para>
</description>
</item>
<item>
<term>
<para>_parent</para>
</term>
<description>
<para>Renders the content in the immediate frameset parent. </para>
</description>
</item>
<item>
<term>
<para>_search</para>
</term>
<description>
<para>Renders the content in the search pane.</para>
</description>
</item>
<item>
<term>
<para>_self</para>
</term>
<description>
<para>Renders the content in the frame with focus. </para>
</description>
</item>
<item>
<term>
<para>_top</para>
</term>
<description>
<para>Renders the content in the full window without frames. </para>
</description>
</item>
</list>
<block subset="none" type="note">
<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>
</block>
<block subset="none" type="note">
<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>
<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>
</block>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="Text">
<MemberSignature Language="C#" Value="public virtual string Text { set; get; }" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.ComponentModel.DefaultValue("")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.ComponentModel.Localizable(true)</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<value>To be added.</value>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
<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>
<block subset="none" type="note">
<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>
</block>
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Gets or sets the text to display for each hyperlink in the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
<Member MemberName="ValidateSupportsCallback">
<MemberSignature Language="C#" Value="public override void ValidateSupportsCallback ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<since version=".NET 2.0" />
<remarks>
<attribution license="cc4" from="Microsoft" modified="false" />
<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>
</remarks>
<summary>
<attribution license="cc4" from="Microsoft" modified="false" />
<para>Indicates that the controls contained by the <see cref="T:System.Web.UI.WebControls.HyperLinkField" /> object support callbacks.</para>
</summary>
</Docs>
<AssemblyInfo>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</AssemblyInfo>
</Member>
</Members>
</Type>
|
