Introduction
Knowledge Base
API Reference / Server-side / Telerik.Web.UI / RadDraggable
New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadDraggable

Class

Represents the RadDraggable control that makes elements draggable with various configuration options.

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:
C#
[ToolboxBitmap(typeof(RadDraggable), "Toolbox.Icons.DragDrop.png")]
[RequiredScript(typeof(jQueryPlugins))]
[RequiredScript(typeof(Html5DragAndDrop))]
[ClientScriptResource("Telerik.Web.UI.RadDraggable", "Telerik.Web.UI.DragDropManager.Draggable.RadDraggable.js")]
public class RadDraggable : RadWebControl, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl

Inheritance: objectControlWebControlRadWebControlRadDraggable

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIParserAccessorIPostBackDataHandlerIScriptControlISkinnableControlIUrlResolutionService...

Inherited Members WebControl.AddAttributesToRender(HtmlTextWriter)WebControl.ApplyStyle(Style)WebControl.CopyBaseAttributes(WebControl)WebControl.CreateControlStyle()WebControl.LoadViewState(object)WebControl.TrackViewState()WebControl.MergeStyle(Style)WebControl.Render(HtmlTextWriter)WebControl.RenderBeginTag(HtmlTextWriter)WebControl.RenderEndTag(HtmlTextWriter)WebControl.RenderContents(HtmlTextWriter)WebControl.SaveViewState()WebControl.AccessKeyWebControl.AttributesWebControl.BackColorWebControl.BorderColorWebControl.BorderWidthWebControl.BorderStyleWebControl.ControlStyleWebControl.ControlStyleCreatedWebControl.CssClassWebControl.DisabledCssClassWebControl.StyleWebControl.EnabledWebControl.EnableThemingWebControl.FontWebControl.ForeColorWebControl.HasAttributesWebControl.HeightWebControl.IsEnabledWebControl.SupportsDisabledAttributeWebControl.SkinIDWebControl.TabIndexWebControl.TagNameWebControl.ToolTipWebControl.WidthControl.ResolveAdapter()Control.HasEvents()Control.GetRouteUrl(object)Control.GetRouteUrl(string, object)Control.GetRouteUrl(RouteValueDictionary)Control.GetRouteUrl(string, RouteValueDictionary)Control.GetUniqueIDRelativeTo(Control)Control.ApplyStyleSheetSkin(Page)Control.OnDataBinding(EventArgs)Control.DataBind()Control.DataBind(bool)Control.DataBindChildren()Control.AddParsedSubObject(object)Control.EnsureID()Control.OnInit(EventArgs)Control.ClearChildState()Control.ClearChildControlState()Control.ClearChildViewState()Control.ClearEffectiveClientIDMode()Control.ClearCachedClientID()Control.Focus()Control.LoadControlState(object)Control.MapPathSecure(string)Control.OpenFile(string)Control.OnLoad(EventArgs)Control.BuildProfileTree(string, bool)Control.SaveControlState()Control.RenderChildren(HtmlTextWriter)Control.RenderControl(HtmlTextWriter)Control.RenderControl(HtmlTextWriter, ControlAdapter)Control.OnUnload(EventArgs)Control.Dispose()Control.RaiseBubbleEvent(object, EventArgs)Control.OnBubbleEvent(object, EventArgs)Control.AddedControl(Control, int)Control.CreateControlCollection()Control.CreateChildControls()Control.ResolveUrl(string)Control.ResolveClientUrl(string)Control.FindControl(string)Control.FindControl(string, int)Control.GetDesignModeState()Control.HasControls()Control.IsLiteralContent()Control.EnsureChildControls()Control.RemovedControl(Control)Control.SetDesignModeState(IDictionary)Control.SetRenderMethodDelegate(RenderMethod)Control.ClientIDModeControl.ClientIDControl.ClientIDSeparatorControl.ContextControl.AdapterControl.DesignModeControl.EventsControl.IDControl.IsChildControlStateClearedControl.EnableViewStateControl.ViewStateModeControl.IsViewStateEnabledControl.NamingContainerControl.IdSeparatorControl.LoadViewStateByIDControl.PageControl.RenderingCompatibilityControl.TemplateControlControl.ParentControl.TemplateSourceDirectoryControl.AppRelativeTemplateSourceDirectoryControl.SiteControl.VisibleControl.UniqueIDControl.HasChildViewStateControl.ControlsControl.ValidateRequestModeControl.ViewStateControl.ViewStateIgnoresCaseControl.ChildControlsCreatedControl.IsTrackingViewStateControl.DisposedControl.DataBindingControl.InitControl.LoadControl.PreRenderControl.Unloadobject.ToString()object.Equals(object)object.Equals(object, object)object.ReferenceEquals(object, object)object.GetHashCode()object.GetType()object.MemberwiseClone()...

