New to Telerik UI for WinForms? Start a free 30-day trial

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.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
public class RadLayoutControlCustomizeDialog : RadForm, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, IContainerControl, IComponentTreeHandler, ILayoutHandler, ISupportInitializeNotification, ISupportInitialize, INotifyPropertyChanged, IAnalyticsProvider, ISupportRootUIAutomation

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlContainerControlFormRadFormControlBaseRadFormRadLayoutControlCustomizeDialog...

Derived Classes: RadCardViewCustomizeDialog

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIContainerControlIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISupportRootUIAutomationISynchronizeInvokeIWin32Window...

Inherited Members RadForm.ScrollToControl(Control)RadForm.EndInit()RadForm.WndProc(ref Message)RadForm.ProcessCaptureChangeRequested(RadElement, bool)RadForm.InitializeFormBehavior()RadForm.SetIconPrimitiveVisibility(bool)RadForm.EnableUIAutomationRadForm.TextRadForm.ThemeClassNameRadForm.FormElementRadForm.IconScalingRadForm.AllowThemingRadForm.ShowIconRadFormControlBase.newBoundsRadFormControlBase.oldDpiRadFormControlBase.currentDpiRadFormControlBase.isBehaviorPreparedRadFormControlBase.controlIsInitializingRootComponentRadFormControlBase.isPaintingRadFormControlBase.Construct()RadFormControlBase.OnCreateControl()RadFormControlBase.LoadElementTree()RadFormControlBase.LoadElementTree(Size)RadFormControlBase.OnLoad(Size)RadFormControlBase.OnShown(EventArgs)RadFormControlBase.OnPaint(PaintEventArgs)RadFormControlBase.OnPaintBackground(PaintEventArgs)RadFormControlBase.ProcessDialogKey(Keys)RadFormControlBase.UpdateDefaultButton()RadFormControlBase.OnBackColorChanged(EventArgs)RadFormControlBase.OnForeColorChanged(EventArgs)RadFormControlBase.OnFontChanged(EventArgs)RadFormControlBase.OnParentChanged(EventArgs)RadFormControlBase.ShouldSerializeProperty(RadProperty)RadFormControlBase.ResetFormBehavior(bool)RadFormControlBase.PerformDesignModeLocationCorrection(ref Message)RadFormControlBase.CallBaseWndProc(ref Message)RadFormControlBase.ProcessFocusRequested(RadElement)RadFormControlBase.OnNotifyPropertyChanged(string)RadFormControlBase.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadFormControlBase.CreateChildItems(RadElement)RadFormControlBase.CreateRootElement()RadFormControlBase.OnThemeNameChanged(ThemeNameChangedEventArgs)RadFormControlBase.OnThemeChanged()RadFormControlBase.OnDisplayPropertyChanged(RadPropertyChangedEventArgs)RadFormControlBase.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadFormControlBase.OnHandleCreated(EventArgs)RadFormControlBase.OnAutoSizeChanged(EventArgs)RadFormControlBase.OnLayout(LayoutEventArgs)RadFormControlBase.CreateHandle()RadFormControlBase.SetClientSizeCore(int, int)RadFormControlBase.SetBoundsCore(int, int, int, int, BoundsSpecified)RadFormControlBase.GetPreferredSize(Size)RadFormControlBase.InvalidateIfNotSuspended()RadFormControlBase.InvalidateElement(RadElement)RadFormControlBase.InvalidateElement(RadElement, Rectangle)RadFormControlBase.AddInvalidatedRect(Rectangle)RadFormControlBase.SuspendUpdate()RadFormControlBase.ResumeUpdate()RadFormControlBase.ResumeUpdate(bool)RadFormControlBase.RegisterHostedControl(RadHostItem)RadFormControlBase.UnregisterHostedControl(RadHostItem, bool)RadFormControlBase.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadFormControlBase.ControlThemeChangedCallback()RadFormControlBase.InvokeLayoutCallback(LayoutCallback)RadFormControlBase.BeginInit()RadFormControlBase.HandleDpiChanged()RadFormControlBase.ScaleControl(SizeF, BoundsSpecified)RadFormControlBase.SuspendDpiScaling()RadFormControlBase.ResumeDpiScaling()RadFormControlBase.OnWm_SettingChange(Message)RadFormControlBase.SiteRadFormControlBase.EnableAnalyticsRadFormControlBase.IsLoadedRadFormControlBase.MaximumSizeRadFormControlBase.MinimumSizeRadFormControlBase.FormBorderStyleRadFormControlBase.FormBehaviorRadFormControlBase.BehaviorRadFormControlBase.SmallImageListRadFormControlBase.FocusedElementRadFormControlBase.AllowShowFocusCuesRadFormControlBase.ShowItemToolTipsRadFormControlBase.CommandBindingsRadFormControlBase.EnableKeyMapRadFormControlBase.WindowsSettingsRadFormControlBase.BackColorRadFormControlBase.ForeColorRadFormControlBase.FontRadFormControlBase.CreateParamsRadFormControlBase.IsDesignModeRadFormControlBase.ElementTreeRadFormControlBase.ThemeNameRadFormControlBase.RootElementRadFormControlBase.IsUpdateSuspendedRadFormControlBase.ImageListRadFormControlBase.SmallImageScalingSizeRadFormControlBase.ImageScalingSizeRadFormControlBase.IsInitializedRadFormControlBase.IsPerformingScaleRadFormControlBase.HasOwnToolbarRadFormControlBase.IsDpiScalingSuspendedRadFormControlBase.ThemeNameChangedRadFormControlBase.ToolTipTextNeededRadFormControlBase.ScreenTipNeededRadFormControlBase.InitializedRadFormControlBase.PropertyChangedRadFormControlBase.WindowsThemeChangedForm.SetVisibleCore(bool)Form.Activate()Form.ActivateMdiChild(Form)Form.AddOwnedForm(Form)Form.AdjustFormScrollbars(bool)Form.Close()Form.CreateControlsInstance()Form.DefWndProc(ref Message)Form.ProcessMnemonic(char)Form.CenterToParent()Form.CenterToScreen()Form.LayoutMdi(MdiLayout)Form.OnActivated(EventArgs)Form.OnBackgroundImageChanged(EventArgs)Form.OnBackgroundImageLayoutChanged(EventArgs)Form.OnClosed(EventArgs)Form.OnFormClosing(FormClosingEventArgs)Form.OnFormClosed(FormClosedEventArgs)Form.OnDeactivate(EventArgs)Form.OnEnabledChanged(EventArgs)Form.OnEnter(EventArgs)Form.OnHandleDestroyed(EventArgs)Form.OnHelpButtonClicked(CancelEventArgs)Form.OnMaximizedBoundsChanged(EventArgs)Form.OnMaximumSizeChanged(EventArgs)Form.OnMinimumSizeChanged(EventArgs)Form.OnInputLanguageChanged(InputLanguageChangedEventArgs)Form.OnInputLanguageChanging(InputLanguageChangingEventArgs)Form.OnMdiChildActivate(EventArgs)Form.OnMenuStart(EventArgs)Form.OnMenuComplete(EventArgs)Form.OnResize(EventArgs)Form.OnDpiChanged(DpiChangedEventArgs)Form.OnGetDpiScaledSize(int, int, ref Size)Form.OnRightToLeftLayoutChanged(EventArgs)Form.OnTextChanged(EventArgs)Form.ProcessDialogChar(char)Form.ProcessKeyPreview(ref Message)Form.ProcessTabKey(bool)Form.RemoveOwnedForm(Form)Form.Select(bool, bool)Form.GetScaledBounds(Rectangle, SizeF, BoundsSpecified)Form.SetDesktopBounds(int, int, int, int)Form.SetDesktopLocation(int, int)Form.Show(IWin32Window)Form.ShowDialog()Form.ShowDialog(IWin32Window)Form.ToString()Form.OnResizeBegin(EventArgs)Form.OnResizeEnd(EventArgs)Form.OnStyleChanged(EventArgs)Form.ValidateChildren()Form.ValidateChildren(ValidationConstraints)Form.AcceptButtonForm.ActiveFormForm.ActiveMdiChildForm.AllowTransparencyForm.AutoScrollForm.AutoSizeForm.AutoSizeModeForm.AutoValidateForm.CancelButtonForm.ClientSizeForm.ControlBoxForm.DefaultImeModeForm.DefaultSizeForm.DesktopBoundsForm.DesktopLocationForm.DialogResultForm.HelpButtonForm.IconForm.IsMdiChildForm.IsMdiContainerForm.IsRestrictedWindowForm.KeyPreviewForm.LocationForm.MaximizedBoundsForm.MainMenuStripForm.MenuForm.MaximizeBoxForm.MdiChildrenForm.MdiParentForm.MergedMenuForm.MinimizeBoxForm.ModalForm.OpacityForm.OwnedFormsForm.OwnerForm.RestoreBoundsForm.RightToLeftLayoutForm.ShowInTaskbarForm.ShowWithoutActivationForm.SizeForm.SizeGripStyleForm.StartPositionForm.TopLevelForm.TopMostForm.TransparencyKeyForm.WindowStateForm.AutoSizeChangedForm.AutoValidateChangedForm.HelpButtonClickedForm.MaximizedBoundsChangedForm.MaximumSizeChangedForm.MinimumSizeChangedForm.ActivatedForm.DeactivateForm.FormClosingForm.FormClosedForm.LoadForm.MdiChildActivateForm.MenuCompleteForm.MenuStartForm.InputLanguageChangedForm.InputLanguageChangingForm.RightToLeftLayoutChangedForm.ShownForm.DpiChangedForm.ResizeBeginForm.ResizeEnd...

