Skip to content

Commit 6a10f1c

Browse files
docs(common): update server API reference for R2 2019
1 parent 0b8aa78 commit 6a10f1c

13 files changed

+204
-29
lines changed

api/server/Telerik.Web.UI.Export/Utils.md

-28
Original file line numberDiff line numberDiff line change
@@ -101,34 +101,6 @@ BIFF: Convert from VerticalAlign to VerticalAlignment enumerations
101101

102102
`Telerik.Web.UI.ExcelBiff.VerticalAlignment`
103103

104-
### ConvertXlsxBorderStyle
105-
106-
Converts the ASP.NET BorderStyle enumeration values to Excel BorderStyle enumeration values
107-
108-
#### Parameters
109-
110-
#### borderStyle `System.Web.UI.WebControls.BorderStyle`
111-
112-
#### Returns
113-
114-
`Telerik.Windows.Documents.Spreadsheet.Model.CellBorderStyle`
115-
116-
### ConvertXlsxHorizontalAlign
117-
118-
XLSX: Convert from HorizontalAlign to HorizontalAlignment enumerations
119-
120-
#### Returns
121-
122-
`Telerik.Windows.Documents.Spreadsheet.Model.RadHorizontalAlignment`
123-
124-
### ConvertXlsxVerticalAlign
125-
126-
XLSX: Convert from VerticalAlign to VerticalAlignment enumerations
127-
128-
#### Returns
129-
130-
`Telerik.Windows.Documents.Spreadsheet.Model.RadVerticalAlignment`
131-
132104
### FontSizeToPoints
133105

134106
Converts strongly typed relative FontSize unit to points (double)

api/server/Telerik.Web.UI.Grid.Export/TableViewExporter.md

+8
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,14 @@ TableCell object
5353

5454
`System.String` String value
5555

56+
### GenerateXlsxOutput
57+
58+
Generates the text representing the Export Output for Microsoft Excel XSLX format
59+
60+
#### Returns
61+
62+
`System.String`
63+
5664
### GetTemplateColumnHeaderText
5765

5866
CSV-specific method. Extracts the text from the given header item cell

api/server/Telerik.Web.UI/GridTableView.md

+9
Original file line numberDiff line numberDiff line change
@@ -1450,6 +1450,15 @@ The dictionary containing key values..
14501450

14511451
`Telerik.Web.UI.GridDataItem[]`
14521452

1453+
### GenerateXlsxOutput
1454+
1455+
Generates the text representing the Export Output for Microsoft Excel XSLX format using the properties set in the
1456+
ExportSettings.
1457+
1458+
#### Returns
1459+
1460+
`System.String`
1461+
14531462
### GetBatchColumnEditor
14541463

14551464
Returns the column editor for the specified column for EditMode="Batch".

api/server/Telerik.Web.UI/RadButton.md

+4
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,10 @@ Gets or sets an optional parameter passed to the Command event along with the as
5151

5252
Gets or sets the command name associated with the RadButton control that is passed to the Command event.
5353

54+
### ConfirmSettings `RadButtonConfirmSettings`
55+
56+
Gets the object that controls the built-in confirmation dialog properties.
57+
5458
### ContentTemplate `ITemplate`
5559

5660
Gets or sets the template for the RadButton control.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Telerik.Web.UI.RadButtonConfirmSettings
3+
page_title: Telerik.Web.UI.RadButtonConfirmSettings
4+
description: Telerik.Web.UI.RadButtonConfirmSettings
5+
---
6+
7+
# Telerik.Web.UI.RadButtonConfirmSettings
8+
9+
Manages the Confirm Settings of the Button control. Setting value of ConfirmText will cause a confirmation dialog with that text to appear when the button is clicked.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* Telerik.Web.StateManager : IMarkableStateManager, IStateManager
15+
* Telerik.Web.UI.RadButtonConfirmSettings
16+
17+
## Properties
18+
19+
### ConfirmText `String`
20+
21+
Gets or sets the text shown in the confirmation dialog the user receives on click. Setting text to it enables the dialog.
22+
23+
### Height `Int32`
24+
25+
Get or set the height of the RadConfirm dialog in pixels.
26+
27+
### Title `String`
28+
29+
Gets or sets the RadConfirm title.
30+
31+
### UseRadConfirm `Boolean`
32+
33+
Get or set whether to use a RadConfirm instead of the browser confirm. Requiers a RadWindowManager on the page.
34+
35+
### Width `Int32`
36+
37+
Get or set the width of the RadConfirm dialog in pixels.
38+

