mscorlib(4.0.0.0) API with additions
System.ComponentModel.Design Namespace Reference

Classes

class  ActiveDesignerEventArgs
 Provides data for the P:System.ComponentModel.Design.IDesignerEventService.ActiveDesigner event. More...
 
class  CheckoutException
 The exception that is thrown when an attempt to check out a file that is checked into a source code management program is canceled or fails. More...
 
class  CommandID
 Represents a unique command identifier that consists of a numeric command ID and a GUID menu group identifier. More...
 
class  ComponentChangedEventArgs
 Provides data for the E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged event. This class cannot be inherited. More...
 
class  ComponentChangingEventArgs
 Provides data for the E:System.ComponentModel.Design.IComponentChangeService.ComponentChanging event. This class cannot be inherited. More...
 
class  ComponentEventArgs
 Provides data for the E:System.ComponentModel.Design.IComponentChangeService.ComponentAdded, E:System.ComponentModel.Design.IComponentChangeService.ComponentAdding, E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoved, and E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoving events. More...
 
class  ComponentRenameEventArgs
 Provides data for the E:System.ComponentModel.Design.IComponentChangeService.ComponentRename event. More...
 
class  DesignerCollection
 Represents a collection of designers. More...
 
class  DesignerEventArgs
 Provides data for the E:System.ComponentModel.Design.IDesignerEventService.DesignerCreated and E:System.ComponentModel.Design.IDesignerEventService.DesignerDisposed events. More...
 
class  DesignerOptionService
 Provides a base class for getting and setting option values for a designer. More...
 
class  DesignerTransaction
 Provides a way to group a series of design-time actions to improve performance and enable most types of changes to be undone. More...
 
class  DesignerTransactionCloseEventArgs
 Provides data for the E:System.ComponentModel.Design.IDesignerHost.TransactionClosed and E:System.ComponentModel.Design.IDesignerHost.TransactionClosing events. More...
 
class  DesignerVerb
 Represents a verb that can be invoked from a designer. More...
 
class  DesignerVerbCollection
 Represents a collection of T:System.ComponentModel.Design.DesignerVerb objects. More...
 
class  DesigntimeLicenseContext
 Represents a design-time license context that can support a license provider at design time. More...
 
class  DesigntimeLicenseContextSerializer
 Provides support for design-time license context serialization. More...
 
class  HelpKeywordAttribute
 Specifies the context keyword for a class or member. This class cannot be inherited. More...
 
interface  IComponentChangeService
 Provides an interface to add and remove the event handlers for events that add, change, remove or rename components, and provides methods to raise a E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged or E:System.ComponentModel.Design.IComponentChangeService.ComponentChanging event. More...
 
interface  IComponentDiscoveryService
 Enables enumeration of components at design time. More...
 
interface  IComponentInitializer
 Provides a set of recommended default values during component creation. More...
 
interface  IDesigner
 Provides the basic framework for building a custom designer. More...
 
interface  IDesignerEventService
 Provides event notifications when root designers are added and removed, when a selected component changes, and when the current root designer changes. More...
 
interface  IDesignerFilter
 Provides an interface that enables a designer to access and filter the dictionaries of a T:System.ComponentModel.TypeDescriptor that stores the property, attribute, and event descriptors that a component designer can expose to the design-time environment. More...
 
interface  IDesignerHost
 Provides an interface for managing designer transactions and components. More...
 
interface  IDesignerHostTransactionState
 Specifies methods for the designer host to report on the state of transactions. More...
 
interface  IDesignerOptionService
 Provides access to the designer options located on the Tools menu under the Options command in the Visual Studio development environment. More...
 
interface  IDictionaryService
 Provides a basic, component site-specific, key-value pair dictionary through a service that a designer can use to store user-defined data. More...
 
interface  IEventBindingService
 Provides a service for registering event handlers for component events. More...
 
interface  IExtenderListService
 Provides an interface that can list extender providers. More...
 
