NGWS SDK Documentation  

This is preliminary documentation and subject to change.
To comment on this topic, please send us email at ngwssdk@microsoft.com. Thanks!

System.ComponentModel.Design Namespace

Classes

Class Description
ActiveDocumentEventArgs Provides data for the System.ComponentModel.Design.IDesignerEventService.ActiveDocument event.
AliasEditor AliasEditor is a value editor that intelligently edits strings that have aliases.
ArrayDialog ArrayDialog is a modal dialog that allows editing of arrays. With it, you can add, remove, and sort the items in the array. It requires an ArrayEditor which it calls to create new values.
ArrayEditor ArrayEditor derives from CollectionEditor to edit arrays of values.
BatchOperationEventArgs Provides data about the System.ComponentModel.Design.IDesignerHost.BatchOperation event.
BinaryEditor Generic editor for editing binary data. This presents a hex editing window to the user.
BlankIntegerEditor [To be supplied.]
ByteEditor [To be supplied.]
ByteViewer This class implements a ByteViewer component. This component is capable of displaying byte arrays in HEXDUMP, ANSI and UNICODE views. The HEXDUMP view is a view with hex values and corresponding byte representations (chars). The dafault number of columns is 16. The ANSI and UNICODE views show the byte aray in a read only edit box. In this view the null characters are replaced with Windows box charcter alowing to display the entire buffer. The AUTO view selects a default display mode based on the contents of the byte array. It uses a simple algorithm to establish what kind of data is stored in the buffer
CheckoutException Represents the exception thrown when an attempt is made to edit a file that is checked into a source control program.
CodePersister The code persister is part of a trio of objects that load and save the document. At the base of this trio is the CodeStream object, which is required for loading and saving documents. On top of the code stream is an optional language layer. This language layer allows documents that are based on source code to be loaded and saved in a generic manner. The language layer implements a series of "code access" interfaces through which an object may read and write source code in a language independent way. The code persister is the object responsible for reading and writing to the code access interfaces.
CodeStream The code stream is used to load and save the document.
CollectionEditor  
CommandID Represents a numeric Command ID and globally unique ID (GUID) menu identifier that together uniquely identify a command.
ComponentChangedEventArgs Provides data for the System.ComponentModel.Design.ComponentChangedEvent.ComponentChangedEvent event.
ComponentChangingEventArgs Provides data for the System.ComponentModel.Design.ComponentChangingEvent event.
ComponentDesigner The default designer for all components. Almost everything that extends from Component will typically have one of these designers as their base designer. Designers do not have to inherit from this class, but it does provide some convenient features.
ComponentEventArgs Provides data for the System.ComponentModel.Design.ComponentEvent event raised for component-level events.
ComponentModelPersister Component model persister. This object can convert a component object graph to and from source code. It also provides code navigation services to the designer.
ComponentModelPersister.LocalCache.LocalCacheItemComparer [To be supplied.]
ComponentRenameEventArgs Provides data for the System.ComponentModel.Design.ComponentRenameEvent.ComponentRenameEvent event.
CompoundPropertyChangeActionUnit Represents a series of property change action units that can be treated as a single atomic action.
ContentAlignmentEditor [To be supplied.]
ContentAlignmentEditor.EditControl [To be supplied.]
CultureInfoEditor [To be supplied.]
CurrencyEditor [To be supplied.]
DatePickerEditor This is a value editor bringing up a dialog with calendar control in it for user to pick a date.
DatePickerEditor.DatePicker [To be supplied.]
DateTimeEditor This date time editor is a UITypeEditor suitable for visually editing DateTime objects.
DateTimeFormatEditor [To be supplied.]
DecimalEditor [To be supplied.]
DesignerVerb Represents a verb that can be executed by a component's designer. Verbs are dynamic menu commands whose text image can be determined at runtime.
DesigntimeLicenseContext Provides design-time support for licensing.
DesigntimeLicenseContextSerializer Provides support for design-time license context serialization.
DocumentCollection Provides a read-only collection of documents.
DocumentEventArgs Provides data for the DocumentEventArgs event that is generated when a document is created or disposed.
EventHandlerSetActionUnit Represents an atomic undoable action unit to be added to the IUndoService implementation.
GuidEditor GuidEditor is the default editor for Guids.
ImmediateStringEditor [To be supplied.]
InheritanceAttribute Marks instances of objects that are inherited from their base superclass. This class cannot be inherited.
InheritanceService The inheritance service provides a set of utilities for analyzing and identifying inherited components.
InheritedPropertyDescriptor An inherited property descriptor is used to replace all properties on a component that is being inherited. An inherited property descriptor is identical to the component's original property descriptor except for two things. First, you can tie additional attributes into this property descriptor, such as ReadOnly if the property should not be accessible on an inherited component. Second, this property descriptor stores a new default value attribute for the property that is the current value of this property on the component. This override is important because the inherited component may have different values for its defaults than its own property descriptor states.
IntegerEditor [To be supplied.]
Localizer [To be supplied.]
MemberModifier Specifies constant values for common attributes applied to member functions.
MenuCommand Represents a Windows menu or toolbar item.
NameEditor [To be supplied.]
NonEditableReferenceEditor NonEditableReferenceEditor is an editor that displays the name of a component. Other references can not be substituted.
NotifyParentPropertyAttribute Indicates whether the parent property is notified if a child namespace property is modified.
NumericFormatEditor [To be supplied.]
NumericFormatTypeEditor [To be supplied.]
ObjectPropertiesEditor [To be supplied.]
ObjectSelectorEditor [To be supplied.]
ObjectSelectorEditor.Selector [To be supplied.]
ObjectSelectorEditor.SelectorNode [To be supplied.]
OldArrayEditor ArrayEditor is a value editor that intelligently edits arrays. It uses ArrayDialog in editValue to visually add, remove, and sort arrays. It is a value editor that takes a Class in it's constructor so it knows the type of the array it is editing. ArrayEditor supports editing values, but does not convert text into values.
OldCollectionEditor Generic editor for any collection property
OldCollectionEditor.CollectionDialog ArrayDialog is a modal dialog that allows editing of arrays. With it, you can add, remove, and sort the items in the array. It requires an ArrayEditor which it calls to create new values.
ParenthesizePropertyNameAttribute Indicates whether the name of the associated property is paraenthesized in the property browser.
PropertyChangeActionUnit Represents a property change action unit.
PropertyTabAttribute This attribute identifies the property tab or tabs that should be displayed for a given class.
PropertyValue PropertyValue encapsulates information about a property's type and value. The goal of the class is to enable persistence in code (code-spit) of any object. @author stefanph, August 1998 UNDONE: Brianpe/ ChrisAn, 5/15/99- Is this really the thing we want to surface here?: I think we should probably be using the code model interfaces more...
ReadOnlyValueEditor [To be supplied.]
ReferenceEditor ReferenceEditor is an editor that handles references to other components. When asked to list the possible values, it will query the container of the hosting component for all components that implement the given type and return that list.
RefreshPropertiesAttribute Specifies how a forms designer refreshes when the property value is changed.
ResourceValueProvider ValueProvider for the ResourceManager
StandardCommands This class contains the standard set of commands that are available to most applications.
StandardToolWindows This class defines GUIDs that reference the standard set of tool windows that are available in the design environment.
StringEditor [To be supplied.]
StringListEditor StringListEditor supports design time editing of an array of Strings using the StringListDialog.
TimeSpanEditor [To be supplied.]
ToolboxComponentsCreatedEvent Provides data for the ToolboxComponentsCreatedEventHandler that handles the event that occurs when components are added to the toolbox.
ToolboxItemAttribute Specifies attributes for a toolbox item.
TypeChangedEventArgs Provides data for the System.ComponentModel.Design.TypeChangedEvent that occurs when the source code for a specified type has been modified.
UIActivationStateEventArgs Provides data for the System.ComponentModel.Design.UIActivationStateEvent event.
ValueEditorConverter [To be supplied.]
ValueEditorHost [To be supplied.]
ValueProvider Interface defining an object that needs to participate in code generation to persist data outside of the code. This allows the runtime object to "provide values" to components on the form.
ValueProviderCollection Collection of IValueProvider objects.
ValueProviderService The value provider service provides a collection of value providers that will be called on when code is persisted or depersisted.
VariantEditor [To be supplied.]

