Share via


Menu Members

Include Protected Members
Include Inherited Members

Represents a custom menu for the Web Part page.

The Menu type exposes the following members.

Constructors

  Name Description
Public method Menu() Initializes a new instance of the Menu class with default values.
Public method Menu(String) Initializes a new instance of the Menu class with the specified label.
Public method Menu(String, String) Initializes a new instance of the Menu class with the specified label and target URL.

Top

Properties

  Name Description
Public property AccessKey (Inherited from WebControl.)
Protected property Adapter (Inherited from Control.)
Public property AlignmentElementOverrideClientId Gets or sets the client-side element that is used to align the menu.
Public property AppRelativeTemplateSourceDirectory (Inherited from Control.)
Public property ArrowImageHeight Gets or sets the height of a clustered down arrow image.
Public property ArrowImageHtml
Public property ArrowImageOffsetX Gets or sets the x-axis offset of a clustered down arrow image.
Public property ArrowImageOffsetY Gets or sets the y-axis offset of a clustered down arrow image.
Public property ArrowImageUrl Gets or sets the URL of the arrow image.
Public property ArrowImageWidth Gets or sets the width of a clustered down arrow image.
Public property Attributes (Inherited from WebControl.)
Public property BackColor (Inherited from WebControl.)
Public property BindingContainer (Inherited from Control.)
Public property BorderColor (Inherited from WebControl.)
Public property BorderStyle (Inherited from WebControl.)
Public property BorderWidth (Inherited from WebControl.)
Public property CallbackArgument
Public property CancelOnclickEvent Gets or sets a value that indicates whether the OnClick event is canceled after the menu OnClick event handle has been triggered.
Public property CheckedMenuItemIds Gets or sets the ID of the checked menu items.
Public property CheckedMenuItems Gets the value of the checked menu items.
Protected property ChildControlsCreated (Inherited from Control.)
Public property ClientAlternativeOnClickScript
Public property ClientID (Overrides Control.ClientID.)
Public property ClientIdOverride Gets or sets the value of the client ID override string.
Protected property ClientIDSeparator (Inherited from Control.)
Public property ClientOnClickPreMenuOpen Gets or sets the value for [ClientOnClickPreMenuOpen].
Public property ClientOnClickScript Gets or sets the script to execute when a split-button is clicked.
Protected property Context (Inherited from Control.)
Public property Controls (Inherited from Control.)
Public property ControlStyle (Inherited from WebControl.)
Public property ControlStyleCreated (Inherited from WebControl.)
Public property CssClass (Inherited from WebControl.)
Protected property DesignMode (Inherited from Control.)
Public property DisabledMenuItemIds Gets or sets the identifiers of the MenuItemTemplate controls to be disabled.
Public property DisabledMenuItems Gets a generic collection object that contains references to the MenuItemTemplate controls that should be disabled on this menu.
Public property Enabled (Inherited from WebControl.)
Public property EnableTheming (Inherited from WebControl.)
Public property EnableTreeViewClickToOpen Gets or sets a value that indicates whether a TreeView node should open the Edit Control Block (ECB) when the user clicks the node.
Public property EnableViewState (Inherited from Control.)
Protected property Events (Inherited from Control.)
Public property Font (Inherited from WebControl.)
Public property ForeColor (Inherited from WebControl.)
Public property GetMenuFromIdClientFunction Gets or sets the name of the client-side function that gets menu elements from a client identifier.
Public property HasAttributes (Inherited from WebControl.)
Protected property HasChildViewState (Inherited from Control.)
Public property Height (Inherited from WebControl.)
Public property HiddenMenuItemIds Gets or sets the identifiers of the MenuItemTemplate controls to be hidden.
Public property HiddenMenuItems Gets a generic collection object that contains references to the MenuItemTemplate controls that should be hidden on this menu.
Public property HoverArrowImageHeight Gets or sets the height of a clustered hover down arrow image.
Public property HoverArrowImageOffsetX Gets or sets the x-axis offset of a clustered hover down arrow image.
Public property HoverArrowImageOffsetY Gets or sets the y-axis offset of a clustered hover down arrow image.
Public property HoverArrowImageUrl Gets or sets the URL of the hover down arrow image.
Public property HoverArrowImageWidth Gets or sets the width of a clustered hover down arrow image.
Public property HoverCellActiveCssClass Gets or sets the Cascading Style Sheet (CSS) class or classes to apply to the cell surrounding the menu text when the pointer moves over the cell.
Public property HoverCellInActiveCssClass Gets or sets the Cascading Style Sheets (CSS) class or classes to apply to the cell surrounding the menu text.
Public property ID (Inherited from Control.)
Protected property IdSeparator (Inherited from Control.)
Public property ImageAlternativeText Gets or sets the image alternative text.
Public property ImageTextSpacing
Public property ImageUrl Gets or sets the URL of the image to be displayed with the link text.
Protected property IsChildControlStateCleared (Inherited from Control.)
Protected property IsEnabled (Inherited from WebControl.)
Protected property IsTrackingViewState (Inherited from Control.)
Protected property IsViewStateEnabled (Inherited from Control.)
Public property LinkExtraAttributes Gets the extra cursor attributes that go with the specified menu control context.
Public property LinkExtraAttributesDictionary Gets the LinkExtraAttributes string as an attribute collection.
Protected property LoadViewStateByID (Inherited from Control.)
Public property MenuAlignment Gets or sets the alignment of the current menu instance.
Public property MenuFormat Gets or sets the display format of the menu item.
Public property MenuNotVisibleHtml
Public property NamingContainer (Inherited from Control.)
Public property href Gets or sets the navigation URL.
Public property Page (Inherited from Control.)
Public property Parent (Inherited from Control.)
Public property PermissionTrimButton Gets or sets a value that indicates whether the menu link will be trimmed based on permission.
Public property PostLinkHtml Gets the post link html.
Public property PrefixHtml
Public property PreLinkHtml Gets the pre-link html.
Public property RightImageUrl Gets or sets the URL of the image to display after the link text.
Public property Site (Inherited from Control.)
Public property SkinID (Inherited from WebControl.)
Public property Style (Inherited from WebControl.)
Public property SuffixHtml Gets or sets the suffix html.
Public property SuppressBubbleIfPostback Gets or sets a value that indicates whether certain results of the OnClick event, such as the bubble cursor display and menu item opening, are to be suppressed if a child link intends to post back.
Public property SystemTokenNamesAndValues Gets the token names and values.
Public property SystemTokenNamesAndValuesInitialized Gets the Boolean value indicating that the system token names and values have been initialized.
Public property TabIndex (Inherited from WebControl.)
Protected property TagKey (Inherited from WebControl.)
Protected property TagName (Inherited from WebControl.)
Public property Template Gets or sets the MenuTemplate that this menu should use.
Public property TemplateControl (Inherited from Control.)
Public property TemplateId A string indicating the Id of the MenuTemplate control to be used.
Public property TemplateSourceDirectory (Inherited from Control.)
Public property Text Gets or sets the text label for this menu.
Public property TextCssClass
Public property TokenNamesAndValues Gets the token name and value pairs to use for the current menu.
Public property TokenValues Gets or sets the list of token names and values by using a string containing the concatenated list of name/value pairs.
Public property ToolTip (Overrides WebControl.ToolTip.)
Public property UniqueID (Inherited from Control.)
Public property UseDivForMenu Gets or sets a value that indicates whether to use a div tag to surround the menu element.
Public property UseMaximumWidth Gets or sets a value that indicates whether this menu attempts to consume the full width of its container.
Public property UseShortId Gets or sets a value that indicates whether the menu uses the short version of the menu identifier.
Protected property ViewState (Inherited from Control.)
Protected property ViewStateIgnoresCase (Inherited from Control.)
Public property Visible (Overrides Control.Visible.)
Public property Width (Inherited from WebControl.)

