Documentation

Class RadLayoutControlCustomizeDialog

The dialog which is opened when RadLayoutControl is in edit mode. Provides interface to access the hidden items, bring new items to the control, or preview and edit the existing item structure.

Inheritance
System.Object
RadFormControlBase
RadForm
RadLayoutControlCustomizeDialog
RadCardViewCustomizeDialog
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadLayoutControlCustomizeDialog : RadForm, IComponentTreeHandler, ILayoutHandler, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged, IAnalyticsProvider

Constructors

RadLayoutControlCustomizeDialog()

Declaration
public RadLayoutControlCustomizeDialog()

RadLayoutControlCustomizeDialog(RadLayoutControl)

Declaration
public RadLayoutControlCustomizeDialog(RadLayoutControl layoutControl)
Parameters
RadLayoutControl layoutControl

Properties

HiddenItemsGroup

Declaration
protected ListViewDataItemGroup HiddenItemsGroup { get; }
Property Value
ListViewDataItemGroup

SplitterItem

Declaration
protected ListViewDataItem SplitterItem { get; }
Property Value
ListViewDataItem

Methods

CreateNewItem(BaseListViewVisualItem)

Called to create a new LayoutControlItemBase when dropping an item from the New Items group.

Declaration
protected virtual LayoutControlItemBase CreateNewItem(BaseListViewVisualItem draggedItem)
Parameters
BaseListViewVisualItem draggedItem

The dragged item.
Returns
LayoutControlItemBase

The newly created item

Dispose(Boolean)

Clean up any resources being used.

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

true if managed resources should be disposed; otherwise, false.
Overrides

GetDragContext(ISupportDrag)

Gets the drag context of a dragged item.

Declaration
protected virtual Type GetDragContext(ISupportDrag dragInstance)
Parameters
ISupportDrag dragInstance

The dragged item.
Returns
System.Type

The type of the associated item.

GetItemImage(LayoutControlItemBase)

Gets the image which should be displayed in an item in the Hidden Items group or the Structure tree view.

Declaration
protected virtual Image GetItemImage(LayoutControlItemBase item)
Parameters
LayoutControlItemBase item

The item to get the image for.
Returns
System.Drawing.Image

The image for that item.

GetItemText(LayoutControlItemBase)

Gets the text which should be displayed in an item in the Hidden Items group or the Structure tree view.

Declaration
protected virtual string GetItemText(LayoutControlItemBase item)
Parameters
LayoutControlItemBase item

The item to get the text for.
Returns
System.String

The text for the item.

GetString(String)

Declaration
protected string GetString(string id)
Parameters
System.String id

Returns
System.String

HandleDropOnEmptyContainer(DraggableLayoutControlOverlayElement, BaseListViewVisualItem)

Handles dropping a list view item over an empty container.

Declaration
protected virtual void HandleDropOnEmptyContainer(DraggableLayoutControlOverlayElement overlayElement, BaseListViewVisualItem draggedItem)
Parameters
DraggableLayoutControlOverlayElement overlayElement

The container.
BaseListViewVisualItem draggedItem

The dragged item.

HandleItemDrop(BaseListViewVisualItem, DraggableLayoutControlItem)

Handles dropping a list view item over a DraggableLayoutControlItem.

Declaration
protected virtual void HandleItemDrop(BaseListViewVisualItem draggedItem, DraggableLayoutControlItem target)
Parameters
BaseListViewVisualItem draggedItem

The dragged list view item.
DraggableLayoutControlItem target

The drop target item.

OnClosing(CancelEventArgs)

Declaration
protected override void OnClosing(CancelEventArgs e)
Parameters
System.ComponentModel.CancelEventArgs e

OnDragServiceDragDrop(Object, RadDropEventArgs)

Called to handle dropping a dragged item from the list view on the Items tab.

Declaration
protected virtual void OnDragServiceDragDrop(object sender, RadDropEventArgs e)
Parameters
System.Object sender

RadDropEventArgs e

OnDragServiceDragOver(Object, RadDragOverEventArgs)

Handles the DragOver event of the list view's drag drop service.

Declaration
protected virtual void OnDragServiceDragOver(object sender, RadDragOverEventArgs e)
Parameters
System.Object sender

RadDragOverEventArgs e

OnDragServiceStopped(Object, EventArgs)

Called when the drag drop service of the list view has started.

Declaration
protected virtual void OnDragServiceStopped(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnLoad(EventArgs)

Declaration
protected override void OnLoad(EventArgs e)
Parameters
System.EventArgs e

Overrides

OnLoadLayoutButtonClick(Object, EventArgs)

Handles the Click event of the Load Layout button.

Declaration
protected virtual void OnLoadLayoutButtonClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnRightToLeftChanged(EventArgs)

Declaration
protected override void OnRightToLeftChanged(EventArgs e)
Parameters
System.EventArgs e

OnSaveLayoutButtonClick(Object, EventArgs)

Handles the Click event of the Save Layout button.

Declaration
protected virtual void OnSaveLayoutButtonClick(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

OnStructureTreeNodeEdited(Object, TreeNodeEditedEventArgs)

Handles the NodeEdited event of the tree view on the Structure tab.

Declaration
protected virtual void OnStructureTreeNodeEdited(object sender, TreeNodeEditedEventArgs e)
Parameters
System.Object sender

TreeNodeEditedEventArgs e

OnStructureTreeViewMouseDown(Object, MouseEventArgs)

Handles the MouseDown event of the tree view on the Structure tab.

Declaration
protected virtual void OnStructureTreeViewMouseDown(object sender, MouseEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs e

OnStructureTreeViewMouseMove(Object, MouseEventArgs)

Handles the MouseMove event of the tree view on the Structure tab.

Declaration
protected virtual void OnStructureTreeViewMouseMove(object sender, MouseEventArgs e)
Parameters
System.Object sender

System.Windows.Forms.MouseEventArgs e

OnStructureTreeViewNodeRemoving(Object, RadTreeViewCancelEventArgs)

Handles the NodeRemoving event of the tree view on the structure tab.

Declaration
protected virtual void OnStructureTreeViewNodeRemoving(object sender, RadTreeViewCancelEventArgs e)
Parameters
System.Object sender

RadTreeViewCancelEventArgs e

OnStructureTreeViewSelectedNodeChanged(Object, RadTreeViewEventArgs)

Handles the SelectedNodeChanged event of the tree view on the Structure tab.

Declaration
protected virtual void OnStructureTreeViewSelectedNodeChanged(object sender, RadTreeViewEventArgs e)
Parameters
System.Object sender

RadTreeViewEventArgs e

OnVisibleChanged(EventArgs)

Declaration
protected override void OnVisibleChanged(EventArgs e)
Parameters
System.EventArgs e

Overrides

ProcessCmdKey(ref Message, Keys)

Declaration
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters
System.Windows.Forms.Message msg

System.Windows.Forms.Keys keyData

Returns
System.Boolean

RightToLeftTranslate()

Called to rearrange the items when the RightToLeft property of the dialog has changed.

Declaration
protected virtual void RightToLeftTranslate()

UpdateHiddenItems()

Called to update the Hidden Items group in the Items tab

Declaration
public virtual void UpdateHiddenItems()

UpdateItemsStructureTreeView()

Called to update the tree view in the Structure tab

Declaration
public virtual void UpdateItemsStructureTreeView()

UpdateLocalizableStrings(Object, EventArgs)

Declaration
protected virtual void UpdateLocalizableStrings(object sender, EventArgs e)
Parameters
System.Object sender

System.EventArgs e

Extension Methods