Export (0) Print
Expand All

WebPartMenuStyle Class

Contains style characteristics for menus on WebPart controls. This class cannot be inherited.

System.Object
  System.MarshalByRefObject
    System.ComponentModel.Component
      System.Web.UI.WebControls.Style
        System.Web.UI.WebControls.TableStyle
          System.Web.UI.WebControls.WebParts.WebPartMenuStyle

Namespace:  System.Web.UI.WebControls.WebParts
Assembly:  System.Web (in System.Web.dll)

public sealed class WebPartMenuStyle : TableStyle, 
	ICustomTypeDescriptor

The WebPartMenuStyle type exposes the following members.

  NameDescription
Public methodWebPartMenuStyle()Initializes a new instance of the WebPartMenuStyle class using default style values.
Public methodWebPartMenuStyle(StateBag)Initializes a new instance of the WebPartMenuStyle class using style values from the specified state bag object.
Top

  NameDescription
Public propertyBackColorGets or sets the background color of the Web server control. (Inherited from Style.)
Public propertyBackImageUrlGets or sets the URL of an image to display in the background of a table control. (Inherited from TableStyle.)
Public propertyBorderColorGets or sets the border color of the Web server control. (Inherited from Style.)
Public propertyBorderStyleGets or sets the border style of the Web server control. (Inherited from Style.)
Public propertyBorderWidthGets or sets the border width of the Web server control. (Inherited from Style.)
Public propertyCellPaddingGets or sets the amount of space between the contents of the cell and the cell's border. (Inherited from TableStyle.)
Public propertyCellSpacingGets or sets the distance between table cells. (Inherited from TableStyle.)
Public propertyContainerGets the IContainer that contains the Component. (Inherited from Component.)
Public propertyCssClassGets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client. (Inherited from Style.)
Public propertyFontGets the font properties associated with the Web server control. (Inherited from Style.)
Public propertyForeColorGets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from Style.)
Public propertyGridLinesGets or sets a value that specifies whether the border between the cells of the table control is displayed. (Inherited from TableStyle.)
Public propertyHeightGets or sets the height of the Web server control. (Inherited from Style.)
Public propertyHorizontalAlignGets a value indicating what type of horizontal alignment to use for the content of a menu on a WebPart control. (Overrides TableStyle.HorizontalAlign.)
Public propertyIsEmptyInfrastructure. A protected property. Gets a value indicating whether any style elements have been defined in the state bag. (Inherited from Style.)
Public propertyRegisteredCssClassGets the cascading style sheet (CSS) class that is registered with the control. (Inherited from Style.)
Public propertyShadowColorGets or sets a value that determines the shadow color for a menu on a WebPart control.
Public propertySiteGets or sets the ISite of the Component. (Inherited from Component.)
Protected propertyViewStateInfrastructure. Gets the state bag that holds the style elements. (Inherited from Style.)
Public propertyWidthGets or sets the width of the Web server control. (Inherited from Style.)
Top

  NameDescription
Public methodAddAttributesToRender(HtmlTextWriter)Adds HTML attributes and styles that need to be rendered to the specified System.Web.UI.HtmlTextWriter. This method is primarily used by control developers. (Inherited from Style.)
Public methodAddAttributesToRender(HtmlTextWriter, WebControl)Infrastructure. Adds information about the background image, cell spacing, cell padding, gridlines, and alignment to the list of attributes to render. (Inherited from TableStyle.)
Public methodCopyFromInfrastructure. Copies nonblank style elements to the WebPartMenuStyle object, overwriting any existing style elements in the process. (Overrides TableStyle.CopyFrom(Style).)
Public methodCreateObjRefCreates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. (Inherited from MarshalByRefObject.)
Public methodDispose()Releases all resources used by the Component. (Inherited from Component.)
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetLifetimeServiceRetrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Public methodGetStyleAttributesRetrieves the System.Web.UI.CssStyleCollection object for the specified System.Web.UI.IUrlResolutionService-implemented object. (Inherited from Style.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeLifetimeServiceObtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject.)
Protected methodLoadViewStateLoads the previously saved state. (Inherited from Style.)
Public methodMergeWithInfrastructure. Copies nonblank style elements to the WebPartMenuStyle instance, but does not overwrite existing style elements. (Overrides TableStyle.MergeWith(Style).)
Public methodResetInfrastructure. Removes any defined style elements from the WebPartMenuStyle object's state bag. (Overrides TableStyle.Reset().)
Protected methodSaveViewStateA protected method. Saves any state that has been modified after the TrackViewState method was invoked. (Inherited from Style.)
Protected methodSetBitInfrastructure. A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag. (Inherited from Style.)
Public methodSetDirtyMarks the Style so that its state will be recorded in view state. (Inherited from Style.)
Public methodToStringReturns a String containing the name of the Component, if any. This method should not be overridden. (Inherited from Component.)
Protected methodTrackViewStateA protected method. Marks the beginning for tracking state changes on the control. Any changes made after tracking has begun will be tracked and saved as part of the control view state. (Inherited from Style.)
Top

  NameDescription
