Skip to content

Commit a63254b

Browse files
committed
Add RadCheckBoxList documentation
1 parent 444251e commit a63254b

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+2021
-0
lines changed
2.31 KB
Loading
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
---
2+
title: Keyboard Support
3+
page_title: Keyboard Support | RadCheckBoxList for ASP.NET AJAX Documentation
4+
description: Keyboard Support
5+
slug: checkboxlist/accessibility-and-internationalization/keyboard-support
6+
tags: keyboard,support
7+
published: True
8+
position: 2
9+
---
10+
11+
# Keyboard Support
12+
13+
There are several ways to use the **RadCheckBoxList** via the keyboard only:
14+
15+
* Set its **TabIndex** property and use the **Tab** key to navigate to the desired item and then press the **Enter** or **Space** key to select it.
16+
17+
* Set its **AccessKey** property. This allows you to use the browser's shortcut combination to select the first item in the checkboxlist ("Alt + AccessKey" in IE and Chrome, "Shift + Alt + AccessKey" for Firefox, "Shift + Esc + AccessKey" for Opera).
18+
19+
>note Note: By default, tab-access is disabled in Safari. To enable it, check "Preferences > Advanced > Press tab to highlight each item on a page".
20+
21+
## See Also
22+
23+
* [WCAG 2.0 and Section 508 Accessibility Compliance]({%slug checkboxlist/accessibility-and-internationalization/wcag-2.0-and-section-508-accessibility-compliance%})
24+
25+
* [Right-to-Left Support]({%slug checkboxlist/accessibility-and-internationalization/right-to-left-support%})
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
title: Right-to-Left Support
3+
page_title: Right-to-Left Support | RadCheckBoxList for ASP.NET AJAX Documentation
4+
description: Right-to-Left Support
5+
slug: checkboxlist/accessibility-and-internationalization/right-to-left-support
6+
tags: right-to-left,support
7+
published: True
8+
position: 1
9+
---
10+
11+
# Right-to-Left Support
12+
13+
The **RadCheckBoxList** fully supports right-to-left (RTL) language locales (**Figure 1**). In order to turn on the RTL support, you should set **dir=rtl to the html or body** element or at least to its parent element (**Figure 1**). You can also use the **direction:rtl** CSS property.
14+
15+
>caption Figure 1: RadCheckBoxList in RTL mode.
16+
17+
![RadCheckBoxList-rtl](images/checkboxlist-rtl.png)
18+
19+
>caption Example 1: Set the "direction: rtl" style to the **RadCheckBoxList**'s wrapper element in order to enable the RTL support for the control.
20+
21+
````ASP.NET
22+
<div style="direction: rtl">
23+
<telerik:RadCheckBoxList runat="server" ID="RadCheckBoxList1">
24+
<Items>
25+
<telerik:CheckBoxListItem Text="יהודי" Selected="true" />
26+
<telerik:CheckBoxListItem Text="גֶרמָנִיָת" />
27+
<telerik:CheckBoxListItem Text="צָרְפָתִית" />
28+
</Items>
29+
</telerik:RadCheckBoxList>
30+
</div>
31+
````
32+
33+
## See Also
34+
35+
* [WCAG 2.0 and Section 508 Accessibility Compliance]({%slug checkboxlist/accessibility-and-internationalization/wcag-2.0-and-section-508-accessibility-compliance%})
36+
37+
* [Keyboard Support]({%slug checkboxlist/accessibility-and-internationalization/keyboard-support%})
Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
title: WAI-ARIA Support
3+
page_title: WAI-ARIA Support | RadCheckBoxList for ASP.NET AJAX Documentation
4+
description: WAI-ARIA Support
5+
slug: checkboxlist/accessibility-and-internationalization/wai-aria-support
6+
tags: wai-aria,support
7+
published: True
8+
position: 3
9+
---
10+
11+
# WAI-ARIA Support
12+
13+
@[template](/_templates/common/wai-aria-templates.md#intro "control: RadCheckBoxList")
14+
15+
The [WAI-ARIA Suite](http://www.w3.org/WAI/intro/aria) defines an approach to make web content and web applications more accessible to people with disabilities. **RadCheckBoxList** offers WAI-ARIA support.
16+
17+
In order to enable the WAI-ARIA support, set the **RadCheckBoxList** control's `EnableAriaSupport` property to `true` and, optionally, set the inner properties ([DescribedBy](http://www.w3.org/TR/wai-aria/states_and_properties#aria-describedby) and [Label](http://www.w3.org/TR/wai-aria/states_and_properties#aria-label)) of the `AriaSettings` composite tag to the desired values as shown in **Example 1**.
18+
19+
>caption **Example 1**: Enabling WAI-ARIA support for RadCheckBoxList
20+
21+
````ASP.NET
22+
<telerik:RadCheckBoxList runat="server" ID="RadCheckBoxList1" EnableAriaSupport="true">
23+
<Items>
24+
<telerik:CheckBoxListItem Text="English" Selected="true" />
25+
<telerik:CheckBoxListItem Text="German" />
26+
<telerik:CheckBoxListItem Text="French" />
27+
</Items>
28+
</telerik:RadCheckBoxList>
29+
````
30+
31+
>note The implementation of the WAI-ARIA support is achieved entirely on the client side (using JavaScript) by appending different attributes and appropriate WAI-ARIA roles to the DOM elements. This is done because an HTML document containing ARIA attributes will not pass validation if they are added on the server.
32+
33+
34+
35+
36+
## See Also
37+
38+
* [W3C: WAI-ARIA Overview](http://www.w3.org/WAI/intro/aria)
39+
40+
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
title: WCAG 2.0 and Section 508 Accessibility Compliance
3+
page_title: WCAG 2.0 and Section 508 Accessibility Compliance | RadCheckBoxList for ASP.NET AJAX Documentation
4+
description: WCAG 2.0 and Section 508 Accessibility Compliance
5+
slug: checkboxlist/accessibility-and-internationalization/wcag-2.0-and-section-508-accessibility-compliance
6+
tags: wcag,2.0,and,section,508,accessibility,compliance
7+
published: True
8+
position: 0
9+
---
10+
11+
# WCAG 2.0 and Section 508 Accessibility Compliance
12+
13+
The interface of **RadCheckBoxList for ASP.NET AJAX** is level AAA accessible (in compliance with the W3C Web Accessibility Guidelines 2.0) as well as Section 508 compliant. It passes the check of the [WAVE](http://wave.webaim.org/) automated content compliance tool for Section 508 and WCAG 2.0 - Compliance Level AAA.
14+
15+
The control is also visible in Windows High Contrast mode when rendered with Simple skin.
16+
17+
It also offers [Keyboard support]({%slug checkboxlist/accessibility-and-internationalization/keyboard-support%}).
18+
19+
## See Also
20+
21+
* [Section 508](http://www.section508.gov/)
22+
23+
* [Web Content Accessibility Guidelines (WCAG) 2.0](http://www.w3.org/TR/WCAG/)
24+
25+
* [Right-to-Left Support]({%slug checkboxlist/accessibility-and-internationalization/right-to-left-support%})
26+
27+
* [Keyboard Support]({%slug checkboxlist/accessibility-and-internationalization/keyboard-support%})
Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
title: Create a Custom Skin
3+
page_title: Create a Custom Skin | RadCheckBoxList for ASP.NET AJAX Documentation
4+
description: Create a Custom Skin
5+
slug: checkboxlist/appearance-and-styling/create-a-custom-skin
6+
tags: create,a,custom,skin
7+
published: True
8+
position: 1
9+
---
10+
11+
# Create a Custom Skin
12+
13+
Each of the controls included in the **Telerik UI for ASP.NET AJAX** suite is styled with two CSS files that are loaded in a certain order. The first file – **[ControlName].css** , also called base stylesheet, contains CSS properties and values that are common for all skins, i.e., it is layout-specific, not skin-specific. These are CSS float, padding, margin, font-size, font-family, etc. In general, when creating a custom skin for a control, this file should not be edited unless the custom skin needs different sizes, padding and / or margins.
14+
15+
The second file represents the actual skin of the control, and its name consists of the control name plus the skin name, e.g., **Button.Default.css**. Upon creating a custom skin for the control, one should edit that particular file, as it contains skin-specific CSS properties and references to images, colors, borders and backgrounds.
16+
17+
## Create a RadCheckBoxList Skin from an Existing One
18+
19+
1. In your project, create a new directory named **Skins**;
20+
21+
1. In the **Skins** folder if you already have some custom skin, most probably you already have a folder named: **MyCustomSkin** – if you don’t – create one;
22+
23+
1. In the **Skins** folder, create a new folder named: **MyCustomSkinLite** - this is the place where your Lightweight custom skins CSS will be placed;
24+
25+
1. Go to **[ControlsInstallationFolder]\Skins\DefaultLite** and copy **Button.Default.css** into your **MyCustomSkinLite** folder;
26+
27+
1. Go to **[TelerikControlsInstallationFolder]\Skins\Default** and copy the **Common** folder into your **MyCustomSkin** folder;
28+
29+
1. In your your **MyCustomSkinLite** folder, rename **Button.Default.css** to **Button.MyCustomSkin.css**;
30+
31+
1. When you are finished you should have the following folder structure in your project:
32+
33+
1. **Skins/MyCustomSkin/Common/** - containing several sprites;
34+
35+
1. **Skins/MyCustomSkinLite/Button.MyCustomSkin.css**.
36+
37+
1. In order to support multiple skins of **RadCheckBoxList** on a single page, the wrapping skin-specific class is created using the name of the control, plus underscore ("_") plus SkinName, i.e., **.RadButton_Default**, so in order to create a custom skin out of the Default skin, we should rename all occurrences of **"RadButton_Default"** in **Button.MyCustomSkin.css** to **"RadButton_MyCustomSkin"** as shown below:
38+
39+
![Rename Button Light](images/RenameButtonLight.png)
40+
41+
1. Add a new server declaration of **RadCheckBoxList** on your page and set **Skin="MyCustomSkin"** and **EnableEmbeddedSkins="false"**:
42+
43+
**ASP.NET**
44+
45+
<telerik:RadCheckBoxList runat="server" ID="RadCheckBoxList1" Skin="MyCustomSkin" EnableEmbeddedSkins="false">
46+
</telerik:RadCheckBoxList>
47+
48+
1. Register **Button.MyCustomSkin.css** in the head section of your web page. In order to have the CSS applied correctly, the base stylesheet should come first in the DOM:
49+
50+
**ASP.NET**
51+
52+
<link href="Skins/MyCustomSkinLite/Button.MyCustomSkin.css" rel="stylesheet" type="text/css" />
53+
54+
1. Make sure the path to the files is correct; otherwise the skin will not apply;
55+
56+
1. Reload the page, and if the steps 1-11 have been followed correctly, you will see **RadCheckBoxList** running a custom Default skin set as an external resource.
57+
58+
## Custom Skin Example
59+
60+
The example below shows how to modify the CSS in order not only to change some colors and background colors, but also some base layout settings such as font size, element height, border-radius, etc.
61+
62+
````ASP.NET
63+
<!DOCTYPE html>
64+
65+
<html xmlns="http://www.w3.org/1999/xhtml">
66+
<head id="Head1" runat="server">
67+
<title></title>
68+
<style>
69+
/* Checkbox normal state */
70+
html .RadButton_Default.rbCheckBox .rbIcon,
71+
html .RadButton_Default.rbCheckBox .rbText {
72+
color: #80078e;
73+
}
74+
75+
/* Checkbox hovered state */
76+
html .RadButton_Default.rbCheckBox.rbHovered .rbIcon,
77+
html .RadButton_Default.rbCheckBox.rbHovered .rbText {
78+
color: #3a0470;
79+
}
80+
</style>
81+
</head>
82+
<body>
83+
<form id="form1" runat="server">
84+
<asp:ScriptManager ID="ScriptManager1" runat="server"></asp:ScriptManager>
85+
<telerik:RadCheckBoxList runat="server" ID="RadCheckBoxList1" Text="Check here">
86+
</telerik:RadCheckBoxList>
87+
</form>
88+
</body>
89+
</html>
90+
````
91+
92+
## See Also
93+
94+
* [Render Modes]({%slug checkboxlist/mobile-support/render-modes%})
48 KB
Loading
34.8 KB
Loading
91.5 KB
Loading
18.8 KB
Loading

0 commit comments

Comments
 (0)