New to Telerik UI for ASP.NET AJAX? Start a free 30-day trial

RadContextMenu

Class

This partial Class describes the client properties and events in RadContextMenu.

The RadContextMenu control is used to display context-aware options for various targets. Those targets are specified through the Targets property. RadContextMenu supports the following targets:

ContextMenuControlTarget - Used to associate a context menu with an ASP.NET Server control. Accepts the control ID as an argument.
ContextMenuElementTarget - Used to associate a context menu with an HTML element. Accepts the HTML element id as an argument.
ContextMenuDocumentTarget - Used to specify document-wide context menu.
ContextMenuTagNameTarget - Used to associate a context menu with all elements with the specified tag name (e.g. IMG, INPUT).

Definition

Namespace:Telerik.Web.UI

Assembly:Telerik.Web.UI.dll

Syntax:

[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Lightweight, typeof(RadContextMenu))]
[RequiredCss("Telerik.Web.UI.Skins.Common.fonticons.css", RenderMode.Mobile, typeof(RadContextMenu))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Lightweight, typeof(RadButton))]
[RequiredCss("Telerik.Web.UI.Skins.Common.MaterialRipple.css", RenderMode.Mobile, typeof(RadButton))]
[ClientScriptResource("Telerik.Web.UI.RadContextMenu", "Telerik.Web.UI.Menu.ContextMenu.RadContextMenuScripts.js", LoadOrder = 7)]
[TelerikToolboxCategory("Navigation")]
public class RadContextMenu : RadMenu, IComponent, IDisposable, IParserAccessor, IUrlResolutionService, IDataBindingsAccessor, IControlBuilderAccessor, IControlDesignerAccessor, IExpressionsAccessor, IAttributeAccessor, IScriptControl, IControlResolver, IPostBackDataHandler, ISkinnableControl, IControl, IFeatureGroup, INamingContainer, IXmlSerializable, IControlItemContainer, IRadMenuItemContainer, IPostBackEventHandler

Inheritance: objectControlWebControlBaseDataBoundControlDataBoundControlRadDataBoundControlControlItemContainerHierarchicalControlItemContainerRadMenuRadContextMenu...

Derived Classes: GridContextMenuPivotGridContextMenuRadFilterContextMenuRadNotificationContextMenuRadSchedulerContextMenuRadTreeViewContextMenuSpreadsheetContextMenu...

Implements: IAttributeAccessorIComponentIControlIControlBuilderAccessorIControlDesignerAccessorIControlItemContainerIControlResolverIDataBindingsAccessorIDisposableIExpressionsAccessorIFeatureGroupINamingContainerIParserAccessorIPostBackDataHandlerIPostBackEventHandlerIRadMenuItemContainerIScriptControlISkinnableControlIUrlResolutionServiceIXmlSerializable...

Constructors

RadContextMenu()

public RadContextMenu()

Properties

EnableSelection

bool

Gets or sets a value indicating if the currently selected item will be tracked and highlighted.

[ClientControlProperty]
[ClientPropertyName("enableSelection")]
public override bool EnableSelection { get; set; }

Overrides: RadMenu.EnableSelection

OnClientHidden

string

Gets or sets a value indicating the client-side event handler that is called when the RadContextMenu is hidden.