Public eventDisposedOccurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)
Top

  NameDescription
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetAttributesReturns a collection of custom attributes for this instance of a component. Implements the ICustomTypeDescriptor.GetAttributes method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetClassNameReturns the class name of this instance of a component. This method implements the ICustomTypeDescriptor.GetClassName method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetComponentNameReturns the name of this instance of a component. This method implements the ICustomTypeDescriptor.GetComponentName method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetConverterReturns a type converter for this instance of a component. This method implements the ICustomTypeDescriptor.GetConverter method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetDefaultEventReturns the default event for this instance of a component. This method implements the ICustomTypeDescriptor.GetDefaultEvent method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetDefaultPropertyReturns the default property for this instance of a component. This method implements the ICustomTypeDescriptor.GetDefaultProperty method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetEditorReturns an editor of the specified type for this instance of a component. This method implements the ICustomTypeDescriptor.GetEditor method.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetEvents()Returns the events for this instance of a component. This method implements the ICustomTypeDescriptor.GetEvents() method overload.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetEvents(Attribute[])Returns the events for this instance of a component using the specified attribute array as a filter. This method implements the ICustomTypeDescriptor.GetEvents(Attribute[]) method overload.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetProperties()Returns the properties for this instance of a component. This method implements the ICustomTypeDescriptor.GetProperties() method overload.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetProperties(Attribute[])Returns the properties for this instance of a component using the attribute array as a filter. This method implements the ICustomTypeDescriptor.GetProperties(Attribute[]) method overload.
Explicit interface implemetationPrivate methodICustomTypeDescriptor.GetPropertyOwnerReturns an object that contains the property described by the specified property descriptor. This method implements the ICustomTypeDescriptor.GetPropertyOwner method.
Explicit interface implemetationPrivate propertyIStateManager.IsTrackingViewStateGets a value that indicates whether a server control is tracking its view state changes. (Inherited from Style.)
Explicit interface implemetationPrivate methodIStateManager.LoadViewStateInfrastructure. Loads the previously saved state. (Inherited from Style.)
Explicit interface implemetationPrivate methodIStateManager.SaveViewStateInfrastructure. Returns the object containing state changes. (Inherited from Style.)
Explicit interface implemetationPrivate methodIStateManager.TrackViewStateInfrastructure. Starts tracking state changes. (Inherited from Style.)
Top

The WebPartMenuStyle class is essentially a TableStyle object, which contains style characteristics to apply to menus on WebPart controls.

The Web Parts control set uses the WebPartMenuStyle object to determine the style characteristics of the verbs menu on a WebPart control. A verbs menu is contained in the title bar of each WebPart control, and it includes various user interface (UI) actions (called verbs) that users can perform, such as closing, minimizing, exporting, or deleting a control.

Important noteImportant

You can set style attributes on the WebPartMenuStyle object, and thus on the verbs menu of all the WebPart controls in a zone, by using the MenuPopupStyle property on a WebPartZoneBase zone.

The WebPartMenuStyle class has two important properties. The first is the HorizontalAlign property, which determines whether the content of the menu is aligned on the left, the center, or the right of the control or the alignment is not set. The ShadowColor property determines the color of the shadow for the menu on a WebPart control, if the menu shadowing feature is enabled on the user's system.

The WebPartMenuStyle class also has some critical methods. The CopyFrom method copies nonblank style elements from the style object passed into the method, and applies them to the WebPartMenuStyle object, overwriting any existing style elements in the process. The MergeWith method similarly copies nonblank style elements from the style object passed to the method, but it does not overwrite existing style elements in the WebPartMenuStyle object. The Reset method removes any defined style elements from the WebPartMenuStyle object's state bag.

The WebPartMenuStyle class also implements all the methods contained in the ICustomTypeDescriptor interface. In general, this enables the WebPartMenuStyle class to be applied to different types of menus.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Show:
© 2014 Microsoft