Interfaces

Interface Description
IActionUnit Represents an atomic undoable action unit to be added to the IUndoService implementation.
IApplicationExtensibilityService The application extensibility service.
ICheckoutService Provides an interface for checking out files to edit.
ICodeNavigatorService Provides simple code navigation services.
ICodePersisterTaskListService The ICodePersisterTaskListService interface provides a way to create a list of failures during the code persistance routines.
IComponentChangeService Provides an interface to add and remove the event handlers for component add, change, remove and rename events.
IComponentCodePersistanceService Provides an interface for retrieving components from code or persisting components to code.
ICompoundActionUnit Represents a series of action units that should be treated as a single atomic action.
IDeferLoadService Allows asynchronous loading of designers.
IDesigner This interface provides the framework for building a custom designer. This interface stores the verbs available to the designer, as well as basic services for the designer.
IDesignerEventService Provides global event notifications and the ability to create designers.
IDesignerFilter Provides access to, and an interface for filtering, the dictionaries that store the properties, attributes, and events of a component.
IDesignerHost Provides methods to adjust the configuration of and retrieve information about the services and behavior of a designer.
IDesignerOptionService Provides access to get and set option values for a designer.
IDictionaryService Provides a generic dictionary service that a designer can store user-defined data on the site.
IEditorSite IEditorSite is a callback through which value editors can get at the owners of the values they are editing. This is useful to get at other objects on the form.
IEventPropertyService This interface can convert EventDescriptors to PropertyDescriptors.
IExtenderListService Provides an interface to track extender providers.
IExtenderProviderService Provides an interface to add and remove extender providers.
IExtensibilityService Provides an interface to get an extensibility service object to control various properties of the project within the development environment.
IFilePersistanceService This service allows designers to open files as binary data. If applicable, source control rules for the files will be followed if a write to the file is attempted.
IHelpService The help service provides a way to provide the IDE (Integrated Development Environment) help system with contextual information for the current task. The help system evaluates all contextual information it gets and determines the most relevant topics to display to the user.
IInheritanceService Provides a set of utilities for analyzing and identifying inherited components.
IMenuCommandService Provides an interface for a designer to add menu items to the Visual Studio menu.
IReferenceService Provides an interface to get names and references to objects. These methods can search using the specified name or reference.
ISelectionService Provides an interface for a designer to select components.
ITestCommandService The test command interface allows various test commands to be added to the designer.
ITypeDescriptorFilterService Modifies the set of type descriptors that a component provides.
IUIActivationService Service that adds and removes event handlers when a UI component's activation state is switched after selection or deselection.
IUndoService Allows access to undo/redo functionality.
IValueProvider Defines an object that participates in code generation to persist data outside of the code.
IValueProviderCollection Provides an interface to manage a collection of IValueProvider objects.
IValueProviderService Provides access to the value provider collection that can be used for managing and checking the value providers that will be used during code persistance and depersistance.

