DesignerActionUIService Class

Reference

Definition

Namespace:: System.ComponentModel.Design

Assembly:: System.Design.dll

Assembly:: System.Windows.Forms.Design.dll

Source:: DesignerActionUIService.cs

Source:: DesignerActionUIService.cs

Source:: DesignerActionUIService.cs

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.

Manages the user interface (UI) for a smart tag panel. This class cannot be inherited.

public ref class DesignerActionUIService sealed : IDisposable

public sealed class DesignerActionUIService : IDisposable

type DesignerActionUIService = class
    interface IDisposable

Public NotInheritable Class DesignerActionUIService
Implements IDisposable

Inheritance: Object
DesignerActionUIService

Implements: IDisposable

Examples

The following code example demonstrates how to use the Refresh method to update a smart tag panel. This example is part of a larger example available in the DesignerActionService class overview.

// Boolean properties are automatically displayed with binary 
// UI (such as a checkbox).
public bool LockColors
{
    get
    {
        return colLabel.ColorLocked;
    }
    set
    {
        GetPropertyByName("ColorLocked").SetValue(colLabel, value);

        // Refresh the list.
        this.designerActionUISvc.Refresh(this.Component);
    }
}

'Boolean properties are automatically displayed with binary 
' UI (such as a checkbox).
Public Property LockColors() As Boolean
    Get
        Return colLabel.ColorLocked
    End Get
    Set(ByVal value As Boolean)
        GetPropertyByName("ColorLocked").SetValue(colLabel, value)

        ' Refresh the list.
        Me.designerActionUISvc.Refresh(Me.Component)
    End Set
End Property

Remarks

You can control the display of your designer's ActionLists with the DesignerActionUIService class. DesignerActionUIService provides a straightforward interface for displaying the items for each component, including the following methods and events:

The ShowUI and HideUI methods display and hide the items for a component.
The DesignerActionUIStateChange event indicates when the UI changes for a component.

Use the DesignerActionService to manage the DesignerActionList collections associated with your component.

Methods

Dispose()	Releases all resources used by the DesignerActionUIService class.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
HideUI(IComponent)	Hides the smart tag panel for a component.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
Refresh(IComponent)	Updates the smart tag panel.
ShouldAutoShow(IComponent)	Indicates whether to automatically show the smart tag panel.
ShowUI(IComponent)	Displays the smart tag panel for a component.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Events

DesignerActionUIStateChange

Occurs when a request is made to show or hide a smart tag panel.

Applies to

Jaa