WebPartMenuStyle Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Contains style characteristics for menus on WebPart controls. This class cannot be inherited.
public ref class WebPartMenuStyle sealed : System::Web::UI::WebControls::TableStyle, System::ComponentModel::ICustomTypeDescriptorpublic sealed class WebPartMenuStyle : System.Web.UI.WebControls.TableStyle, System.ComponentModel.ICustomTypeDescriptortype WebPartMenuStyle = class
inherit TableStyle
interface ICustomTypeDescriptorPublic NotInheritable Class WebPartMenuStyle
Inherits TableStyle
Implements ICustomTypeDescriptor- Inheritance
- Implements
Remarks
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
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.
Constructors
| WebPartMenuStyle() |
Initializes a new instance of the WebPartMenuStyle class using default style values. |
| WebPartMenuStyle(StateBag) |
Initializes a new instance of the WebPartMenuStyle class using style values from the specified state bag object. |
Properties
| BackColor |
Gets or sets the background color of the Web server control. (Inherited from Style) |
| BackImageUrl |
Gets or sets the URL of an image to display in the background of a table control. (Inherited from TableStyle) |
| BorderColor |
Gets or sets the border color of the Web server control. (Inherited from Style) |
| BorderStyle |
Gets or sets the border style of the Web server control. (Inherited from Style) |
| BorderWidth |
Gets or sets the border width of the Web server control. (Inherited from Style) |
| CanRaiseEvents |
Gets a value indicating whether the component can raise an event. (Inherited from Component) |
| CellPadding |
Gets or sets the amount of space between the contents of the cell and the cell's border. (Inherited from TableStyle) |
| CellSpacing |
Gets or sets the distance between table cells. (Inherited from TableStyle) |
| Container |
Gets the IContainer that contains the Component. (Inherited from Component) |
| CssClass |
Gets or sets the cascading style sheet (CSS) class rendered by the Web server control on the client. (Inherited from Style) |
| DesignMode |
Gets a value that indicates whether the Component is currently in design mode. (Inherited from Component) |
| Events |
Gets the list of event handlers that are attached to this Component. (Inherited from Component) |
| Font |
Gets the font properties associated with the Web server control. (Inherited from Style) |
| ForeColor |
Gets or sets the foreground color (typically the color of the text) of the Web server control. (Inherited from Style) |
| GridLines |
Gets or sets a value that specifies whether the border between the cells of the table control is displayed. (Inherited from TableStyle) |
| Height |
Gets or sets the height of the Web server control. (Inherited from Style) |
| HorizontalAlign |
Gets a value indicating what type of horizontal alignment to use for the content of a menu on a WebPart control. |
| IsEmpty |
A protected property. Gets a value indicating whether any style elements have been defined in the state bag. (Inherited from Style) |
| IsTrackingViewState |
Returns a value indicating whether any style elements have been defined in the state bag. (Inherited from Style) |
| RegisteredCssClass |
Gets the cascading style sheet (CSS) class that is registered with the control. (Inherited from Style) |
| ShadowColor |
Gets or sets a value that determines the shadow color for a menu on a WebPart control. |
| Site |
Gets or sets the ISite of the Component. (Inherited from Component) |
| ViewState |
Gets the state bag that holds the style elements. (Inherited from Style) |
| Width |
Gets or sets the width of the Web server control. (Inherited from Style) |
Methods
| AddAttributesToRender(HtmlTextWriter) |
Adds HTML attributes and styles that need to be rendered to the specified HtmlTextWriter. This method is primarily used by control developers. (Inherited from Style) |
| AddAttributesToRender(HtmlTextWriter, WebControl) |
Adds information about the background image, cell spacing, cell padding, gridlines, and alignment to the list of attributes to render. (Inherited from TableStyle) |
| CopyFrom(Style) |
Copies nonblank style elements to the WebPartMenuStyle object, overwriting any existing style elements in the process. |
| CreateObjRef(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) |
| Dispose() |
Releases all resources used by the Component. (Inherited from Component) |
| Dispose(Boolean) |
Releases the unmanaged resources used by the Component and optionally releases the managed resources. (Inherited from Component) |
| Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
| FillStyleAttributes(CssStyleCollection, IUrlResolutionService) |
Adds the style properties of the TableStyle object to the specified CssStyleCollection collection. (Inherited from TableStyle) |
| GetHashCode() |
Serves as the default hash function. (Inherited from Object) |
| GetLifetimeService() |
Obsolete.
Retrieves the current lifetime service object that controls the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| GetService(Type) |
Returns an object that represents a service provided by the Component or by its Container. (Inherited from Component) |
| GetStyleAttributes(IUrlResolutionService) |
Retrieves the CssStyleCollection object for the specified IUrlResolutionService-implemented object. (Inherited from Style) |
| GetType() |
Gets the Type of the current instance. (Inherited from Object) |
| InitializeLifetimeService() |
Obsolete.
Obtains a lifetime service object to control the lifetime policy for this instance. (Inherited from MarshalByRefObject) |
| LoadViewState(Object) |
Loads the previously saved state. (Inherited from Style) |
| MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
| MemberwiseClone(Boolean) |
Creates a shallow copy of the current MarshalByRefObject object. (Inherited from MarshalByRefObject) |
| MergeWith(Style) |
Copies nonblank style elements to the WebPartMenuStyle instance, but does not overwrite existing style elements. |
| Reset() |
Removes any defined style elements from the WebPartMenuStyle object's state bag. |
| SaveViewState() |
A protected method. Saves any state that has been modified after the TrackViewState() method was invoked. (Inherited from Style) |
| SetBit(Int32) |
A protected internal method. Sets an internal bitmask field that indicates the style properties that are stored in the state bag. (Inherited from Style) |
| SetDirty() |
Marks the Style so that its state will be recorded in view state. (Inherited from Style) |
| ToString() |
Returns a string that represents the current object. (Inherited from Style) |
| TrackViewState() |
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) |
Events
| Disposed |
Occurs when the component is disposed by a call to the Dispose() method. (Inherited from Component) |
Explicit Interface Implementations
| ICustomTypeDescriptor.GetAttributes() |
Returns a collection of custom attributes for this instance of a component. Implements the GetAttributes() method. |
| ICustomTypeDescriptor.GetClassName() |
Returns the class name of this instance of a component. This method implements the GetClassName() method. |
| ICustomTypeDescriptor.GetComponentName() |
Returns the name of this instance of a component. This method implements the GetComponentName() method. |
| ICustomTypeDescriptor.GetConverter() |
Returns a type converter for this instance of a component. This method implements the GetConverter() method. |
| ICustomTypeDescriptor.GetDefaultEvent() |
Returns the default event for this instance of a component. This method implements the GetDefaultEvent() method. |
| ICustomTypeDescriptor.GetDefaultProperty() |
Returns the default property for this instance of a component. This method implements the GetDefaultProperty() method. |
| ICustomTypeDescriptor.GetEditor(Type) |
Returns an editor of the specified type for this instance of a component. This method implements the GetEditor(Type) method. |
| ICustomTypeDescriptor.GetEvents() |
Returns the events for this instance of a component. This method implements the GetEvents() method overload. |
| ICustomTypeDescriptor.GetEvents(Attribute[]) |
Returns the events for this instance of a component using the specified attribute array as a filter. This method implements the GetEvents(Attribute[]) method overload. |
| ICustomTypeDescriptor.GetProperties() |
Returns the properties for this instance of a component. This method implements the GetProperties() method overload. |
| ICustomTypeDescriptor.GetProperties(Attribute[]) |
Returns the properties for this instance of a component using the attribute array as a filter. This method implements the GetProperties(Attribute[]) method overload. |
| ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor) |
Returns an object that contains the property described by the specified property descriptor. This method implements the GetPropertyOwner(PropertyDescriptor) method. |
| IStateManager.IsTrackingViewState |
Gets a value that indicates whether a server control is tracking its view state changes. (Inherited from Style) |
| IStateManager.LoadViewState(Object) |
Loads the previously saved state. (Inherited from Style) |
| IStateManager.SaveViewState() |
Returns the object containing state changes. (Inherited from Style) |
| IStateManager.TrackViewState() |
Starts tracking state changes. (Inherited from Style) |