Delegates

Delegate Description
ActiveDocumentEventHandler Represents the method that will handle the System.ComponentModel.Design.DocumentManager.ActiveDocument event raised on changes to the currently active document.
BatchOperationEventHandler Represents the method that will handle the System.ComponentModel.Design.IDesignerHost.BatchOperation event.
ComponentChangedEventHandler Represents the method that will handle a System.ComponentModel.Design.ComponentChangedEvent event.
ComponentChangingEventHandler Represents the method that will handle a System.ComponentModel.Design.ComponentChangingEvent event.
ComponentEventHandler Represents the method that will handle the System.ComponentModel.Design.ComponentEvent event raised for component-level events.
ComponentRenameEventHandler Represents the method that will handle a System.ComponentModel.Design.ComponentRenameEvent.ComponentRenameEvent.
ContainerSelectorActiveEventHandler Represents the method that will handle a System.ComponentModel.Design.ContainerSelectorActiveEvent event.
DocumentEventHandler Represents the method that will handle the DocumentEventArgs event raised when a document is created or disposed.
TestCommand [To be supplied.]
ToolboxComponentsCreatedEventHandler Represents the method that will handle the System.ComponentModel.Design.ToolboxComponentsCreatedEvent.ToolboxComponentsCreatedEvent event.
TypeChangedEventHandler Represents the method that handles the event raised when a System.ComponentModel.Design.TypeChangedEvent.TypeChangedEvent occurs.
UIActivationStateEventHandler Represents the method that will handle the event raised when a System.ComponentModel.Design.UIActiavationStateEvent.UIActivationStateEvent occurs.

Enumerations

Enumeration Description
ActionType Specifies the values to represent an action's undo/redo ActionType state.
DisplayMode [To be supplied.]
HelpKeywordType [To be supplied.]
InheritanceLevel Specifies numeric IDs for different inheritance levels.
PropertyTabScope Specifies the function scope of a tab in the property browser.
RefreshProperties Specifies values for use in refreshing the design time view.
SelectionRules Specifies a set of selection rule identifiers that can be used to indicate attributes for a selected component.
SelectionStyles Specifies identifiers to use to indicate the style of the selection frame of a component.
SelectionTypes Specifies identifiers that indicate the type of selection for a component or group of components that are selected.
ValueExpressionLevel Specifies the levels of support for an IValueProvider.