interface  IExtenderProviderService
 Provides an interface for adding and removing extender providers at design time. More...
 
interface  IHelpService
 Provides methods for showing Help topics and adding and removing Help keywords at design time. More...
 
interface  IInheritanceService
 Provides methods for identifying the components of a component. More...
 
interface  IMenuCommandService
 Provides methods to manage the global designer verbs and menu commands available in design mode, and to show some types of shortcut menus. More...
 
interface  IReferenceService
 Provides an interface for obtaining references to objects within a project by name or type, obtaining the name of a specified object, and for locating the parent of a specified object within a designer project. More...
 
interface  IResourceService
 Provides an interface for designers to access resource readers and writers for specific T:System.Globalization.CultureInfo resource types. More...
 
interface  IRootDesigner
 Provides support for root-level designer view technologies. More...
 
interface  ISelectionService
 Provides an interface for a designer to select components. More...
 
interface  IServiceContainer
 Provides a container for services. More...
 
interface  ITreeDesigner
 Provides support for building a set of related custom designers. More...
 
interface  ITypeDescriptorFilterService
 Provides an interface to modify the set of member descriptors for a component in design mode. More...
 
interface  ITypeDiscoveryService
 Discovers available types at design time. More...
 
interface  ITypeResolutionService
 Provides an interface to retrieve an assembly or type by name. More...
 
class  MenuCommand
 Represents a Windows menu or toolbar command item. More...
 
class  ServiceContainer
 Provides a simple implementation of the T:System.ComponentModel.Design.IServiceContainer interface. This class cannot be inherited. More...
 
class  StandardCommands
 Defines identifiers for the standard set of commands that are available to most applications. More...
 
class  StandardToolWindows
 Defines GUID identifiers that correspond to the standard set of tool windows that are available in the design environment. More...
 
class  TypeDescriptionProviderService
 Provides a type description provider for a specified type. More...
 

Enumerations

enum  HelpContextType { HelpContextType.Ambient, HelpContextType.Window, HelpContextType.Selection, HelpContextType.ToolWindowSelection }
 Defines identifiers that indicate information about the context in which a request for Help information originated. More...
 
enum  HelpKeywordType { HelpKeywordType.F1Keyword, HelpKeywordType.GeneralKeyword, HelpKeywordType.FilterKeyword }
 Defines identifiers that indicate the type of a Help keyword. More...
 
enum  SelectionTypes {
  SelectionTypes.Auto = 0x1, SelectionTypes.Normal = 0x1, SelectionTypes.Replace = 0x2, SelectionTypes.MouseDown = 0x4,
  SelectionTypes.MouseUp = 0x8, SelectionTypes.Click = 0x10, SelectionTypes.Primary = 0x10, SelectionTypes.Toggle = 0x20,
  SelectionTypes.Add = 0x40, SelectionTypes.Remove = 0x80, SelectionTypes.Valid = 0x1F
}
 Defines identifiers that indicate the type of a selection. More...
 
enum  ViewTechnology { ViewTechnology.Passthrough, ViewTechnology.WindowsForms, ViewTechnology.Default }
 Defines identifiers for a set of technologies that designer hosts support. More...
 

Functions

delegate void ActiveDesignerEventHandler (object sender, ActiveDesignerEventArgs e)
 Represents the method that will handle the E:System.ComponentModel.Design.IDesignerEventService.ActiveDesignerChanged event. More...
 
delegate void ComponentChangedEventHandler (object sender, ComponentChangedEventArgs e)
 Represents the method that will handle a E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged event. More...
 
delegate void ComponentChangingEventHandler (object sender, ComponentChangingEventArgs e)
 Represents the method that will handle a E:System.ComponentModel.Design.IComponentChangeService.ComponentChanging event. More...
 
delegate void ComponentEventHandler (object sender, ComponentEventArgs e)
 Represents the method that will handle the E:System.ComponentModel.Design.IComponentChangeService.ComponentAdding, E:System.ComponentModel.Design.IComponentChangeService.ComponentAdded, E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoving, and E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoved events raised for component-level events. More...
 
