diff --git a/api/server/Telerik.Web.UI.Gauge/RadialScale.md b/api/server/Telerik.Web.UI.Gauge/RadialScale.md index d708b2e032..5fee9eeb2b 100644 --- a/api/server/Telerik.Web.UI.Gauge/RadialScale.md +++ b/api/server/Telerik.Web.UI.Gauge/RadialScale.md @@ -54,6 +54,11 @@ Gets or sets the interval between the minor divisions. Defines a collection of gauge ranges. +### RangeSize `Nullable`1` + +Gets or sets the width of the range indicators of the RadialGauge. + If the value is null, it will default to size equal to half of the MinorTick size. + ### Reverse `Boolean` Gets or sets a bool value indicating whether the direction of the scale values will be reversed. diff --git a/api/server/Telerik.Web.UI/DraggableClientEvents.md b/api/server/Telerik.Web.UI/DraggableClientEvents.md new file mode 100644 index 0000000000..8d978e0561 --- /dev/null +++ b/api/server/Telerik.Web.UI/DraggableClientEvents.md @@ -0,0 +1,46 @@ +--- +title: Telerik.Web.UI.DraggableClientEvents +page_title: Telerik.Web.UI.DraggableClientEvents +description: Telerik.Web.UI.DraggableClientEvents +--- + +# Telerik.Web.UI.DraggableClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.DraggableClientEvents : IDefaultCheck + +## Properties + +### OnDrag `String` + +Fired while dragging. The drag event represents a jQuery mousemove event and contains all the event data of the jQuery Event Object. + +### OnDragCancel `String` + +Fired when item drag is canceled by pressing the Escape key. The dragcancel event represents a jQuery keyup event and contains all the event data of the jQuery Event Object. + +### OnDragEnd `String` + +Fired when item drag ends. The dragend event represents a jQuery mouseup event and contains all the event data of the jQuery Event Object. + +### OnDragStart `String` + +Fired when item drag starts. The dragstart event represents a jQuery mousedown event and contains all the event data of the jQuery Event Object. + +### OnHold `String` + +Fired before the dragStart event. The hold event represents a jQuery mousedown event and contains all the event data of the jQuery Event Object. + +### OnInitialize `String` + +Fired when the control is initialized. + +### OnLoad `String` + +Fired when the control is loaded on the page. + diff --git a/api/server/Telerik.Web.UI/DraggableCursorOffsetSettings.md b/api/server/Telerik.Web.UI/DraggableCursorOffsetSettings.md new file mode 100644 index 0000000000..8066204830 --- /dev/null +++ b/api/server/Telerik.Web.UI/DraggableCursorOffsetSettings.md @@ -0,0 +1,26 @@ +--- +title: Telerik.Web.UI.DraggableCursorOffsetSettings +page_title: Telerik.Web.UI.DraggableCursorOffsetSettings +description: Telerik.Web.UI.DraggableCursorOffsetSettings +--- + +# Telerik.Web.UI.DraggableCursorOffsetSettings + +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.DraggableCursorOffsetSettings : IDefaultCheck + +## Properties + +### Left `Decimal` + +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" + +### Top `Decimal` + +Defines a jQuery selector that will be used to find a container element, where the popup will be appended to. + diff --git a/api/server/Telerik.Web.UI/DraggableCursorOffsetSettingsConverter.md b/api/server/Telerik.Web.UI/DraggableCursorOffsetSettingsConverter.md new file mode 100644 index 0000000000..de16e86994 --- /dev/null +++ b/api/server/Telerik.Web.UI/DraggableCursorOffsetSettingsConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.DraggableCursorOffsetSettingsConverter +page_title: Telerik.Web.UI.DraggableCursorOffsetSettingsConverter +description: Telerik.Web.UI.DraggableCursorOffsetSettingsConverter +--- + +# Telerik.Web.UI.DraggableCursorOffsetSettingsConverter + +Serialization JS converter class for DraggableCursorOffsetSettings + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.DraggableCursorOffsetSettingsConverter + +## 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/DropTargetAreaClientEvents.md b/api/server/Telerik.Web.UI/DropTargetAreaClientEvents.md new file mode 100644 index 0000000000..3286db5950 --- /dev/null +++ b/api/server/Telerik.Web.UI/DropTargetAreaClientEvents.md @@ -0,0 +1,38 @@ +--- +title: Telerik.Web.UI.DropTargetAreaClientEvents +page_title: Telerik.Web.UI.DropTargetAreaClientEvents +description: Telerik.Web.UI.DropTargetAreaClientEvents +--- + +# Telerik.Web.UI.DropTargetAreaClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.DropTargetAreaClientEvents : IDefaultCheck + +## Properties + +### OnDragEnter `String` + +Fired when draggable moves over one of the drop targets. The dragenter event represents a jQuery mousemove event and contains all the event data of the jQuery Event Object. + +### OnDragLeave `String` + +Fired when draggable moves out of one of the drop targets. The dragleave event represents a jQuery mousemove event and contains all the event data of the jQuery Event Object. + +### OnDrop `String` + +Fired when draggable is dropped over one of the drop targets. The drop event represents a jQuery mouseup event and contains all the event data of the jQuery Event Object. + +### OnInitialize `String` + +Fired when the control is initialized. + +### OnLoad `String` + +Fired when the control is loaded on the page. + diff --git a/api/server/Telerik.Web.UI/DropTargetClientEvents.md b/api/server/Telerik.Web.UI/DropTargetClientEvents.md new file mode 100644 index 0000000000..0bfb8474e2 --- /dev/null +++ b/api/server/Telerik.Web.UI/DropTargetClientEvents.md @@ -0,0 +1,38 @@ +--- +title: Telerik.Web.UI.DropTargetClientEvents +page_title: Telerik.Web.UI.DropTargetClientEvents +description: Telerik.Web.UI.DropTargetClientEvents +--- + +# Telerik.Web.UI.DropTargetClientEvents + +Defines the client events handlers. + +## Inheritance Hierarchy + +* System.Object +* Telerik.Web.StateManager : IMarkableStateManager, IStateManager +* Telerik.Web.UI.DropTargetClientEvents : IDefaultCheck + +## Properties + +### OnDragEnter `String` + +Fired when draggable moves over the drop target. The dragenter event represents a jQuery mousemove event and contains all the event data of the jQuery Event Object. + +### OnDragLeave `String` + +Fired when draggable moves out of the drop target. The dragleave event represents a jQuery mousemove event and contains all the event data of the jQuery Event Object. + +### OnDrop `String` + +Fired when draggable is dropped over the drop target. The drop event represents a jQuery mouseup event and contains all the event data of the jQuery Event Object. + +### OnInitialize `String` + +Fired when the control is initialized. + +### OnLoad `String` + +Fired when the control is loaded on the page. + diff --git a/api/server/Telerik.Web.UI/RadAsyncUpload.md b/api/server/Telerik.Web.UI/RadAsyncUpload.md index 57730754fe..9b37cbf9e0 100644 --- a/api/server/Telerik.Web.UI/RadAsyncUpload.md +++ b/api/server/Telerik.Web.UI/RadAsyncUpload.md @@ -371,6 +371,7 @@ When set to string.Empty, the files must be saved manually to the desired locati Sets how long temporary files should be kept before automatically deleting them. The property accepts TimeSpan values. The default value is 4 hours. More information regarding the TimeSpan structure can be found here - http://www.dotnetperls.com/timespan + RadAsyncUpload1.TemporaryFileExpiration = New TimeSpan(2, 0, 0, 0, 0); #### Remarks Note that when a postback occurs temporary files are either saved as permanent or removed. diff --git a/api/server/Telerik.Web.UI/RadDragDropManager.md b/api/server/Telerik.Web.UI/RadDragDropManager.md new file mode 100644 index 0000000000..d93d97ebdc --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDragDropManager.md @@ -0,0 +1,196 @@ +--- +title: Telerik.Web.UI.RadDragDropManager +page_title: Telerik.Web.UI.RadDragDropManager +description: Telerik.Web.UI.RadDragDropManager +--- + +# Telerik.Web.UI.RadDragDropManager + +Telerik RadDragDropManager + You can find information on the Server-side API of RadDragDropManager at https://docs.telerik.com/devtools/aspnet-ajax/controls/window/server-side-programming/properties . + +## 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.RadDragDropManager + +## Properties + +### 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() + +### DraggableSettings `RadDraggable` + +Gets the RadCalendar instance of the datepicker control. + +### DropTargetAreaSettings `RadDropTargetArea` + +Gets the RadCalendar instance of the datepicker control. + +### DropTargetSettings `RadDropTarget` + +Gets the RadCalendar instance of the datepicker control. + +### 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. + +### 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. + +## 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/RadDraggable.md b/api/server/Telerik.Web.UI/RadDraggable.md new file mode 100644 index 0000000000..033ba0a76a --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDraggable.md @@ -0,0 +1,245 @@ +--- +title: Telerik.Web.UI.RadDraggable +page_title: Telerik.Web.UI.RadDraggable +description: Telerik.Web.UI.RadDraggable +--- + +# Telerik.Web.UI.RadDraggable + +## 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.RadDraggable + +## Properties + +### AutoScroll `Boolean` + +If set to true the widget will auto-scroll the container when the mouse/finger is close to the top/bottom of it. + +### Axis `RadDraggableAxisMode` + +Constrains the hint movement to either the horizontal (x) or vertical (y) axis. Can be set to either "x" or "y". + +### ClientEvents `DraggableClientEvents` + +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". + +### ContainerSelectors `String[]` + +If set, the hint movement is constrained to the container boundaries. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### CursorOffset `Object` + +If set, specifies the offset of the hint relative to the mouse cursor/finger. By default, the hint is initially positioned on top of the draggable source offset. The option accepts an object with two keys: top and left. + +### CursorOffsetSettings `Object` + +The options that will be used for the popup initialization. For more details about the available options refer to Popup documentation. + +### Distance `Double` + +The required distance that the mouse should travel in order to initiate a drag. + +### 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 + +### FilterSelectors `String[]` + +Gets or sets the selectors used to get the elements within the Draggable that will be draggable. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +### Group `String` + +Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target. + +### Hint `String` + +Provides a way for customization of the drag indicator. If a function is supplied, it receives one argument - the draggable element's jQuery object. + +### HoldToDrag `Boolean` + +Suitable for touch oriented user interface, in order to avoid collision with the touch scrolling gesture. When set to true, the widget will be activated after the user taps and holds the finger on the element for a short amount of time.The draggable will also be activated by pressing, holding and lifting the finger without any movement. Dragging it afterwards will initiate the drag immediately. The activated mode can be canceled by calling cancelHold. + +### IgnoreSelectors `String[]` + +Gets or sets the selectors used to get the elements within the Draggable that will not trigger a drag. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +### IsSkinSet `String` + +For internal use. + +### 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. + +### TargetSelectors `String[]` + +Gets or sets the selectors used to get the elements that will become Draggables. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +## 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/RadDraggableConverter.md b/api/server/Telerik.Web.UI/RadDraggableConverter.md new file mode 100644 index 0000000000..f894f8e312 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDraggableConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadDraggableConverter +page_title: Telerik.Web.UI.RadDraggableConverter +description: Telerik.Web.UI.RadDraggableConverter +--- + +# Telerik.Web.UI.RadDraggableConverter + +Serialization JS converter class for RadDraggable + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadDraggableConverter + +## 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/RadDropTarget.md b/api/server/Telerik.Web.UI/RadDropTarget.md new file mode 100644 index 0000000000..6648134067 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDropTarget.md @@ -0,0 +1,196 @@ +--- +title: Telerik.Web.UI.RadDropTarget +page_title: Telerik.Web.UI.RadDropTarget +description: Telerik.Web.UI.RadDropTarget +--- + +# Telerik.Web.UI.RadDropTarget + +## 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.RadDropTarget + +## Properties + +### ClientEvents `DropTargetClientEvents` + +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 + +### Group `String` + +Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target. + +### IsSkinSet `String` + +For internal use. + +### 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. + +### TargetSelectors `String[]` + +Gets or sets the selectors used to get the elements that will become Draggables. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +## 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/RadDropTargetArea.md b/api/server/Telerik.Web.UI/RadDropTargetArea.md new file mode 100644 index 0000000000..92b191613e --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDropTargetArea.md @@ -0,0 +1,203 @@ +--- +title: Telerik.Web.UI.RadDropTargetArea +page_title: Telerik.Web.UI.RadDropTargetArea +description: Telerik.Web.UI.RadDropTargetArea +--- + +# Telerik.Web.UI.RadDropTargetArea + +## 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.RadDropTargetArea + +## Properties + +### ClientEvents `DropTargetAreaClientEvents` + +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 + +### FilterSelectors `String[]` + +Gets or sets the selectors used to get the elements within the Draggable that will be draggable. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +### Group `String` + +Used to group sets of draggable and drop targets. A draggable with the same group value as a drop target will be accepted by the drop target. + +### IsSkinSet `String` + +For internal use. + +### 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. + +### TargetSelectors `String[]` + +Gets or sets the selectors used to get the elements that will become Draggables. + +#### Remarks +The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element. + +## 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/RadDropTargetAreaConverter.md b/api/server/Telerik.Web.UI/RadDropTargetAreaConverter.md new file mode 100644 index 0000000000..e276e181b7 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDropTargetAreaConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadDropTargetAreaConverter +page_title: Telerik.Web.UI.RadDropTargetAreaConverter +description: Telerik.Web.UI.RadDropTargetAreaConverter +--- + +# Telerik.Web.UI.RadDropTargetAreaConverter + +Serialization JS converter class for RadDropTargetArea + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadDropTargetAreaConverter + +## 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/RadDropTargetConverter.md b/api/server/Telerik.Web.UI/RadDropTargetConverter.md new file mode 100644 index 0000000000..363a0fea6b --- /dev/null +++ b/api/server/Telerik.Web.UI/RadDropTargetConverter.md @@ -0,0 +1,41 @@ +--- +title: Telerik.Web.UI.RadDropTargetConverter +page_title: Telerik.Web.UI.RadDropTargetConverter +description: Telerik.Web.UI.RadDropTargetConverter +--- + +# Telerik.Web.UI.RadDropTargetConverter + +Serialization JS converter class for RadDropTarget + +## Inheritance Hierarchy + +* System.Object +* System.Web.Script.Serialization.JavaScriptConverter +* Telerik.Web.UI.ExplicitJavaScriptConverter +* Telerik.Web.UI.RadDropTargetConverter + +## 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/RadNavigation.md b/api/server/Telerik.Web.UI/RadNavigation.md index 78d2d0ef0f..c0043e10f0 100644 --- a/api/server/Telerik.Web.UI/RadNavigation.md +++ b/api/server/Telerik.Web.UI/RadNavigation.md @@ -120,6 +120,14 @@ If EnableEmbeddedSkins is set to false you will have to register the needed CSS Returns true if ripple effect should be added +### EnableScreenBoundaryDetection `Boolean` + +Gets or sets a value indicating whether the screen boundary detection will be applied when menu items are expanded. + +#### Remarks +By default RadNavigation will check if there is enough space to open a menu item. If there isn't the expand direction of the + item will be inverted - Left to Right, Bottom to Top and vice versa. + ### ExpandAnimation `AnimationSettings` Gets the settings for the animation played when the dropdown opens. diff --git a/api/server/Telerik.Web.UI/RadSplitButton.md b/api/server/Telerik.Web.UI/RadSplitButton.md new file mode 100644 index 0000000000..d6450d2d36 --- /dev/null +++ b/api/server/Telerik.Web.UI/RadSplitButton.md @@ -0,0 +1,367 @@ +--- +title: Telerik.Web.UI.RadSplitButton +page_title: Telerik.Web.UI.RadSplitButton +description: Telerik.Web.UI.RadSplitButton +--- + +# Telerik.Web.UI.RadSplitButton + +RadSplitButton control provides the features, that ASP.NET: Button controls has. + +## 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.ButtonBase.RadButtonBase : INamingContainer +* Telerik.Web.UI.ButtonBase.PostBackButtonBase : IButtonControl, IPostBackEventHandler +* Telerik.Web.UI.RadSplitButton : IJavaScriptConverterProvider + +## Properties + +### AccessKey `String` + +Gets or sets the accessKey of the Button control. + +### AriaSettings `WaiAriaSettings` + +Gets the object that controls the Wai-Aria settings applied on the control's element. + +### AutoPostBack `Boolean` + +Gets or sets a bool value indicating whether the Button control automatically posts back to the server when clicked. + +### CausesValidation `Boolean` + +Gets or sets a value indicating whether validation is performed when the Button control is clicked. + +### ClientIDMode `ClientIDMode` + +This property is overridden in order to support controls which implement INamingContainer. + The default value is changed to "AutoID". + +### CommandArgument `String` + +Gets or sets an optional parameter passed to the Command event along with the associated CommandName. + +### CommandName `String` + +Gets or sets the command name associated with the Button control that is passed to the Command event. + +### ConfirmSettings `RadButtonConfirmSettings` + +Gets the object that controls the built-in confirmation dialog properties. + +### ContentTemplate `ITemplate` + +Gets or sets the template for the Button control. + +### ContextMenu `RadContextMenu` + +Gets the RadContextMenu instance of the SplitButton control. + +### CssClass `String` + +Gets or sets the CSS class rendered by the Button control on the client. + +### CssClassFormatString `String` + +The CssClass property will now be used instead of the former Skin + and will be modified in AddAttributesToRender() + +### DisabledCssClass `String` + +Gets or sets the CSS class applied to the Button control when it is in a disabled state. + +### 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. + +### EnableAriaSupport `Boolean` + +When set to true enables support for WAI-ARIA + +### EnableAriaSupport `Boolean` + +When set to true enables support for WAI-ARIA + +### 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 + +### Height `Unit` + +Gets or sets the height of the Button control. + +### HoveredCssClass `String` + +Gets or sets the CSS class applied to the Button control when the mouse pointer is over the control. + +### Icon `ButtonIcon` + +Gets the object that controls the Primary and Secondary Icon related properties. + +### IsSkinSet `String` + +For internal use. + +### OnClientClicked `String` + +Gets or sets the name of the JavaScript function that will be called when the Button is clicked, after the OnClientClicking event. + +### OnClientClicking `String` + +Gets or sets the name of the JavaScript function that will be called when the Button is clicked. The event is cancelable. + +### OnClientContextMenuItemClicked `RadContextMenu` + +Gets or sets the name of the JavaScript function that will be called when the RadButton is clicked. The event is cancelable. + +### OnClientLoad `String` + +Gets or sets the name of the JavaScript function that will be called when the Button is loaded on the page. + +### OnClientMouseOut `String` + +Gets or sets the name of the JavaScript function that will be called when the mouse pointer leaves the Button. + +### OnClientMouseOver `String` + +Gets or sets the name of the JavaScript function that will be called when the mouse pointer hovers over the Button. + +### OriginalEnabled `Boolean` + +The Enabled property is reset in AddAttributesToRender in order + to avoid setting disabled attribute in the control tag (this is + the default behavior). This property has the real value of the + Enabled property in that moment. + +### PersistChangesFromContextMenu `RadContextMenu` + +Controls wether the Text of a clicked ContextMenu item should become the button's Text. + +### PostBackUrl `String` + +Gets or sets the URL of the page to post to from the current page when the Button control is clicked. + +### PressedCssClass `String` + +Gets or sets the CSS class applied to the Button control when the control is pressed. + +### Primary `Boolean` + +Gets/Sets the primary appearance of the button. + +### 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. + +### SingleClick `Boolean` + +Gets or sets a bool value indicating whether the Button control will be immediately disabled after the user has clicks it. (i.e. enables/disables "Single Click" functionality) + +### SingleClickText `Boolean` + +Gets or sets the text displayed in the Button control after the button is being clicked and disabled. (i.e. the text used for the 'Single Click' functionality) + +### 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. + +### SupportsRenderingMode `Boolean` + +Gets or RenderingMode support + +### TabIndex `Int16` + +Gets or sets the TabIndex of the Button control. + +### Text `String` + +Gets or sets the text displayed in the Button control. + +### ToolTip `String` + +Gets or sets the text that will be displayed in the tooltip of the Button control when it is hovered. + +### UseSubmitBehavior `Boolean` + +Gets or sets a value indicating whether the Button control uses the client browser's submit mechanism or the ASP.NET postback mechanism. + +### ValidationGroup `String` + +Gets or sets the group of controls for which the Button control causes validation when it posts back to the server. + +### Value `String` + +Gets or sets an optional Value of the Button control. + +### Width `Unit` + +Gets or sets the width of the Button control. + +## Methods + +### AddAttributesToRender + +Adds the attributes of the RadButton control to the output stream for rendering on the client. + +#### Parameters + +#### writer `System.Web.UI.HtmlTextWriter` + +An HtmlTextWriter that contains the output stream to render on the client. + +#### Returns + +`System.Void` + +### 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` + +### GetPostbackEventReference + +Creates a PostBackOptions object that represents the RadButton control's postback behavior, and returns the client script + generated as a result of the PostBackOptions. + +#### Returns + +`System.String` The client script that represents the RadButton control's PostBackOptions. + +### GetPostBackOptions + +Creates a PostBackOptions object that represents the RadButton control's postback behavior. + +#### Returns + +`System.Web.UI.PostBackOptions` A PostBackOptions that represents the RadButton control's postback behavior. + +### 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/RadToolBar.md b/api/server/Telerik.Web.UI/RadToolBar.md index c6e2e660c4..51aa6ac54c 100644 --- a/api/server/Telerik.Web.UI/RadToolBar.md +++ b/api/server/Telerik.Web.UI/RadToolBar.md @@ -530,6 +530,50 @@ The ignore case. `Telerik.Web.UI.TControlItem` +### FindDropDownByValue + +Searches the RadToolBar control for the first + RadToolBarDropDown which + Value + property is equal to the specified value. + +#### Parameters + +#### value `System.String` + +The value to search for. + +#### Returns + +`Telerik.Web.UI.RadToolBarDropDown` A RadToolBarDropDown which + Value + property is equal to the specified value. If an item is not found, null + (Nothing in Visual Basic) is returned. + +### FindDropDownByValue + +Searches the RadToolBar control for the first + RadToolBarDropDown which + Value + property is equal to the specified value. + +#### Parameters + +#### value `System.String` + +The value to search for. + +#### ignoreCase `System.Boolean` + +A Boolean indicating a case-sensitive or insensitive comparison (true indicates a case-insensitive comparison). + +#### Returns + +`Telerik.Web.UI.RadToolBarDropDown` A RadToolBarButton which + Value + property is equal to the specified value. If an item is not found, null + (Nothing in Visual Basic) is returned. + ### FindItem Returns the first RadToolBarItem diff --git a/api/server/Telerik.Web.UI/RadToolBarDropDown.md b/api/server/Telerik.Web.UI/RadToolBarDropDown.md index 2ab6d6e972..85b4b65413 100644 --- a/api/server/Telerik.Web.UI/RadToolBarDropDown.md +++ b/api/server/Telerik.Web.UI/RadToolBarDropDown.md @@ -204,10 +204,6 @@ Gets the RadToolBar instance which contains the item. Use this property to obtain an instance to the RadToolBar object containing the item. -### Value `String` - -Gets or sets the value. - ## Methods ### IsChildControl