Top

Methods

  Name Description
Protected method AddAttributesToRender (Inherited from WebControl.)
Protected method AddedControl (Inherited from Control.)
Protected method AddParsedSubObject (Inherited from Control.)
Public method ApplyStyle (Inherited from WebControl.)
Public method ApplyStyleSheetSkin (Inherited from Control.)
Protected method BuildProfileTree (Inherited from Control.)
Protected method ClearChildControlState (Inherited from Control.)
Protected method ClearChildState (Inherited from Control.)
Protected method ClearChildViewState (Inherited from Control.)
Public method CopyBaseAttributes (Inherited from WebControl.)
Protected method CreateChildControls (Inherited from Control.)
Protected method CreateControlCollection (Inherited from Control.)
Protected method CreateControlStyle (Inherited from WebControl.)
Public method DataBind() (Inherited from Control.)
Protected method DataBind(Boolean) (Inherited from Control.)
Protected method DataBindChildren (Inherited from Control.)
Public methodStatic member DecodeClientTokenValue
Public method Dispose (Inherited from Control.)
Public methodStatic member EncodeClientTokenValue
Protected method EnsureChildControls (Inherited from Control.)
Protected method EnsureID (Inherited from Control.)
Public methodStatic member EnsureOnlyValidSystemTokenNames
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method FindControl(String) (Inherited from Control.)
Protected method FindControl(String, Int32) (Inherited from Control.)
Public method Focus (Inherited from Control.)
Protected method GenerateCallbackResultInternal
Public method GetCallbackResult
Protected method GetDesignModeState (Inherited from Control.)
Public method GetHashCode (Inherited from Object.)
Public method GetType (Inherited from Object.)
Public method HasControls (Inherited from Control.)
Protected method HasEvents (Inherited from Control.)
Public method InitializeControlIds Sets the properties that could not be initialized correctly during the point in the control life cycle when they were set for the first time.
Protected method IsLiteralContent (Inherited from Control.)
Public methodStatic member IsValidSystemTokenName
Protected method LoadControlState (Inherited from Control.)
Protected method LoadViewState (Inherited from WebControl.)
Protected method MapPathSecure (Inherited from Control.)
Protected method MemberwiseClone (Inherited from Object.)
Public method MergeStyle (Inherited from WebControl.)
Protected method OnBubbleEvent (Inherited from Control.)
Protected method OnCallbackMenuGeneration
Protected method OnDataBinding (Inherited from Control.)
Protected method OnInit (Inherited from Control.)
Protected method OnLoad (Overrides Control.OnLoad(EventArgs).)
Protected method OnPreRender (Inherited from Control.)
Public method OnPreRenderOverride
Protected method OnUnload (Inherited from Control.)
Protected method OpenFile (Inherited from Control.)
Protected method RaiseBubbleEvent (Inherited from Control.)
Public method RaiseCallbackEvent
Protected method RemovedControl (Inherited from Control.)
Protected method Render Renders this control to the HTML writer. (Overrides WebControl.Render(HtmlTextWriter).)
Public method RenderBeginTag (Inherited from WebControl.)
Protected method RenderChildren (Inherited from Control.)
Protected method RenderContents (Inherited from WebControl.)
Public method RenderControl(HtmlTextWriter) (Inherited from Control.)
Protected method RenderControl(HtmlTextWriter, ControlAdapter) (Inherited from Control.)
Public method RenderEndTag (Inherited from WebControl.)
Protected method ResolveAdapter (Inherited from Control.)
Public method ResolveClientUrl (Inherited from Control.)
Public method ResolveUrl (Inherited from Control.)
Protected method SaveControlState (Inherited from Control.)
Protected method SaveViewState (Inherited from WebControl.)
Protected method SetDesignModeState (Inherited from Control.)
Public method SetRenderMethodDelegate (Inherited from Control.)
Public method ToString (Inherited from Object.)
Protected method TrackViewState (Inherited from WebControl.)