Constructors

RadDraggable()

C#
public RadDraggable()

Properties

AutoScroll

If set to true the widget will auto-scroll the container when the mouse/finger is close to the top/bottom of it.

C#
public bool AutoScroll { get; set; }

Axis

Constrains the hint movement to either the horizontal (x) or vertical (y) axis. Can be set to either "x" or "y".

C#
public RadDraggableAxisMode Axis { get; set; }

ClientEvents

Defines the client events handlers.

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public DraggableClientEvents ClientEvents { get; }

ContainerSelectors

If set, the hint movement is constrained to the container boundaries.

C#
[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] ContainerSelectors { get; set; }

The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element.

CssClassFormatString

The CssClass property will now be used instead of the former Skin and will be modified in AddAttributesToRender()

C#
protected override string CssClassFormatString { get; }

Overrides: RadWebControl.CssClassFormatString

Example:
C#
protected override string CssClassFormatString
{
       get
       {
           return "RadDock RadDock_{0} rdWTitle rdWFooter";
       }
}

CursorOffset

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.

C#
public object CursorOffset { get; set; }

CursorOffsetSettings

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

C#
[PersistenceMode(PersistenceMode.InnerProperty)]
public DraggableCursorOffsetSettings CursorOffsetSettings { get; }

Distance

The required distance that the mouse should travel in order to initiate a drag.

C#
public double Distance { get; set; }

FilterSelectors

Gets or sets the selectors used to get the elements within the Draggable that will be draggable.

C#
[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] FilterSelectors { get; set; }

The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element.

Group

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.

C#
public string Group { get; set; }

Hint

Provides a way for customization of the drag indicator. If a function is supplied, it receives one argument - the draggable element's jQuery object.

C#
public string Hint { get; set; }

HoldToDrag

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.

C#
public bool HoldToDrag { get; set; }

IgnoreSelectors

Gets or sets the selectors used to get the elements within the Draggable that will not trigger a drag.

C#
[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] IgnoreSelectors { get; set; }

The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element.

TagKey

C#
protected override HtmlTextWriterTag TagKey { get; }

Overrides: WebControl.TagKey

TargetSelectors

Gets or sets the selectors used to get the elements that will become Draggables.

C#
[TypeConverter(typeof(ListConverter))]
[PersistenceMode(PersistenceMode.Attribute)]
[Bindable(true)]
public string[] TargetSelectors { get; set; }

The values of the property should be a valid jQuery selectors. E.g. class name or Id of html element.

Methods

DescribeClientEvents(IScriptDescriptor)

C#
protected override void DescribeClientEvents(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeClientEvents(IScriptDescriptor)

DescribeComponent(IScriptDescriptor)

C#
protected override void DescribeComponent(IScriptDescriptor descriptor)
Parameters:descriptorIScriptDescriptor

Overrides: RadWebControl.DescribeComponent(IScriptDescriptor)

OnPreRender(EventArgs)

C#
protected override void OnPreRender(EventArgs e)
Parameters:eEventArgs

Overrides: RadWebControl.OnPreRender(EventArgs)

In this article
DefinitionConstructorsRadDraggable()PropertiesAutoScrollAxisClientEventsContainerSelectorsCssClassFormatStringCursorOffsetCursorOffsetSettingsDistanceFilterSelectorsGroupHintHoldToDragIgnoreSelectorsTagKeyTargetSelectorsMethodsDescribeClientEvents(IScriptDescriptor)DescribeComponent(IScriptDescriptor)OnPreRender(EventArgs)
Not finding the help you need?
Contact Support