DesignerActionService.GetComponentActions Method

Definition

Namespace:

System.ComponentModel.Design

Assembly:

System.Windows.Forms.Design.dll

Returns the collection of smart tag item lists associated with a component.

Overloads

GetComponentActions(IComponent)	Returns the collection of smart tag item lists associated with a component.
GetComponentActions(IComponent, ComponentActionsType)	Returns the collection of designer action item lists of the specified type associated with a component.

GetComponentActions(IComponent)

Returns the collection of smart tag item lists associated with a component.

public:
 System::ComponentModel::Design::DesignerActionListCollection ^ GetComponentActions(System::ComponentModel::IComponent ^ component);

public System.ComponentModel.Design.DesignerActionListCollection GetComponentActions (System.ComponentModel.IComponent component);

member this.GetComponentActions : System.ComponentModel.IComponent -> System.ComponentModel.Design.DesignerActionListCollection

Public Function GetComponentActions (component As IComponent) As DesignerActionListCollection

Parameters

component

IComponent

The component that the smart tags are associated with.

Returns

DesignerActionListCollection

The collection of smart tags for the specified component.

Exceptions

ArgumentNullException

comp is null.

Remarks

The GetComponentActions method is equivalent to a call to the GetComponentActions(IComponent, ComponentActionsType) method using a type parameter of All. Therefore, the collection returned will contain both the push and pull lists of smart tags.

The returned DesignerActionListCollection is the union of item lists added through the Add methods and also the lists obtained from the DesignerCommandSet instance obtained from the component's site.

See also

• GetComponentDesignerActions(IComponent, DesignerActionListCollection)
• GetComponentServiceActions(IComponent, DesignerActionListCollection)
• Add
• DesignerCommandSet
• Designer Commands and the DesignerAction Object Model for Windows Forms

GetComponentActions(IComponent, ComponentActionsType)

Returns the collection of designer action item lists of the specified type associated with a component.

public:
 virtual System::ComponentModel::Design::DesignerActionListCollection ^ GetComponentActions(System::ComponentModel::IComponent ^ component, System::Windows::Forms::Design::ComponentActionsType type);

public virtual System.ComponentModel.Design.DesignerActionListCollection GetComponentActions (System.ComponentModel.IComponent component, System.Windows.Forms.Design.ComponentActionsType type);

abstract member GetComponentActions : System.ComponentModel.IComponent * System.Windows.Forms.Design.ComponentActionsType -> System.ComponentModel.Design.DesignerActionListCollection
override this.GetComponentActions : System.ComponentModel.IComponent * System.Windows.Forms.Design.ComponentActionsType -> System.ComponentModel.Design.DesignerActionListCollection

Public Overridable Function GetComponentActions (component As IComponent, type As ComponentActionsType) As DesignerActionListCollection

Parameters

component

IComponent

The component that the DesignerActions are associated with.

type

ComponentActionsType

The ComponentActionsType to filter the associated designer actions with.

Returns

DesignerActionListCollection

The collection of designer actions of the specified type for the specified component.

Exceptions

ArgumentNullException

component is null.

Remarks

This version of the overloaded GetComponentActions method filters on the type parameter, which can have one of the following values.

Value	Description
All	All associated designer actions.
Component	Pull-model designer actions only.
Service	Push-model designer actions only.

If the associated designer for a component does not supply a pull-model designer action list, then the GetComponentActions method will instead use the designer's design-time shortcut menu items from the Verbs property.