[ClientControlEvent]
[ClientPropertyName("hidden")]
public string OnClientHidden { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientHidden client-side event handler is called after the context menu is hidden on the client. Two parameters are passed to the handler:

sender, the menu client object;
eventArgs with one property, get_domEvent (a reference to the browser event).

Example:

The following example demonstrates how to use the
<strong>OnClientHidden</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;input type="text" id="txtContextMenuState" /&gt;
        &lt;script type="text/javascript"&gt;<br />
         function onClientHiddenHandler(sender, eventArgs)<br />
         {<br />
              document.getElementById("txtContextMenuState").value = "hidden";<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;Telerik:RadContextMenu ID="RadContextMenu1"<br />
         runat= "server"<br />
        <strong>OnClientHidden="onClientHiddenHandler"</strong>&gt;<br />
        ....<br />
        &lt;/Telerik:RadContextMenu&gt;
    </div>
</p>

OnClientHiding

string

Gets or sets a value indicating the client-side event handler that is called when the RadContextMenu is to be hidden.

[ClientControlEvent]
[ClientPropertyName("hiding")]
public virtual string OnClientHiding { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientHiding client-side event handler is called before the context menu is hidden on the client. Two parameters are passed to the handler:

sender, the menu client object;
eventArgs with two properties, get_cancel()/set_cancel(cancel) and get_domEvent (a reference to the browser event).

The OnClientHiding event can be cancelled. To do so, set the cancel property to false from the event handler (e.g. eventArgs.set_cancel(true);).

Example:

The following example demonstrates how to use the
<strong>OnClientHiding</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         function onClientShowingHandler(sender, eventArgs)<br />
         {<br />
             var shouldHide = confirm("Do you want to hide the context menu?")
              eventArgs.set_cancel(!shouldHide);<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;Telerik:RadContextMenu ID="RadContextMenu1"<br />
         runat= "server"<br />
        <strong>OnClientHiding="onClientHidingHandler"</strong>&gt;<br />
        ....<br />
        &lt;/Telerik:RadContextMenu&gt;
    </div>
</p>

OnClientShowing

string

Gets or sets a value indicating the client-side event handler that is called when the RadContextMenu is to be displayed.

[ClientControlEvent]
[ClientPropertyName("showing")]
public virtual string OnClientShowing { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientShowing client-side event handler is called before the context menu is shown on the client. Two parameters are passed to the handler:

sender, the menu client object;
eventArgs with two properties, get_cancel()/set_cancel(cancel) and get_domEvent (a reference to the browser event).

The OnClientShowing event can be cancelled. To do so, set the cancel property to false from the event handler (e.g. eventArgs.set_cancel(true);).

Example:

The following example demonstrates how to use the
<strong>OnClientShowing</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;script type="text/javascript"&gt;<br />
         var shouldDisplayContextMenu = confirm("Do you want to enable context menus on this page?");
         function onClientShowingHandler(sender, eventArgs)<br />
         {<br />
              eventArgs.set_cancel(!shouldDisplayContextMenu);<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;Telerik:RadContextMenu ID="RadContextMenu1"<br />
         runat= "server"<br />
        <strong>OnClientShowing="onClientShowingHandler"</strong>&gt;<br />
        ....<br />
        &lt;/Telerik:RadContextMenu&gt;
    </div>
</p>

OnClientShown

string

Gets or sets a value indicating the client-side event handler that is called when the RadContextMenu is displayed.

[ClientControlEvent]
[ClientPropertyName("shown")]
public virtual string OnClientShown { get; set; }

Property Value:

A string specifying the name of the JavaScript function that will handle the event. The default value is empty string.

If specified, the OnClientShown client-side event handler is called after the context menu is shown on the client. Two parameters are passed to the handler:

sender, the menu client object;
eventArgs with one property, get_domEvent (a reference to the browser event).

Example:

The following example demonstrates how to use the
<strong>OnClientShown</strong> property.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;input type="text" id="txtContextMenuState" value="hidden" /&gt;
        &lt;script type="text/javascript"&gt;<br />
         function onClientShownHandler(sender, eventArgs)<br />
         {<br />
              document.getElementById("txtContextMenuState").value = "shown";<br />
         }<br />
        &lt;/script&gt;
    </div>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;Telerik:RadContextMenu ID="RadContextMenu1"<br />
         runat= "server"<br />
        <strong>OnClientShown="onClientShownHandler"</strong>&gt;<br />
        ....<br />
        &lt;/Telerik:RadContextMenu&gt;
    </div>
</p>

SupportsAdaptiveRendering

bool

protected override bool SupportsAdaptiveRendering { get; }

Overrides: RadDataBoundControl.SupportsAdaptiveRendering

Targets

ContextMenuTargetCollection

Gets the collection containing the targets to which right-click RadContextMenu will attach.

[PersistenceMode(PersistenceMode.InnerProperty)]
public virtual ContextMenuTargetCollection Targets { get; }

Property Value:

A ContextMenuTargetCollection containing the targets to which RadContextMenu will attach.

RadContextMenu can attach to four target types: ASP.NET control, element on the page, document, set of client-side elements, specified by tagName.

Example:

This example demonstrates how to configure RadContextMenu to be displayed
       when a specific textbox on the page is right clicked.

<p>
    <div class="LanguageSpecific" name="Code_VB">
        &lt;asp:TextBox ID="TextBox1" runat="server"/gt;<br />
        &lt;Telerik:RadContextMenu ID="RadContextMenu1" runat="server"&gt;<br />
            &lt;Targets&gt;<br />
                &lt;Telerik:RadContextMenuControlTarget ControlID="TextBox1"/&gt;<br />
            &lt;/Targets&gt;<br />
        &lt;/Telerik:RadContextMenu&gt;
    </div>
</p>

Methods

AddAttributesToRender(HtmlTextWriter)

protected override void AddAttributesToRender(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadMenu.AddAttributesToRender(HtmlTextWriter)

CreateControlRenderer()

protected override IRenderer CreateControlRenderer()

Returns:

IRenderer

Overrides: RadMenu.CreateControlRenderer()

DescribeClientEvents(IScriptDescriptor)

protected override void DescribeClientEvents(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadMenu.DescribeClientEvents(IScriptDescriptor)

DescribeClientProperties(IScriptDescriptor)

protected override void DescribeClientProperties(IScriptDescriptor descriptor)

Parameters:descriptorIScriptDescriptor

Overrides: RadMenu.DescribeClientProperties(IScriptDescriptor)

LoadViewState(object)

protected override void LoadViewState(object savedState)

Parameters:savedStateobject

Overrides: HierarchicalControlItemContainer.LoadViewState(object)

RenderContents(HtmlTextWriter)

protected override void RenderContents(HtmlTextWriter writer)

Parameters:writerHtmlTextWriter

Overrides: RadMenu.RenderContents(HtmlTextWriter)

SaveViewState()

protected override object SaveViewState()

Returns:

object

Overrides: HierarchicalControlItemContainer.SaveViewState()

TrackViewState()

protected override void TrackViewState()

Overrides: HierarchicalControlItemContainer.TrackViewState()