/
WebControl.xml
2316 lines (2030 loc) · 174 KB
/
WebControl.xml
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
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<Type Name="WebControl" FullName="System.Web.UI.WebControls.WebControl">
<TypeSignature Language="C#" Value="public class WebControl : System.Web.UI.Control, System.Web.UI.IAttributeAccessor" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit WebControl extends System.Web.UI.Control implements class System.Web.UI.IAttributeAccessor" />
<TypeSignature Language="DocId" Value="T:System.Web.UI.WebControls.WebControl" />
<TypeSignature Language="VB.NET" Value="Public Class WebControl
Inherits Control
Implements IAttributeAccessor" />
<TypeSignature Language="F#" Value="type WebControl = class
 inherit Control
 interface IAttributeAccessor" />
<TypeSignature Language="C++ CLI" Value="public ref class WebControl : System::Web::UI::Control, System::Web::UI::IAttributeAccessor" />
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Web.UI.Control</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Web.UI.IAttributeAccessor</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.ParseChildren(true)]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.ParseChildren(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Web.UI.PersistChildren(false)]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.PersistChildren(false)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Web.UI.Themeable(true)]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.Themeable(true)>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Serves as the base class that defines the methods, properties and events common to all controls in the <see cref="N:System.Web.UI.WebControls" /> namespace.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.WebControl> class provides the properties, methods, and events that are common to all Web server controls. You can control the appearance and behavior of a Web server control by setting properties defined in this class. For example, the background color and font color of a control are controlled by using the <xref:System.Web.UI.WebControls.WebControl.BackColor%2A> and <xref:System.Web.UI.WebControls.WebControl.ForeColor%2A> properties, respectively. On controls that can display a border, you can control the border width, the border style, and the border color by setting the <xref:System.Web.UI.WebControls.WebControl.BorderWidth%2A>, <xref:System.Web.UI.WebControls.WebControl.BorderStyle%2A>, and <xref:System.Web.UI.WebControls.WebControl.BorderColor%2A> properties. The size of a Web server control can be specified by using the <xref:System.Web.UI.WebControls.WebControl.Height%2A> and <xref:System.Web.UI.WebControls.WebControl.Width%2A> properties.
The behavior of the control can be specified by setting certain properties. You can enable and disable a control by setting the <xref:System.Web.UI.WebControls.WebControl.Enabled%2A> property. The place of the control in the tab order is controlled by setting the <xref:System.Web.UI.WebControls.WebControl.TabIndex%2A> property. You can specify a ToolTip for the control by setting the <xref:System.Web.UI.WebControls.WebControl.ToolTip%2A> property.
> [!NOTE]
> Not all controls support every property defined in this class. For specific information about whether a property is supported, see the documentation for the specific control.
> [!NOTE]
> Some properties in this class render differently, depending on the browser. Some properties do not render at all, while others render, but have no effect. The <xref:System.Web.Configuration.HttpCapabilitiesBase.TagWriter%2A> property of the <xref:System.Web.HttpBrowserCapabilities> object determines the way in which a Web server control renders. For browsers that support HTML 4.0, the <xref:System.Web.Configuration.HttpCapabilitiesBase.TagWriter%2A> property will contain a regular <xref:System.Web.HttpBrowserCapabilities> object, and most properties will be rendered using HTML 4.0 style attributes. Browsers that are not known to support HTML 4.0 will use the <xref:System.Web.UI.Html32TextWriter> object. This will automatically map the style attributes to any relevant HTML 3.2 tag attributes. In some cases, such as with the <xref:System.Web.UI.WebControls.WebControl.ForeColor%2A> property, the style attributes will be converted into additional tags, such as `<font>` tags. In some cases, there will be no mapping performed. For specific information about how a property is rendered in different browsers, see the documentation for the specific property.
For a list of initial property values for an instance of <xref:System.Web.UI.WebControls.WebControl>, see the <xref:System.Web.UI.WebControls.WebControl.%23ctor%2A> constructor.
## Examples
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebControlAddAttributesToRender/CS/addattrib.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebControlAddAttributesToRender/VB/addattrib.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="P:System.Web.UI.WebControls.WebControl.BackColor" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.ForeColor" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.BorderWidth" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.BorderStyle" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.BorderColor" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.Height" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.Width" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.Enabled" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.TabIndex" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.ToolTip" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
<Members>
<MemberGroup MemberName=".ctor">
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WebControl" /> class.</summary>
</Docs>
</MemberGroup>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected WebControl ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberSignature Language="C++ CLI" Value="protected:
 WebControl();" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WebControl" /> class that represents a <see langword="Span" /> HTML tag.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