delegate void ComponentRenameEventHandler (object sender, ComponentRenameEventArgs e)
 Represents the method that will handle a E:System.ComponentModel.Design.IComponentChangeService.ComponentRename event. More...
 
delegate void DesignerEventHandler (object sender, DesignerEventArgs e)
 Represents the method that will handle the E:System.ComponentModel.Design.IDesignerEventService.DesignerCreated and E:System.ComponentModel.Design.IDesignerEventService.DesignerDisposed events that are raised when a document is created or disposed of. More...
 
delegate void DesignerTransactionCloseEventHandler (object sender, DesignerTransactionCloseEventArgs e)
 Represents the method that handles the E:System.ComponentModel.Design.IDesignerHost.TransactionClosed and E:System.ComponentModel.Design.IDesignerHost.TransactionClosing events of a designer. More...
 
delegate object ServiceCreatorCallback (IServiceContainer container, Type serviceType)
 Provides a callback mechanism that can create an instance of a service on demand. More...
 

Enumeration Type Documentation

◆ HelpContextType

Defines identifiers that indicate information about the context in which a request for Help information originated.

Enumerator
Ambient 

A general context.

Window 

A window.

Selection 

A selection.

ToolWindowSelection 

A tool window selection.

Definition at line 4 of file HelpContextType.cs.

◆ HelpKeywordType

Defines identifiers that indicate the type of a Help keyword.

Enumerator
F1Keyword 

A keyword that F1 was pressed to request help about.

GeneralKeyword 

A general keyword.

FilterKeyword 

A filter keyword.

Definition at line 4 of file HelpKeywordType.cs.

◆ SelectionTypes

Defines identifiers that indicate the type of a selection.

Enumerator
Auto 

Represents a regular selection. The selection service responds to the CTRL and SHIFT keys to support adding or removing components to or from the selection.

Normal 

Represents a regular selection. The selection service responds to the CTRL and SHIFT keys to support adding or removing components to or from the selection.

Replace 

Represents a selection that occurs when the content of a selection is replaced. The selection service replaces the current selection with the replacement.

MouseDown 

Represents a selection that occurs when the user presses on the mouse button while the mouse pointer is over a component. If the component under the pointer is already selected, it is promoted to become the primary selected component rather than being canceled.

MouseUp 

Represents a selection that occurs when the user releases the mouse button immediately after a component has been selected. If the newly selected component is already selected, it is promoted to be the primary selected component rather than being canceled.

Click 

Represents a selection that occurs when a user clicks a component. If the newly selected component is already selected, it is promoted to be the primary selected component rather than being canceled.

Primary 

Represents a primary selection that occurs when a user clicks on a component. If a component in the selection list is already selected, the component is promoted to be the primary selection.

Toggle 

Represents a toggle selection that switches between the current selection and the provided selection. If a component is already selected and is passed into Overload:System.ComponentModel.Design.ISelectionService.SetSelectedComponents with a selection type of F:System.ComponentModel.Design.SelectionTypes.Toggle, the component selection will be canceled.

Add 

Represents an add selection that adds the selected components to the current selection, maintaining the current set of selected components.

Remove 

Represents a remove selection that removes the selected components from the current selection, maintaining the current set of selected components.

Valid 

Identifies the valid selection types as F:System.ComponentModel.Design.SelectionTypes.Normal, F:System.ComponentModel.Design.SelectionTypes.Replace, F:System.ComponentModel.Design.SelectionTypes.MouseDown, F:System.ComponentModel.Design.SelectionTypes.MouseUp, or F:System.ComponentModel.Design.SelectionTypes.Click.

Definition at line 8 of file SelectionTypes.cs.

◆ ViewTechnology

Defines identifiers for a set of technologies that designer hosts support.

Enumerator
Passthrough 