Top

Events

  Name Description
Public event CallbackMenuGeneration Occurs when the server control creates the callback menu template.
Public event DataBinding (Inherited from Control.)
Public event Disposed (Inherited from Control.)
Public event Init (Inherited from Control.)
Public event Load (Inherited from Control.)
Public event PreRender (Inherited from Control.)
Public event Unload (Inherited from Control.)

Top

Fields

  Name Description
Public fieldStatic member AttributeListDelimiter Specifies the character used as a delimiter for control identifiers and name/value pairs.
Public fieldStatic member AttributeListDelimiterAsString Represents the string version of the character used as a delimiter for control Ids and name/value pairs but is already in string form.
Public fieldStatic member AttributeListDelimiterEncoded Represents the encoded form of the character used as the delimiter for attribute lists.
Public fieldStatic member AttributeListSecondaryEncodedDelimiter Represents the encoded version of the secondary character used as the delimiter for attribute lists.
Public fieldStatic member AttributeListSecondaryEncodedDelimiterAsString
Public fieldStatic member AttributeListSecondaryEncodedDelimiterEncoded

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IParserAccessor.AddParsedSubObject (Inherited from Control.)
Explicit interface implemetationPrivate property IControlBuilderAccessor.ControlBuilder (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.DataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.Expressions (Inherited from Control.)
Explicit interface implemetationPrivate method IAttributeAccessor.GetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.GetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate property IDataBindingsAccessor.HasDataBindings (Inherited from Control.)
Explicit interface implemetationPrivate property IExpressionsAccessor.HasExpressions (Inherited from Control.)
Explicit interface implemetationPrivate method IAttributeAccessor.SetAttribute (Inherited from WebControl.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetDesignModeState (Inherited from Control.)
Explicit interface implemetationPrivate method IControlDesignerAccessor.SetOwnerControl (Inherited from Control.)
Explicit interface implemetationPrivate property IControlDesignerAccessor.UserData (Inherited from Control.)

Top

See Also

Reference

Menu Class

Microsoft.SharePoint.WebControls Namespace