From e6ddf6e2f2875c469b92b20afe570c49cb83ca9e Mon Sep 17 00:00:00 2001 From: Marin Bratanov Date: Tue, 15 Jan 2019 11:58:57 +0200 Subject: [PATCH] docs(common): update server API reference for R1 2019 --- api/server/Telerik.Web.UI.Chat/Animation.md | 26 ++ .../Telerik.Web.UI.Chat/AnimationConverter.md | 41 ++ api/server/Telerik.Web.UI.Chat/ChatToolbar.md | 38 ++ .../ChatToolbarConverter.md | 41 ++ api/server/Telerik.Web.UI.Chat/Collapse.md | 26 ++ .../Telerik.Web.UI.Chat/CollapseConverter.md | 41 ++ api/server/Telerik.Web.UI.Chat/Expand.md | 26 ++ .../Telerik.Web.UI.Chat/ExpandConverter.md | 41 ++ api/server/Telerik.Web.UI.Chat/Messages.md | 22 + .../Telerik.Web.UI.Chat/MessagesConverter.md | 41 ++ api/server/Telerik.Web.UI.Chat/User.md | 26 ++ .../Telerik.Web.UI.Chat/UserConverter.md | 41 ++ .../Animation.md | 24 ++ .../AnimationConverter.md | 41 ++ .../Close.md | 24 ++ .../CloseConverter.md | 41 ++ .../Open.md | 26 ++ .../OpenConverter.md | 41 ++ .../Popup.md | 30 ++ .../PopupConverter.md | 41 ++ .../Virtual.md | 30 ++ .../VirtualConverter.md | 41 ++ api/server/Telerik.Web.UI/BarSeries.md | 6 - api/server/Telerik.Web.UI/ChatClientEvents.md | 50 +++ .../Telerik.Web.UI/ChatToolbarButton.md | 30 ++ .../ChatToolbarButtonConverter.md | 41 ++ .../MultiColumnComboBoxClientEvents.md | 54 +++ .../MultiColumnComboBoxColumn.md | 38 ++ .../MultiColumnComboBoxColumnConverter.md | 41 ++ api/server/Telerik.Web.UI/RadChat.md | 197 +++++++++ api/server/Telerik.Web.UI/RadChatConverter.md | 41 ++ .../Telerik.Web.UI/RadMultiColumnComboBox.md | 380 ++++++++++++++++++ .../RadMultiColumnComboBoxConverter.md | 41 ++ api/server/Telerik.Web.UI/RadProgressBar.md | 232 +++++++++++ api/server/Telerik.Web.UI/RadTreeList.md | 2 +- api/server/Telerik.Web.UI/RangeBarSeries.md | 6 - api/server/Telerik.Web.UI/WaterfallSeries.md | 6 - 37 files changed, 1895 insertions(+), 19 deletions(-) create mode 100644 api/server/Telerik.Web.UI.Chat/Animation.md create mode 100644 api/server/Telerik.Web.UI.Chat/AnimationConverter.md create mode 100644 api/server/Telerik.Web.UI.Chat/ChatToolbar.md create mode 100644 api/server/Telerik.Web.UI.Chat/ChatToolbarConverter.md create mode 100644 api/server/Telerik.Web.UI.Chat/Collapse.md create mode 100644 api/server/Telerik.Web.UI.Chat/CollapseConverter.md create mode 100644 api/server/Telerik.Web.UI.Chat/Expand.md create mode 100644 api/server/Telerik.Web.UI.Chat/ExpandConverter.md create mode 100644 api/server/Telerik.Web.UI.Chat/Messages.md create mode 100644 api/server/Telerik.Web.UI.Chat/MessagesConverter.md create mode 100644 api/server/Telerik.Web.UI.Chat/User.md create mode 100644 api/server/Telerik.Web.UI.Chat/UserConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/Animation.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/AnimationConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/Close.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/CloseConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/Open.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/OpenConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/Popup.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/PopupConverter.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/Virtual.md create mode 100644 api/server/Telerik.Web.UI.MultiColumnComboBox/VirtualConverter.md create mode 100644 api/server/Telerik.Web.UI/ChatClientEvents.md create mode 100644 api/server/Telerik.Web.UI/ChatToolbarButton.md create mode 100644 api/server/Telerik.Web.UI/ChatToolbarButtonConverter.md create mode 100644 api/server/Telerik.Web.UI/MultiColumnComboBoxClientEvents.md create mode 100644 api/server/Telerik.Web.UI/MultiColumnComboBoxColumn.md create mode 100644 api/server/Telerik.Web.UI/MultiColumnComboBoxColumnConverter.md create mode 100644 api/server/Telerik.Web.UI/RadChat.md create mode 100644 api/server/Telerik.Web.UI/RadChatConverter.md create mode 100644 api/server/Telerik.Web.UI/RadMultiColumnComboBox.md create mode 100644 api/server/Telerik.Web.UI/RadMultiColumnComboBoxConverter.md create mode 100644 api/server/Telerik.Web.UI/RadProgressBar.md diff --git a/api/server/Telerik.Web.UI.Chat/Animation.md b/api/server/Telerik.Web.UI.Chat/Animation.md new file mode 100644 index 0000000000..85be811e04 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/Animation.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.Chat.Animation +page_title: Telerik.Web.UI.Chat.Animation +description: Telerik.Web.UI.Chat.Animation +--- + +# Telerik.Web.UI.Chat.Animation + +Configures the toolbar toggle animation. If disabled animation will not play. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Chat.Animation : IDefaultCheck + +## Properties + +### CollapseSettings `Collapse` + +Configures the toolbar collapse animation. + +### ExpandSettings `Expand` + +Configures the expand animation of the toolbar; + diff --git a/api/server/Telerik.Web.UI.Chat/AnimationConverter.md b/api/server/Telerik.Web.UI.Chat/AnimationConverter.md new file mode 100644 index 0000000000..19cc6187a6 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/AnimationConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Chat.AnimationConverter +page_title: Telerik.Web.UI.Chat.AnimationConverter +description: Telerik.Web.UI.Chat.AnimationConverter +--- + +# Telerik.Web.UI.Chat.AnimationConverter + +Serialization JS converter class for Animation + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Chat.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.Chat/ChatToolbar.md b/api/server/Telerik.Web.UI.Chat/ChatToolbar.md new file mode 100644 index 0000000000..57f854866f --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/ChatToolbar.md @@ -0,0 +1,38 @@ +--- +title: Telerik.Web.UI.Chat.ChatToolbar +page_title: Telerik.Web.UI.Chat.ChatToolbar +description: Telerik.Web.UI.Chat.ChatToolbar +--- + +# Telerik.Web.UI.Chat.ChatToolbar + +Configures the Kedno UI Chat toolbar. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Chat.ChatToolbar : IDefaultCheck + +## Properties + +### Animation `Boolean` + +Configures the toolbar toggle animation. If disabled animation will not play. + +### AnimationSettings `Boolean` + +Configures the toolbar toggle animation. If disabled animation will not play. + +### ButtonsCollection `ChatToolbarButtonsCollection` + +Defines the collection of buttons to be rendered. + +### Scrollable `Boolean` + +Enables or disables the scrollable behavior of the toolbar. + +### Toggleable `Boolean` + +Enables or disables the toggleable behavior of the toolbar. + diff --git a/api/server/Telerik.Web.UI.Chat/ChatToolbarConverter.md b/api/server/Telerik.Web.UI.Chat/ChatToolbarConverter.md new file mode 100644 index 0000000000..0ee6a2c42b --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/ChatToolbarConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Chat.ChatToolbarConverter +page_title: Telerik.Web.UI.Chat.ChatToolbarConverter +description: Telerik.Web.UI.Chat.ChatToolbarConverter +--- + +# Telerik.Web.UI.Chat.ChatToolbarConverter + +Serialization JS converter class for Toolbar + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Chat.ChatToolbarConverter + +## 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.Chat/Collapse.md b/api/server/Telerik.Web.UI.Chat/Collapse.md new file mode 100644 index 0000000000..db48ff5563 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/Collapse.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.Chat.Collapse +page_title: Telerik.Web.UI.Chat.Collapse +description: Telerik.Web.UI.Chat.Collapse +--- + +# Telerik.Web.UI.Chat.Collapse + +Configures the toolbar collapse animation. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Chat.Collapse : IDefaultCheck + +## Properties + +### Duration `Double` + +Configures the duration (in miliseconds) of the toolbar collapse animation. + +### Effects `String` + +Configures the effects of the toolbar collapse animation. + diff --git a/api/server/Telerik.Web.UI.Chat/CollapseConverter.md b/api/server/Telerik.Web.UI.Chat/CollapseConverter.md new file mode 100644 index 0000000000..db02be3bc8 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/CollapseConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Chat.CollapseConverter +page_title: Telerik.Web.UI.Chat.CollapseConverter +description: Telerik.Web.UI.Chat.CollapseConverter +--- + +# Telerik.Web.UI.Chat.CollapseConverter + +Serialization JS converter class for Collapse + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Chat.CollapseConverter + +## 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.Chat/Expand.md b/api/server/Telerik.Web.UI.Chat/Expand.md new file mode 100644 index 0000000000..74ebf61694 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/Expand.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.Chat.Expand +page_title: Telerik.Web.UI.Chat.Expand +description: Telerik.Web.UI.Chat.Expand +--- + +# Telerik.Web.UI.Chat.Expand + +Configures the expand animation of the toolbar; + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Chat.Expand : IDefaultCheck + +## Properties + +### Duration `Double` + +Configures the duration of the expand animation. + +### Effects `String` + +Configures the effects of the expand animation. + diff --git a/api/server/Telerik.Web.UI.Chat/ExpandConverter.md b/api/server/Telerik.Web.UI.Chat/ExpandConverter.md new file mode 100644 index 0000000000..ea21e44ecf --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/ExpandConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Chat.ExpandConverter +page_title: Telerik.Web.UI.Chat.ExpandConverter +description: Telerik.Web.UI.Chat.ExpandConverter +--- + +# Telerik.Web.UI.Chat.ExpandConverter + +Serialization JS converter class for Expand + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Chat.ExpandConverter + +## 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.Chat/Messages.md b/api/server/Telerik.Web.UI.Chat/Messages.md new file mode 100644 index 0000000000..12df36f479 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/Messages.md @@ -0,0 +1,22 @@ +--- +title: Telerik.Web.UI.Chat.Messages +page_title: Telerik.Web.UI.Chat.Messages +description: Telerik.Web.UI.Chat.Messages +--- + +# Telerik.Web.UI.Chat.Messages + +Allows localization of the strings that are used in the widget. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Chat.Messages : IDefaultCheck + +## Properties + +### Placeholder `String` + +The hint displayed in the input textbox of the widget. + diff --git a/api/server/Telerik.Web.UI.Chat/MessagesConverter.md b/api/server/Telerik.Web.UI.Chat/MessagesConverter.md new file mode 100644 index 0000000000..63d937b651 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/MessagesConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Chat.MessagesConverter +page_title: Telerik.Web.UI.Chat.MessagesConverter +description: Telerik.Web.UI.Chat.MessagesConverter +--- + +# Telerik.Web.UI.Chat.MessagesConverter + +Serialization JS converter class for Messages + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Chat.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.Chat/User.md b/api/server/Telerik.Web.UI.Chat/User.md new file mode 100644 index 0000000000..3225a30277 --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/User.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.Chat.User +page_title: Telerik.Web.UI.Chat.User +description: Telerik.Web.UI.Chat.User +--- + +# Telerik.Web.UI.Chat.User + +Configures the Kendo UI Chat user information. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.Chat.User : IDefaultCheck + +## Properties + +### IconUrl `String` + +If set, sets the image url to be used for the user avatar icon. + +### Name `String` + +Sets the name of the chat user. + diff --git a/api/server/Telerik.Web.UI.Chat/UserConverter.md b/api/server/Telerik.Web.UI.Chat/UserConverter.md new file mode 100644 index 0000000000..04e910b01f --- /dev/null +++ b/api/server/Telerik.Web.UI.Chat/UserConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.Chat.UserConverter +page_title: Telerik.Web.UI.Chat.UserConverter +description: Telerik.Web.UI.Chat.UserConverter +--- + +# Telerik.Web.UI.Chat.UserConverter + +Serialization JS converter class for User + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.Chat.UserConverter + +## 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.MultiColumnComboBox/Animation.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/Animation.md new file mode 100644 index 0000000000..43a66d82f6 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/Animation.md @@ -0,0 +1,24 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.Animation +page_title: Telerik.Web.UI.MultiColumnComboBox.Animation +description: Telerik.Web.UI.MultiColumnComboBox.Animation +--- + +# Telerik.Web.UI.MultiColumnComboBox.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. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiColumnComboBox.Animation : IDefaultCheck + +## Properties + +### CloseSettings `Close` + +### OpenSettings `Open` + +The animation played when the suggestion popup is opened. + diff --git a/api/server/Telerik.Web.UI.MultiColumnComboBox/AnimationConverter.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/AnimationConverter.md new file mode 100644 index 0000000000..9cb2b53c48 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/AnimationConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.AnimationConverter +page_title: Telerik.Web.UI.MultiColumnComboBox.AnimationConverter +description: Telerik.Web.UI.MultiColumnComboBox.AnimationConverter +--- + +# Telerik.Web.UI.MultiColumnComboBox.AnimationConverter + +Serialization JS converter class for Animation + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox/Close.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/Close.md new file mode 100644 index 0000000000..be3b1460ec --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/Close.md @@ -0,0 +1,24 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.Close +page_title: Telerik.Web.UI.MultiColumnComboBox.Close +description: Telerik.Web.UI.MultiColumnComboBox.Close +--- + +# Telerik.Web.UI.MultiColumnComboBox.Close + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox/CloseConverter.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/CloseConverter.md new file mode 100644 index 0000000000..c2d66c4868 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/CloseConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.CloseConverter +page_title: Telerik.Web.UI.MultiColumnComboBox.CloseConverter +description: Telerik.Web.UI.MultiColumnComboBox.CloseConverter +--- + +# Telerik.Web.UI.MultiColumnComboBox.CloseConverter + +Serialization JS converter class for Close + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox/Open.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/Open.md new file mode 100644 index 0000000000..fdc3eaf5f5 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/Open.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.Open +page_title: Telerik.Web.UI.MultiColumnComboBox.Open +description: Telerik.Web.UI.MultiColumnComboBox.Open +--- + +# Telerik.Web.UI.MultiColumnComboBox.Open + +The animation played when the suggestion popup is opened. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox/OpenConverter.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/OpenConverter.md new file mode 100644 index 0000000000..d40f884dc7 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/OpenConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.OpenConverter +page_title: Telerik.Web.UI.MultiColumnComboBox.OpenConverter +description: Telerik.Web.UI.MultiColumnComboBox.OpenConverter +--- + +# Telerik.Web.UI.MultiColumnComboBox.OpenConverter + +Serialization JS converter class for Open + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox/Popup.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/Popup.md new file mode 100644 index 0000000000..3f548ffd90 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/Popup.md @@ -0,0 +1,30 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.Popup +page_title: Telerik.Web.UI.MultiColumnComboBox.Popup +description: Telerik.Web.UI.MultiColumnComboBox.Popup +--- + +# Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox.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.MultiColumnComboBox/PopupConverter.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/PopupConverter.md new file mode 100644 index 0000000000..76beca77f6 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/PopupConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.PopupConverter +page_title: Telerik.Web.UI.MultiColumnComboBox.PopupConverter +description: Telerik.Web.UI.MultiColumnComboBox.PopupConverter +--- + +# Telerik.Web.UI.MultiColumnComboBox.PopupConverter + +Serialization JS converter class for Popup + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox/Virtual.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/Virtual.md new file mode 100644 index 0000000000..3c6e5ac712 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/Virtual.md @@ -0,0 +1,30 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.Virtual +page_title: Telerik.Web.UI.MultiColumnComboBox.Virtual +description: Telerik.Web.UI.MultiColumnComboBox.Virtual +--- + +# Telerik.Web.UI.MultiColumnComboBox.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.MultiColumnComboBox.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. + diff --git a/api/server/Telerik.Web.UI.MultiColumnComboBox/VirtualConverter.md b/api/server/Telerik.Web.UI.MultiColumnComboBox/VirtualConverter.md new file mode 100644 index 0000000000..c590b9c140 --- /dev/null +++ b/api/server/Telerik.Web.UI.MultiColumnComboBox/VirtualConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBox.VirtualConverter +page_title: Telerik.Web.UI.MultiColumnComboBox.VirtualConverter +description: Telerik.Web.UI.MultiColumnComboBox.VirtualConverter +--- + +# Telerik.Web.UI.MultiColumnComboBox.VirtualConverter + +Serialization JS converter class for Virtual + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBox.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/BarSeries.md b/api/server/Telerik.Web.UI/BarSeries.md index 7f3f3a6ff0..d4ad51a3bf 100644 --- a/api/server/Telerik.Web.UI/BarSeries.md +++ b/api/server/Telerik.Web.UI/BarSeries.md @@ -57,9 +57,6 @@ The data field with the values of the series along the Y axis Gets or Sets the distance between the category clusters. -#### Remarks -The value of the property cannot be negative. - ### GroupName `String` Defines a group name for the series and applies stacking automatically @@ -87,9 +84,6 @@ Creates a collection of category series items. Gets or Sets the space between the chart series as proportion of the series width. -#### Remarks -The value of the property cannot be negative. - ### Stacked `Nullable`1` Get/Set whether the series is stacked diff --git a/api/server/Telerik.Web.UI/ChatClientEvents.md b/api/server/Telerik.Web.UI/ChatClientEvents.md new file mode 100644 index 0000000000..8482caedba --- /dev/null +++ b/api/server/Telerik.Web.UI/ChatClientEvents.md @@ -0,0 +1,50 @@ +--- +title: Telerik.Web.UI.ChatClientEvents +page_title: Telerik.Web.UI.ChatClientEvents +description: Telerik.Web.UI.ChatClientEvents +--- + +# Telerik.Web.UI.ChatClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.ChatClientEvents : IDefaultCheck + +## Properties + +### OnActionClick `String` + +Fired when an action button is clicked inside an attachment template, or when a suggestedAction is clicked. + +### OnInitialize `String` + +Fired when the chat control is initialized. + +### OnLoad `String` + +Fired when the chat control is loaded on the page. + +### OnPost `String` + +Fired when a message is posted to the chat widget. This can be either through the message box, or an action button click. + +### OnSendMessage `String` + +Fired when a message is posted through the chat message box. + +### OnToolClick `String` + +Fired when a button from the toolbar is clicked. + +### OnTypingEnd `String` + +Fired when the user clears the chat message box, signaling that he stopped typing. The event is also triggered when the user submits the currenlty typed in message. + +### OnTypingStart `String` + +Fired when the user starts typing in the chat message box. The event is fired only once, and not upon each keystroke. + diff --git a/api/server/Telerik.Web.UI/ChatToolbarButton.md b/api/server/Telerik.Web.UI/ChatToolbarButton.md new file mode 100644 index 0000000000..9cb29afe09 --- /dev/null +++ b/api/server/Telerik.Web.UI/ChatToolbarButton.md @@ -0,0 +1,30 @@ +--- +title: Telerik.Web.UI.ChatToolbarButton +page_title: Telerik.Web.UI.ChatToolbarButton +description: Telerik.Web.UI.ChatToolbarButton +--- + +# Telerik.Web.UI.ChatToolbarButton + +Defines the collection of buttons to be rendered. When using only an array of strings, the string added will define the name option of the button. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.ChatToolbarButton + +## Properties + +### IconClass `String` + +Defines the icon classes of the span rendered in the button. + +### Name `String` + +Defines the name of the button. + +### Text `String` + +Defines the text to be rendered in the button. + diff --git a/api/server/Telerik.Web.UI/ChatToolbarButtonConverter.md b/api/server/Telerik.Web.UI/ChatToolbarButtonConverter.md new file mode 100644 index 0000000000..542e887534 --- /dev/null +++ b/api/server/Telerik.Web.UI/ChatToolbarButtonConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.ChatToolbarButtonConverter +page_title: Telerik.Web.UI.ChatToolbarButtonConverter +description: Telerik.Web.UI.ChatToolbarButtonConverter +--- + +# Telerik.Web.UI.ChatToolbarButtonConverter + +Serialization JS converter class for ToolbarButton + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.ChatToolbarButtonConverter + +## 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/MultiColumnComboBoxClientEvents.md b/api/server/Telerik.Web.UI/MultiColumnComboBoxClientEvents.md new file mode 100644 index 0000000000..062c1d55ea --- /dev/null +++ b/api/server/Telerik.Web.UI/MultiColumnComboBoxClientEvents.md @@ -0,0 +1,54 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBoxClientEvents +page_title: Telerik.Web.UI.MultiColumnComboBoxClientEvents +description: Telerik.Web.UI.MultiColumnComboBoxClientEvents +--- + +# Telerik.Web.UI.MultiColumnComboBoxClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiColumnComboBoxClientEvents : IDefaultCheck + +## Properties + +### OnCascade `String` + +Fired when the value of the widget is changed via API or user interaction. + +### OnChange `String` + +Fired when the value of the widget is changed by the user. As of 2015 Q3 SP1 cascading widget will trigger change event when its value is changed due to parent update.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. + +### 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 either with mouse/tap or with keyboard navigation. + diff --git a/api/server/Telerik.Web.UI/MultiColumnComboBoxColumn.md b/api/server/Telerik.Web.UI/MultiColumnComboBoxColumn.md new file mode 100644 index 0000000000..2f38fc2a63 --- /dev/null +++ b/api/server/Telerik.Web.UI/MultiColumnComboBoxColumn.md @@ -0,0 +1,38 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBoxColumn +page_title: Telerik.Web.UI.MultiColumnComboBoxColumn +description: Telerik.Web.UI.MultiColumnComboBoxColumn +--- + +# Telerik.Web.UI.MultiColumnComboBoxColumn + +Defines the columns rendered in the table of the MultiColumnComboBox. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.MultiColumnComboBoxColumn + +## Properties + +### Field `String` + +Defines the field for the column. + +### HeaderTemplate `String` + +Renders a template for the column header. + +### Template `String` + +Renders a template for the column. + +### Title `String` + +Defines the text of the column title in the header. + +### Width `String` + +The width of the column. Numeric values are treated as pixels. + diff --git a/api/server/Telerik.Web.UI/MultiColumnComboBoxColumnConverter.md b/api/server/Telerik.Web.UI/MultiColumnComboBoxColumnConverter.md new file mode 100644 index 0000000000..a4fdc55c07 --- /dev/null +++ b/api/server/Telerik.Web.UI/MultiColumnComboBoxColumnConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.MultiColumnComboBoxColumnConverter +page_title: Telerik.Web.UI.MultiColumnComboBoxColumnConverter +description: Telerik.Web.UI.MultiColumnComboBoxColumnConverter +--- + +# Telerik.Web.UI.MultiColumnComboBoxColumnConverter + +Serialization JS converter class for MultiColumnComboBoxColumn + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.MultiColumnComboBoxColumnConverter + +## 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/RadChat.md b/api/server/Telerik.Web.UI/RadChat.md new file mode 100644 index 0000000000..da9e646caa --- /dev/null +++ b/api/server/Telerik.Web.UI/RadChat.md @@ -0,0 +1,197 @@ +--- +title: Telerik.Web.UI.RadChat +page_title: Telerik.Web.UI.RadChat +description: Telerik.Web.UI.RadChat +--- + +# Telerik.Web.UI.RadChat + +## 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.RadChat + +## Properties + +### ClientEvents `ChatClientEvents` + +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() + +### 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. + +### MessagesSettings `Messages` + +Allows localization of the strings that are used in the widget. + +### 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. + +### 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. + +### ToolbarSettings `ChatToolbar` + +Configures the Kedno UI Chat toolbar. + +### UserSettings `User` + +Configures the Kendo UI Chat user information. + +## 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/RadChatConverter.md b/api/server/Telerik.Web.UI/RadChatConverter.md new file mode 100644 index 0000000000..ee8582e6d3 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadChatConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadChatConverter +page_title: Telerik.Web.UI.RadChatConverter +description: Telerik.Web.UI.RadChatConverter +--- + +# Telerik.Web.UI.RadChatConverter + +Serialization JS converter class for RadChat + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadChatConverter + +## 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/RadMultiColumnComboBox.md b/api/server/Telerik.Web.UI/RadMultiColumnComboBox.md new file mode 100644 index 0000000000..2ec2f8570f --- /dev/null +++ b/api/server/Telerik.Web.UI/RadMultiColumnComboBox.md @@ -0,0 +1,380 @@ +--- +title: Telerik.Web.UI.RadMultiColumnComboBox +page_title: Telerik.Web.UI.RadMultiColumnComboBox +description: Telerik.Web.UI.RadMultiColumnComboBox +--- + +# Telerik.Web.UI.RadMultiColumnComboBox + +## 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.RadMultiColumnComboBox : ICallbackEventHandler, IPostBackEventHandler + +## Properties + +### AllowPaging `Boolean` + +Gets or sets a value indicating whether the paging in is enabled + The default is false. + +### AnimationSettings `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. + +### CascadeFrom `String` + +Use it to set the Id of the parent MultiColumnComboBox 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. + +### 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 `MultiColumnComboBoxClientEvents` + +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". + +### ColumnsCollection `MultiColumnComboBoxColumnsCollection` + +Defines the columns rendered in the table of the MultiColumnComboBox. + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### 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` + +The delay in milliseconds between a keystroke and when the widget displays the popup. + +### DropDownWidth `String` + +The width of the dropdown. Numeric values are treated as 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 + +### EnableServerFiltering `Boolean` + +Gets or sets value indicating whether server-side filtering is enabled + +### EnableServerPaging `Boolean` + +Gets or sets value indicating whether server-side paging is enabled + +### 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 `String` + +The filtering method used to determine the suggestions for the current value. Filtration is turned off 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. + +### FilterFields `String` + +Enables multicolumn filtering. + +### 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. + +### GroupByField `String` + +Defines the field to be used to group the data source in web service binding scenario. + +### 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. + +### Height `Unit` + +The height of the suggestion popup in pixels. The default value is 200 pixels. + +### 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. + +### Index `Double` + +The index of the initially selected item. The index is 0 based. + +### IsSkinSet `String` + +For internal use. + +### 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. + +### 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. + +### PageSize `Int32` + +Gets or sets the maximum number of items that would appear on a page. + Default value is 10. + +### 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. + +### 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. + +### Suggest `Boolean` + +If set to true the widget will automatically use the first suggestion as its value. + +### SyncValueAndText `Boolean` + +When set to true the widget will automatically set selected value to the typed custom text. Set the option to false to clear the selected value but keep the custom text. + +### Text `String` + +The text of the widget used when the autoBind is set to false. + +### Value `String` + +The value of the widget. + +### ValuePrimitive `String` + +Specifies the value binding behavior for the widget when the initial model value is null. 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. + +### WebServiceSettings `WebServiceDataSourceSettings` + +Gets the web service settings to be used for binding this instance of RadMultiColumnComboBox. + +## 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` + +### 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/RadMultiColumnComboBoxConverter.md b/api/server/Telerik.Web.UI/RadMultiColumnComboBoxConverter.md new file mode 100644 index 0000000000..f986c7f3ef --- /dev/null +++ b/api/server/Telerik.Web.UI/RadMultiColumnComboBoxConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadMultiColumnComboBoxConverter +page_title: Telerik.Web.UI.RadMultiColumnComboBoxConverter +description: Telerik.Web.UI.RadMultiColumnComboBoxConverter +--- + +# Telerik.Web.UI.RadMultiColumnComboBoxConverter + +Serialization JS converter class for RadMultiColumnComboBox + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadMultiColumnComboBoxConverter + +## 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/RadProgressBar.md b/api/server/Telerik.Web.UI/RadProgressBar.md new file mode 100644 index 0000000000..fc1ade74a3 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadProgressBar.md @@ -0,0 +1,232 @@ +--- +title: Telerik.Web.UI.RadProgressBar +page_title: Telerik.Web.UI.RadProgressBar +description: Telerik.Web.UI.RadProgressBar +--- + +# Telerik.Web.UI.RadProgressBar + +A control that shows a progress of a task or process in percent, absolute value or discrete steps. Its value can be set on the server, or on the client. + +## 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.RadProgressBar + +## Properties + +### AnimationSettings `ProgressBarAnimationSettings` + +Configures the progress animation settings. + +### BarType `ProgressBarType` + +Specifies the type of RadProgressBar. The supported types are Value, Percent and Chunk. + +### ChunksCount `Int32` + +Specifies the number of chunks. Default is 5. + This property is applicable only when the type of the ProgressBar is set to chunk. + +### ClientEvents `ProgressBarClientEvents` + +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() + +### 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 + +### Indeterminate `Boolean` + +Specifies if the progress state is Indeterminate. + +### IsSkinSet `String` + +For internal use. + +### Label `String` + +Specifies if the progress label will be shown. + +### MaxValue `Double` + +Specifies the maximum value of the ProgressBar. + +### MinValue `Double` + +Specifies the minimum value of the ProgressBar. + +### Orientation `ProgressBarOrientation` + +The orientation of the ProgressBar. Possible values are horizontal and vertical. + +### 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 + +### Reversed `Boolean` + +Specifies if the progress direction will be reversed. + +### RuntimeSkin `String` + +Gets the real skin name for the control user interface. If Skin is not set, returns + "Default", otherwise returns Skin. + +### ShowLabel `Boolean` + +Specifies if the progress label will be shown. + +### 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. + +### Value `Double` + +Specifies the underlying value of the ProgressBar. + +## 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/RadTreeList.md b/api/server/Telerik.Web.UI/RadTreeList.md index 21dc719e25..761cf031c3 100644 --- a/api/server/Telerik.Web.UI/RadTreeList.md +++ b/api/server/Telerik.Web.UI/RadTreeList.md @@ -346,7 +346,7 @@ Gets or sets the height of the Web server control. ### HideExpandCollapseButtonIfNoChildren `Boolean` -Enables TreeListItem's child items to be loaded on demand. +Gets or sets a value indicating whether the expand/collapse image of the treelist item should be visible when it does not have child items. ### InsertIndexes `TreeListEditIndexesCollection` diff --git a/api/server/Telerik.Web.UI/RangeBarSeries.md b/api/server/Telerik.Web.UI/RangeBarSeries.md index 15a6c3c0e4..63ca11415c 100644 --- a/api/server/Telerik.Web.UI/RangeBarSeries.md +++ b/api/server/Telerik.Web.UI/RangeBarSeries.md @@ -73,9 +73,6 @@ The data field with the values of the To value Gets or Sets the distance between the category clusters. -#### Remarks -The value of the property cannot be negative. - ### Items `SeriesItemCollection` The Items collection is Obsolete. Use the SeriesItems collection to specify the series items. @@ -99,9 +96,6 @@ Creates a collection of range series items. Gets or Sets the space between the chart series as proportion of the series width. -#### Remarks -The value of the property cannot be negative. - ### TooltipsAppearance `SeriesAppearance` Defines the appearance settings of the series diff --git a/api/server/Telerik.Web.UI/WaterfallSeries.md b/api/server/Telerik.Web.UI/WaterfallSeries.md index d5fbb52e37..8774b10b2d 100644 --- a/api/server/Telerik.Web.UI/WaterfallSeries.md +++ b/api/server/Telerik.Web.UI/WaterfallSeries.md @@ -62,9 +62,6 @@ The data field with the values of the SummaryType value. Gets or Sets the distance between the category clusters. -#### Remarks -The value of the property cannot be negative. - ### Items `SeriesItemCollection` The Items collection is Obsolete. Use the SeriesItems collection to specify the series items. @@ -88,9 +85,6 @@ Creates a collection of waterfall series items. Gets or Sets the space between the chart series as proportion of the series width. -#### Remarks -The value of the property cannot be negative. - ### TooltipsAppearance `SeriesAppearance` Defines the appearance settings of the series