Constructors

Initializes the dialog's controls and built-in item palette without associating a layout control. Use RadLayoutControlCustomizeDialog(RadLayoutControl) to customize a live layout.

C#
public RadLayoutControlCustomizeDialog()

Initializes the customization dialog for the specified layout control.

C#
public RadLayoutControlCustomizeDialog(RadLayoutControl layoutControl)
Parameters:layoutControlRadLayoutControl

The layout control whose hidden items and structure are edited.

Properties

Gets the list-view group containing items currently hidden from the layout.

C#
protected ListViewDataItemGroup HiddenItemsGroup { get; }

Gets the palette entry used to add a splitter to the layout, allowing derived dialogs to customize its availability.

C#
protected ListViewDataItem SplitterItem { get; }

Methods

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

C#
protected virtual LayoutControlItemBase CreateNewItem(BaseListViewVisualItem draggedItem)
Parameters:draggedItemBaseListViewVisualItem

The dragged item.

Returns:

LayoutControlItemBase

The newly created item

Clean up any resources being used.

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

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

Overrides: RadForm.Dispose(bool)

Gets the drag context of a dragged item.

C#
protected virtual Type GetDragContext(ISupportDrag dragInstance)
Parameters:dragInstanceISupportDrag

The dragged item.

Returns:

Type

