This documentation is archived and is not being maintained.

DesignerActionUIService Class

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

System.Object
  System.ComponentModel.Design.DesignerActionUIService

Namespace:  System.ComponentModel.Design
Assembly:  System.Design (in System.Design.dll)

public sealed class DesignerActionUIService : IDisposable

The DesignerActionUIService type exposes the following members.

  NameDescription
Public methodDisposeReleases all resources used by the DesignerActionUIService class.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodHideUIHides the smart tag panel for a component.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodRefreshUpdates the smart tag panel.
Public methodShouldAutoShowIndicates whether to automatically show the smart tag panel.
Public methodShowUIDisplays the smart tag panel for a component.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public eventDesignerActionUIStateChangeOccurs when a request is made to show or hide a smart tag panel.
Top

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:

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

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);
    }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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: