WebPartMenuStyle Class
TOC
Collapse the table of content
Expand the table of content

WebPartMenuStyle Class

 

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

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

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

public sealed class WebPartMenuStyle : TableStyle, ICustomTypeDescriptor

NameDescription
System_CAPS_pubmethodWebPartMenuStyle()

Initializes a new instance of the WebPartMenuStyle class using default style values.

System_CAPS_pubmethodWebPartMenuStyle(StateBag)

Initializes a new instance of the WebPartMenuStyle class using style values from the specified state bag object.

NameDescription
System_CAPS_pubpropertyBackColor

Gets or sets the background color of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyBackImageUrl

Gets or sets the URL of an image to display in the background of a table control.(Inherited from TableStyle.)

System_CAPS_pubpropertyBorderColor

Gets or sets the border color of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyBorderStyle

Gets or sets the border style of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyBorderWidth

Gets or sets the border width of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyCellPadding

Gets or sets the amount of space between the contents of the cell and the cell's border.(Inherited from TableStyle.)

System_CAPS_pubpropertyCellSpacing

Gets or sets the distance between table cells.(Inherited from TableStyle.)

System_CAPS_pubpropertyContainer

Gets the IContainer that contains the Component.(Inherited from Component.)

System_CAPS_pubpropertyCssClass

Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client.(Inherited from Style.)

System_CAPS_pubpropertyFont

Gets the font properties associated with the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyForeColor

Gets or sets the foreground color (typically the color of the text) of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyGridLines

Gets or sets a value that specifies whether the border between the cells of the table control is displayed.(Inherited from TableStyle.)

System_CAPS_pubpropertyHeight

Gets or sets the height of the Web server control.(Inherited from Style.)

System_CAPS_pubpropertyHorizontalAlign

Gets a value indicating what type of horizontal alignment to use for the content of a menu on a WebPart control.(Overrides TableStyle.HorizontalAlign.)

System_CAPS_pubpropertyIsEmpty

This API supports the product infrastructure and is not intended to be used directly from your code. A protected property. Gets a value indicating whether any style elements have been defined in the state bag.(Inherited from Style.)

System_CAPS_pubpropertyRegisteredCssClass

Gets the cascading style sheet (CSS) class that is registered with the control.(Inherited from Style.)

System_CAPS_pubpropertyShadowColor

Gets or sets a value that determines the shadow color for a menu on a WebPart control.

System_CAPS_pubpropertySite

Gets or sets the ISite of the Component.(Inherited from Component.)

System_CAPS_protpropertyViewState

This API supports the product infrastructure and is not intended to be used directly from your code. Gets the state bag that holds the style elements.(Inherited from Style.)

System_CAPS_pubpropertyWidth

Gets or sets the width of the Web server control.(Inherited from Style.)

NameDescription
System_CAPS_pubmethodAddAttributesToRender(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.)

System_CAPS_pubmethodAddAttributesToRender(HtmlTextWriter, WebControl)

This API supports the product infrastructure and is not intended to be used directly from your code. Adds information about the background image, cell spacing, cell padding, gridlines, and alignment to the list of attributes to render.(Inherited from TableStyle.)

System_CAPS_pubmethodCopyFrom(Style)

This API supports the product infrastructure and is not intended to be used directly from your code. Copies nonblank style elements to the WebPartMenuStyle object, overwriting any existing style elements in the process. (Overrides TableStyle.CopyFrom(Style).)

System_CAPS_pubmethodCreateObjRef(Type)

Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodDispose()

Releases all resources used by the Component.(Inherited from Component.)

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetLifetimeService()

Retrieves the current lifetime service object that controls the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_pubmethodGetStyleAttributes(IUrlResolutionService)

Retrieves the System.Web.UI.CssStyleCollection object for the specified System.Web.UI.IUrlResolutionService-implemented object.(Inherited from Style.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodInitializeLifetimeService()

Obtains a lifetime service object to control the lifetime policy for this instance.(Inherited from MarshalByRefObject.)

System_CAPS_protmethodLoadViewState(Object)

Loads the previously saved state.(Inherited from Style.)

System_CAPS_pubmethodMergeWith(Style)

This API supports the product infrastructure and is not intended to be used directly from your code. Copies nonblank style elements to the WebPartMenuStyle instance, but does not overwrite existing style elements.(Overrides TableStyle.MergeWith(Style).)

System_CAPS_pubmethodReset()

This API supports the product infrastructure and is not intended to be used directly from your code. Removes any defined style elements from the WebPartMenuStyle object's state bag.(Overrides TableStyle.Reset().)

System_CAPS_protmethodSaveViewState()

A protected method. Saves any state that has been modified after the TrackViewState method was invoked.(Inherited from Style.)

System_CAPS_protmethodSetBit(Int32)

This API supports the product infrastructure and is not intended to be used directly from your code. A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag.(Inherited from Style.)

System_CAPS_pubmethodSetDirty()

Marks the Style so that its state will be recorded in view state.(Inherited from Style.)

System_CAPS_pubmethodToString()

Returns a String containing the name of the Component, if any. This method should not be overridden.(Inherited from Component.)

System_CAPS_protmethodTrackViewState()

A 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.)

NameDescription
System_CAPS_pubeventDisposed

Occurs when the component is disposed by a call to the Dispose method. (Inherited from Component.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetAttributes()

Returns a collection of custom attributes for this instance of a component. Implements the ICustomTypeDescriptor.GetAttributes method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetClassName()

Returns the class name of this instance of a component. This method implements the ICustomTypeDescriptor.GetClassName method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetComponentName()

Returns the name of this instance of a component. This method implements the ICustomTypeDescriptor.GetComponentName method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetConverter()

Returns a type converter for this instance of a component. This method implements the ICustomTypeDescriptor.GetConverter method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetDefaultEvent()

Returns the default event for this instance of a component. This method implements the ICustomTypeDescriptor.GetDefaultEvent method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetDefaultProperty()

Returns the default property for this instance of a component. This method implements the ICustomTypeDescriptor.GetDefaultProperty method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetEditor(Type)

Returns an editor of the specified type for this instance of a component. This method implements the ICustomTypeDescriptor.GetEditor method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetEvents()

Returns the events for this instance of a component. This method implements the ICustomTypeDescriptor.GetEvents() method overload.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetProperties()

Returns the properties for this instance of a component. This method implements the ICustomTypeDescriptor.GetProperties() method overload.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.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.

System_CAPS_pubinterfaceSystem_CAPS_privmethodICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)

Returns an object that contains the property described by the specified property descriptor. This method implements the ICustomTypeDescriptor.GetPropertyOwner method.

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.LoadViewState(Object)

This API supports the product infrastructure and is not intended to be used directly from your code. Loads the previously saved state.(Inherited from Style.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.SaveViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Returns the object containing state changes.(Inherited from Style.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIStateManager.TrackViewState()

This API supports the product infrastructure and is not intended to be used directly from your code. Starts tracking state changes.(Inherited from Style.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyIStateManager.IsTrackingViewState

Gets a value that indicates whether a server control is tracking its view state changes.(Inherited from Style.)

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.

System_CAPS_importantImportant

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
Available since 2.0

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

Return to top
Show:
© 2016 Microsoft