From aec51363e8e24e123ba9bf6ab31039f30926bc68 Mon Sep 17 00:00:00 2001 From: Peter Milchev Date: Tue, 14 Jan 2020 15:33:35 +0200 Subject: [PATCH] docs(common): Add API from R1 2020 Release assemblies --- api/server/Telerik.Web.UI.Drawer/Mini.md | 26 + .../Telerik.Web.UI.Drawer/MiniConverter.md | 41 ++ .../PieSeriesBase.md | 4 + .../Messages.md | 26 + .../MessagesConverter.md | 41 ++ .../Telerik.Web.UI.MultiSelect/Animation.md | 24 + .../AnimationConverter.md | 41 ++ .../Telerik.Web.UI.MultiSelect/Close.md | 24 + .../CloseConverter.md | 41 ++ .../Telerik.Web.UI.MultiSelect/Messages.md | 34 ++ .../MessagesConverter.md | 41 ++ api/server/Telerik.Web.UI.MultiSelect/Open.md | 26 + .../OpenConverter.md | 41 ++ .../Telerik.Web.UI.MultiSelect/Popup.md | 30 ++ .../PopupConverter.md | 41 ++ .../Telerik.Web.UI.MultiSelect/Virtual.md | 30 ++ .../VirtualConverter.md | 41 ++ api/server/Telerik.Web.UI/AreaSeries.md | 4 + api/server/Telerik.Web.UI/BarSeries.md | 4 + api/server/Telerik.Web.UI/BoxPlotSeries.md | 4 + api/server/Telerik.Web.UI/BulletSeries.md | 4 + .../Telerik.Web.UI/CandlestickSeries.md | 4 + api/server/Telerik.Web.UI/DonutSeries.md | 4 + .../Telerik.Web.UI/DrawerClientEvents.md | 38 ++ api/server/Telerik.Web.UI/FunnelSeries.md | 4 + .../Telerik.Web.UI/GridExportSettings.md | 5 + api/server/Telerik.Web.UI/LineSeries.md | 4 + .../Telerik.Web.UI/MultiSelectClientEvents.md | 54 +++ api/server/Telerik.Web.UI/PieSeries.md | 4 + .../Telerik.Web.UI/RadAutoCompleteBox.md | 9 + api/server/Telerik.Web.UI/RadDrawer.md | 238 +++++++++ .../Telerik.Web.UI/RadDrawerConverter.md | 41 ++ api/server/Telerik.Web.UI/RadListBox.md | 4 + .../Telerik.Web.UI/RadMultiColumnComboBox.md | 4 + api/server/Telerik.Web.UI/RadMultiSelect.md | 451 ++++++++++++++++++ .../Telerik.Web.UI/RadMultiSelectConverter.md | 41 ++ .../RadMultiSelectItemEventArgs.md | 22 + ...ultiSelectSelectedIndexChangedEventArgs.md | 34 ++ api/server/Telerik.Web.UI/RadTreeView.md | 4 + api/server/Telerik.Web.UI/RangeBarSeries.md | 4 + .../Telerik.Web.UI/VerticalBoxPlotSeries.md | 4 + .../Telerik.Web.UI/VerticalBulletSeries.md | 4 + api/server/Telerik.Web.UI/WaterfallSeries.md | 4 + 43 files changed, 1549 insertions(+) create mode 100644 api/server/Telerik.Web.UI.Drawer/Mini.md create mode 100644 api/server/Telerik.Web.UI.Drawer/MiniConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/Messages.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/MessagesConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/Animation.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/AnimationConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/Close.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/CloseConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/Messages.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/MessagesConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/Open.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/OpenConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/Popup.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/PopupConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/Virtual.md create mode 100644 api/server/Telerik.Web.UI.MultiSelect/VirtualConverter.md create mode 100644 api/server/Telerik.Web.UI/DrawerClientEvents.md create mode 100644 api/server/Telerik.Web.UI/MultiSelectClientEvents.md create mode 100644 api/server/Telerik.Web.UI/RadDrawer.md create mode 100644 api/server/Telerik.Web.UI/RadDrawerConverter.md create mode 100644 api/server/Telerik.Web.UI/RadMultiSelect.md create mode 100644 api/server/Telerik.Web.UI/RadMultiSelectConverter.md create mode 100644 api/server/Telerik.Web.UI/RadMultiSelectItemEventArgs.md create mode 100644 api/server/Telerik.Web.UI/RadMultiSelectSelectedIndexChangedEventArgs.md diff --git a/api/server/Telerik.Web.UI.Drawer/Mini.md b/api/server/Telerik.Web.UI.Drawer/Mini.md new file mode 100644 index 0000000000..115f70ddca --- /dev/null +++ b/api/server/Telerik.Web.UI.Drawer/Mini.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.Drawer.Mini +page_title: Telerik.Web.UI.Drawer.Mini +description: Telerik.Web.UI.Drawer.Mini +--- + +# Telerik.Web.UI.Drawer.Mini + +Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Drawer.Mini : IDefaultCheck + +## Properties + +### MiniTemplate `String` + +Defines a specific template for the Kendo UI Drawer when in mini mode. + +### Width `Double` + +Defines a specific width for the Kendo UI Drawer when in mini mode. + diff --git a/api/server/Telerik.Web.UI.Drawer/MiniConverter.md b/api/server/Telerik.Web.UI.Drawer/MiniConverter.md new file mode 100644 index 0000000000..24ed7a6496 --- /dev/null +++ b/api/server/Telerik.Web.UI.Drawer/MiniConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Drawer.MiniConverter +page_title: Telerik.Web.UI.Drawer.MiniConverter +description: Telerik.Web.UI.Drawer.MiniConverter +--- + +# Telerik.Web.UI.Drawer.MiniConverter + +Serialization JS converter class for Mini + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Drawer.MiniConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Series/PieSeriesBase.md b/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Series/PieSeriesBase.md index ad031eed69..0d3631c9a3 100644 --- a/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Series/PieSeriesBase.md +++ b/api/server/Telerik.Web.UI.HtmlChart.PlotArea.Series/PieSeriesBase.md @@ -76,6 +76,10 @@ Get/Set the name of the series The data field holding names of the sectors +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `PieSeriesItemCollection` Creates a collection with specific series items for the current series type diff --git a/api/server/Telerik.Web.UI.MultiColumnComboBox/Messages.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/Messages.md new file mode 100644 index 0000000000..e0721002a2 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/Messages.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.Messages +page_title: Telerik.Web.UI.MultiColumnComboBox.Messages +description: Telerik.Web.UI.MultiColumnComboBox.Messages +--- + +# Telerik.Web.UI.MultiColumnComboBox.Messages + +The text messages displayed in the widget. Use this option to customize or localize the messages. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiColumnComboBox.Messages : IDefaultCheck + +## Properties + +### Clear `String` + +The text message when hovering the input clear button. + +### NoData `String` + +The text message shown in the noDataTemplate when no data is available in the widget drop-down. + diff --git a/api/server/Telerik.Web.UI.MultiColumnComboBox/MessagesConverter.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/MessagesConverter.md new file mode 100644 index 0000000000..78aa68d861 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/MessagesConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.MessagesConverter +page_title: Telerik.Web.UI.MultiColumnComboBox.MessagesConverter +description: Telerik.Web.UI.MultiColumnComboBox.MessagesConverter +--- + +# Telerik.Web.UI.MultiColumnComboBox.MessagesConverter + +Serialization JS converter class for Messages + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBox.MessagesConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.MultiSelect/Animation.md b/api/server/Telerik.Web.UI.MultiSelect/Animation.md new file mode 100644 index 0000000000..d1ab855f31 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/Animation.md @@ -0,0 +1,24 @@ +--- +title: Telerik.Web.UI.MultiSelect.Animation +page_title: Telerik.Web.UI.MultiSelect.Animation +description: Telerik.Web.UI.MultiSelect.Animation +--- + +# Telerik.Web.UI.MultiSelect.Animation + +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. is not a valid configuration. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelect.Animation : IDefaultCheck + +## Properties + +### CloseSettings `Close` + +### OpenSettings `Open` + +The animation played when the suggestion popup is opened. + diff --git a/api/server/Telerik.Web.UI.MultiSelect/AnimationConverter.md b/api/server/Telerik.Web.UI.MultiSelect/AnimationConverter.md new file mode 100644 index 0000000000..b059ad13f7 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/AnimationConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiSelect.AnimationConverter +page_title: Telerik.Web.UI.MultiSelect.AnimationConverter +description: Telerik.Web.UI.MultiSelect.AnimationConverter +--- + +# Telerik.Web.UI.MultiSelect.AnimationConverter + +Serialization JS converter class for Animation + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiSelect.AnimationConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.MultiSelect/Close.md b/api/server/Telerik.Web.UI.MultiSelect/Close.md new file mode 100644 index 0000000000..d447c0e29a --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/Close.md @@ -0,0 +1,24 @@ +--- +title: Telerik.Web.UI.MultiSelect.Close +page_title: Telerik.Web.UI.MultiSelect.Close +description: Telerik.Web.UI.MultiSelect.Close +--- + +# Telerik.Web.UI.MultiSelect.Close + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelect.Close : IDefaultCheck + +## Properties + +### Duration `Double` + +The duration of the close animation in milliseconds. + +### Effects `String` + +The effect(s) to use when playing the close animation. Multiple effects should be separated with a space.Complete list of available animations + diff --git a/api/server/Telerik.Web.UI.MultiSelect/CloseConverter.md b/api/server/Telerik.Web.UI.MultiSelect/CloseConverter.md new file mode 100644 index 0000000000..d10022a778 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/CloseConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiSelect.CloseConverter +page_title: Telerik.Web.UI.MultiSelect.CloseConverter +description: Telerik.Web.UI.MultiSelect.CloseConverter +--- + +# Telerik.Web.UI.MultiSelect.CloseConverter + +Serialization JS converter class for Close + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiSelect.CloseConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.MultiSelect/Messages.md b/api/server/Telerik.Web.UI.MultiSelect/Messages.md new file mode 100644 index 0000000000..431936cd27 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/Messages.md @@ -0,0 +1,34 @@ +--- +title: Telerik.Web.UI.MultiSelect.Messages +page_title: Telerik.Web.UI.MultiSelect.Messages +description: Telerik.Web.UI.MultiSelect.Messages +--- + +# Telerik.Web.UI.MultiSelect.Messages + +The text messages displayed in the widget. Use this option to customize or localize the messages. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelect.Messages : IDefaultCheck + +## Properties + +### Clear `String` + +The text message when hovering the input clear button. + +### DeleteTag `String` + +The text message shown when hovering delete icon in a selected tag. + +### NoData `String` + +The text message shown in the noDataTemplate when no data is available in the widget drop-down. + +### SingleTag `String` + +The text message shown in the single TagMode tag. + diff --git a/api/server/Telerik.Web.UI.MultiSelect/MessagesConverter.md b/api/server/Telerik.Web.UI.MultiSelect/MessagesConverter.md new file mode 100644 index 0000000000..d83bb73c71 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/MessagesConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiSelect.MessagesConverter +page_title: Telerik.Web.UI.MultiSelect.MessagesConverter +description: Telerik.Web.UI.MultiSelect.MessagesConverter +--- + +# Telerik.Web.UI.MultiSelect.MessagesConverter + +Serialization JS converter class for Messages + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiSelect.MessagesConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.MultiSelect/Open.md b/api/server/Telerik.Web.UI.MultiSelect/Open.md new file mode 100644 index 0000000000..a48890fc7a --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/Open.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.MultiSelect.Open +page_title: Telerik.Web.UI.MultiSelect.Open +description: Telerik.Web.UI.MultiSelect.Open +--- + +# Telerik.Web.UI.MultiSelect.Open + +The animation played when the suggestion popup is opened. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelect.Open : IDefaultCheck + +## Properties + +### Duration `Double` + +The duration of the open animation in milliseconds. + +### Effects `String` + +The effect(s) to use when playing the open animation. Multiple effects should be separated with a space.Complete list of available animations + diff --git a/api/server/Telerik.Web.UI.MultiSelect/OpenConverter.md b/api/server/Telerik.Web.UI.MultiSelect/OpenConverter.md new file mode 100644 index 0000000000..d256138ee0 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/OpenConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiSelect.OpenConverter +page_title: Telerik.Web.UI.MultiSelect.OpenConverter +description: Telerik.Web.UI.MultiSelect.OpenConverter +--- + +# Telerik.Web.UI.MultiSelect.OpenConverter + +Serialization JS converter class for Open + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiSelect.OpenConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.MultiSelect/Popup.md b/api/server/Telerik.Web.UI.MultiSelect/Popup.md new file mode 100644 index 0000000000..1700ca1f9a --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/Popup.md @@ -0,0 +1,30 @@ +--- +title: Telerik.Web.UI.MultiSelect.Popup +page_title: Telerik.Web.UI.MultiSelect.Popup +description: Telerik.Web.UI.MultiSelect.Popup +--- + +# Telerik.Web.UI.MultiSelect.Popup + +The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelect.Popup : IDefaultCheck + +## Properties + +### AppendTo `String` + +Defines a jQuery selector that will be used to find a container element, where the popup will be appended to. + +### Origin `String` + +Specifies how to position the popup element based on anchor point. The value is space separated "y" plus "x" position.The available "y" positions are: - "bottom" - "center" - "top"The available "x" positions are: - "left" - "center" - "right" + +### Position `String` + +Specifies which point of the popup element to attach to the anchor's origin point. The value is space separated "y" plus "x" position.The available "y" positions are: - "bottom" - "center" - "top"The available "x" positions are: - "left" - "center" - "right" + diff --git a/api/server/Telerik.Web.UI.MultiSelect/PopupConverter.md b/api/server/Telerik.Web.UI.MultiSelect/PopupConverter.md new file mode 100644 index 0000000000..e97f1db462 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/PopupConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiSelect.PopupConverter +page_title: Telerik.Web.UI.MultiSelect.PopupConverter +description: Telerik.Web.UI.MultiSelect.PopupConverter +--- + +# Telerik.Web.UI.MultiSelect.PopupConverter + +Serialization JS converter class for Popup + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiSelect.PopupConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI.MultiSelect/Virtual.md b/api/server/Telerik.Web.UI.MultiSelect/Virtual.md new file mode 100644 index 0000000000..7d5691f456 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/Virtual.md @@ -0,0 +1,30 @@ +--- +title: Telerik.Web.UI.MultiSelect.Virtual +page_title: Telerik.Web.UI.MultiSelect.Virtual +description: Telerik.Web.UI.MultiSelect.Virtual +--- + +# Telerik.Web.UI.MultiSelect.Virtual + +Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelect.Virtual : IDefaultCheck + +## Properties + +### ItemHeight `Double` + +Specifies the height of the virtual item. All items in the virtualized list must have the same height. If the developer does not specify one, the framework will automatically set itemHeight based on the current theme and font size. + +### MapValueTo `String` + +The changes introduced with the Kendo UI R3 2016 release enable you to determine if the valueMapper must resolve a value to an index or a value to a dataItem. This is configured through the mapValueTo option that accepts two possible values - "index" or "dataItem". By default, the mapValueTo is set to "index", which does not affect the current behavior of the virtualization process.For more information, refer to the article on virtualization. + +### ValueMapper `String` + +The widget calls the valueMapper function when the widget receives a value, that is not fetched from the remote server yet. The widget will pass the selected value(s) in the valueMapper function. In turn, the valueMapper implementation should return the respective data item(s) index/indices. > Important > > As of the Kendo UI R3 2016 release, the implementation of the valueMapper function is optional. It is required only if the widget contains an initial value or if the value method is used. + diff --git a/api/server/Telerik.Web.UI.MultiSelect/VirtualConverter.md b/api/server/Telerik.Web.UI.MultiSelect/VirtualConverter.md new file mode 100644 index 0000000000..e690f6f1d0 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiSelect/VirtualConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiSelect.VirtualConverter +page_title: Telerik.Web.UI.MultiSelect.VirtualConverter +description: Telerik.Web.UI.MultiSelect.VirtualConverter +--- + +# Telerik.Web.UI.MultiSelect.VirtualConverter + +Serialization JS converter class for Virtual + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiSelect.VirtualConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI/AreaSeries.md b/api/server/Telerik.Web.UI/AreaSeries.md index 0eee5ce3b5..5f8292035a 100644 --- a/api/server/Telerik.Web.UI/AreaSeries.md +++ b/api/server/Telerik.Web.UI/AreaSeries.md @@ -86,6 +86,10 @@ Get/Set missing values behavior Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `CategorySeriesItemCollection` Creates a collection with specific series items for the current series type diff --git a/api/server/Telerik.Web.UI/BarSeries.md b/api/server/Telerik.Web.UI/BarSeries.md index d4ad51a3bf..1ebd967b5c 100644 --- a/api/server/Telerik.Web.UI/BarSeries.md +++ b/api/server/Telerik.Web.UI/BarSeries.md @@ -76,6 +76,10 @@ Defines the appearance settings of the series labels Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `CategorySeriesItemCollection` Creates a collection of category series items. diff --git a/api/server/Telerik.Web.UI/BoxPlotSeries.md b/api/server/Telerik.Web.UI/BoxPlotSeries.md index c922271fe0..0c7eba2c7f 100644 --- a/api/server/Telerik.Web.UI/BoxPlotSeries.md +++ b/api/server/Telerik.Web.UI/BoxPlotSeries.md @@ -96,6 +96,10 @@ The Items collection is Obsolete. Use the SeriesItems collection to programmatic Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### OutliersAppearance `OutliersAppearance` Defines the appearance settings of the outliers. diff --git a/api/server/Telerik.Web.UI/BulletSeries.md b/api/server/Telerik.Web.UI/BulletSeries.md index f3abeeb41c..e6a152d0a3 100644 --- a/api/server/Telerik.Web.UI/BulletSeries.md +++ b/api/server/Telerik.Web.UI/BulletSeries.md @@ -72,6 +72,10 @@ The Items collection is Obsolete. Use the SeriesItems collection to programmatic Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `BulletSeriesItemCollection` The collection of series items for the Bullet series diff --git a/api/server/Telerik.Web.UI/CandlestickSeries.md b/api/server/Telerik.Web.UI/CandlestickSeries.md index 059d68cb1b..c5db2879f6 100644 --- a/api/server/Telerik.Web.UI/CandlestickSeries.md +++ b/api/server/Telerik.Web.UI/CandlestickSeries.md @@ -92,6 +92,10 @@ The Items collection is Obsolete. Use the SeriesItems collection to programmatic Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `CandlestickSeriesItemCollection` Creates a collection of candlestick series items. diff --git a/api/server/Telerik.Web.UI/DonutSeries.md b/api/server/Telerik.Web.UI/DonutSeries.md index 3890b27392..64a44ba1c2 100644 --- a/api/server/Telerik.Web.UI/DonutSeries.md +++ b/api/server/Telerik.Web.UI/DonutSeries.md @@ -85,6 +85,10 @@ Get/Set the name of the series The data field holding names of the sectors +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `PieSeriesItemCollection` Creates a collection with specific series items for the current series type diff --git a/api/server/Telerik.Web.UI/DrawerClientEvents.md b/api/server/Telerik.Web.UI/DrawerClientEvents.md new file mode 100644 index 0000000000..cbfaafd2e8 --- /dev/null +++ b/api/server/Telerik.Web.UI/DrawerClientEvents.md @@ -0,0 +1,38 @@ +--- +title: Telerik.Web.UI.DrawerClientEvents +page_title: Telerik.Web.UI.DrawerClientEvents +description: Telerik.Web.UI.DrawerClientEvents +--- + +# Telerik.Web.UI.DrawerClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.DrawerClientEvents : IDefaultCheck + +## Properties + +### OnHide `String` + +Fired when the Kendo UI Drawer is about to be hidden. The event can be prevented by calling the preventDefault method of the event parameter. + +### OnInitialize `String` + +Fired when the multicolumncombobox control is initialized. + +### OnItemClick `String` + +Fires when user clicks on item from the Kendo UI Drawer. + +### OnLoad `String` + +Fired when the multicolumncombobox control is loaded on the page. + +### OnShow `String` + +Fires before the Kendo UI Drawer is revealed. The event can be prevented by calling the preventDefault method of the event parameter. + diff --git a/api/server/Telerik.Web.UI/FunnelSeries.md b/api/server/Telerik.Web.UI/FunnelSeries.md index 8ab07869c7..7c35bcb6e1 100644 --- a/api/server/Telerik.Web.UI/FunnelSeries.md +++ b/api/server/Telerik.Web.UI/FunnelSeries.md @@ -88,6 +88,10 @@ Get/Set the name of the series Get/Set the neck ratio of the funnel's segments +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SegmentSpacing `Nullable`1` Get/Set the spacing between the funnel's segments diff --git a/api/server/Telerik.Web.UI/GridExportSettings.md b/api/server/Telerik.Web.UI/GridExportSettings.md index 63f82d427b..21de1859b2 100644 --- a/api/server/Telerik.Web.UI/GridExportSettings.md +++ b/api/server/Telerik.Web.UI/GridExportSettings.md @@ -34,6 +34,11 @@ A string specifying the name (without the extension) of the file that will be created. The file extension is automatically added based on the method that is used. +### HideNonDataBoundColumns `Boolean` + +Determines whether the Action columns + (Select, Edit, Delete, Button) will be exported. + ### HideStructureColumns `Boolean` Determines whether the structure columns (the row indicator and the expand/collapse columns) will be exported. diff --git a/api/server/Telerik.Web.UI/LineSeries.md b/api/server/Telerik.Web.UI/LineSeries.md index 079143eb34..0b7ac265d2 100644 --- a/api/server/Telerik.Web.UI/LineSeries.md +++ b/api/server/Telerik.Web.UI/LineSeries.md @@ -82,6 +82,10 @@ Get/Set missing values behavior Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `CategorySeriesItemCollection` Creates a collection with specific series items for the current series type diff --git a/api/server/Telerik.Web.UI/MultiSelectClientEvents.md b/api/server/Telerik.Web.UI/MultiSelectClientEvents.md new file mode 100644 index 0000000000..6530693987 --- /dev/null +++ b/api/server/Telerik.Web.UI/MultiSelectClientEvents.md @@ -0,0 +1,54 @@ +--- +title: Telerik.Web.UI.MultiSelectClientEvents +page_title: Telerik.Web.UI.MultiSelectClientEvents +description: Telerik.Web.UI.MultiSelectClientEvents +--- + +# Telerik.Web.UI.MultiSelectClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiSelectClientEvents : IDefaultCheck + +## Properties + +### OnChange `String` + +Fired when the value of the widget is changed by the user.The event handler function context (available via the this keyword) will be set to the widget instance. + +### OnClose `String` + +Fired when the popup of the widget is closed.The event handler function context (available via the this keyword) will be set to the widget instance. + +### OnDataBound `String` + +Fired when the widget is bound to data from its data source.The event handler function context (available via the this keyword) will be set to the widget instance. + +### OnDeselect `String` + +Fired when an item is deselected or tag is removed. + +### OnFiltering `String` + +Fired when the widget is about to filter the data source.The event handler function context (available via the this keyword) will be set to the widget instance. + +### OnInitialize `String` + +Fired when the multicolumncombobox control is initialized. + +### OnLoad `String` + +Fired when the multicolumncombobox control is loaded on the page. + +### OnOpen `String` + +Fired when the popup of the widget is opened by the user.The event handler function context (available via the this keyword) will be set to the widget instance. + +### OnSelect `String` + +Fired when an item from the popup is selected by the user. + diff --git a/api/server/Telerik.Web.UI/PieSeries.md b/api/server/Telerik.Web.UI/PieSeries.md index 52ac990cc9..16852d08e6 100644 --- a/api/server/Telerik.Web.UI/PieSeries.md +++ b/api/server/Telerik.Web.UI/PieSeries.md @@ -81,6 +81,10 @@ Get/Set the name of the series The data field holding names of the sectors +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `PieSeriesItemCollection` Creates a collection with specific series items for the current series type diff --git a/api/server/Telerik.Web.UI/RadAutoCompleteBox.md b/api/server/Telerik.Web.UI/RadAutoCompleteBox.md index c536032d96..869de02d3a 100644 --- a/api/server/Telerik.Web.UI/RadAutoCompleteBox.md +++ b/api/server/Telerik.Web.UI/RadAutoCompleteBox.md @@ -331,6 +331,15 @@ Specifies the rendering mode of the control. Setting the mode to Lightweight wil Lightweight rendering mode might change the outlook of the component in some older browsers that don't support CSS3/HTML5. +### RequestDelay `Int32` + +Specifies the timeout after each keypress before RadAutoCompleteBox + fires a request to get its data from web service or server-side. + +#### Remarks +In miliseconds. RequestDelay = 500 is equal to half a + second delay. + ### ResolvedRenderMode `RenderMode` Returns resolved RenderMode should the original value was Auto diff --git a/api/server/Telerik.Web.UI/RadDrawer.md b/api/server/Telerik.Web.UI/RadDrawer.md new file mode 100644 index 0000000000..0d93ce01fb --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDrawer.md @@ -0,0 +1,238 @@ +--- +title: Telerik.Web.UI.RadDrawer +page_title: Telerik.Web.UI.RadDrawer +description: Telerik.Web.UI.RadDrawer +--- + +# Telerik.Web.UI.RadDrawer + +## Inheritance Hierarchy + +* System.Object +* System.Web.UI.Control +* System.Web.UI.WebControls.WebControl +* Telerik.Web.UI.RadWebControl : IControl, IControlResolver, IPostBackDataHandler, IScriptControl, ISkinnableControl +* Telerik.Web.UI.RadDrawer : INamingContainer + +## Properties + +### ClientEvents `DrawerClientEvents` + +Defines the client events handlers. + +### ClientIDMode `ClientIDMode` + +This property is overridden in order to support controls which implement INamingContainer. + The default value is changed to "AutoID". + +### ContentContainer `SingleTemplateContainer` + +Gets the control, where the ContentTemplate will be instantiated in. You can add controls programmatically here. + +#### Remarks +You can use this property to programmatically add controls to the content area. + If you add controls to the ContentContainer the NavigateUrl property will be ignored. + +### ContentTemplate `ITemplate` + +Gets or sets the System.Web.UI.ITemplate that contains the controls which will be + placed in the control content area. + +#### Remarks +You cannot set this property twice, or when you added controls to the ContentContainer. If you set + ContentTemplate the NavigateUrl property will be ignored. + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### DrawerWidth `Double` + +Defines a specific width for the Kendo UI Drawer when expanded. + +### EnableAjaxSkinRendering `String` + +Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests + +#### Remarks +If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax. + +### EnableEmbeddedBaseStylesheet `Boolean` + +Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not. + +#### Remarks +If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand. + +### EnableEmbeddedScripts `Boolean` + +Gets or sets the value, indicating whether to render script references to the embedded scripts or not. + +#### Remarks +If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand. + +### EnableEmbeddedSkins `String` + +Gets or sets the value, indicating whether to render links to the embedded skins or not. + +#### Remarks +If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand. + +### EnableRippleEffect `Boolean` + +Returns true if ripple effect should be added + +### IsSkinSet `String` + +For internal use. + +### ItemsTemplate `String` + +Specifies the drawer's content. + +### MinHeight `Double` + +Specifies the minimum height for the drawer in push mode. The overlay mode takes 100% of the page height. + +### Mini `Boolean` + +Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template. + +### MiniSettings `Boolean` + +Enables or configures the mini mode for the Kendo UI Drawer. This is a compact view that is displayed when the Kendo UI Drawer is collapsed. Usually it used to show only the icons when the drawer content contains icon and text for an item. When set to true it uses the main template. + +### Mode `DrawerModeType` + +Determines how the Kendo UI Drawer will interact with the associated content. The default one (overlay) will simply overlap the associated content with overlay effect. On the other hand "push" mode will show the drawer next to associated cotent. The associated content will shrink its content. + +### Position `DrawerPositionType` + +The position of the drawer. Can be left (default) or right. + +### RegisterWithScriptManager `Boolean` + +Gets or sets the value, indicating whether to register with the ScriptManager control on the page. + +#### Remarks +If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods. + +### RenderMode `RenderMode` + +Specifies the rendering mode of the control. Setting the mode to Lightweight will yield + HTML 5/CSS 3 html and css. + +#### Remarks +Lightweight rendering mode might change the outlook of the component in some older browsers + that don't support CSS3/HTML5. + +### ResolvedRenderMode `RenderMode` + +Returns resolved RenderMode should the original value was Auto + +### RuntimeSkin `String` + +Gets the real skin name for the control user interface. If Skin is not set, returns + "Default", otherwise returns Skin. + +### ShowBorders `Boolean` + +Gets or sets a value indicating whether the outer borders will be displayed. + +### Skin `String` + +Gets or sets the skin name for the control user interface. + +#### Remarks +If this property is not set, the control will render using the skin named "Default". + If EnableEmbeddedSkins is set to false, the control will not render skin. + +### SwipeToOpen `Boolean` + +If set to false, swiping the associated content will not activate the drawer. In this case, the drawer will only be open by calling the show method. should be disabled for browsers, which use side swiping gestures for back/forward navigation, such as iOS Safari. Otherwise, users should swipe from an inner part of the view, and not from the view edge. + +## Methods + +### ApplyConditionalRendering + +Use this from RenderContents of the inheritor + +#### Returns + +`System.Void` + +### ControlPreRender + +Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason + +#### Returns + +`System.Void` + +### GetEmbeddedSkinNames + +Returns the names of all embedded skins. Used by Telerik.Web.Examples. + +#### Returns + +`System.Collections.Generic.List`1` + +### LoadClientState + +Loads the client state data + +#### Parameters + +#### clientState `System.Collections.Generic.Dictionary{System.String,System.Object}` + +#### Returns + +`System.Void` + +### LoadPostData + +Executed when post data is loaded from the request + +#### Parameters + +#### postDataKey `System.String` + +#### postCollection `System.Collections.Specialized.NameValueCollection` + +#### Returns + +`System.Boolean` + +### RaisePostDataChangedEvent + +Executed when post data changes should invoke a changed event + +#### Returns + +`System.Void` + +### RegisterCssReferences + +Registers the CSS references + +#### Returns + +`System.Void` + +### RegisterScriptControl + +Registers the control with the ScriptManager + +#### Returns + +`System.Void` + +### SaveClientState + +Saves the client state data + +#### Returns + +`System.String` + diff --git a/api/server/Telerik.Web.UI/RadDrawerConverter.md b/api/server/Telerik.Web.UI/RadDrawerConverter.md new file mode 100644 index 0000000000..767d3e6661 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDrawerConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadDrawerConverter +page_title: Telerik.Web.UI.RadDrawerConverter +description: Telerik.Web.UI.RadDrawerConverter +--- + +# Telerik.Web.UI.RadDrawerConverter + +Serialization JS converter class for RadDrawer + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadDrawerConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI/RadListBox.md b/api/server/Telerik.Web.UI/RadListBox.md index a6fb0bc830..e6b41a6778 100644 --- a/api/server/Telerik.Web.UI/RadListBox.md +++ b/api/server/Telerik.Web.UI/RadListBox.md @@ -527,6 +527,10 @@ Automatically sorts items alphabetically (based on the Text Gets/sets whether the sorting will be case-sensitive or not. By default is set to true. +### SupportsDisabledAttribute `Boolean` + +For internal use. + ### TransferMode `ListBoxTransferMode` Gets or sets the transfer mode used for transfer operations. diff --git a/api/server/Telerik.Web.UI/RadMultiColumnComboBox.md b/api/server/Telerik.Web.UI/RadMultiColumnComboBox.md index d705c9603b..b267000f81 100644 --- a/api/server/Telerik.Web.UI/RadMultiColumnComboBox.md +++ b/api/server/Telerik.Web.UI/RadMultiColumnComboBox.md @@ -211,6 +211,10 @@ The index of the initially selected item. The index is 0 based. For internal use. +### MessagesSettings `Messages` + +The text messages displayed in the widget. Use this option to customize or localize the messages. + ### MinLength `Double` The minimum number of characters the user must type before a search is performed. Set to higher value than 1 if the search could match a lot of items. diff --git a/api/server/Telerik.Web.UI/RadMultiSelect.md b/api/server/Telerik.Web.UI/RadMultiSelect.md new file mode 100644 index 0000000000..116cf36d40 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadMultiSelect.md @@ -0,0 +1,451 @@ +--- +title: Telerik.Web.UI.RadMultiSelect +page_title: Telerik.Web.UI.RadMultiSelect +description: Telerik.Web.UI.RadMultiSelect +--- + +# Telerik.Web.UI.RadMultiSelect + +## Inheritance Hierarchy + +* System.Object +* System.Web.UI.Control +* System.Web.UI.WebControls.WebControl +* System.Web.UI.WebControls.BaseDataBoundControl +* System.Web.UI.WebControls.DataBoundControl +* Telerik.Web.UI.RadDataBoundControl : IControl, IControlResolver, IFeatureGroup, IPostBackDataHandler, IScriptControl, ISkinnableControl +* Telerik.Web.UI.RadMultiSelect : INamingContainer + +## Properties + +### Animation `Boolean` + +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. is not a valid configuration. + +### AnimationSettings `Boolean` + +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. is not a valid configuration. + +### AutoBind `Boolean` + +Controls whether to bind the widget to the data source on initialization + +### AutoClose `Boolean` + +Controls whether to close the widget suggestion list on item selection. + +### AutoPostBack `Boolean` + +Gets or sets a value indicating whether a postback to the server automatically + occurs when the user changes the RadComboBox selection. + +#### Remarks +Set this property to true if the server needs to capture the selection + as soon as it is made. For example, other controls on the Web page can be + 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 + the Web page based on a user's selection from a list.The value of this property is stored in view state. + The server-side event that is fired is + SelectedIndexChanged. + +### AutoWidth `Boolean` + +If set to true, the widget automatically adjusts the width of the popup element and does not wrap up the item label. + +### CascadeFrom `String` + +Use it to set the Id of the parent MultiSelect widget.Help topic showing how cascading functionality works + +### CascadeFromField `String` + +Defines the field to be used to filter the data source. If not defined the parent's dataValueField option will be used.Help topic showing how cascading functionality works + +### CascadeFromParentField `String` + +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. + +### CausesValidation `Boolean` + +Gets or sets a value indicating whether validation is performed when an item within + the control is selected. + +#### Remarks +By default, page validation is performed when an item is selected. Page + validation determines whether the input controls associated with a validation + control on the page all pass the validation rules specified by the validation + control. You can specify or determine whether validation is performed on both the + client and the server when an item is clicked by using the CausesValidation + property. To prevent validation from being performed, set the + CausesValidation property to false. + +### ClearButton `Boolean` + +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. + +### ClientDataSourceID `String` + +Gets or sets ID of ClientDataSource control that is used for client side binding + +### ClientEvents `MultiSelectClientEvents` + +Defines the client events handlers. + +### ClientIDMode `ClientIDMode` + +This property is overridden in order to support controls which implement INamingContainer. + The default value is changed to "AutoID". + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### DataKeyNames `String[]` + +Gets or sets an array of data-field names that will be used to populate the MultiSelect's DataItem property which is used to populated the control's template. The field declared in the Columns are added by default. + +#### Remarks +Note: The dataItem's properties declared in the template should be with lower case. + +### DataTextField `String` + +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. + +### DataValueField `String` + +The field of the data item that provides the value of the widget. + +### Delay `Double` + +Specifies the delay in milliseconds after which the MultiSelect will start filtering dataSource. + +### DropDownHeight `Unit` + +The height of the suggestion popup in pixels. The default value is 200 pixels. + +### Enable `Boolean` + +If set to false the widget will be disabled and will not allow user input. The widget is enabled by default and allows user input. + +### EnableAjaxSkinRendering `String` + +Gets or sets the value, indicating whether to render the skin CSS files during Ajax requests + +#### Remarks +If EnableAjaxSkinRendering is set to false you will have to register the needed control base CSS file by hand when adding/showing the control with Ajax. + +### EnableEmbeddedBaseStylesheet `Boolean` + +Gets or sets the value, indicating whether to render the link to the embedded base stylesheet of the control or not. + +#### Remarks +If EnableEmbeddedBaseStylesheet is set to false you will have to register the needed control base CSS file by hand. + +### EnableEmbeddedScripts `Boolean` + +Gets or sets the value, indicating whether to render script references to the embedded scripts or not. + +#### Remarks +If EnableEmbeddedScripts is set to false you will have to register the needed Scripts files by hand. + +### EnableEmbeddedSkins `String` + +Gets or sets the value, indicating whether to render links to the embedded skins or not. + +#### Remarks +If EnableEmbeddedSkins is set to false you will have to register the needed CSS files by hand. + +### EnableRippleEffect `Boolean` + +Returns true if ripple effect should be added + +### EnforceMinLength `Boolean` + +If set to true the widget will not show all items when the text of the search input cleared. By default the widget shows all items when the text of the search input is cleared. Works in conjunction with minLength. + +### Filter `RadMultiSelectFilter` + +The filtering method used to determine the suggestions for the current value. Filtration is turned of by default, and can be performed over string values only (either the widget's data has to be an array of strings, or over the field, configured in the dataTextField option). The supported filter values are startswith, endswith and contains. + +### FixedGroupTemplate `String` + +The template used to render the fixed header group. By default the widget displays only the value of the current group. + +### FooterTemplate `String` + +The template used to render the footer template. The footer template receives the widget itself as a part of the data argument. Use the widget fields directly in the template. + +### GroupTemplate `String` + +The template used to render the groups. By default the widget displays only the value of the group. + +### HeaderTemplate `String` + +Specifies a static HTML content, which will be rendered as a header of the popup element. + +### HighlightFirst `Boolean` + +If set to true the first suggestion will be automatically highlighted. + +### IgnoreCase `Boolean` + +If set to false case-sensitive search will be performed to find suggestions. The widget performs case-insensitive searching by default. + +### IsSkinSet `String` + +For internal use. + +### ItemTemplate `String` + +The template used to render the items in the popup list. + +### MaxSelectedItems `Double` + +Defines the limit of the selected items. If set to null widget will not limit number of the selected items. + +### MessagesSettings `Messages` + +The text messages displayed in the widget. Use this option to customize or localize the messages. + +### MinLength `Double` + +The minimum number of characters the user must type before a search is performed. Set to a higher value if the search could match a lot of items. A zero value means that a request will be made as soon as the user focuses the widget. + +### NoDataTemplate `String` + +The template used to render the "no data" template, which will be displayed if no results are found or the underlying data source is empty. The noData template receives the widget itself as a part of the data argument. The template will be evaluated on every widget data bound. + +### ODataDataSourceID `String` + +Gets or sets the ODataDataSource used for data binding. + +### Placeholder `String` + +The hint displayed by the widget when it is empty. Not set by default. + +### PopupSettings `Popup` + +The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation. + +### PostBackUrl `String` + +Gets or sets the URL of the page to post to from the current page when a tab + from the tabstrip is clicked. + +### RegisterWithScriptManager `Boolean` + +Gets or sets the value, indicating whether to register with the ScriptManager control on the page. + +#### Remarks +If RegisterWithScriptManager is set to false the control can be rendered on the page using Web Services or normal callback requests/page methods. + +### RenderMode `RenderMode` + +Specifies the rendering mode of the control. Setting the mode to Lightweight will yield + HTML 5/CSS 3 html and css. If the set value is Auto use ResolvedRenderMode to receive the actual RenderMode + with respect to the user angent of the current request. + +#### Remarks +Lightweight rendering mode might change the outlook of the component in some older browsers + that don't support CSS3/HTML5. + +### ResolvedRenderMode `RenderMode` + +Returns resolved RenderMode should the original value was Auto + +### RuntimeSkin `String` + +Gets the real skin name for the control user interface. If Skin is not set, returns + "Default", otherwise returns Skin. + +### Skin `String` + +Gets or sets the skin name for the control user interface. + +#### Remarks +If this property is not set, the control will render using the skin named "Default". + If EnableEmbeddedSkins is set to false, the control will not render skin. + +### TagMode `RadMultiSelectTagMode` + +The mode used to render the selected tags. The available modes are: - multiple - renders a tag for every selected value - single - renders only one tag that shows the number of the selected values + +### TagTemplate `String` + +The template used to render the tags. + +### UniqueID `String` + +Gets the unique, hierarchically qualified identifier for the server + control. + +### ValidationGroup `String` + +Gets or sets the name of the validation group to which this validation + control belongs. + +#### Remarks +This property works only when CausesValidation + is set to true. + +### Value `IEnumerable`1` + +The value of the widget. + +### ValuePrimitive `Boolean` + +Specifies the value binding behavior for the widget. If set to true, the View-Model field will be updated with the selected item value field. If set to false, the View-Model field will be updated with the selected item. + +### Virtual `Boolean` + +Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization. + +### VirtualSettings `Boolean` + +Enables the virtualization feature of the widget. The configuration can be set on an object, which contains two properties - itemHeight and valueMapper.For detailed information, refer to the article on virtualization. + +### WebServiceClientDataSource `WebServiceClientDataSource` + +Gets the RadClientDataSource instance of the MultiSelect control. + +## Methods + +### ApplyConditionalRendering + +Use this from RenderContents of the inheritor + +#### Returns + +`System.Void` + +### ControlPreRender + +Code moved into this method from OnPreRender to make sure it executed when the framework skips OnPreRender() for some reason + +#### Returns + +`System.Void` + +### DescribeRenderingMode + +Should be used by inheritors + +#### Returns + +`System.Void` + +### GetEmbeddedSkinNames + +Returns the names of all embedded skins. Used by Telerik.Web.Examples. + +#### Returns + +`System.Collections.Generic.List`1` + +### LoadClientState + +Loads the client state data + +#### Parameters + +#### clientState `System.Collections.Generic.Dictionary{System.String,System.Object}` + +#### Returns + +`System.Void` + +### LoadPostData + +Loads the posted content of the list control, if it is different from the last posting. + +#### Parameters + +#### postDataKey `System.String` + +The key identifier for the control, used to index the postCollection. + +#### postCollection `System.Collections.Specialized.NameValueCollection` + +A that contains value information indexed by control identifiers. + +#### Returns + +`System.Boolean` true if the posted content is different from the last posting; otherwise, false. + +### LoadPostData + +Executed when post data is loaded from the request + +#### Parameters + +#### postDataKey `System.String` + +#### postCollection `System.Collections.Specialized.NameValueCollection` + +#### Returns + +`System.Boolean` + +### OnItemDeselected + +Raises the OnItemDeselected event. This allows you to handle the event directly. + +#### Returns + +`System.Void` + +### OnItemSelected + +Raises the OnItemSelected event. This allows you to handle the event directly. + +#### Returns + +`System.Void` + +### OnSelectionChanged + +Raises the OnItemSelected event. This allows you to handle the event directly. + +#### Returns + +`System.Void` + +### RaisePostDataChangedEvent + +Signals the RadMultiSelect control to notify the ASP.NET application that the state of the control has changed. + +#### Returns + +`System.Void` + +### RaisePostDataChangedEvent + +Executed when post data changes should invoke a changed event + +#### Returns + +`System.Void` + +### RegisterCssReferences + +Registers the CSS references + +#### Returns + +`System.Void` + +### RegisterScriptControl + +Registers the control with the ScriptManager + +#### Returns + +`System.Void` + +### SaveClientState + +Saves the client state data + +#### Returns + +`System.String` + diff --git a/api/server/Telerik.Web.UI/RadMultiSelectConverter.md b/api/server/Telerik.Web.UI/RadMultiSelectConverter.md new file mode 100644 index 0000000000..66a04741b2 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadMultiSelectConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadMultiSelectConverter +page_title: Telerik.Web.UI.RadMultiSelectConverter +description: Telerik.Web.UI.RadMultiSelectConverter +--- + +# Telerik.Web.UI.RadMultiSelectConverter + +Serialization JS converter class for RadMultiSelect + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadMultiSelectConverter + +## Methods + +### AddScript + +Serialize the value as a script, not a string. Should be used alongside with + +#### Parameters + +#### state `System.Collections.Generic.IDictionary{System.String,System.Object}` + +The state collection for the values + +#### key `System.String` + +The key in the JSON object + +#### value `System.Object` + +The value in the JSON obejct + +#### Returns + +`System.Void` + diff --git a/api/server/Telerik.Web.UI/RadMultiSelectItemEventArgs.md b/api/server/Telerik.Web.UI/RadMultiSelectItemEventArgs.md new file mode 100644 index 0000000000..4ea946606e --- /dev/null +++ b/api/server/Telerik.Web.UI/RadMultiSelectItemEventArgs.md @@ -0,0 +1,22 @@ +--- +title: Telerik.Web.UI.RadMultiSelectItemEventArgs +page_title: Telerik.Web.UI.RadMultiSelectItemEventArgs +description: Telerik.Web.UI.RadMultiSelectItemEventArgs +--- + +# Telerik.Web.UI.RadMultiSelectItemEventArgs + +Provides data to the RadComboBoxItem event argument. + +## Inheritance Hierarchy + +* System.Object +* System.EventArgs +* Telerik.Web.UI.RadMultiSelectItemEventArgs + +## Properties + +### Item `MultiSelectItem` + +Gets or sets the RadComboBoxItem. + diff --git a/api/server/Telerik.Web.UI/RadMultiSelectSelectedIndexChangedEventArgs.md b/api/server/Telerik.Web.UI/RadMultiSelectSelectedIndexChangedEventArgs.md new file mode 100644 index 0000000000..eed88e1d1f --- /dev/null +++ b/api/server/Telerik.Web.UI/RadMultiSelectSelectedIndexChangedEventArgs.md @@ -0,0 +1,34 @@ +--- +title: Telerik.Web.UI.RadMultiSelectSelectedIndexChangedEventArgs +page_title: Telerik.Web.UI.RadMultiSelectSelectedIndexChangedEventArgs +description: Telerik.Web.UI.RadMultiSelectSelectedIndexChangedEventArgs +--- + +# Telerik.Web.UI.RadMultiSelectSelectedIndexChangedEventArgs + +Provides data for the RadComboBoxSelectedIndexChanged event of the RadComboBoxcontrol. + +## Inheritance Hierarchy + +* System.Object +* System.EventArgs +* Telerik.Web.UI.RadMultiSelectSelectedIndexChangedEventArgs + +## Properties + +### OldText `String` + +Gets or sets the old text. + +### OldValue `String` + +Gets or sets the old value. + +### Text `String` + +Gets or sets the text. + +### Value `String` + +Gets or sets the value. + diff --git a/api/server/Telerik.Web.UI/RadTreeView.md b/api/server/Telerik.Web.UI/RadTreeView.md index 49e15caf27..c7bdd6b449 100644 --- a/api/server/Telerik.Web.UI/RadTreeView.md +++ b/api/server/Telerik.Web.UI/RadTreeView.md @@ -530,6 +530,10 @@ Gets or sets the skin name for the control user interface. If this property is not set, the control will render using the skin named "Default". If EnableEmbeddedSkins is set to false, the control will not render skin. +### SupportsDisabledAttribute `Boolean` + +For internal use. + ### TriStateCheckBoxes `Boolean` Gets or sets a value indicating whether RadTreeView should display tri-state checkboxes. diff --git a/api/server/Telerik.Web.UI/RangeBarSeries.md b/api/server/Telerik.Web.UI/RangeBarSeries.md index 63ca11415c..a38981abd1 100644 --- a/api/server/Telerik.Web.UI/RangeBarSeries.md +++ b/api/server/Telerik.Web.UI/RangeBarSeries.md @@ -88,6 +88,10 @@ Defines the appearance settings of the series labels Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `RangeSeriesItemCollection` Creates a collection of range series items. diff --git a/api/server/Telerik.Web.UI/VerticalBoxPlotSeries.md b/api/server/Telerik.Web.UI/VerticalBoxPlotSeries.md index ecb3e50549..6fd7b7d653 100644 --- a/api/server/Telerik.Web.UI/VerticalBoxPlotSeries.md +++ b/api/server/Telerik.Web.UI/VerticalBoxPlotSeries.md @@ -97,6 +97,10 @@ The Items collection is Obsolete. Use the SeriesItems collection to programmatic Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### OutliersAppearance `OutliersAppearance` Defines the appearance settings of the outliers. diff --git a/api/server/Telerik.Web.UI/VerticalBulletSeries.md b/api/server/Telerik.Web.UI/VerticalBulletSeries.md index 2cd87214fb..eb40503d08 100644 --- a/api/server/Telerik.Web.UI/VerticalBulletSeries.md +++ b/api/server/Telerik.Web.UI/VerticalBulletSeries.md @@ -73,6 +73,10 @@ The Items collection is Obsolete. Use the SeriesItems collection to programmatic Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `BulletSeriesItemCollection` The collection of series items for the Bullet series diff --git a/api/server/Telerik.Web.UI/WaterfallSeries.md b/api/server/Telerik.Web.UI/WaterfallSeries.md index 8774b10b2d..4e09e17f21 100644 --- a/api/server/Telerik.Web.UI/WaterfallSeries.md +++ b/api/server/Telerik.Web.UI/WaterfallSeries.md @@ -77,6 +77,10 @@ Defines the appearance settings of the series labels Get/Set the name of the series +### Opacity `Decimal` + +The series opacity. By default the series are opaque with default value 1. + ### SeriesItems `WaterfallSeriesItemCollection` Creates a collection of waterfall series items.