This constructor is used to initialize a new instance of the <xref:System.Web.UI.WebControls.WebControl> class that represents a `Span` HTML element.
The following table shows the initial property value for an instance of <xref:System.Web.UI.WebControls.WebControl>.
|Property|Initial Value|
|--------------|-------------------|
|`TagKey`|The <xref:System.Web.UI.HtmlTextWriterTag.Span> enumeration value.|
> [!NOTE]
> This constructor is not called directly. Instead, it is often called by the constructor of a derived class to initialize the <xref:System.Web.UI.WebControls.WebControl.TagKey%2A> property to the <xref:System.Web.UI.HtmlTextWriterTag.Span> enumeration value.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.HtmlTextWriterTag" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.TagKey" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected WebControl (string tag);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(string tag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.#ctor(System.String)" />
<MemberSignature Language="VB.NET" Value="Protected Sub New (tag As String)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.WebControl : string -> System.Web.UI.WebControls.WebControl" Usage="new System.Web.UI.WebControls.WebControl tag" />
<MemberSignature Language="C++ CLI" Value="protected:
 WebControl(System::String ^ tag);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tag" Type="System.String" />
</Parameters>
<Docs>
<param name="tag">An HTML tag.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WebControl" /> class using the specified HTML tag.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to create and initialize a new instance of the <xref:System.Web.UI.WebControls.WebControl> class using the specified HTML tag.
The following table shows initial property values for an instance of <xref:System.Web.UI.WebControls.WebControl>.
|Property|Initial Value|
|--------------|-------------------|
|`TagKey`|The <xref:System.Web.UI.HtmlTextWriterTag.Unknown> enumeration value.|
|`TagName`|The value of the `tag` parameter.|
> [!NOTE]
> This constructor is not called directly. Instead, it is often called by the constructor of a derived class to initialize the <xref:System.Web.UI.WebControls.WebControl.TagKey%2A> and <xref:System.Web.UI.WebControls.WebControl.TagName%2A> properties.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.HtmlTextWriterTag" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.TagKey" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.TagName" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public WebControl (System.Web.UI.HtmlTextWriterTag tag);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype System.Web.UI.HtmlTextWriterTag tag) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.#ctor(System.Web.UI.HtmlTextWriterTag)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tag As HtmlTextWriterTag)" />
<MemberSignature Language="F#" Value="new System.Web.UI.WebControls.WebControl : System.Web.UI.HtmlTextWriterTag -> System.Web.UI.WebControls.WebControl" Usage="new System.Web.UI.WebControls.WebControl tag" />
<MemberSignature Language="C++ CLI" Value="public:
 WebControl(System::Web::UI::HtmlTextWriterTag tag);" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<Parameters>
<Parameter Name="tag" Type="System.Web.UI.HtmlTextWriterTag" />
</Parameters>
<Docs>
<param name="tag">One of the <see cref="T:System.Web.UI.HtmlTextWriterTag" /> values.</param>
<summary>Initializes a new instance of the <see cref="T:System.Web.UI.WebControls.WebControl" /> class using the specified HTML tag.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use this constructor to create and initialize a new instance of the <xref:System.Web.UI.WebControls.WebControl> class using the specified <xref:System.Web.UI.HtmlTextWriterTag?displayProperty=nameWithType> value.
The following table shows the initial property value for an instance of <xref:System.Web.UI.WebControls.WebControl>.
|Property|Initial Value|
|--------------|-------------------|
|`TagKey`|The <xref:System.Web.UI.HtmlTextWriterTag> enumeration value specified by the `tag` parameter.|
## Examples
The following example demonstrates how to use the constructor for the <xref:System.Web.UI.WebControls.WebControl> class to create a `TextArea` HTML element and display it on the Web Forms page.
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx file name extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
> [!IMPORTANT]
> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.WebControl Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.WebControl Example/VB/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.HtmlTextWriterTag" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.TagKey" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="AccessKey">
<MemberSignature Language="C#" Value="public virtual string AccessKey { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AccessKey" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.AccessKey" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property AccessKey As String" />
<MemberSignature Language="F#" Value="member this.AccessKey : string with get, set" Usage="System.Web.UI.WebControls.WebControl.AccessKey" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ AccessKey { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the access key that allows you to quickly navigate to the Web server control.</summary>
<value>The access key for quick navigation to the Web server control. The default value is <see cref="F:System.String.Empty" />, which indicates that this property is not set.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.WebControl.AccessKey%2A> property to specify the keyboard shortcut for the Web server control. This allows you to navigate quickly to the control by pressing the ALT key and the key for the specified character on the keyboard. For example, setting the access key of a control to the string `"D"` indicates that the user can navigate to the control by pressing ALT+D.
Only a single character string is allowed for the <xref:System.Web.UI.WebControls.WebControl.AccessKey%2A> property. If you attempt to set this property to a value that is neither `null`, <xref:System.String.Empty>, nor a single character string, an exception is thrown.
> [!NOTE]
> This property is supported only in Internet Explorer 4.0 and later.
## Examples
The following example illustrates how to set and use the <xref:System.Web.UI.WebControls.WebControl.AccessKey%2A> property of a <xref:System.Web.UI.WebControls.TextBox> control.
> [!IMPORTANT]
> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.AccessKey Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.AccessKey Example/VB/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentOutOfRangeException">The specified access key is neither <see langword="null" />, <see cref="F:System.String.Empty" /> nor a single character string.</exception>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="AddAttributesToRender">
<MemberSignature Language="C#" Value="protected virtual void AddAttributesToRender (System.Web.UI.HtmlTextWriter writer);" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void AddAttributesToRender(class System.Web.UI.HtmlTextWriter writer) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.AddAttributesToRender(System.Web.UI.HtmlTextWriter)" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Sub AddAttributesToRender (writer As HtmlTextWriter)" />
<MemberSignature Language="F#" Value="abstract member AddAttributesToRender : System.Web.UI.HtmlTextWriter -> unit
override this.AddAttributesToRender : System.Web.UI.HtmlTextWriter -> unit" Usage="webControl.AddAttributesToRender writer" />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual void AddAttributesToRender(System::Web::UI::HtmlTextWriter ^ writer);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="writer" Type="System.Web.UI.HtmlTextWriter" />
</Parameters>
<Docs>
<param name="writer">A <see cref="T:System.Web.UI.HtmlTextWriter" /> that represents the output stream to render HTML content on the client.</param>
<summary>Adds HTML attributes and styles that need to be rendered to the specified <see cref="T:System.Web.UI.HtmlTextWriterTag" />. This method is used primarily by control developers.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
To render attributes and styles for a Web Server control on the client, you typically call the <xref:System.Web.UI.HtmlTextWriter.AddAttribute%2A> and <xref:System.Web.UI.HtmlTextWriter.AddStyleAttribute%2A?displayProperty=nameWithType> methods to insert each attribute and style individually to the <xref:System.Web.UI.HtmlTextWriter> output stream. To simplify the process, this method encapsulates all calls to the <xref:System.Web.UI.HtmlTextWriter.AddAttribute%2A?displayProperty=nameWithType> and <xref:System.Web.UI.HtmlTextWriter.AddStyleAttribute%2A?displayProperty=nameWithType> methods for every attribute and style associated with the Web server control. All attributes and styles are inserted into the <xref:System.Web.UI.HtmlTextWriter> output stream in a single method call. This method is typically overridden by control developers in derived classes to insert the appropriate attributes and styles to the <xref:System.Web.UI.HtmlTextWriter> output stream for the class.
> [!NOTE]
> The <xref:System.Web.UI.WebControls.WebControl.AddAttributesToRender%2A> method cannot be used to insert client script. To use client script, see the <xref:System.Web.UI.ClientScriptManager> class.
## Examples
The following example demonstrates how to create a class that derives from the <xref:System.Web.UI.WebControls.WebControl> class. The base implementation of the <xref:System.Web.UI.WebControls.WebControl.AddAttributesToRender%2A> method is overridden to add attributes appropriate to the derived class in the <xref:System.Web.UI.HtmlTextWriter> output stream.
:::code language="csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebControlAddAttributesToRender/CS/addattrib.cs" id="Snippet1":::
:::code language="vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebControlAddAttributesToRender/VB/addattrib.vb" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="Overload:System.Web.UI.HtmlTextWriter.AddAttribute" />
<altmember cref="Overload:System.Web.UI.HtmlTextWriter.AddStyleAttribute" />
<altmember cref="T:System.Web.UI.HtmlTextWriter" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="ApplyStyle">
<MemberSignature Language="C#" Value="public void ApplyStyle (System.Web.UI.WebControls.Style s);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ApplyStyle(class System.Web.UI.WebControls.Style s) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.ApplyStyle(System.Web.UI.WebControls.Style)" />
<MemberSignature Language="VB.NET" Value="Public Sub ApplyStyle (s As Style)" />
<MemberSignature Language="F#" Value="member this.ApplyStyle : System.Web.UI.WebControls.Style -> unit" Usage="webControl.ApplyStyle s" />
<MemberSignature Language="C++ CLI" Value="public:
 void ApplyStyle(System::Web::UI::WebControls::Style ^ s);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="s" Type="System.Web.UI.WebControls.Style" />
</Parameters>
<Docs>
<param name="s">A <see cref="T:System.Web.UI.WebControls.Style" /> that represents the style to be copied.</param>
<summary>Copies any nonblank elements of the specified style to the Web control, overwriting any existing style elements of the control. This method is primarily used by control developers.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Examples
The following example demonstrates how to use the <xref:System.Web.UI.WebControls.WebControl.ApplyStyle%2A> method to apply a style to a <xref:System.Web.UI.WebControls.DataGrid> control.
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/WebControlApplyStyle/CS/webcontrolapplystylecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/WebControlApplyStyle/VB/webcontrolapplystylevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="M:System.Web.UI.WebControls.WebControl.MergeStyle(System.Web.UI.WebControls.Style)" />
<altmember cref="T:System.Web.UI.WebControls.Style" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="Attributes">
<MemberSignature Language="C#" Value="public System.Web.UI.AttributeCollection Attributes { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.AttributeCollection Attributes" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.Attributes" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Attributes As AttributeCollection" />
<MemberSignature Language="F#" Value="member this.Attributes : System.Web.UI.AttributeCollection" Usage="System.Web.UI.WebControls.WebControl.Attributes" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::UI::AttributeCollection ^ Attributes { System::Web::UI::AttributeCollection ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.AttributeCollection</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the collection of arbitrary attributes (for rendering only) that do not correspond to properties on the control.</summary>
<value>A <see cref="T:System.Web.UI.AttributeCollection" /> of name and value pairs.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.WebControl.Attributes%2A> collection contains a collection of all attributes declared in the opening tag of a Web server control. This allows you to programmatically control the attributes associated with a Web server control. You can add attributes to the collection or remove attributes from the collection.
> [!NOTE]
> This property is rendered with all attributes in the collection in the control's opening tag, regardless of the browser settings. Not all browsers support every attribute that is rendered. The unsupported attributes are usually ignored by the browser.
> [!NOTE]
> You cannot add client-side script to a <xref:System.Web.UI.WebControls.WebControl> instance using the <xref:System.Web.UI.WebControls.WebControl.Attributes%2A> collection. To add client-side script, use the <xref:System.Web.UI.Page.ClientScript%2A> property on the <xref:System.Web.UI.Page> control.
## Examples
The following example illustrates how the <xref:System.Web.UI.WebControls.WebControl.Attributes%2A> property of a <xref:System.Web.UI.WebControls.WebControl> can be used to run a JavaScript command when the <xref:System.Web.UI.WebControls.TextBox> control loses focus.
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
> [!IMPORTANT]
> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.Attributes Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.Attributes Example/VB/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.AttributeCollection" />
<altmember cref="T:System.Web.UI.ClientScriptManager" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="BackColor">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Color BackColor { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Drawing.Color BackColor" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.BackColor" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property BackColor As Color" />
<MemberSignature Language="F#" Value="member this.BackColor : System.Drawing.Color with get, set" Usage="System.Web.UI.WebControls.WebControl.BackColor" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Drawing::Color BackColor { System::Drawing::Color get(); void set(System::Drawing::Color value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(typeof(System.Drawing.Color), "")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(typeof(System.Drawing.Color), "")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.WebColorConverter))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.WebColorConverter))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Drawing.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the background color of the Web server control.</summary>
<value>A <see cref="T:System.Drawing.Color" /> that represents the background color of the control. The default is <see cref="F:System.Drawing.Color.Empty" />, which indicates that this property is not set.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.WebControl.BackColor%2A> property to specify the background color of the Web server control. This property is set using a <xref:System.Drawing.Color?displayProperty=nameWithType> object.
> [!NOTE]
> This property will render for only certain controls. For example, <xref:System.Web.UI.WebControls.Table>, <xref:System.Web.UI.WebControls.Panel>, <xref:System.Web.UI.WebControls.DataGrid>, <xref:System.Web.UI.WebControls.Calendar>, and <xref:System.Web.UI.WebControls.ValidationSummary> will render this property. It will also work for <xref:System.Web.UI.WebControls.CheckBoxList>, <xref:System.Web.UI.WebControls.RadioButtonList> and <xref:System.Web.UI.WebControls.DataList> if their `RepeatLayout` property is `RepeatLayout.Table`, not `RepeatLayout.Flow`.
In general, only controls that render as a `<table>` tag can display a background color in HTML 3.2, whereas almost any control can in HTML 4.0.
For controls that render as a `<span>` tag (including <xref:System.Web.UI.WebControls.Label>, all validation controls, and list controls with their `RepeatLayout` property set to `RepeatLayout.Flow`), this property will work in Microsoft Internet Explorer version 5 and later, but not in Microsoft Internet Explorer version 4.
## Examples
The following example illustrates how to set the <xref:System.Web.UI.WebControls.WebControl.BackColor%2A> property of the <xref:System.Web.UI.WebControls.Table> control, which is inherited from the <xref:System.Web.UI.WebControls.WebControl> base class.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.BackColor Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.BackColor Example/VB/sourcevb.aspx" id="Snippet1":::
]]></format>
</remarks>
<altmember cref="T:System.Drawing.Color" />
<altmember cref="T:System.Web.UI.WebControls.Style" />
<altmember cref="T:System.Web.UI.WebControls.Table" />
<altmember cref="T:System.Web.UI.WebControls.Panel" />
<altmember cref="T:System.Web.UI.WebControls.DataGrid" />
<altmember cref="T:System.Web.UI.WebControls.Calendar" />
<altmember cref="T:System.Web.UI.WebControls.ValidationSummary" />
<altmember cref="T:System.Web.UI.WebControls.CheckBoxList" />
<altmember cref="T:System.Web.UI.WebControls.RadioButtonList" />
<altmember cref="T:System.Web.UI.WebControls.DataList" />
<altmember cref="T:System.Web.UI.WebControls.RepeatLayout" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="BorderColor">
<MemberSignature Language="C#" Value="public virtual System.Drawing.Color BorderColor { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Drawing.Color BorderColor" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.BorderColor" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property BorderColor As Color" />
<MemberSignature Language="F#" Value="member this.BorderColor : System.Drawing.Color with get, set" Usage="System.Web.UI.WebControls.WebControl.BorderColor" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Drawing::Color BorderColor { System::Drawing::Color get(); void set(System::Drawing::Color value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(typeof(System.Drawing.Color), "")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(typeof(System.Drawing.Color), "")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.WebColorConverter))]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.TypeConverter(typeof(System.Web.UI.WebControls.WebColorConverter))>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Drawing.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the border color of the Web control.</summary>
<value>A <see cref="T:System.Drawing.Color" /> that represents the border color of the control. The default is <see cref="F:System.Drawing.Color.Empty" />, which indicates that this property is not set.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.WebControl.BorderColor%2A> property to specify the border color of the Web Server control. This property is set using a <xref:System.Drawing.Color> object.
> [!NOTE]
> The <xref:System.Web.UI.WebControls.WebControl.BorderColor%2A> property will render only for certain controls. For example, the <xref:System.Web.UI.WebControls.Table>, <xref:System.Web.UI.WebControls.Panel>, <xref:System.Web.UI.WebControls.DataGrid>, <xref:System.Web.UI.WebControls.Calendar>, and <xref:System.Web.UI.WebControls.ValidationSummary> controls will render this property. It will also work for the <xref:System.Web.UI.WebControls.CheckBoxList>, <xref:System.Web.UI.WebControls.RadioButtonList>, and <xref:System.Web.UI.WebControls.DataList> controls, if their `RepeatLayout` property is set to `RepeatLayout.Table`, not `RepeatLayout.Flow`. However, it is rendered as the `bordercolor` attribute, which is not part of the HTML 3.2 standard. The `bordercolor` attribute works for Microsoft Internet Explorer version 3.0 or later, but not most other browsers.
When the <xref:System.Web.UI.WebControls.WebControl.BorderColor%2A> property is not set, the browser will use its default border color. Refer to your browser to determine its default color scheme.
## Examples
The following example illustrates how to set the <xref:System.Web.UI.WebControls.WebControl.BorderColor%2A> property of the <xref:System.Web.UI.WebControls.Table> control, which is inherited from the <xref:System.Web.UI.WebControls.WebControl> base class.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.BorderColor Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.BorderColor Example/VB/sourcevb.aspx" id="Snippet1":::
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/CS/borderpropertiescs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/VB/borderpropertiesvb.aspx" id="Snippet1":::
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/CS/borderpropertiescs.aspx" id="Snippet3":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/VB/borderpropertiesvb.aspx" id="Snippet3":::
]]></format>
</remarks>
<altmember cref="T:System.Drawing.Color" />
<altmember cref="T:System.Web.UI.WebControls.Style" />
<altmember cref="T:System.Web.UI.WebControls.Table" />
<altmember cref="T:System.Web.UI.WebControls.Panel" />
<altmember cref="T:System.Web.UI.WebControls.DataGrid" />
<altmember cref="T:System.Web.UI.WebControls.Calendar" />
<altmember cref="T:System.Web.UI.WebControls.ValidationSummary" />
<altmember cref="T:System.Web.UI.WebControls.CheckBoxList" />
<altmember cref="T:System.Web.UI.WebControls.RadioButtonList" />
<altmember cref="T:System.Web.UI.WebControls.DataList" />
<altmember cref="T:System.Web.UI.WebControls.RepeatLayout" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="BorderStyle">
<MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.BorderStyle BorderStyle { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.WebControls.BorderStyle BorderStyle" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.BorderStyle" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property BorderStyle As BorderStyle" />
<MemberSignature Language="F#" Value="member this.BorderStyle : System.Web.UI.WebControls.BorderStyle with get, set" Usage="System.Web.UI.WebControls.WebControl.BorderStyle" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::WebControls::BorderStyle BorderStyle { System::Web::UI::WebControls::BorderStyle get(); void set(System::Web::UI::WebControls::BorderStyle value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(System.Web.UI.WebControls.BorderStyle.NotSet)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(System.Web.UI.WebControls.BorderStyle.NotSet)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.BorderStyle</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the border style of the Web server control.</summary>
<value>One of the <see cref="T:System.Web.UI.WebControls.BorderStyle" /> enumeration values. The default is <see langword="NotSet" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.WebControl.BorderStyle%2A> property to specify the border style for the Web server control. This property is set using one of the <xref:System.Web.UI.WebControls.BorderStyle> enumeration values. The following table lists the possible values.
|Border Style|Description|
|------------------|-----------------|
|`NotSet`|The border style is not set.|
|`None`|No border|
|`Dotted`|A dotted line border.|
|`Dashed`|A dashed line border.|
|`Solid`|A solid line border.|
|`Double`|A solid double line border.|
|`Groove`|A grooved border for a sunken border appearance.|
|`Ridge`|A ridged border for a raised border appearance.|
|`Inset`|An inset border for a sunken control appearance.|
|`Outset`|An outset border for a raised control appearance.|
> [!NOTE]
> This property will not render on browsers earlier than Microsoft Internet Explorer 4 for any Web server control. There is no equivalent to it in HTML 3.2.
## Examples
The following example illustrates how to set the <xref:System.Web.UI.WebControls.WebControl.BorderStyle%2A> property of the <xref:System.Web.UI.WebControls.Table> control, which is inherited from the <xref:System.Web.UI.WebControls.WebControl> base class.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.BorderStyle Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.BorderStyle Example/VB/sourcevb.aspx" id="Snippet1":::
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/CS/borderpropertiescs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/VB/borderpropertiesvb.aspx" id="Snippet1":::
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/CS/borderpropertiescs.aspx" id="Snippet3":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/VB/borderpropertiesvb.aspx" id="Snippet3":::
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.Style" />
<altmember cref="T:System.Web.UI.WebControls.BorderStyle" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="BorderWidth">
<MemberSignature Language="C#" Value="public virtual System.Web.UI.WebControls.Unit BorderWidth { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Web.UI.WebControls.Unit BorderWidth" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.BorderWidth" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property BorderWidth As Unit" />
<MemberSignature Language="F#" Value="member this.BorderWidth : System.Web.UI.WebControls.Unit with get, set" Usage="System.Web.UI.WebControls.WebControl.BorderWidth" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::Web::UI::WebControls::Unit BorderWidth { System::Web::UI::WebControls::Unit get(); void set(System::Web::UI::WebControls::Unit value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue(typeof(System.Web.UI.WebControls.Unit), "")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue(typeof(System.Web.UI.WebControls.Unit), "")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.Unit</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the border width of the Web server control.</summary>
<value>A <see cref="T:System.Web.UI.WebControls.Unit" /> that represents the border width of a Web server control. The default value is <see cref="F:System.Web.UI.WebControls.Unit.Empty" />, which indicates that this property is not set.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.WebControl.BorderWidth%2A> property to specify a border width for a control.
> [!NOTE]
> This property does not work with all Web server controls. It applies only to controls that display as a table, such as <xref:System.Web.UI.WebControls.Table> and <xref:System.Web.UI.WebControls.DataGrid>.
This property is set with a <xref:System.Web.UI.WebControls.Unit> object. If the <xref:System.Web.UI.WebControls.Unit.Value%2A> property of the <xref:System.Web.UI.WebControls.Unit> contains a negative number, an exception is thrown.
> [!NOTE]
> The border width can be expressed only in pixels for browsers earlier than Microsoft Internet Explorer version 5. All unit types are supported in Microsoft Internet Explorer version 5 and later. Refer to the specific control for details.
## Examples
The following example illustrates how to set the <xref:System.Web.UI.WebControls.WebControl.BorderWidth%2A> property of the <xref:System.Web.UI.WebControls.Table> control, inherited from the <xref:System.Web.UI.WebControls.WebControl> base class.
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.BorderWidth Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.BorderWidth Example/VB/sourcevb.aspx" id="Snippet1":::
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/CS/borderpropertiescs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/VB/borderpropertiesvb.aspx" id="Snippet1":::
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/CS/borderpropertiescs.aspx" id="Snippet3":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/System.Web.UI.WebControl.BorderProperties/VB/borderpropertiesvb.aspx" id="Snippet3":::
]]></format>
</remarks>
<exception cref="T:System.ArgumentException">The specified border width is a negative value.</exception>
<altmember cref="T:System.Web.UI.WebControls.Unit" />
<altmember cref="T:System.Web.UI.WebControls.Style" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="ControlStyle">
<MemberSignature Language="C#" Value="public System.Web.UI.WebControls.Style ControlStyle { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Web.UI.WebControls.Style ControlStyle" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.ControlStyle" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ControlStyle As Style" />
<MemberSignature Language="F#" Value="member this.ControlStyle : System.Web.UI.WebControls.Style" Usage="System.Web.UI.WebControls.WebControl.ControlStyle" />
<MemberSignature Language="C++ CLI" Value="public:
 property System::Web::UI::WebControls::Style ^ ControlStyle { System::Web::UI::WebControls::Style ^ get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.Style</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the style of the Web server control. This property is used primarily by control developers.</summary>
<value>A <see cref="T:System.Web.UI.WebControls.Style" /> that encapsulates the appearance properties of the Web server control.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.WebControl.ControlStyle%2A> property encapsulates all properties of the <xref:System.Web.UI.WebControls.WebControl> class that specify the appearance of the control, such as <xref:System.Web.UI.WebControls.WebControl.BorderColor%2A> and <xref:System.Web.UI.WebControls.WebControl.Font%2A>.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.Style" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.ControlStyleCreated" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="ControlStyleCreated">
<MemberSignature Language="C#" Value="public bool ControlStyleCreated { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ControlStyleCreated" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.ControlStyleCreated" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ControlStyleCreated As Boolean" />
<MemberSignature Language="F#" Value="member this.ControlStyleCreated : bool" Usage="System.Web.UI.WebControls.WebControl.ControlStyleCreated" />
<MemberSignature Language="C++ CLI" Value="public:
 property bool ControlStyleCreated { bool get(); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.Browsable(false)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Browsable(false)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DesignerSerializationVisibility(System.ComponentModel.DesignerSerializationVisibility.Hidden)>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Advanced)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether a <see cref="T:System.Web.UI.WebControls.Style" /> object has been created for the <see cref="P:System.Web.UI.WebControls.WebControl.ControlStyle" /> property. This property is primarily used by control developers.</summary>
<value>
<see langword="true" /> if a <see cref="T:System.Web.UI.WebControls.Style" /> object has been created for the <see cref="P:System.Web.UI.WebControls.WebControl.ControlStyle" /> property; otherwise, <see langword="false" />.</value>
<remarks>To be added.</remarks>
<altmember cref="P:System.Web.UI.WebControls.WebControl.ControlStyle" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="CopyBaseAttributes">
<MemberSignature Language="C#" Value="public void CopyBaseAttributes (System.Web.UI.WebControls.WebControl controlSrc);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void CopyBaseAttributes(class System.Web.UI.WebControls.WebControl controlSrc) cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.CopyBaseAttributes(System.Web.UI.WebControls.WebControl)" />
<MemberSignature Language="VB.NET" Value="Public Sub CopyBaseAttributes (controlSrc As WebControl)" />
<MemberSignature Language="F#" Value="member this.CopyBaseAttributes : System.Web.UI.WebControls.WebControl -> unit" Usage="webControl.CopyBaseAttributes controlSrc" />
<MemberSignature Language="C++ CLI" Value="public:
 void CopyBaseAttributes(System::Web::UI::WebControls::WebControl ^ controlSrc);" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="controlSrc" Type="System.Web.UI.WebControls.WebControl" />
</Parameters>
<Docs>
<param name="controlSrc">A <see cref="T:System.Web.UI.WebControls.WebControl" /> that represents the source control with properties to be copied to the Web server control that this method is called from.</param>
<summary>Copies the properties not encapsulated by the <see cref="P:System.Web.UI.WebControls.WebControl.Style" /> object from the specified Web server control to the Web server control that this method is called from. This method is used primarily by control developers.</summary>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.WebControl.CopyBaseAttributes%2A> method copies the <xref:System.Web.UI.WebControls.WebControl.AccessKey%2A>, <xref:System.Web.UI.WebControls.WebControl.Enabled%2A>, <xref:System.Web.UI.WebControls.WebControl.ToolTip%2A>, <xref:System.Web.UI.WebControls.WebControl.TabIndex%2A>, and <xref:System.Web.UI.WebControls.WebControl.Attributes%2A> properties from the specified Web server control to the Web server control that this method is called from. This is commonly used in cases where a Web server control works by dynamically creating new controls while it is rendering and using the controls. This method is useful in this situation because it copies all properties of Web server controls not encapsulated by the <xref:System.Web.UI.WebControls.Style> object so they can be placed on the outermost control of a tag that is being rendered.
]]></format>
</remarks>
<exception cref="T:System.ArgumentNullException">
<paramref name="controlSrc" /> is <see langword="null" />.</exception>
<altmember cref="P:System.Web.UI.WebControls.WebControl.Style" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="CreateControlStyle">
<MemberSignature Language="C#" Value="protected virtual System.Web.UI.WebControls.Style CreateControlStyle ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class System.Web.UI.WebControls.Style CreateControlStyle() cil managed" />
<MemberSignature Language="DocId" Value="M:System.Web.UI.WebControls.WebControl.CreateControlStyle" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function CreateControlStyle () As Style" />
<MemberSignature Language="F#" Value="abstract member CreateControlStyle : unit -> System.Web.UI.WebControls.Style
override this.CreateControlStyle : unit -> System.Web.UI.WebControls.Style" Usage="webControl.CreateControlStyle " />
<MemberSignature Language="C++ CLI" Value="protected:
 virtual System::Web::UI::WebControls::Style ^ CreateControlStyle();" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Web.UI.WebControls.Style</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Creates the style object that is used internally by the <see cref="T:System.Web.UI.WebControls.WebControl" /> class to implement all style related properties. This method is used primarily by control developers.</summary>
<returns>A <see cref="T:System.Web.UI.WebControls.Style" /> that is used to implement all style-related properties of the control.</returns>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
The <xref:System.Web.UI.WebControls.WebControl.CreateControlStyle%2A> method is used to create the style object that is used internally to implement all style related properties. Derived classes can override this method to create a style that is appropriate to the class. This method is primarily used by control developers.
**Note** Control developers should return a <xref:System.Web.UI.WebControls.Style> that derives from the <xref:System.Web.UI.WebControls.Style> that the base control returns. It cannot be assumed that the <xref:System.Web.UI.WebControls.WebControl.ControlStyle%2A> is of a particular Style type since a derived control may return a different type.
]]></format>
</remarks>
<altmember cref="T:System.Web.UI.WebControls.Style" />
<altmember cref="P:System.Web.UI.WebControls.WebControl.ControlStyle" />
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="CssClass">
<MemberSignature Language="C#" Value="public virtual string CssClass { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string CssClass" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.CssClass" />
<MemberSignature Language="VB.NET" Value="Public Overridable Property CssClass As String" />
<MemberSignature Language="F#" Value="member this.CssClass : string with get, set" Usage="System.Web.UI.WebControls.WebControl.CssClass" />
<MemberSignature Language="C++ CLI" Value="public:
 virtual property System::String ^ CssClass { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>1.0.5000.0</AssemblyVersion>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-1.1">
<AttributeName Language="C#">[System.ComponentModel.Bindable(true)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.Bindable(true)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("")>]</AttributeName>
</Attribute>
<Attribute FrameworkAlternate="netframework-2.0;netframework-3.0;netframework-3.5;netframework-4.0;netframework-4.5;netframework-4.5.1;netframework-4.5.2;netframework-4.6;netframework-4.6.1;netframework-4.6.2;netframework-4.7;netframework-4.7.1;netframework-4.7.2;netframework-4.8;netframework-4.8.1">
<AttributeName Language="C#">[System.Web.UI.CssClassProperty]</AttributeName>
<AttributeName Language="F#">[<System.Web.UI.CssClassProperty>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the Cascading Style Sheet (CSS) class rendered by the Web server control on the client.</summary>
<value>The CSS class rendered by the Web server control on the client. The default is <see cref="F:System.String.Empty" />.</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks
Use the <xref:System.Web.UI.WebControls.WebControl.CssClass%2A> property to specify the CSS class to render on the client for the Web Server control. This property will render on browsers for all controls. It will always be rendered as the class attribute, regardless of the browser.
> [!IMPORTANT]
> This example has a text box that accepts user input, which is a potential security threat. By default, ASP.NET Web pages validate that user input does not include script or HTML elements. For more information, see [Script Exploits Overview](https://docs.microsoft.com/previous-versions/aspnet/w1sw53ds(v=vs.100)).
For example, suppose you have the following Web server control declaration:
```
<asp:TextBox id="TextBox1" ForeColor="Red" CssClass="class1" />
```
The following HTML is rendered on the client for the previous Web server control declaration:
```
<input type=text class="class1" style="ForeColor:red">
```
If you use cascading style sheets (CSS) to customize the appearance of a control, use either inline styles or a separate CSS file, but not both. Using both inline styles and a separate CSS file could cause unexpected results.
> [!NOTE]
> On browsers that do not support CSS, setting the <xref:System.Web.UI.WebControls.WebControl.CssClass%2A> property will have no effect.
## Examples
The following example illustrates how to use the <xref:System.Web.UI.WebControls.WebControl.CssClass%2A> property to change the style of a <xref:System.Web.UI.WebControls.HyperLink> control.
> [!NOTE]
> The following code sample uses the single-file code model and may not work correctly if copied directly into a code-behind file. This code sample must be copied into an empty text file that has an .aspx extension. For more information on the Web Forms code model, see [ASP.NET Web Forms Page Code Model](https://docs.microsoft.com/previous-versions/aspnet/015103yb(v=vs.100)).
:::code language="aspx-csharp" source="~/snippets/csharp/VS_Snippets_WebNet/Classic WebControl.CssClass Example/CS/sourcecs.aspx" id="Snippet1":::
:::code language="aspx-vb" source="~/snippets/visualbasic/VS_Snippets_WebNet/Classic WebControl.CssClass Example/VB/sourcevb.aspx" id="Snippet1":::
:::code language="xml" source="~/snippets/common/VS_Snippets_WebNet/Classic WebControl.CssClass Example/Common/source.xml" id="Snippet1":::
]]></format>
</remarks>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/x3k2ssx2(v=vs.100)">ASP.NET Server Controls and Browser Capabilities</related>
<related type="Article" href="https://docs.microsoft.com/previous-versions/aspnet/zt27tfhy(v=vs.100)">Developing Custom ASP.NET Server Controls</related>
</Docs>
</Member>
<Member MemberName="DisabledCssClass">
<MemberSignature Language="C#" Value="public static string DisabledCssClass { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property string DisabledCssClass" />
<MemberSignature Language="DocId" Value="P:System.Web.UI.WebControls.WebControl.DisabledCssClass" />
<MemberSignature Language="VB.NET" Value="Public Shared Property DisabledCssClass As String" />
<MemberSignature Language="F#" Value="static member DisabledCssClass : string with get, set" Usage="System.Web.UI.WebControls.WebControl.DisabledCssClass" />
<MemberSignature Language="C++ CLI" Value="public:
 static property System::String ^ DisabledCssClass { System::String ^ get(); void set(System::String ^ value); };" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>System.Web</AssemblyName>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="netframework-4.0">
<AttributeName Language="C#">[set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")]</AttributeName>
<AttributeName Language="F#">[<set: System.Runtime.TargetedPatchingOptOut("Performance critical to inline this type of method across NGen image boundaries")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the CSS class to apply to the rendered HTML element when the control is disabled.</summary>
<value>The CSS class that should be applied to the rendered HTML element when the control is disabled. The default value is "aspNetDisabled".</value>
<remarks>
<format type="text/markdown"><![CDATA[
## Remarks