api/server/Telerik.Web.UI/RadCheckBox.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ RadCheckBox leverages the functionality of the standard checkbox.
1717
* Telerik.Web.UI.ButtonBase.RadButtonBase : INamingContainer
1818
* Telerik.Web.UI.ButtonBase.PostBackButtonBase : IButtonControl, IPostBackEventHandler
1919
* Telerik.Web.UI.ButtonBase.CheckableButton : ICheckableButton
20-
* Telerik.Web.UI.RadCheckBox
20+
* Telerik.Web.UI.RadCheckBox : IJavaScriptConverterProvider
2121

2222
## Properties
2323

@@ -54,6 +54,10 @@ Gets or sets an optional parameter passed to the Command event along with the as
5454

5555
Gets or sets the command name associated with the Button control that is passed to the Command event.
5656

57+
### ConfirmSettings `RadButtonConfirmSettings`
58+
59+
Gets the object that controls the built-in confirmation dialog properties.
60+
5761
### CssClass `String`
5862

5963
Gets or sets the CSS class rendered by the Button control on the client.

api/server/Telerik.Web.UI/RadImageButton.md

+4
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ Gets or sets an optional parameter passed to the Command event along with the as
4949

5050
Gets or sets the command name associated with the Button control that is passed to the Command event.
5151

52+
### ConfirmSettings `RadButtonConfirmSettings`
53+
54+
Gets the object that controls the built-in confirmation dialog properties.
55+
5256
### ContentTemplate `ITemplate`
5357

5458
Gets or sets the template for the Button control.

api/server/Telerik.Web.UI/RadLinkButton.md

+4
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ Gets the object that controls the Wai-Aria settings applied on the control's ele
3232
This property is overridden in order to support controls which implement INamingContainer.
3333
The default value is changed to "AutoID".
3434

35+
### ConfirmSettings `RadButtonConfirmSettings`
36+
37+
Gets the object that controls the built-in confirmation dialog properties.
38+
3539
### ContentTemplate `ITemplate`
3640

3741
Gets or sets the template for the Button control.

api/server/Telerik.Web.UI/RadMultiColumnComboBox.md

+68
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ Gets or sets a value indicating whether the paging in is enabled
2727

2828
Configures the opening and closing animations of the suggestion popup. Setting the animation option to false will disable the opening and closing animations. As a result the suggestion popup will open and close instantly.
2929

30+
### AutoPostBack `Boolean`
31+
32+
Gets or sets a value indicating whether a postback to the server automatically
33+
occurs when the user changes the RadComboBox selection.
34+
35+
#### Remarks
36+
Set this property to true if the server needs to capture the selection
37+
as soon as it is made. For example, other controls on the Web page can be
38+
automatically filled depending on the user's selection from a list control.This property can be used to allow automatic population of other controls on
39+
the Web page based on a user's selection from a list.The value of this property is stored in view state.
40+
The server-side event that is fired is
41+
SelectedIndexChanged.
42+
3043
### CascadeFrom `String`
3144

3245
Use it to set the Id of the parent MultiColumnComboBox widget.Help topic showing how cascading functionality works
@@ -39,6 +52,20 @@ Defines the field to be used to filter the data source. If not defined the paren
3952

4053
Defines the parent field to be used to retain value from. This value will be used further to filter the dataSource. If not defined the value from the parent's dataValueField will be used.
4154

55+
### CausesValidation `Boolean`
56+
57+
Gets or sets a value indicating whether validation is performed when an item within
58+
the control is selected.
59+
60+
#### Remarks
61+
By default, page validation is performed when an item is selected. Page
62+
validation determines whether the input controls associated with a validation
63+
control on the page all pass the validation rules specified by the validation
64+
control. You can specify or determine whether validation is performed on both the
65+
client and the server when an item is clicked by using the CausesValidation
66+
property. To prevent validation from being performed, set the
67+
CausesValidation property to false.
68+
4269
### ClearButton `Boolean`
4370

4471
Unless this options is set to false, a button will appear when hovering the widget. Clicking that button will reset the widget's value and will trigger the change event.
@@ -65,6 +92,13 @@ Defines the columns rendered in the table of the MultiColumnComboBox.
6592
The CssClass property will now be used instead of the former Skin
6693
and will be modified in AddAttributesToRender()
6794

95+
### DataKeyNames `String[]`
96+
97+
Gets or sets an array of data-field names that will be used to populate the MultiColumnComboBox's DataItem property which is used to populated the control's template. The field declared in the Columns are added by default.
98+
99+
#### Remarks
100+
Note: The dataItem's properties declared in the template should be with lower case.
101+
68102
### DataTextField `String`
69103

70104
The field of the data item that provides the text content of the list items. The widget will filter the data source based on this field.
@@ -202,6 +236,11 @@ The hint displayed by the widget when it is empty. Not set by default.
202236