The type of the associated item.

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

C#
protected virtual Image GetItemImage(LayoutControlItemBase item)
Parameters:itemLayoutControlItemBase

The item to get the image for.

Returns:

Image

The image for that item.

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

C#
protected virtual string GetItemText(LayoutControlItemBase item)
Parameters:itemLayoutControlItemBase

The item to get the text for.

Returns:

string

The text for the item.

Resolves a layout-dialog string through the current LayoutControlLocalizationProvider.

C#
protected string GetString(string id)
Parameters:idstring

The localization key to resolve.

Returns:

string

The localized string for the key.

Handles dropping a list view item over an empty container.

C#
protected virtual void HandleDropOnEmptyContainer(DraggableLayoutControlOverlayElement overlayElement, BaseListViewVisualItem draggedItem)
Parameters:overlayElementDraggableLayoutControlOverlayElement

The container.

draggedItemBaseListViewVisualItem

The dragged item.

Handles dropping a list view item over a DraggableLayoutControlItem.

C#
protected virtual void HandleItemDrop(BaseListViewVisualItem draggedItem, DraggableLayoutControlItem target)
Parameters:draggedItemBaseListViewVisualItem

The dragged list view item.

targetDraggableLayoutControlItem

The drop target item.

Hides the drag overlay, removes layout-change subscriptions, and cancels closing so the dialog is hidden instead of disposed.