Represents a mode in which the view object is passed directly to the development environment.

WindowsForms 

Represents a mode in which a Windows Forms control object provides the display for the root designer.

Default 

Specifies the default view technology support.

Definition at line 7 of file ViewTechnology.cs.

Function Documentation

◆ ActiveDesignerEventHandler()

delegate void System.ComponentModel.Design.ActiveDesignerEventHandler ( object  sender,
ActiveDesignerEventArgs  e 
)

Represents the method that will handle the E:System.ComponentModel.Design.IDesignerEventService.ActiveDesignerChanged event.

Parameters
senderThe source of the event.
eAn T:System.ComponentModel.Design.ActiveDesignerEventArgs that contains the event data.

◆ ComponentChangedEventHandler()

delegate void System.ComponentModel.Design.ComponentChangedEventHandler ( object  sender,
ComponentChangedEventArgs  e 
)

Represents the method that will handle a E:System.ComponentModel.Design.IComponentChangeService.ComponentChanged event.

Parameters
senderThe source of the event.
eA T:System.ComponentModel.Design.ComponentChangedEventArgs that contains the event data.

◆ ComponentChangingEventHandler()

delegate void System.ComponentModel.Design.ComponentChangingEventHandler ( object  sender,
ComponentChangingEventArgs  e 
)

Represents the method that will handle a E:System.ComponentModel.Design.IComponentChangeService.ComponentChanging event.

Parameters
senderThe source of the event.
eA T:System.ComponentModel.Design.ComponentChangingEventArgs event that contains the event data.

◆ ComponentEventHandler()

delegate void System.ComponentModel.Design.ComponentEventHandler ( object  sender,
ComponentEventArgs  e 
)

Represents the method that will handle the E:System.ComponentModel.Design.IComponentChangeService.ComponentAdding, E:System.ComponentModel.Design.IComponentChangeService.ComponentAdded, E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoving, and E:System.ComponentModel.Design.IComponentChangeService.ComponentRemoved events raised for component-level events.

Parameters
senderThe source of the event.
eA T:System.ComponentModel.Design.ComponentEventArgs that contains the event data.

◆ ComponentRenameEventHandler()

delegate void System.ComponentModel.Design.ComponentRenameEventHandler ( object  sender,
ComponentRenameEventArgs  e 
)

Represents the method that will handle a E:System.ComponentModel.Design.IComponentChangeService.ComponentRename event.

Parameters
senderThe source of the event.
eA T:System.ComponentModel.Design.ComponentRenameEventArgs that contains the event data.

◆ DesignerEventHandler()

delegate void System.ComponentModel.Design.DesignerEventHandler ( object  sender,
DesignerEventArgs  e 
)

Represents the method that will handle the E:System.ComponentModel.Design.IDesignerEventService.DesignerCreated and E:System.ComponentModel.Design.IDesignerEventService.DesignerDisposed events that are raised when a document is created or disposed of.

Parameters
senderThe source of the event.
eA T:System.ComponentModel.Design.DesignerEventArgs that contains the event data.

◆ DesignerTransactionCloseEventHandler()

delegate void System.ComponentModel.Design.DesignerTransactionCloseEventHandler ( object  sender,
DesignerTransactionCloseEventArgs  e 
)

Represents the method that handles the E:System.ComponentModel.Design.IDesignerHost.TransactionClosed and E:System.ComponentModel.Design.IDesignerHost.TransactionClosing events of a designer.

Parameters
senderThe source of the event.
eA T:System.ComponentModel.Design.DesignerTransactionCloseEventArgs that contains the event data.

◆ ServiceCreatorCallback()

delegate object System.ComponentModel.Design.ServiceCreatorCallback ( IServiceContainer  container,
Type  serviceType 
)

Provides a callback mechanism that can create an instance of a service on demand.

Parameters
containerThe service container that requested the creation of the service.
serviceTypeThe type of service to create.
Returns
The service specified by serviceType , or null if the service could not be created.