203237
The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation.
204238

239+
### PostBackUrl `String`
240+
241+
Gets or sets the URL of the page to post to from the current page when a tab
242+
from the tabstrip is clicked.
243+
205244
### RegisterWithScriptManager `Boolean`
206245

207246
Gets or sets the value, indicating whether to register with the ScriptManager control on the page.
@@ -228,6 +267,10 @@ Returns resolved RenderMode should the original value was Auto
228267
Gets the real skin name for the control user interface. If Skin is not set, returns
229268
"Default", otherwise returns Skin.
230269

270+
### Schema `ClientDataSourceSchema`
271+
272+
Contains settings about the schema and model of the data used in .
273+
231274
### Skin `String`
232275

233276
Gets or sets the skin name for the control user interface.
@@ -248,6 +291,15 @@ When set to true the widget will automatically set selected value to the typed c
248291

249292
The text of the widget used when the autoBind is set to false.
250293

294+
### ValidationGroup `String`
295+
296+
Gets or sets the name of the validation group to which this validation
297+
control belongs.
298+
299+
#### Remarks
300+
This property works only when CausesValidation
301+
is set to true.
302+
251303
### Value `String`
252304

253305
The value of the widget.
@@ -346,6 +398,22 @@ Executed when post data is loaded from the request
346398

347399
`System.Boolean`
348400

401+
### OnSelectedIndexChanged
402+
403+
Raises the SelectedIndexChanged event. This allows you to handle the event directly.
404+
405+
#### Returns
406+
407+
`System.Void`
408+
409+
### RaisePostDataChangedEvent
410+
411+
Signals the RadComboBox control to notify the ASP.NET application that the state of the control has changed.
412+
413+
#### Returns
414+
415+
`System.Void`
416+
349417
### RaisePostDataChangedEvent
350418

351419
Executed when post data changes should invoke a changed event
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: Telerik.Web.UI.RadMultiColumnComboBoxItemEventArgs
3+
page_title: Telerik.Web.UI.RadMultiColumnComboBoxItemEventArgs
4+
description: Telerik.Web.UI.RadMultiColumnComboBoxItemEventArgs
5+
---
6+
7+
# Telerik.Web.UI.RadMultiColumnComboBoxItemEventArgs
8+
9+
Provides data to the RadComboBoxItem event argument.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* System.EventArgs
15+
* Telerik.Web.UI.RadMultiColumnComboBoxItemEventArgs
16+
17+
## Properties
18+
19+
### Item `MultiColumnComboBoxItem`
20+
21+
Gets or sets the RadComboBoxItem.
22+
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Telerik.Web.UI.RadMultiColumnComboBoxSelectedIndexChangedEventArgs
3+
page_title: Telerik.Web.UI.RadMultiColumnComboBoxSelectedIndexChangedEventArgs
4+
description: Telerik.Web.UI.RadMultiColumnComboBoxSelectedIndexChangedEventArgs
5+
---
6+
7+
# Telerik.Web.UI.RadMultiColumnComboBoxSelectedIndexChangedEventArgs
8+
9+
Provides data for the RadComboBoxSelectedIndexChanged event of the RadComboBoxcontrol.
10+
11+
## Inheritance Hierarchy
12+
13+
* System.Object
14+
* System.EventArgs
15+
* Telerik.Web.UI.RadMultiColumnComboBoxSelectedIndexChangedEventArgs
16+
17+
## Properties
18+
19+
### OldText `String`
20+
21+
Gets or sets the old text.
22+
23+
### OldValue `String`
24+
25+
Gets or sets the old value.
26+
27+
### Text `String`
28+
29+
Gets or sets the text.
30+
31+
### Value `String`
32+
33+
Gets or sets the value.
34+

api/server/Telerik.Web.UI/RadPushButton.md

+4
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ Gets or sets an optional parameter passed to the Command event along with the as
4949

5050
Gets or sets the command name associated with the Button control that is passed to the Command event.
5151

52+
### ConfirmSettings `RadButtonConfirmSettings`
53+
54+
Gets the object that controls the built-in confirmation dialog properties.
55+
5256
### ContentTemplate `ITemplate`
5357

5458
Gets or sets the template for the Button control.

api/server/Telerik.Web.UI/RadToggleButton.md

+4
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@ Gets or sets an optional parameter passed to the Command event along with the as
4949

5050
Gets or sets the command name associated with the Button control that is passed to the Command event.
5151

52+
### ConfirmSettings `RadButtonConfirmSettings`
53+
54+
Gets the object that controls the built-in confirmation dialog properties.
55+
5256
### CssClass `String`
5357

5458
Gets or sets the CSS class rendered by the Button control on the client.

0 commit comments

Comments
 (0)