C#
protected override void OnClosing(CancelEventArgs e)
Parameters:eCancelEventArgs

The event data that can cancel the close operation.

Overrides: Form.OnClosing(CancelEventArgs)

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

C#
protected virtual void OnDragServiceDragDrop(object sender, RadDropEventArgs e)
Parameters:senderobjecteRadDropEventArgs

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

C#
protected virtual void OnDragServiceDragOver(object sender, RadDragOverEventArgs e)
Parameters:senderobjecteRadDragOverEventArgs

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

C#
protected virtual void OnDragServiceStopped(object sender, EventArgs e)
Parameters:senderobjecteEventArgs

Applies the larger dialog and button dimensions required by the Material theme.

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

The event data for the load operation.

Overrides: RadForm.OnLoad(EventArgs)

Handles the Click event of the Load Layout button.

C#
protected virtual void OnLoadLayoutButtonClick(object sender, EventArgs e)
Parameters:senderobjecteEventArgs

Repositions the main-panel controls after the dialog's right-to-left setting changes.

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

The event data for the right-to-left change.

Overrides: ScrollableControl.OnRightToLeftChanged(EventArgs)

Handles the Click event of the Save Layout button.

C#
protected virtual void OnSaveLayoutButtonClick(object sender, EventArgs e)
Parameters:senderobjecteEventArgs

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

C#
protected virtual void OnStructureTreeNodeEdited(object sender, TreeNodeEditedEventArgs e)
Parameters:senderobjecteTreeNodeEditedEventArgs

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

C#
protected virtual void OnStructureTreeViewMouseDown(object sender, MouseEventArgs e)
Parameters:senderobjecteMouseEventArgs

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

C#
protected virtual void OnStructureTreeViewMouseMove(object sender, MouseEventArgs e)
Parameters:senderobjecteMouseEventArgs

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

C#
protected virtual void OnStructureTreeViewNodeRemoving(object sender, RadTreeViewCancelEventArgs e)
Parameters:senderobjecteRadTreeViewCancelEventArgs

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

C#
protected virtual void OnStructureTreeViewSelectedNodeChanged(object sender, RadTreeViewEventArgs e)
Parameters:senderobjecteRadTreeViewEventArgs

Refreshes the dialog's hidden-item and structure views and subscribes to layout changes when the dialog becomes visible.

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

The event data for the visibility change.

Overrides: RadFormControlBase.OnVisibleChanged(EventArgs)

Closes the dialog when Escape is pressed; the close handler hides it instead of disposing it.

C#
protected override bool ProcessCmdKey(ref Message msg, Keys keyData)
Parameters:msgMessage

The message associated with the key.

keyDataKeys

The key and modifier data.

Returns:

bool

true when Escape is handled; otherwise, the base form's result.

Overrides: Form.ProcessCmdKey(ref Message, Keys)

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

C#
protected virtual void RightToLeftTranslate()

Called to update the Hidden Items group in the Items tab

C#
public virtual void UpdateHiddenItems()

Called to update the tree view in the Structure tab

C#
public virtual void UpdateItemsStructureTreeView()

Refreshes the dialog's item lists, structure tree, and built-in labels when the localization provider changes.

C#
protected virtual void UpdateLocalizableStrings(object sender, EventArgs e)
Parameters:senderobject

The event source.

eEventArgs

The event data.